Add tests for custom server (#2798)

mui · Oct 13, 2023 · 34b6b53 · 34b6b53
1 parent 4f8a835
commit 34b6b53
Show file tree

Hide file tree

Showing 36 changed files with 455 additions and 141 deletions.
diff --git a/packages/toolpad-app/src/server/EnvManager.ts b/packages/toolpad-app/src/server/EnvManager.ts
@@ -99,4 +99,9 @@ export default class EnvManager {
   async getDeclaredValues(): Promise<Record<string, string>> {
     return this.values;
   }
+
+  // eslint-disable-next-line class-methods-use-this
+  getEnv() {
+    return process.env;
+  }
 }
diff --git a/packages/toolpad-app/src/server/FunctionsManager.ts b/packages/toolpad-app/src/server/FunctionsManager.ts
@@ -17,6 +17,7 @@ import {
 import { errorFrom } from '@mui/toolpad-utils/errors';
 import { ToolpadDataProviderIntrospection } from '@mui/toolpad-core/runtime';
 import * as url from 'node:url';
+import invariant from 'invariant';
 import EnvManager from './EnvManager';
 import { ProjectEvents, ToolpadProjectOptions } from '../types';
 import { createWorker as createDevWorker } from './functionsDevWorker';
@@ -113,7 +114,7 @@ export default class FunctionsManager {
 
   private buildErrors: esbuild.Message[] = [];
 
-  private devWorker: ReturnType<typeof createDevWorker>;
+  private devWorker: ReturnType<typeof createDevWorker> | undefined;
 
   private extractedTypes: Awaitable<IntrospectionResult> | undefined;
 
@@ -123,7 +124,6 @@ export default class FunctionsManager {
 
   constructor(project: IToolpadProject) {
     this.project = project;
-    this.devWorker = createDevWorker(process.env);
   }
 
   private getResourcesFolder(): string {
@@ -172,7 +172,7 @@ export default class FunctionsManager {
   private async extractTypes() {
     if (!this.extractTypesWorker) {
       this.extractTypesWorker = new Piscina({
-        filename: path.join(currentDirectory, 'functionsTypesWorker.js'),
+        filename: path.resolve(currentDirectory, '../cli/functionsTypesWorker.js'),
       });
     }
 
@@ -252,26 +252,24 @@ export default class FunctionsManager {
     resourcesWatcher.on('unlink', reinitializeWatcher);
   }
 
-  private async createRuntimeWorkerWithEnv() {
+  private async createRuntimeWorker() {
     const oldWorker = this.devWorker;
-    this.devWorker = createDevWorker(process.env);
-
-    await oldWorker.terminate();
-
+    this.devWorker = createDevWorker(this.project.envManager.getEnv());
+    await oldWorker?.terminate();
     this.project.invalidateQueries();
   }
 
   async start() {
+    await this.createRuntimeWorker();
+
     if (this.project.options.dev) {
       await this.migrateLegacy();
 
       await this.startWatchingFunctionFiles();
 
       this.project.events.subscribe('envChanged', async () => {
-        await this.createRuntimeWorkerWithEnv();
+        await this.createRuntimeWorker();
       });
-
-      await this.createRuntimeWorkerWithEnv();
     }
   }
 
@@ -297,7 +295,7 @@ export default class FunctionsManager {
   async dispose() {
     await Promise.all([
       this.disposeBuildcontext(),
-      this.devWorker.terminate(),
+      this.devWorker?.terminate(),
       this.extractTypesWorker?.destroy(),
     ]);
   }
@@ -344,6 +342,7 @@ export default class FunctionsManager {
       ? [{ parameters }]
       : handler.parameters.map(([parameterName]) => parameters[parameterName]);
 
+    invariant(this.devWorker, 'devWorker must be initialized');
     const data = await this.devWorker.execute(outputFilePath, name, executeParams);
 
     return { data };
@@ -388,6 +387,7 @@ export default class FunctionsManager {
     exportName: string = 'default',
   ): Promise<ToolpadDataProviderIntrospection> {
     const fullPath = await this.getBuiltOutputFilePath(fileName);
+    invariant(this.devWorker, 'devWorker must be initialized');
     return this.devWorker.introspectDataProvider(fullPath, exportName);
   }
 
@@ -397,6 +397,7 @@ export default class FunctionsManager {
     params: GetRecordsParams<R, P>,
   ): Promise<GetRecordsResult<R, P>> {
     const fullPath = await this.getBuiltOutputFilePath(fileName);
+    invariant(this.devWorker, 'devWorker must be initialized');
     return this.devWorker.getDataProviderRecords(fullPath, exportName, params);
   }
 }
diff --git a/test/integration/backend-basic/base.spec.ts b/test/integration/backend-basic/base.spec.ts
@@ -1,5 +1,6 @@
 import * as path from 'path';
 import * as url from 'url';
+import invariant from 'invariant';
 import { expect, test } from '../../playwright/localTest';
 import { ToolpadRuntime } from '../../models/ToolpadRuntime';
 import { expectBasicPageContent } from './shared';
@@ -15,8 +16,10 @@ test.use({
 });
 
 test.use({
-  localAppConfig: {
+  projectConfig: {
     template: path.resolve(currentDirectory, './fixture'),
+  },
+  localAppConfig: {
     cmd: 'dev',
     env: {
       SECRET_BAZ: 'Some baz secret',
@@ -26,6 +29,11 @@ test.use({
 });
 
 test('base path basics', async ({ page, context, localApp }) => {
+  invariant(
+    localApp,
+    'test must be configured with `localAppConfig`. Add `test.use({ localAppConfig: ... })`',
+  );
+
   await context.addCookies([
     { name: 'MY_TOOLPAD_COOKIE', value: 'foo-bar-baz', domain: 'localhost', path: '/' },
   ]);

diff --git a/test/integration/backend-basic/baseProd.spec.ts b/test/integration/backend-basic/baseProd.spec.ts
@@ -1,5 +1,6 @@
 import * as path from 'path';
 import * as url from 'url';
+import invariant from 'invariant';
 import { expect, test } from '../../playwright/localTest';
 import { ToolpadRuntime } from '../../models/ToolpadRuntime';
 import { expectBasicPageContent } from './shared';
@@ -15,8 +16,10 @@ test.use({
 });
 
 test.use({
-  localAppConfig: {
+  projectConfig: {
     template: path.resolve(currentDirectory, './fixture'),
+  },
+  localAppConfig: {
     cmd: 'start',
     env: {
       SECRET_BAZ: 'Some baz secret',
@@ -26,6 +29,11 @@ test.use({
 });
 
 test('base path basics', async ({ page, context, localApp }) => {
+  invariant(
+    localApp,
+    'test must be configured with `localAppConfig`. Add `test.use({ localAppConfig: ... })`',
+  );
+
   await context.addCookies([
     { name: 'MY_TOOLPAD_COOKIE', value: 'foo-bar-baz', domain: 'localhost', path: '/' },
   ]);

diff --git a/test/integration/backend-basic/index.spec.ts b/test/integration/backend-basic/index.spec.ts
@@ -1,5 +1,6 @@
 import * as path from 'path';
 import * as url from 'url';
+import invariant from 'invariant';
 import { fileReplace } from '../../../packages/toolpad-utils/src/fs';
 import { test, expect } from '../../playwright/localTest';
 import { ToolpadRuntime } from '../../models/ToolpadRuntime';
@@ -28,8 +29,10 @@ test.use({
 });
 
 test.use({
-  localAppConfig: {
+  projectConfig: {
     template: path.resolve(currentDirectory, './fixture'),
+  },
+  localAppConfig: {
     cmd: 'dev',
     env: {
       SECRET_BAZ: 'Some baz secret',
@@ -49,6 +52,11 @@ test('functions basics', async ({ page, context }) => {
 });
 
 test('function editor reload', async ({ page, localApp }) => {
+  invariant(
+    localApp,
+    'test must be configured with `localAppConfig`. Add `test.use({ localAppConfig: ... })`',
+  );
+
   const editorModel = new ToolpadEditor(page);
   await editorModel.goToPageById(BASIC_TESTS_PAGE_ID);
 
@@ -68,6 +76,11 @@ test('function editor reload', async ({ page, localApp }) => {
 });
 
 test('function editor parameters update', async ({ page, localApp, argosScreenshot }) => {
+  invariant(
+    localApp,
+    'test must be configured with `localAppConfig`. Add `test.use({ localAppConfig: ... })`',
+  );
+
   const editorModel = new ToolpadEditor(page);
   await editorModel.goToPageById(BASIC_TESTS_PAGE_ID);
 
@@ -143,6 +156,11 @@ test('Extracted types', async ({ page }) => {
 });
 
 test('function editor extracted parameters', async ({ page, localApp }) => {
+  invariant(
+    localApp,
+    'test must be configured with `localAppConfig`. Add `test.use({ localAppConfig: ... })`',
+  );
+
   const editorModel = new ToolpadEditor(page);
   await editorModel.goToPageById(EXTRACTED_TYPES_PAGE_ID);
 

diff --git a/test/integration/backend-basic/prod.spec.ts b/test/integration/backend-basic/prod.spec.ts
@@ -18,8 +18,10 @@ test.use({
 });
 
 test.use({
-  localAppConfig: {
+  projectConfig: {
     template: path.resolve(currentDirectory, './fixture'),
+  },
+  localAppConfig: {
     cmd: 'start',
     env: {
       SECRET_BAZ: 'Some baz secret',

diff --git a/test/integration/basic-auth/prod.spec.ts b/test/integration/basic-auth/prod.spec.ts
@@ -1,5 +1,6 @@
 import * as path from 'path';
 import * as url from 'url';
+import invariant from 'invariant';
 import { test, expect } from '../../playwright/localTest';
 
 const currentDirectory = url.fileURLToPath(new URL('.', import.meta.url));
@@ -11,8 +12,10 @@ test.use({
 });
 
 test.use({
-  localAppConfig: {
+  projectConfig: {
     template: path.resolve(currentDirectory, './fixture'),
+  },
+  localAppConfig: {
     cmd: 'start',
     env: {
       TOOLPAD_BASIC_AUTH_USER: 'foo',
@@ -32,6 +35,11 @@ test('Access is blocked to API route', async ({ request }) => {
 });
 
 test('Access is granted when authenticated', async ({ browserName, page, localApp }) => {
+  invariant(
+    localApp,
+    'test must be configured with `localAppConfig`. Add `test.use({ localAppConfig: ... })`',
+  );
+
   test.skip(
     browserName === 'firefox',
     'Fails due to https://bugzilla.mozilla.org/show_bug.cgi?id=1742396',

diff --git a/test/integration/bindings/index.spec.ts b/test/integration/bindings/index.spec.ts
@@ -15,8 +15,10 @@ test.use({
 });
 
 test.use({
-  localAppConfig: {
+  projectConfig: {
     template: path.resolve(currentDirectory, './fixture'),
+  },
+  localAppConfig: {
     cmd: 'dev',
   },
 });

diff --git a/test/integration/bindings/navigation.spec.ts b/test/integration/bindings/navigation.spec.ts
@@ -6,8 +6,10 @@ import { expect, test } from '../../playwright/localTest';
 const currentDirectory = url.fileURLToPath(new URL('.', import.meta.url));
 
 test.use({
-  localAppConfig: {
+  projectConfig: {
     template: path.resolve(currentDirectory, './fixture-navigation'),
+  },
+  localAppConfig: {
     cmd: 'dev',
   },
 });

diff --git a/test/integration/codeComponents/index.spec.ts b/test/integration/codeComponents/index.spec.ts
@@ -1,15 +1,18 @@
 import * as path from 'path';
 import * as fs from 'fs/promises';
 import * as url from 'url';
+import invariant from 'invariant';
 import { ToolpadRuntime } from '../../models/ToolpadRuntime';
 import { expect, test } from '../../playwright/localTest';
 import { ToolpadEditor } from '../../models/ToolpadEditor';
 
 const currentDirectory = url.fileURLToPath(new URL('.', import.meta.url));
 
 test.use({
-  localAppConfig: {
+  projectConfig: {
     template: path.resolve(currentDirectory, './fixture'),
+  },
+  localAppConfig: {
     cmd: 'dev',
   },
 });
@@ -23,6 +26,11 @@ test('custom components can use external libraries', async ({ page }) => {
 });
 
 test('can create new custom components', async ({ page, localApp }) => {
+  invariant(
+    localApp,
+    'test must be configured with `localAppConfig`. Add `test.use({ localAppConfig: ... })`',
+  );
+
   const editorModel = new ToolpadEditor(page);
 
   await editorModel.goto();

diff --git a/test/integration/components/basic.spec.ts b/test/integration/components/basic.spec.ts
@@ -41,8 +41,10 @@ async function waitForComponents(page: Page, frame: Page | FrameLocator = page)
 }
 
 test.use({
-  localAppConfig: {
+  projectConfig: {
     template: path.resolve(currentDirectory, './fixture-basic'),
+  },
+  localAppConfig: {
     cmd: 'dev',
   },
 });

diff --git a/test/integration/components/chart.spec.ts b/test/integration/components/chart.spec.ts
@@ -13,8 +13,10 @@ test.use({
 });
 
 test.use({
-  localAppConfig: {
+  projectConfig: {
     template: path.resolve(currentDirectory, './fixture-chart'),
+  },
+  localAppConfig: {
     cmd: 'dev',
   },
 });

diff --git a/test/integration/components/form.spec.ts b/test/integration/components/form.spec.ts
@@ -6,8 +6,10 @@ import { test, expect } from '../../playwright/localTest';
 const currentDirectory = url.fileURLToPath(new URL('.', import.meta.url));
 
 test.use({
-  localAppConfig: {
+  projectConfig: {
     template: path.resolve(currentDirectory, './fixture-form'),
+  },
+  localAppConfig: {
     cmd: 'dev',
   },
 });

diff --git a/test/integration/components/list.spec.ts b/test/integration/components/list.spec.ts
@@ -6,8 +6,10 @@ import { test, expect } from '../../playwright/localTest';
 const currentDirectory = url.fileURLToPath(new URL('.', import.meta.url));
 
 test.use({
-  localAppConfig: {
+  projectConfig: {
     template: path.resolve(currentDirectory, './fixture-list'),
+  },
+  localAppConfig: {
     cmd: 'dev',
   },
 });