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

Vite: Fix HMR issue for Storybook preview files #27256

Merged
merged 1 commit into from
May 23, 2024

Conversation

valentinpalkovic
Copy link
Contributor

@valentinpalkovic valentinpalkovic commented May 23, 2024

Closes #26881

What I did

Changes in .storybook/preview.<ts|js> files were not updated after an HMR event. A full browser reload was necessary. The issue was that even though the HMR event was sent successfully to the browser, the old preview annotation files were loaded.

before

1. `.storybook/preview.js` changes
2. HMR event sent to the browser
3. Preview annotations for `./.storybook/preview.js` loaded -> Since this was already imported once, the browser will return the cached version of the module and will not request it again

after

1. `.storybook/preview.js` changes
2. HMR event sent to the browser
3. Preview annotations for `./storybook/preview.js?t=<hash>` loaded -> This contains the latest changes

I have adjusted the logic to always consider the updated annotation files instead of a previous cached version.

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>

Copy link

nx-cloud bot commented May 23, 2024

☁️ Nx Cloud Report

CI is running/has finished running commands for commit 525bd60. 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
Member

@tmeasday tmeasday left a comment

Choose a reason for hiding this comment

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

This change makes sense to me!

@valentinpalkovic valentinpalkovic marked this pull request as ready for review May 23, 2024 12:19
@valentinpalkovic valentinpalkovic added the patch:yes Bugfix & documentation PR that need to be picked to main branch label May 23, 2024
@valentinpalkovic valentinpalkovic force-pushed the valentin/fix-hmr-issue-in-preview branch from 5ede738 to 525bd60 Compare May 23, 2024 14:07
@valentinpalkovic valentinpalkovic merged commit 6c04751 into next May 23, 2024
60 of 61 checks passed
@valentinpalkovic valentinpalkovic deleted the valentin/fix-hmr-issue-in-preview branch May 23, 2024 14:32
@github-actions github-actions bot mentioned this pull request May 23, 2024
25 tasks
storybook-bot pushed a commit that referenced this pull request May 23, 2024
…preview

Vite: Fix HMR issue for Storybook preview files
(cherry picked from commit 6c04751)
@github-actions github-actions bot mentioned this pull request May 23, 2024
13 tasks
storybook-bot pushed a commit that referenced this pull request May 23, 2024
…preview

Vite: Fix HMR issue for Storybook preview files
(cherry picked from commit 6c04751)
storybook-bot pushed a commit that referenced this pull request May 23, 2024
…preview

Vite: Fix HMR issue for Storybook preview files
(cherry picked from commit 6c04751)
storybook-bot pushed a commit that referenced this pull request May 23, 2024
…preview

Vite: Fix HMR issue for Storybook preview files
(cherry picked from commit 6c04751)
storybook-bot pushed a commit that referenced this pull request May 24, 2024
…preview

Vite: Fix HMR issue for Storybook preview files
(cherry picked from commit 6c04751)
storybook-bot pushed a commit that referenced this pull request May 24, 2024
…preview

Vite: Fix HMR issue for Storybook preview files
(cherry picked from commit 6c04751)
storybook-bot pushed a commit that referenced this pull request May 24, 2024
…preview

Vite: Fix HMR issue for Storybook preview files
(cherry picked from commit 6c04751)
storybook-bot pushed a commit that referenced this pull request May 24, 2024
…preview

Vite: Fix HMR issue for Storybook preview files
(cherry picked from commit 6c04751)
storybook-bot pushed a commit that referenced this pull request May 27, 2024
…preview

Vite: Fix HMR issue for Storybook preview files
(cherry picked from commit 6c04751)
storybook-bot pushed a commit that referenced this pull request May 27, 2024
…preview

Vite: Fix HMR issue for Storybook preview files
(cherry picked from commit 6c04751)
@github-actions github-actions bot added the patch:done Patch/release PRs already cherry-picked to main/release branch label May 27, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug builder-vite ci:normal patch:done Patch/release PRs already cherry-picked to main/release branch patch:yes Bugfix & documentation PR that need to be picked to main branch
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Bug]: HMR of preview.tsx is not working
3 participants