Skip to content
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

Draft
wants to merge 1 commit into
base: next
Choose a base branch
from

Conversation

valentinpalkovic
Copy link
Contributor

@valentinpalkovic valentinpalkovic commented Nov 18, 2024

Closes #29620

What I did

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-29639-sha-4154c3cb. Try it out in a new sandbox by running npx storybook@0.0.0-pr-29639-sha-4154c3cb sandbox or in an existing project with npx storybook@0.0.0-pr-29639-sha-4154c3cb upgrade.

More information
Published version 0.0.0-pr-29639-sha-4154c3cb
Triggered by @valentinpalkovic
Repository storybookjs/storybook
Branch valentin/fix-yarn-pnp-node-linker-pnpm
Commit 4154c3cb
Datetime Mon Nov 18 12:14:35 UTC 2024 (1731932075)
Workflow run 11892209961

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

Copy link
Contributor

Fails
🚫

PR is not labeled with one of: ["cleanup","BREAKING CHANGE","feature request","bug","documentation","maintenance","build","dependencies"]

🚫

PR is not labeled with one of: ["ci:normal","ci:merged","ci:daily","ci:docs"]

Generated by 🚫 dangerJS against 4154c3c

Copy link

nx-cloud bot commented Nov 18, 2024

☁️ Nx Cloud Report

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

Sent with 💌 from NxCloud.

Copy link

@ethanwu10 ethanwu10 left a 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:

// 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'))) {

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Bug]: bare import path resolution doesn't work under Yarn PNPM linker
2 participants