Skip to content

Conversation

@valentinpalkovic
Copy link
Contributor

@valentinpalkovic valentinpalkovic commented Jun 11, 2025

Closes #

What I did

Problem

When using pnpm with different Next.js versions across apps, pnpm cannot hoist the Next.js package to the root due to version conflicts. This results in packages like @storybook/nextjs and package-a carrying their own Next.js packages in nested node_modules folders.

This creates a critical issue where multiple Next.js instances exist in the bundle, leading to React Context problems. For example:

  • Storybook sets up a Next.js Router Context Provider using Next.js instance "A"
  • Application code or libraries try to access the context using Next.js instance "B"
  • React.useContext() fails to resolve the context because it's looking for a provider from a different Next.js instance

Solution

Add a webpack alias that resolves all next and next/**/* imports to a single Next.js package location:

next: path.dirname(require.resolve('next/package.json'))

Why this approach:

  • require.resolve('next/package.json') resolves to the package.json of the Next.js version in the current app's node_modules
  • path.dirname() returns the package directory, enabling access to sub-paths like next/dist/shared/lib/app-router-context.shared-runtime
  • We can't use require.resolve('next') directly as it resolves to the entry file (e.g., next/dist/server/next.js), which doesn't support sub-path resolution

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

Added webpack alias configuration to resolve Next.js package conflicts in pnpm monorepo setups, preventing React Context failures caused by multiple Next.js instances.

  • Added webpack alias to map all next/**/* imports to a single Next.js package location using path.dirname(require.resolve('next/package.json'))
  • Ensures consistent module resolution when multiple Next.js versions exist across apps
  • Prevents React Context provider/consumer mismatches between different Next.js instances
  • Resolves critical issues with Router Context Provider in Storybook when using pnpm

Add webpack alias to ensure consistent Next.js module resolution when
multiple Next.js instances exist due to pnpm hoisting limitations.
@valentinpalkovic valentinpalkovic added ci:normal nextjs bug patch:yes Bugfix & documentation PR that need to be picked to main branch labels Jun 11, 2025
@valentinpalkovic valentinpalkovic self-assigned this Jun 11, 2025
@valentinpalkovic valentinpalkovic requested a review from yannbf June 11, 2025 19:24
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 reviewed, no comments
Edit PR Review Bot Settings | Greptile

@nx-cloud
Copy link

nx-cloud bot commented Jun 11, 2025

View your CI Pipeline Execution ↗ for commit c6152a3.

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

☁️ Nx Cloud last updated this comment at 2025-06-11 19:29:29 UTC

@valentinpalkovic valentinpalkovic merged commit d4c4e50 into next Jun 12, 2025
58 of 75 checks passed
@valentinpalkovic valentinpalkovic deleted the valentin/nextjs-improve-mono-repo-support branch June 12, 2025 06:25
@github-actions github-actions bot mentioned this pull request Jun 12, 2025
14 tasks
JReinhold pushed a commit that referenced this pull request Jun 12, 2025
…no-repo-support

Next.js: Add webpack alias to resolve Next.js package conflicts

(cherry picked from commit d4c4e50)
@github-actions github-actions bot added the patch:done Patch/release PRs already cherry-picked to main/release branch label Jun 12, 2025
@github-actions github-actions bot mentioned this pull request Jun 16, 2025
71 tasks
@ndelangen ndelangen removed the patch:yes Bugfix & documentation PR that need to be picked to main branch label Oct 28, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug ci:normal nextjs patch:done Patch/release PRs already cherry-picked to main/release branch

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants