Try very hard to fix vitest

Author: leeyi45

devserver/vite.config.ts

@@ -6,9 +6,8 @@ import pathlib from 'path';
 import react from '@vitejs/plugin-react';
 import { nodePolyfills } from 'vite-plugin-node-polyfills';
 import { loadEnv, defineConfig, type UserConfig } from 'vite'
-import { mergeConfig } from 'vitest/config';
+import { defineProject } from 'vitest/config';
 import type { BrowserCommand } from 'vitest/node';
-import rootConfig from '../vitest.config';
 
 const setLocalStorage: BrowserCommand<[key: string, value: any]> = async (ctx, key, value) => {
   if (ctx.provider.name === 'playwright') {
@@ -72,26 +71,26 @@ export default defineConfig(({ mode }) => {
     },
   }
 
-  return mergeConfig(
-    rootConfig, {
-      ...viteConfig,
-      test: {
-        name: 'Dev Server',
-        include: [
-          `${import.meta.dirname}/**/__tests__/**/*.ts*`
-        ],
-        browser: {
-          enabled: true,
-          headless: true,
-          provider: 'playwright',
-          instances: [{
-            browser: 'chromium'
-          }],
-          commands: {
-            setLocalStorage
-          }
+  const testConfig = defineProject({
+    test: {
+      root: import.meta.dirname,
+      name: 'Dev Server',
+      include: ['**/__tests__/**/*.{ts,tsx}'],
+      browser: {
+        enabled: true,
+        provider: 'playwright',
+        instances: [{
+          browser: 'chromium'
+        }],
+        commands: {
+          setLocalStorage
         }
       }
     }
-  );
+  })
+
+  return {
+    ...viteConfig,
+    ...testConfig,
+  }
 })

lib/buildtools/src/commands/main.ts

@@ -3,7 +3,7 @@ import { getBuildCommand, getBuildHtmlCommand, getManifestCommand } from './buil
 import { getListCommand } from './list.js';
 import { getLintCommand, getLintGlobalCommand, getPrebuildAllCommand, getTscCommand } from './prebuild.js';
 import getTemplateCommand from './template.js';
-import { getTestCommand } from './testing.js';
+import { getTestAllCommand, getTestCommand } from './testing.js';
 
 const commands: (() => Command<any>)[] = [
   getBuildCommand,
@@ -15,6 +15,7 @@ const commands: (() => Command<any>)[] = [
   getPrebuildAllCommand,
   getTemplateCommand,
   getTestCommand,
+  getTestAllCommand,
   getTscCommand
 ];
 

lib/buildtools/src/commands/testing.ts

@@ -1,18 +1,17 @@
 import { resolve } from 'path';
 import { Command, Option } from '@commander-js/extra-typings';
+import chalk from 'chalk';
 import type { VitestRunMode } from 'vitest/node';
-import { resolveEitherBundleOrTab } from '../build/manifest.js';
-import { runIndividualVitest } from '../testing.js';
+import { runVitest } from '../testing/runner.js';
+import { getAllTestConfigurations, getTestConfiguration } from '../testing/utils.js';
 import { logCommandErrorAndExit } from './commandUtils.js';
 
 const vitestModeOption = new Option('--mode <mode>', 'Vitest Run Mode. See https://vitest.dev/guide/cli.html#mode')
   .choices(['test', 'benchmark'] as VitestRunMode[])
   .default('test');
 
 const watchOption = new Option('-w, --watch', 'Run tests in watch mode');
-
 const updateOption = new Option('-u, --update', 'Update snapshots');
-
 const coverageOption = new Option('--coverage');
 
 export const getTestCommand = () => new Command('test')
@@ -24,15 +23,27 @@ export const getTestCommand = () => new Command('test')
   .argument('[directory]', 'Directory to search for tests. If no directory is specified, the current working directory is used')
   .action(async (directory, { mode, ...options }) => {
     const fullyResolved = resolve(directory ?? process.cwd());
-    const resolveResult = await resolveEitherBundleOrTab(fullyResolved);
+    const configResult = await getTestConfiguration(fullyResolved, !!options.watch);
 
-    if (resolveResult.severity === 'error') {
-      if (resolveResult.errors.length === 0 ) {
-        logCommandErrorAndExit(`No tab or bundle found at ${fullyResolved}`);
-      }
+    if (configResult.severity === 'error') {
+      logCommandErrorAndExit(configResult);
+    }
 
-      logCommandErrorAndExit(resolveResult);
+    if (configResult.config === null) {
+      console.log(chalk.yellowBright(`No tests found for in ${fullyResolved}`));
+      return;
     }
 
-    await runIndividualVitest(mode, resolveResult.asset, options);
+    await runVitest(mode, [fullyResolved], [configResult.config], options);
+  });
+
+export const getTestAllCommand = () => new Command('testall')
+  .description('Run all tests based on the configuration of the root vitest file')
+  .addOption(vitestModeOption)
+  .addOption(watchOption)
+  .addOption(updateOption)
+  .addOption(coverageOption)
+  .action(async ({ mode, ...options }) => {
+    const configs = await getAllTestConfigurations(!!options.watch);
+    await runVitest(mode, undefined, configs, options);
   });

lib/buildtools/src/testing.ts

@@ -0,0 +1,71 @@
+import pathlib from 'path';
+import react from '@vitejs/plugin-react';
+import { coverageConfigDefaults, defineConfig, defineProject, mergeConfig } from 'vitest/config';
+import { getGitRoot } from '../getGitRoot.js';
+
+const gitRoot = await getGitRoot();
+
+/**
+ * A shared Vitest configuration object that can be combined with {@link mergeConfig}
+ * to create custom Vitest configurations for each sub project
+ */
+export const sharedVitestConfiguration = defineConfig({
+  resolve: {
+    alias: [{
+      find: /^js-slang\/context/,
+      replacement: pathlib.join(gitRoot, 'src/__mocks__/context.ts')
+    }]
+  },
+  test: {
+    clearMocks: true,
+    coverage: {
+      provider: 'v8',
+      exclude: [
+        ...coverageConfigDefaults.exclude,
+        './build/**',
+        '**/__mocks__/**',
+        '**/__test_mocks__/**',
+        '**/bin/**',
+        '**/build.js',
+        '**/*.config.?(c)[jt]s',
+        '**/dist.?(c)js',
+        './docs',
+        '**/src/**/samples/**',
+        './lib/buildtools/src/build/docs/drawdown.ts'
+      ]
+    },
+    silent: 'passed-only',
+  }
+});
+
+/**
+ * Vitest configuration specific to tabs
+ */
+export const sharedTabsConfig = mergeConfig(
+  sharedVitestConfiguration,
+  // @ts-expect-error help why are plugins weird
+  defineProject({
+    // @ts-expect-error help why are plugins weird
+    plugins: [react()],
+    optimizeDeps: {
+      include: [
+        '@blueprintjs/core',
+        '@blueprintjs/icons',
+        'gl-matrix',
+        'js-slang',
+        'lodash',
+        'vitest-browser-react'
+      ]
+    },
+    test: {
+      include: ['**/__tests__/*.{ts,tsx}'],
+      environment: 'jsdom',
+      browser: {
+        provider: 'playwright',
+        instances: [{
+          browser: 'chromium',
+        }]
+      }
+    }
+  })
+);

lib/buildtools/src/testing/configs.ts

@@ -0,0 +1,39 @@
+import { mergeConfig, type TestProjectInlineConfiguration } from 'vitest/config';
+import { startVitest, type VitestRunMode } from 'vitest/node';
+import { sharedVitestConfiguration } from './configs.js';
+import type { RunVitestBoolOptions } from './types.js';
+
+/**
+ * Create a new Vitest instance and run it. Refer to https://vitest.dev/advanced/api/#startvitest for more information.
+ */
+export async function runVitest(mode: VitestRunMode, filters: string[] | undefined, projects: TestProjectInlineConfiguration[], options: RunVitestBoolOptions) {
+  try {
+    const finalConfig = mergeConfig(
+      sharedVitestConfiguration.test!,
+      {
+        config: false,
+        projects,
+        watch: !!options.watch,
+        update: !!options.update,
+        coverage: {
+          // Coverage is always just blank so I can never seem to get
+          // specific coverage reports only
+          // include: filters?.map(each => `${each}/**/*.tsx`),
+          enabled: !!options.coverage
+        },
+      }
+    );
+    const vitest = await startVitest(mode, filters, finalConfig);
+
+    if (vitest.shouldKeepServer()) {
+    // If Vitest is called in watch mode, then we wait for the onClose hook
+    // to be called to return instead
+    // Refer to https://vitest.dev/advanced/api/vitest.html#shouldkeepserver
+      await new Promise<void>(resolve => vitest.onClose(resolve));
+    } else {
+      await vitest.close();
+    }
+  } catch (error) {
+    console.error(error);
+  }
+}

lib/buildtools/src/testing/runner.ts

@@ -0,0 +1,5 @@
+export interface RunVitestBoolOptions {
+  watch?: boolean
+  coverage?: boolean
+  update?: boolean
+}