Core: Update StoryStore.extract to handle tests#32388
Merged
Merged
Conversation
…act, and track the parent story name for a test. - Updated 'story' property to always be the story name rather than the test name - Added 'storyId' property to point to the parent story from a test
StoryStore.extract to handle testsStoryStore.extract to handle tests
|
View your CI Pipeline Execution ↗ for commit d61fba2
☁️ Nx Cloud last updated this comment at |
yannbf
approved these changes
Sep 3, 2025
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
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 #
What I did
Make it possible to distinguish tests from stories in
StoryStore.extract, and track the parent story name for a test.storyproperty to always be the story name rather than the test namestoryIdproperty to point to the parent story from a testChecklist 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
Updated On: 2025-09-03 14:47:43 UTC
This PR enhances Storybook's
StoryStore.extractmethod to properly distinguish between tests and stories, which is part of a test function prototype feature. The changes introduce a newparentNameproperty to the story indexing system that tracks the parent story name for test entries.The implementation spans across four key files:
indexer.ts): Adds optionalparentNameproperty to bothStoryIndexEntryandStoryIndexInputinterfacesStoryIndexGenerator.ts): Conditionally includes parent metadata (bothparentID andparentName) when processing test entriesCsfFile.ts): AddsparentNameto test index entries during CSF parsingStoryStore.ts): Modifies the extract method so that test entries use their parent story name in thestoryproperty and includes a newstoryIdproperty for tracking parent-child relationshipsThe core behavioral change is that when extracting test entries, the
storyproperty now contains the parent story name rather than the test name itself, and a newstoryIdproperty points to the parent story ID. This allows consumers to understand that tests are conceptually part of their parent story while maintaining clear hierarchical relationships.The changes maintain backward compatibility since the
parentNameproperty is optional and only applies to test entries. This fits into Storybook's architecture by extending the existing story indexing system to support test-story relationships without breaking existing functionality.Confidence score: 4/5