Support for @vitest/browser v2.1.2 and later in @storybook/experiment-addon-test/vitest-plugin

[strozw]

Closes #

closes #29404

What I did

This PR has been corrected to address an error that occurs when importing @vitest/borwser/context when browser mode is not used in vitest v2.1.2 or later.

In @storybook/experiment-addon-test/vitest-plugin, change @vitest/browser/context in setViewport to dynamic import, so that when an error is thrown it is handled as { page: null } when an error is thrown, so that the same processing can be done as before.

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/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 PR does not have a canary release associated. You can request a canary release of this pull request by mentioning the @storybookjs/core team here.

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

Greptile Summary

This PR modifies the Vitest plugin in Storybook's experimental addon-test to support @vitest/browser v2.1.2 and later versions.

• Changed import of @vitest/browser/context to dynamic import in code/addons/test/src/vitest-plugin/viewports.ts
• Added error handling for cases when browser mode is not used in Vitest
• Ensures backward compatibility with previous versions of @vitest/browser
• Addresses issue [Bug]: Tests fail in non-browser mode with @storybook/experimental-addon-test/vitest-plugin and @vitest/browser 2.1.2 or later. #29404 where tests failed in non-browser mode
• Improves code resilience by gracefully handling unavailable browser context

[JReinhold]

Notice that this still points to a patched v2.0.5, that's probably not what we want. Either we should remove the patch (if we can because of the upgrade), or re-apply the patch to v2.1.3

[strozw]

Thanks for pointing that out, I had overlooked that about the patch 🤦‍♂️
As for updating the vitest related packages, as you pointed out separately, there was no need to update them, so we have reverted the commits that update them.

97f93b7

[JReinhold]

Are these peer deps changes necessary? Can't this change still work with Vitest 2.0.0 and onwards?

The only logic change I see in this PR is moving the import to be a dynamic import, and that's probably still compatible with vitest 2.0.0

[strozw]

As you say, these updates were unnecessary and I have reverted.

97f93b7

[greptile-apps]

_{1 file(s) reviewed, 1 comment(s)
Edit PR Review Bot Settings | Greptile}