-
-
Notifications
You must be signed in to change notification settings - Fork 9.3k
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
NextJS: Fix Image Context re-use via singleton #24146
Merged
valentinpalkovic
merged 2 commits into
storybookjs:next
from
martinnabhan:bugfix/nextjs-image-context-2
Oct 5, 2023
Merged
NextJS: Fix Image Context re-use via singleton #24146
valentinpalkovic
merged 2 commits into
storybookjs:next
from
martinnabhan:bugfix/nextjs-image-context-2
Oct 5, 2023
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
martinnabhan
commented
Sep 12, 2023
martinnabhan
commented
Sep 12, 2023
martinnabhan
commented
Sep 12, 2023
martinnabhan
requested review from
valentinpalkovic,
kasperpeulen and
yannbf
as code owners
September 12, 2023 06:10
@ndelangen Sorry to bother you with this again. Could you please take a look? |
Hey @ndelangen would you mind checking this out whenever you have time? Thanks! It might take some time as we are quite busy, we really appreciate your efforts and patience <3 |
ndelangen
added
bug
nextjs
ci:daily
Run the CI jobs that normally run in the daily job.
labels
Sep 19, 2023
martinnabhan
force-pushed
the
bugfix/nextjs-image-context-2
branch
from
October 3, 2023 02:24
2382868
to
bc8a496
Compare
ndelangen
changed the title
NextJS: Fix Image Context reuse (ensure singleton by using the same Image Context for both ESM and CommonJS imports)
NextJS: Fix Image Context re-use via singleton
Oct 3, 2023
ndelangen
approved these changes
Oct 3, 2023
This was referenced Oct 5, 2023
8 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What I did
#23881 was supposed to fix Image Context reuse, but it turns out that
code/frameworks/nextjs/src/preview.tsx
uses the CommonJS export (code/frameworks/nextjs/dist/image-context.js
), whilecode/frameworks/nextjs/src/images/next-image.tsx
etc. uses the ESM export (code/frameworks/nextjs/dist/image-context.mjs
), causing the Image Context to not be reused and thus parameters specified inparameters.nextjs.image
and applied inpreview.tsx
won't be available innext-image.tsx
.This pull request forces the use of the CommonJS export, even when using
import
, making sure the same Image Context is reused for both ESM and CommonJS imports.Checklist for Contributors
Testing
The changes in this PR are covered in the following automated tests:
Manual testing
If you check the Eager story from the previous pull request you can see the image isn't being eagerly loaded, while the Eager story of this branch properly eager loads the image.
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/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>