-
-
Notifications
You must be signed in to change notification settings - Fork 9.4k
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
Preview: Fix path resolution in yarn pnp node-linker=pnpm mode #29639
base: next
Are you sure you want to change the base?
Conversation
☁️ Nx Cloud ReportCI is running/has finished running commands for commit 4154c3c. As they complete they will appear below. Click to see the status, the terminal output, and the build insights. 📂 See all runs for this CI Pipeline Execution ✅ Successfully ran 1 targetSent with 💌 from NxCloud. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The intent of the stripAbsNodeModules
path as used by its callers seems to be to force a node_modules
-absolute path into being a bare import:
storybook/code/builders/builder-vite/src/utils/process-preview-annotation.ts
Lines 31 to 36 in ea41d77
// For addon dependencies that use require.resolve(), we need to convert to a bare path | |
// so that vite will process it as a dependency (cjs -> esm, etc). | |
// TODO: Evaluate if searching for node_modules in a yarn pnp environment is correct | |
if (path.includes('node_modules')) { | |
return stripAbsNodeModulesPath(path); | |
} |
Bailing out of doing this transformation in stripAbsNodeModules
is almost certainly the wrong behavior (at least without modifying callers), since at each call site the return value is directly used expecting it to be a bare path and it would instead return an absolute path. (The other callsite is in core populating the bare
field, which is similarly used unmodified as an assumed bare path by the vite builder)
Indeed, with this patch fixed to target .store
instead of .cache
, there are more problems later with vite trying to serve up a CJS module as ESM, resulting in imports failing in the browser.
@@ -9,6 +9,10 @@ function normalizePath(id: string) { | |||
// We need to convert from an absolute path, to a traditional node module import path, | |||
// so that vite can correctly pre-bundle/optimize | |||
export function stripAbsNodeModulesPath(absPath: string) { | |||
// If the environment is a yarn pnp node_linker=pnpm environment, we don't want to strip the path | |||
if (absPath.includes(join('node_modules', '.cache'))) { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yarn's PNPM linker uses node_modules/.store
, not node_modules/.cache
.
Closes #29620
What I did
Checklist for Contributors
Testing
The changes in this PR are covered in the following automated tests:
Manual testing
This section is mandatory for all contributions. If you believe no manual test is necessary, please state so explicitly. Thanks!
Documentation
MIGRATION.MD
Checklist for Maintainers
When this PR is ready for testing, make sure to add
ci:normal
,ci:merged
orci:daily
GH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found incode/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-29639-sha-4154c3cb
. Try it out in a new sandbox by runningnpx storybook@0.0.0-pr-29639-sha-4154c3cb sandbox
or in an existing project withnpx storybook@0.0.0-pr-29639-sha-4154c3cb upgrade
.More information
0.0.0-pr-29639-sha-4154c3cb
valentin/fix-yarn-pnp-node-linker-pnpm
4154c3cb
1731932075
)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=29639