Addon Test: Add Vitest 3 support #30181

valentinpalkovic · 2025-01-03T10:59:56Z

Closes #

What I did

Added compatibility for @storybook/experimental-addon-test to support Vitest 3
Updated the mono repository to use the latest Vitest 3 beta and updated tests to make them compatible with Vitest 3

Checklist for Contributors

Testing

The changes in this PR are covered in the following automated tests:

stories
unit tests
integration tests
end-to-end tests

Manual testing

This section is mandatory for all contributions. If you believe no manual test is necessary, please state so explicitly. Thanks!

Documentation

Add or update documentation reflecting your changes
If you are deprecating/removing a feature, make sure to update
MIGRATION.MD

Checklist for Maintainers

When this PR is ready for testing, make sure to add ci:normal, ci:merged or ci:daily GH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found in code/lib/cli-storybook/src/sandbox-templates.ts
Make sure this PR contains one of the labels below:
Available labels
- bug: Internal changes that fixes incorrect behavior.
- maintenance: User-facing maintenance tasks.
- dependencies: Upgrading (sometimes downgrading) dependencies.
- build: Internal-facing build tooling & test updates. Will not show up in release changelog.
- cleanup: Minor cleanup style change. Will not show up in release changelog.
- documentation: Documentation only changes. Will not show up in release changelog.
- feature request: Introducing a new feature.
- BREAKING CHANGE: Changes that break compatibility in some way with current major version.
- other: Changes that don't fit in the above categories.

🦋 Canary release

This pull request has been released as version 0.0.0-pr-30181-sha-2fdb0bfe. Try it out in a new sandbox by running npx storybook@0.0.0-pr-30181-sha-2fdb0bfe sandbox or in an existing project with npx storybook@0.0.0-pr-30181-sha-2fdb0bfe upgrade.

More information


Published version	`0.0.0-pr-30181-sha-2fdb0bfe`
Triggered by	@valentinpalkovic
Repository	storybookjs/storybook
Branch	`valentin/add-vitest-3-support`
Commit	`2fdb0bfe`
Datetime	Wed Jan 15 08:40:37 UTC 2025 (`1736930437`)
Workflow run	12784527795

To request a new release of this pull request, mention the @storybookjs/core team.

core team members can create a new canary release here or locally with gh workflow run --repo storybookjs/storybook canary-release-pr.yml --field pr=30181

name	before	after	diff	z	%
createSize	0 B	0 B	0 B	-	-
generateSize	77.9 MB	77.9 MB	0 B	1.54	0%
initSize	131 MB	131 MB	24 B	1.5	0%
diffSize	52.9 MB	52.9 MB	24 B	-0.82	0%
buildSize	7.19 MB	7.19 MB	0 B	1.97	0%
buildSbAddonsSize	1.85 MB	1.85 MB	0 B	-1.11	0%
buildSbCommonSize	195 kB	195 kB	0 B	-	0%
buildSbManagerSize	1.87 MB	1.87 MB	0 B	2.38	0%
buildSbPreviewSize	0 B	0 B	0 B	-	-
buildStaticSize	0 B	0 B	0 B	-	-
buildPrebuildSize	3.91 MB	3.91 MB	0 B	1.74	0%
buildPreviewSize	3.28 MB	3.28 MB	0 B	1.99	0%
testBuildSize	0 B	0 B	0 B	-	-
testBuildSbAddonsSize	0 B	0 B	0 B	-	-
testBuildSbCommonSize	0 B	0 B	0 B	-	-
testBuildSbManagerSize	0 B	0 B	0 B	-	-
testBuildSbPreviewSize	0 B	0 B	0 B	-	-
testBuildStaticSize	0 B	0 B	0 B	-	-
testBuildPrebuildSize	0 B	0 B	0 B	-	-
testBuildPreviewSize	0 B	0 B	0 B	-	-

name	before	after	diff	z	%
createTime	18.3s	14.8s	-3s -439ms	0.17	-23.1%
generateTime	20.4s	22.7s	2.3s	1.33	🔺10.1%
initTime	14s	16.2s	2.1s	1.47	🔺13.4%
buildTime	9.4s	8.8s	-619ms	-0.53	-7%
testBuildTime	0ms	0ms	0ms	-	-
devPreviewResponsive	5.4s	5.5s	57ms	0.73	1%
devManagerResponsive	4s	3.8s	-237ms	0.27	-6.2%
devManagerHeaderVisible	766ms	589ms	-177ms	-0.61	-30.1%
devManagerIndexVisible	800ms	625ms	-175ms	-0.61	-28%
devStoryVisibleUncached	2s	2.1s	77ms	0.82	3.6%
devStoryVisible	801ms	626ms	-175ms	-0.64	-28%
devAutodocsVisible	702ms	610ms	-92ms	0.27	-15.1%
devMDXVisible	589ms	613ms	24ms	0.45	3.9%
buildManagerHeaderVisible	624ms	587ms	-37ms	0.04	-6.3%
buildManagerIndexVisible	714ms	674ms	-40ms	0.12	-5.9%
buildStoryVisible	592ms	569ms	-23ms	0.01	-4%
buildAutodocsVisible	452ms	473ms	21ms	-0.02	4.4%
buildMDXVisible	457ms	497ms	40ms	0.41	8%

