Addon-Vitest: Use Vitest's provide-API for injecting values

code/addons/vitest/src/constants.ts

@@ -39,6 +39,7 @@ export const storeOptions = {
       componentTestStatuses: [],
       a11yStatuses: [],
       a11yReports: {},
+      reports: {},
       componentTestCount: {
         success: 0,
         error: 0,
@@ -66,6 +67,9 @@ export const TEST_PROVIDER_STORE_CHANNEL_EVENT_NAME = 'UNIVERSAL_STORE:storybook
 
 export const STATUS_TYPE_ID_COMPONENT_TEST = 'storybook/component-test';
 export const STATUS_TYPE_ID_A11Y = 'storybook/a11y';
+export const STORYBOOK_TEST_PROVIDE_KEY = 'storybook/test-provided';
+export const STORYBOOK_CORE_GHOST_STORIES_PROVIDE_KEY = 'storybook/core-ghost-stories';
+export const STORYBOOK_CORE_RENDER_ANALYSIS_PROVIDE_KEY = 'storybook/core-render-analysis';
 
 // Channel event names for programmatic test triggering
 export const TRIGGER_TEST_RUN_REQUEST = `${ADDON_ID}/trigger-test-run-request`;
@@ -75,7 +79,7 @@ export type TriggerTestRunRequestPayload = {
   requestId: string;
   actor: string;
   storyIds?: string[];
-  config?: Partial<StoreState['config']>;
+  config?: Record<string, unknown>;
 };
 
 export type TestRunResult = CurrentRun;

code/addons/vitest/src/node/test-manager.test.ts

@@ -10,8 +10,14 @@ import type {
 } from 'storybook/internal/types';
 
 import path from 'pathe';
-
-import { STATUS_TYPE_ID_A11Y, STATUS_TYPE_ID_COMPONENT_TEST, storeOptions } from '../constants.ts';
+import type { Report } from 'storybook/preview-api';
+
+import {
+  STATUS_TYPE_ID_A11Y,
+  STATUS_TYPE_ID_COMPONENT_TEST,
+  STORYBOOK_TEST_PROVIDE_KEY,
+  storeOptions,
+} from '../constants.ts';
 import type { StoreEvent, StoreState } from '../types.ts';
 import { TestManager, type TestManagerOptions } from './test-manager.ts';
 import { DOUBLE_SPACES } from './vitest-manager.ts';
@@ -22,6 +28,10 @@ const vitest = vi.hoisted(() => ({
   init: vi.fn(),
   close: vi.fn(),
   onCancel: vi.fn(),
+  logger: {
+    clearHighlightCache: vi.fn(),
+  },
+  provide: vi.fn(),
   runTestSpecifications: vi.fn(),
   cancelCurrentRun: vi.fn(),
   globTestSpecifications: vi.fn(),
@@ -52,6 +62,13 @@ vi.mock('vitest/node', () => ({
 const createVitest = mockCreateVitest;
 
 beforeEach(() => {
+  vi.clearAllMocks();
+  mockStore.setState(() => ({
+    ...storeOptions.initialState,
+    index: mockIndex,
+  }));
+  vitest.projects = [{}];
+  vitest.config.coverage.enabled = false;
   createVitest.mockResolvedValue(vitest);
 });
 
@@ -154,11 +171,15 @@ const mockTestProviderStore: TestProviderStoreById = {
 
 const tests = [
   {
-    project: { config: { env: { __STORYBOOK_URL__: 'http://localhost:6006' } } },
+    project: {
+      config: { env: { __STORYBOOK_URL__: 'http://localhost:6006' } },
+    },
     moduleId: path.join(process.cwd(), 'path/to/file'),
   },
   {
-    project: { config: { env: { __STORYBOOK_URL__: 'http://localhost:6006' } } },
+    project: {
+      config: { env: { __STORYBOOK_URL__: 'http://localhost:6006' } },
+    },
     moduleId: path.join(process.cwd(), 'path/to/another/file'),
   },
 ];
@@ -211,9 +232,124 @@ describe('TestManager', () => {
       },
     });
     expect(createVitest).toHaveBeenCalledTimes(1);
+    expect(vitest.provide).toHaveBeenCalledWith(STORYBOOK_TEST_PROVIDE_KEY, {
+      coverage: false,
+      a11y: false,
+    });
     expect(vitest.runTestSpecifications).toHaveBeenCalledWith(tests, true);
   });
 
+  it('should provide merged config override before running tests', async () => {
+    vitest.globTestSpecifications.mockImplementation(() => tests);
+    const testManager = await TestManager.start(options);
+
+    await testManager.handleTriggerRunEvent({
+      type: 'TRIGGER_RUN',
+      payload: {
+        triggeredBy: 'external:actor',
+        configOverride: {
+          coverage: false,
+          a11y: true,
+          customFlag: 'custom-value',
+        },
+      },
+    });
+
+    expect(vitest.provide).toHaveBeenLastCalledWith(STORYBOOK_TEST_PROVIDE_KEY, {
+      coverage: false,
+      a11y: true,
+      customFlag: 'custom-value',
+    });
+  });
+
+  it('should refresh provided config before watch-triggered reruns', async () => {
+    vitest.globTestSpecifications.mockImplementation(() => tests);
+    vitest.projects = [
+      {
+        config: {
+          env: { __STORYBOOK_URL__: 'http://localhost:6006' },
+          root: process.cwd(),
+          setupFiles: [],
+        },
+        matchesTestGlob: vi.fn(),
+        vite: {
+          moduleGraph: {
+            getModuleById: vi.fn(),
+            getModulesByFile: vi.fn(() => []),
+            invalidateModule: vi.fn(),
+          },
+          transformRequest: vi.fn(),
+        },
+      },
+    ] as any;
+
+    const testManager = await TestManager.start(options);
+
+    await testManager.handleTriggerRunEvent({
+      type: 'TRIGGER_RUN',
+      payload: {
+        triggeredBy: 'global',
+      },
+    });
+
+    vitest.provide.mockClear();
+    mockStore.setState((s) => ({
+      ...s,
+      watching: true,
+      config: { coverage: false, a11y: true },
+    }));
+
+    vi.spyOn(testManager.vitestManager as any, 'getTestDependencies').mockResolvedValue(new Set());
+
+    await testManager.vitestManager.runAffectedTestsAfterChange(tests[0].moduleId, 'change');
+
+    expect(vitest.provide).toHaveBeenCalledWith(STORYBOOK_TEST_PROVIDE_KEY, {
+      coverage: false,
+      a11y: true,
+    });
+    expect(vitest.runTestSpecifications).toHaveBeenLastCalledWith(tests.slice(0, 1), false);
+  });
+
+  it('should persist all reports in currentRun', async () => {
+    const testManager = await TestManager.start(options);
+    const passedResult = {
+      state: 'passed',
+      errors: [],
+    } as unknown as TestResult;
+
+    await testManager.runTestsWithState({
+      storyIds: ['story--one'],
+      triggeredBy: 'global',
+      callback: async () => {
+        testManager.onTestCaseResult({
+          storyId: 'story--one',
+          testResult: passedResult,
+          reports: [
+            {
+              type: 'a11y',
+              status: 'passed',
+              result: { id: 'a11y-report' },
+            } as Report,
+            {
+              type: 'custom',
+              status: 'passed',
+              result: { id: 'custom-report' },
+            } as Report,
+          ],
+        });
+        testManager.onTestRunEnd({
+          totalTestCount: 1,
+          unhandledErrors: [],
+        });
+      },
+    });
+
+    expect(mockStore.getState().currentRun.reports['story--one']).toEqual([
+      { type: 'a11y', status: 'passed', result: { id: 'a11y-report' } },
+      { type: 'custom', status: 'passed', result: { id: 'custom-report' } },
+    ]);
+  });
+
   it('should filter tests', async () => {
     vitest.globTestSpecifications.mockImplementation(() => tests);
     const testManager = await TestManager.start(options);
@@ -325,7 +461,10 @@ describe('TestManager', () => {
 
   it('should ignore non-requested same-name story results after run', async () => {
     const testManager = await TestManager.start(options);
-    const passedResult = { state: 'passed', errors: [] } as unknown as TestResult;
+    const passedResult = {
+      state: 'passed',
+      errors: [],
+    } as unknown as TestResult;
 
     await testManager.runTestsWithState({
       storyIds: ['story--one', 'another--two'],
@@ -357,7 +496,10 @@ describe('TestManager', () => {
 
   it('should keep child test results when parent story is requested', async () => {
     const testManager = await TestManager.start(options);
-    const passedResult = { state: 'passed', errors: [] } as unknown as TestResult;
+    const passedResult = {
+      state: 'passed',
+      errors: [],
+    } as unknown as TestResult;
 
     await testManager.runTestsWithState({
       storyIds: ['parent--story'],
@@ -385,7 +527,10 @@ describe('TestManager', () => {
     expect(createVitest).toHaveBeenCalledTimes(1);
     createVitest.mockClear();
 
-    mockStore.setState((s) => ({ ...s, config: { coverage: true, a11y: false } }));
+    mockStore.setState((s) => ({
+      ...s,
+      config: { coverage: true, a11y: false },
+    }));
 
     await testManager.handleTriggerRunEvent({
       type: 'TRIGGER_RUN',
@@ -408,7 +553,10 @@ describe('TestManager', () => {
     expect(createVitest).toHaveBeenCalledTimes(1);
     createVitest.mockClear();
 
-    mockStore.setState((s) => ({ ...s, config: { coverage: true, a11y: false } }));
+    mockStore.setState((s) => ({
+      ...s,
+      config: { coverage: true, a11y: false },
+    }));
 
     await testManager.handleTriggerRunEvent({
       type: 'TRIGGER_RUN',

code/addons/vitest/src/node/test-manager.ts

@@ -8,14 +8,13 @@ import type {
   TestProviderStoreById,
 } from 'storybook/internal/types';
 
-import type { A11yReport } from '@storybook/addon-a11y';
-
 import { throttle } from 'es-toolkit/function';
 import type { Report } from 'storybook/preview-api';
 
 import { STATUS_TYPE_ID_A11Y, STATUS_TYPE_ID_COMPONENT_TEST, storeOptions } from '../constants.ts';
 import type {
   CurrentRun,
+  RunConfig,
   RunTrigger,
   StoreEvent,
   StoreState,
@@ -79,7 +78,9 @@ export class TestManager {
     this.store
       .untilReady()
       .then(() => {
-        return this.vitestManager.startVitest({ coverage: this.store.getState().config.coverage });
+        return this.vitestManager.startVitest({
+          coverage: this.store.getState().config.coverage,
+        });
       })
       .then(() => this.onReady?.())
       .catch((e) => {
@@ -129,7 +130,7 @@ export class TestManager {
   }: {
     storyIds?: string[];
     triggeredBy: RunTrigger;
-    configOverride?: StoreState['config'];
+    configOverride?: RunConfig;
     callback: () => Promise<void>;
   }) {
     this.componentTestStatusStore.unset(storyIds);
@@ -147,10 +148,6 @@ export class TestManager {
         config: runConfig,
       },
     }));
-    // set the config at the start of a test run,
-    // so that changing the config during the test run does not affect the currently running test run
-    process.env.VITEST_STORYBOOK_CONFIG = JSON.stringify(runConfig);
-
     await this.testProviderStore.runWithState(async () => {
       await callback();
       this.store.send({
@@ -229,14 +226,19 @@ export class TestManager {
     this.componentTestStatusStore.set(componentTestStatuses);
 
     const a11yReportsByStoryId: CurrentRun['a11yReports'] = {};
+    const reportsByStoryId: CurrentRun['reports'] = {};
     const a11yStatuses: typeof componentTestStatuses = [];
 
     for (const { storyId, reports } of testCaseResultsToFlush) {
+      if (reports?.length) {
+        reportsByStoryId[storyId] = reports;
+      }
+
       const storyA11yReports = reports?.filter((r) => r.type === 'a11y');
       if (!storyA11yReports?.length) {
         continue;
       }
-      a11yReportsByStoryId[storyId] = storyA11yReports.map((r) => r.result) as A11yReport[];
+      a11yReportsByStoryId[storyId] = storyA11yReports.map((report) => report.result);
       for (const a11yReport of storyA11yReports) {
         a11yStatuses.push({
           storyId,
@@ -281,13 +283,25 @@ export class TestManager {
         currentRun: {
           ...s.currentRun,
           componentTestCount: { success: ctSuccess, error: ctError },
-          a11yCount: { success: a11ySuccess, warning: a11yWarning, error: a11yError },
+          a11yCount: {
+            success: a11ySuccess,
+            warning: a11yWarning,
+            error: a11yError,
+          },
           componentTestStatuses: s.currentRun.componentTestStatuses.concat(componentTestStatuses),
           a11yStatuses: s.currentRun.a11yStatuses.concat(a11yStatuses),
+          /*
+            TODO: a11yReports is just here for backwards compatibility with older versions of addon-mcp.
+            They are also part of the more generic reports property, so we can remove this in a future major release when we can break compatibility.
+          */
           a11yReports: {
             ...s.currentRun.a11yReports,
             ...a11yReportsByStoryId,
           },
+          reports: {
+            ...s.currentRun.reports,
+            ...reportsByStoryId,
+          },
           // in some cases successes and errors can exceed the anticipated totalTestCount
           // e.g. when testing more tests than the stories we know about upfront
           // in those cases, we set the totalTestCount to the sum of successes and errors