Allow msw bypass (#246)

* add new variable to hold the url to the local umbraco instance * set api base-url if msw is turned off * add instructions how to use local umbraco instance * set baseurl for e2e mode Co-authored-by: Mads Rasmussen <[email protected]>
umbraco · Nov 14, 2022 · e568be5 · e568be5
1 parent ab9a6af
commit e568be5
Show file tree

Hide file tree

Showing 5 changed files with 18 additions and 3 deletions.
diff --git a/.env b/.env
@@ -1,3 +1,4 @@
 # Copy this to .env.local and change what you want to test.
 VITE_UMBRACO_USE_MSW=on # on = turns on MSW, off = disables all mock handlers
+VITE_UMBRACO_API_URL=http://localhost:9000
 VITE_UMBRACO_INSTALL_STATUS=running # running or must-install or must-upgrade
diff --git a/.env.e2e b/.env.e2e
@@ -1,2 +1,3 @@
 # Copy this to .env.local and change what you want to test.
-VITE_UMBRACO_USE_MSW=off
+VITE_UMBRACO_USE_MSW=off # Playwright handles the mocking itself (using msw but it starts it up manually)
+VITE_UMBRACO_API_URL=
diff --git a/README.md b/README.md
@@ -19,6 +19,19 @@ VITE_UMBRACO_INSTALL_STATUS=must-install
 
 ## Environments
 
+### Development
+
+The development environment is the default environment and is used when running `npm run dev`. All API calls are mocked and the Umbraco backoffice is served from the `src` folder.
+
+### Run against a local Umbraco instance
+
+Create a `.env.local` file and set the following variables:
+
+```bash
+VITE_UMBRACO_API_URL=http://localhost:5000 # This will be the URL to your Umbraco instance
+VITE_UMBRACO_USE_MSW=off # Indicate that you want all API calls to bypass MSW (mock-service-worker)
+```
+
 ### Static website
 
 See the Main branch in action here as an [Azure Static Web App](https://ashy-bay-09f36a803.1.azurestaticapps.net/). The deploy runs automatically every time the `main` branch is updated. It uses mocked responses from the Umbraco API to simulate the site just like the local development environment.

diff --git a/src/app.ts b/src/app.ts
@@ -64,7 +64,7 @@ export class UmbApp extends UmbContextProviderMixin(LitElement) {
 	async connectedCallback() {
 		super.connectedCallback();
 
-		OpenAPI.BASE = '';
+		OpenAPI.BASE = import.meta.env.VITE_UMBRACO_USE_MSW === 'on' ? '' : import.meta.env.VITE_UMBRACO_API_URL;
 		OpenAPI.WITH_CREDENTIALS = true;
 
 		await this._setInitStatus();

diff --git a/src/vite-env.d.ts b/src/vite-env.d.ts
@@ -2,6 +2,6 @@
 
 interface ImportMetaEnv {
 	VITE_UMBRACO_INSTALL_STATUS: 'running' | 'must-upgrade' | 'must-install';
-	VITE_UMBRACO_INSTALL_PRECONFIGURED: string;
+	VITE_UMBRACO_API_URL: string;
 	VITE_UMBRACO_USE_MSW: 'on' | 'off';
 }