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

Next.js: Use ESM instead of CJS #24841

Merged

Conversation

JReinhold
Copy link
Contributor

@JReinhold JReinhold commented Nov 14, 2023

Telescopes on #24834, hopefully fixing the problems that it caused.

What I did

  • Refactor the preview.js import in Next.js to use ESM throughout the modules instead of CJS.
  • Remove conditional import of addon-actions as it's a direct dependency anyway, so it will always be there.
  • Refactor conditional use of Next.js app router context providers to not use require() but instead import() the mock AppRouterProvider.

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>

@JReinhold JReinhold added the ci:daily Run the CI jobs that normally run in the daily job. label Nov 14, 2023
@JReinhold JReinhold self-assigned this Nov 14, 2023
@JReinhold JReinhold added maintenance User-facing maintenance tasks addon: actions nextjs labels Nov 14, 2023
@@ -24,7 +24,8 @@ export function configureNextImport(baseConfig: WebpackConfig) {
baseConfig.plugins.push(
new IgnorePlugin({
// ignore next/dist/shared/lib/hooks-client-context and next/legacy/image imports
resourceRegExp: /(next\/dist\/shared\/lib\/hooks-client-context|next\/legacy\/image)$/,
resourceRegExp:
/(next\/dist\/shared\/lib\/hooks-client-context|next\/dist\/shared\/lib\/hooks-client-context\.shared-runtime|next\/legacy\/image)$/,
Copy link
Contributor Author

Choose a reason for hiding this comment

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

we could make this more readable with a checkResource filter-function instead, but I don't know which is more performant.

@JReinhold JReinhold marked this pull request as ready for review November 15, 2023 09:05
@ndelangen
Copy link
Member

This is a massive improvement, I think. 👏

Copy link
Contributor

@valentinpalkovic valentinpalkovic left a comment

Choose a reason for hiding this comment

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

LGTM!

@JReinhold JReinhold merged commit c5cddf6 into revert-24832-revert-24676-experiment-addon-peer-dep Nov 15, 2023
115 of 124 checks passed
@JReinhold JReinhold deleted the fix-nextjs-esm branch November 15, 2023 09:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
addon: actions ci:daily Run the CI jobs that normally run in the daily job. maintenance User-facing maintenance tasks nextjs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants