-
-
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
Core: Ensure that simultaneous onStoriesChanged don't clobber each other #26882
Conversation
// We are about to render an error so make sure the previous story is | ||
// no longer rendered. | ||
if (lastRender) await this.teardownRender(lastRender); |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm really unsure why the logic wouldn't have applied in the aborted cased too (the lastRender
is out of date no matter what!). The tests from the PR that added this code #17599 still pass so I think it's good.
☁️ Nx Cloud ReportCI is running/has finished running commands for commit 7cf08a8. 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 targetSent with 💌 from NxCloud. |
code/lib/preview-api/src/modules/preview-web/PreviewWeb.test.ts
Outdated
Show resolved
Hide resolved
4482c8f
to
7cf08a8
Compare
There was an issue where if you HMR-ed there was a chance that the two calls to
onStoriesChanged
happened simultaneously, which would end up with 2 storyRenders for the same story that competed with each other.The net result of that is that args changing would sort of stop working (
storyArgsUpdated
wasn't emitted).What I did
Added tests and deal with the case that two
renderSelection
s happen simultaneous (without a change of story - see #17599 for that case).Checklist for Contributors
Testing
The changes in this PR are covered in the following automated tests:
Manual testing
This section is mandatory for all contributions. If you believe no manual test is necessary, please state so explicitly. Thanks!
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>