storybook-bot · 2025-01-03T11:07:48Z

Failed to publish canary version of this pull request, triggered by @valentinpalkovic. See the failed workflow run at: https://github.com/storybookjs/storybook/actions/runs/12596687166

… valentin/add-vitest-3-support

storybook-bot · 2025-01-03T11:12:15Z

Failed to publish canary version of this pull request, triggered by @valentinpalkovic. See the failed workflow run at: https://github.com/storybookjs/storybook/actions/runs/12596812168

nx-cloud · 2025-01-03T11:26:57Z

View your CI Pipeline Execution ↗ for commit 3071566.

Command	Status	Duration	Result
`nx run-many -t build --parallel=3`	✅ Succeeded	9s	View ↗

☁️ Nx Cloud last updated this comment at 2025-01-15 10:36:44 UTC

storybook-bot · 2025-01-03T11:29:31Z

Failed to publish canary version of this pull request, triggered by @valentinpalkovic. See the failed workflow run at: https://github.com/storybookjs/storybook/actions/runs/12596958152

… valentin/add-vitest-3-support

storybook-pr-benchmarking · 2025-01-13T09:34:17Z

Package Benchmarks

^{Commit: 3071566, ran on 15 January 2025 at 10:43:50 UTC}

The following packages have significant changes to their size or dependencies:

`@storybook/experimental-addon-test`

	Before	After	Difference
Dependency count	60	60	0
Self size	762 KB	832 KB	🚨 +70 KB 🚨
Dependency size	14.15 MB	14.15 MB	🚨 +18 B 🚨
Bundle Size Analyzer	Link	Link

valentinpalkovic · 2025-01-13T09:37:50Z

code/lib/cli-storybook/src/automigrate/fixes/eslint-plugin.test.ts

