Addon-Test: Make sure that only one global portable story config is ever loaded #30582
Conversation
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
There was a problem hiding this comment.
4 file(s) reviewed, 4 comment(s)
Edit PR Review Bot Settings | Greptile
| annotations.preview, | ||
| // get the story preview, or fallback to the global csf4 preview, if CSF3 is used alongside a CSF4 preview file | ||
| composeConfigs([ | ||
| annotations.preview ?? globalThis.csf4Preview.composed, |
There was a problem hiding this comment.
logic: Accessing globalThis.csf4Preview.composed without type checking could cause runtime errors if csf4Preview is undefined
| ): Preview<TRenderer> { | ||
| return { | ||
| let composed: NormalizedProjectAnnotations<TRenderer>; |
There was a problem hiding this comment.
logic: mutable variable could lead to race conditions if multiple previews are initialized concurrently
| beforeAll(() => { | ||
| if (globalThis.csf4Preview) { | ||
| return globalThis.csf4Preview.composed.beforeAll(); | ||
| } | ||
| }); |
There was a problem hiding this comment.
style: Consider handling the case where csf4Preview.composed exists but beforeAll() is undefined
code/core/src/csf/csf-factories.ts
Outdated
| }, | ||
| meta(meta: ComponentAnnotations<TRenderer>) { | ||
| return defineMeta(meta, this); | ||
| }, | ||
| }; | ||
| globalThis.csf4Preview = preview; |
There was a problem hiding this comment.
style: setting global variable could cause issues in environments with multiple preview instances
|
View your CI Pipeline Execution ↗ for commit a2d4030.
☁️ Nx Cloud last updated this comment at |
kasperpeulen
force-pushed
the
kasper/automatic-before-all
branch
from
b0f5d66 to
308d77a
Compare
kasperpeulen
changed the title
What I did
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:mergedorci:dailyGH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found incode/lib/cli-storybook/src/sandbox-templates.tsMake 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/coreteam 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
Based on the provided information, I'll create a concise summary of the pull request changes:
Enhanced Vitest integration in Storybook's addon-test by adding automatic detection and execution of beforeAll lifecycle methods.
csf-factories.tsfor composed project annotations to improve performancetest-utils.tsto usecomposeConfigsfor handling story previews with CSF3/CSF4 compatibilityglobalThis.csf4Previewinsetup-file.tsto store and access preview instance globallyportable-stories.tsto properly compose default and global annotations for project configuration