fix: include external Storybook entries for full story name retrieval #29452
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
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
There was a problem hiding this comment.
1 file(s) reviewed, 3 comment(s)
Edit PR Review Bot Settings | Greptile
Comment on lines
22
to
34
| function combineIndexes(rootIndex: API_IndexHash | undefined, refs: API_Refs) { | ||
| // Create a copy of the root index to avoid mutation | ||
| const combinedIndex = { ...(rootIndex || {}) }; // Use an empty object as fallback | ||
|
|
||
| // Traverse refs and merge each nested index with the root index | ||
| Object.values(refs).forEach((ref) => { | ||
| if (ref.index) { | ||
| Object.assign(combinedIndex, ref.index); | ||
| } | ||
| }); | ||
|
|
||
| return combinedIndex; | ||
| } |
There was a problem hiding this comment.
style: potential race condition if refs are updated while combining indexes - consider using useMemo to cache the combined index
| while ('parent' in node && node.parent && index[node.parent] && fullStoryName.length < 24) { | ||
| // @ts-expect-error (non strict) | ||
| node = index[node.parent]; | ||
| let node = combinedIndex[currentStory.id]; |
There was a problem hiding this comment.
logic: add null check for combinedIndex[currentStory.id] to prevent runtime errors
Comment on lines
53
to
59
| while ( | ||
| node && | ||
| 'parent' in node && | ||
| node.parent && | ||
| combinedIndex[node.parent] && | ||
| fullStoryName.length < 24 | ||
| ) { |
There was a problem hiding this comment.
style: consider moving length check to beginning of loop to prevent unnecessary iterations
jsingh0026
force-pushed
the
fix/external-storybook-composition
branch
from
7c5f8f1 to
6098c01
Compare
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.
Closes #29268
What I did
This PR resolves the issue of composition failures by including external Storybook entries in the index data. Previously, the current story ID was only searched in the internal Storybook index, which caused mismatches. By incorporating external Storybook IDs into the combined index, full story names are now correctly retrieved and visible on mobile devices without breaking.
Screen.Recording.2024-10-26.at.2.39.59.AM.mov
Checklist for Contributors
Testing
The changes in this PR are covered in the following automated tests:
Manual testing
yarn start.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/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
Enhanced mobile navigation to properly handle external Storybook composition by merging root and external indexes for accurate story name retrieval.
combineIndexesfunction in/code/core/src/manager/components/mobile/navigation/MobileNavigation.tsxto merge root and external ref indexes@ts-expect-errorcomments and adding proper type checksuseFullStoryNamehook to handle undefined nodes gracefullyrefsobject to prevent runtime errors during composition