@@ -96,7 +96,7 @@ describe('eslint-plugin fix', () => {
    });

    describe('should install eslint plugin', () => {
-      it('when .eslintrc is using a supported extension', async () => {
+      it.skip('when .eslintrc is using a supported extension', async () => {


I may need some help from @yannbf figuring out why, in Vitest 3, these tests are failing.

…-support

valentinpalkovic · 2025-01-13T13:52:50Z

Currently blocked by vitest-dev/vitest#7212

…-support

…on 3 or later

yannbf · 2025-01-15T11:39:33Z

code/addons/test/src/vitest-plugin/index.ts

          browser: {
-            ...inputConfig_ONLY_MUTATE_WHEN_STRICTLY_NEEDED_OR_YOU_WILL_BE_FIRED.test?.browser,


I think this is needed

yannbf · 2025-01-15T11:41:48Z

code/addons/test/src/vitest-plugin/index.ts

@@ -273,6 +280,8 @@ export const storybookTest = async (options?: UserOptions): Promise<Plugin[]> =>
            '@storybook/experimental-addon-test/internal/setup-file',
            '@storybook/experimental-addon-test/internal/global-setup',
            '@storybook/experimental-addon-test/internal/test-utils',
+            ...(isAddonA11yAvailable() ? ['@storybook/addon-a11y'] : []),


Seems like this is not needed anymore because of this:

storybook/code/builders/builder-vite/src/optimizeDeps.ts

Line 16 in 7ec361e

'@storybook/addon-a11y/preview',

Plus Jeppe's PR.

yannbf · 2025-01-15T11:44:09Z

test-storybooks/portable-stories-kitchen-sink/react/.storybook/main.ts

+      optimizeDeps: {
+        ...config.optimizeDeps,
+        include: [
+          ...(config.optimizeDeps?.include || []),
+          "react-dom/test-utils",
+          "@storybook/react/**",
+          "@storybook/experimental-addon-test/preview",
+        ],
+      },


potentially not needed anymore, just please run the react kitchen sink project and make sure it doesn't take a long time loading as it can cause flake on E2E

valentinpalkovic added 3 commits January 3, 2025 11:52

Addon Test: Add Vitest 3 support

09196b1

Adjust tests for Vitest 3

e61762b

Remove unnecessary spread of browser config in vitest-plugin

cbc7305

valentinpalkovic changed the base branch from next to valentin/a11y-refactorings January 3, 2025 11:00

valentinpalkovic self-assigned this Jan 3, 2025

Merge remote-tracking branch 'origin/valentin/a11y-refactorings' into…

91ad81f

… valentin/add-vitest-3-support

Update yarn.lock

dc6db06

valentinpalkovic added bug ci:daily Run the CI jobs that normally run in the daily job. labels Jan 3, 2025

valentinpalkovic added 11 commits January 3, 2025 12:52

Downgrade Vite and fix type issues

dba7ad3

Further Vitest 3 compat adjustments

c2245b0

Fix tests

aded285

Merge remote-tracking branch 'origin/valentin/a11y-refactorings' into…

161a29c

… valentin/add-vitest-3-support

Upgrade to Vitest 3.0.0-beta.4

61996e1

Remove obsolete comma

d099241

Format file outputs in postinstall of addon-test

a6be1e6

Merge remote-tracking branch 'origin/valentin/a11y-refactorings' into…

e6ec8b1

… valentin/add-vitest-3-support

Fix tests

ecf9f7f

Fix tests

644690c

Merge remote-tracking branch 'origin/valentin/a11y-refactorings' into…

ccbdb71

… valentin/add-vitest-3-support

Base automatically changed from valentin/a11y-refactorings to next January 13, 2025 09:32

valentinpalkovic commented Jan 13, 2025

View reviewed changes

Merge remote-tracking branch 'origin/next' into valentin/add-vitest-3…

ed3ed9a

…-support

valentinpalkovic added ci:normal and removed ci:daily Run the CI jobs that normally run in the daily job. labels Jan 13, 2025

valentinpalkovic added addon: test feature request and removed bug labels Jan 13, 2025

valentinpalkovic marked this pull request as ready for review January 13, 2025 09:42

valentinpalkovic requested review from kylegach and jonniebigodes as code owners January 13, 2025 09:42

Update Vitest packages to 3.0.0 beta

b2da8de

valentinpalkovic added 7 commits January 15, 2025 09:35

Refactor Vitest browser configuration

e90d717

Remove comment

a00619c

Remove test timeout

b1e99df

Merge remote-tracking branch 'origin/next' into valentin/add-vitest-3…

2fdb0bf

…-support

Refactor Vitest version import and check for compatibility with versi…

4c45960

…on 3 or later

Fix optional chaining for Vitest compatibility checks

a539692

fix watch mode in Vitest 3

3071566

yannbf reviewed Jan 15, 2025

View reviewed changes

yannbf approved these changes Jan 15, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Addon Test: Add Vitest 3 support #30181

Addon Test: Add Vitest 3 support #30181

valentinpalkovic commented Jan 3, 2025 •

edited by storybook-pr-benchmarking bot

Loading

storybook-bot commented Jan 3, 2025

storybook-bot commented Jan 3, 2025

nx-cloud bot commented Jan 3, 2025 •

edited

Loading

storybook-bot commented Jan 3, 2025

storybook-pr-benchmarking bot commented Jan 13, 2025 •

edited

Loading

valentinpalkovic Jan 13, 2025 •

edited

Loading

valentinpalkovic commented Jan 13, 2025

yannbf Jan 15, 2025

yannbf Jan 15, 2025

yannbf Jan 15, 2025

		browser: {
		...inputConfig_ONLY_MUTATE_WHEN_STRICTLY_NEEDED_OR_YOU_WILL_BE_FIRED.test?.browser,

Addon Test: Add Vitest 3 support #30181

Are you sure you want to change the base?

Addon Test: Add Vitest 3 support #30181

Conversation

valentinpalkovic commented Jan 3, 2025 • edited by storybook-pr-benchmarking bot Loading

What I did

Checklist for Contributors

Testing

The changes in this PR are covered in the following automated tests:

Manual testing

Documentation

Checklist for Maintainers

🦋 Canary release

storybook-bot commented Jan 3, 2025

storybook-bot commented Jan 3, 2025

nx-cloud bot commented Jan 3, 2025 • edited Loading

storybook-bot commented Jan 3, 2025

storybook-pr-benchmarking bot commented Jan 13, 2025 • edited Loading

Package Benchmarks

@storybook/experimental-addon-test

valentinpalkovic Jan 13, 2025 • edited Loading

Choose a reason for hiding this comment

valentinpalkovic commented Jan 13, 2025

yannbf Jan 15, 2025

Choose a reason for hiding this comment

yannbf Jan 15, 2025

Choose a reason for hiding this comment

yannbf Jan 15, 2025

Choose a reason for hiding this comment

valentinpalkovic commented Jan 3, 2025 •

edited by storybook-pr-benchmarking bot

Loading

nx-cloud bot commented Jan 3, 2025 •

edited

Loading

storybook-pr-benchmarking bot commented Jan 13, 2025 •

edited

Loading

`@storybook/experimental-addon-test`

valentinpalkovic Jan 13, 2025 •

edited

Loading