Skip to content

Addon Vitest: Use its own cache directory #31439

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
May 12, 2025

Conversation

yannbf
Copy link
Member

@yannbf yannbf commented May 9, 2025

Closes #31431

What I did

When using Storybook with other browser mode projects, the cache was getting corrupted as each Vitest instance needs its own cache, and dependency optimization from Storybook was affecting other project's cache. This PR makes it so that each Storybook vitest workspace has its own unique cache directory.

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 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

Modified the Vitest plugin to ensure each Storybook workspace uses a unique cache directory based on the config directory path hash, preventing cache corruption when running multiple Vitest instances simultaneously.

  • Added cache directory configuration in code/addons/vitest/src/vitest-plugin/index.ts using config path hash
  • Fixed issue where multiple Vitest instances were sharing and corrupting each other's cache
  • Resolved test hanging/failing issues when running Vitest with multiple browser mode workspaces

Copy link
Contributor

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

1 file(s) reviewed, no comment(s)
Edit PR Review Bot Settings | Greptile

Copy link

nx-cloud bot commented May 9, 2025

View your CI Pipeline Execution ↗ for commit e5912a7.

Command Status Duration Result
nx run-many -t build --parallel=3 ✅ Succeeded 1m 42s View ↗

☁️ Nx Cloud last updated this comment at 2025-05-12 07:29:36 UTC

@yannbf yannbf merged commit 2d24b8a into next May 12, 2025
57 checks passed
@yannbf yannbf deleted the yann/fix-vitest-with-multiple-projects branch May 12, 2025 09:39
@github-actions github-actions bot mentioned this pull request May 12, 2025
29 tasks
sjwilczynski added a commit to sjwilczynski/nova-facade that referenced this pull request May 21, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Bug]: Storybook 9 - Tests hang or fail when running Vitest and multiple browser mode workspaces + Storybook
2 participants