Instrumenter: Fix preview-api import for react-native
#31057
Merged
Conversation
This file contains hidden or 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
…ons. This change improves dependency management and eliminates the need for a circular dependency workaround.
preview-api import for react-native
There was a problem hiding this comment.
Pull Request Overview
This PR improves the initialization of the addons module in the Instrumenter class by removing the dynamic import workaround for circular dependencies in favor of a direct import. Key changes include:
- Changing the dynamic import of addons from 'storybook/preview-api' to a static import.
- Simplifying the initialization logic by directly calling addons.ready() when addons is available.
There was a problem hiding this comment.
LGTM
2 file(s) reviewed, no comment(s)
Edit PR Review Bot Settings | Greptile
|
View your CI Pipeline Execution ↗ for commit a4eda8b.
☁️ Nx Cloud last updated this comment at |
…s change simplifies mocking and improves code organization by eliminating direct dependency on the global addons channel.
valentinpalkovic
approved these changes
Apr 3, 2025
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
This pull request includes changes to the
Instrumenterclass in thecode/core/src/instrumenter/instrumenter.tsfile, aimed at improving the handling of theaddonsmodule by removing a workaround for circular dependencies. The most important changes include importing theaddonsmodule directly and simplifying the initialization process.Changes to
Instrumenterclass:code/core/src/instrumenter/instrumenter.ts: Imported theaddonsmodule directly fromstorybook/preview-apiinstead of using a dynamic import to avoid circular dependencies.code/core/src/instrumenter/instrumenter.ts: Simplified the initialization of theaddonsmodule by checking ifaddonsis available and then callingaddons.ready()directly. [1] [2]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 pull request has been released as version
0.0.0-pr-31057-sha-a4eda8b5. Try it out in a new sandbox by runningnpx [email protected] sandboxor in an existing project withnpx [email protected] upgrade.More information
0.0.0-pr-31057-sha-a4eda8b5norbert/intrumenter-fixa4eda8b51743748750)To request a new release of this pull request, mention the
@storybookjs/coreteam.core team members can create a new canary release here or locally with
gh workflow run --repo storybookjs/storybook canary-release-pr.yml --field pr=31057Greptile Summary
Improved the Instrumenter initialization by replacing dynamic imports with direct imports for the addons module and tightening type safety in the typings file.
code/core/src/instrumenter/instrumenter.tsto directly import and initialize the addons module, removing circular dependency workarounds.code/core/src/typings.d.tsto explicitly type__STORYBOOK_ADDONS_PREVIEWusing theAddonStoretype.addons.ready()directly once addons are available.