Core: Introduce run over play in portable stories, and revert back play changes of 8.2 #28764
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
…ay-to-run' into kasper/introduce-run
☁️ Nx Cloud ReportCI is running/has finished running commands for commit 2772623. 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. |
kasperpeulen
added
the
patch:yes
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
There was a problem hiding this comment.
11 file(s) reviewed, 30 comment(s)
Edit PR Review Bot Settings
| @@ -44,7 +44,8 @@ export type ComposedStoryFn< | |||
| > = PartialArgsStoryFn<TRenderer, TArgs> & { | |||
| args: TArgs; | |||
| id: StoryId; | |||
| play: (context?: Partial<StoryContext<TRenderer, Partial<TArgs>>>) => Promise<void>; | |||
| play?: (context?: Partial<StoryContext<TRenderer, Partial<TArgs>>>) => Promise<void>; | |||
There was a problem hiding this comment.
style: Making play optional might cause issues if existing code relies on it being present.
test-storybooks/portable-stories-kitchen-sink/react/stories/Button.test.tsx
Show resolved
Hide resolved
| @@ -117,6 +117,6 @@ it('should pass with decorators that need addons channel', () => { | |||
| // Batch snapshot testing | |||
| const testCases = Object.values(composeStories(stories)).map((Story) => [Story.storyName, Story]); | |||
| it.each(testCases)('Renders %s story', async (_storyName, Story) => { | |||
| await Story.play(); | |||
| await Story.run(); | |||
There was a problem hiding this comment.
logic: Verify that the run function maintains the same performance characteristics as play.
test-storybooks/portable-stories-kitchen-sink/svelte/stories/Button.test.ts
Show resolved
Hide resolved
test-storybooks/portable-stories-kitchen-sink/svelte/stories/Button.test.ts
Show resolved
Hide resolved
test-storybooks/portable-stories-kitchen-sink/svelte/stories/Button.test.ts
Show resolved
Hide resolved
yannbf
approved these changes
Jul 31, 2024
yannbf
added
ci:daily
Co-authored-by: Yann Braga <yannbf@gmail.com>
Co-authored-by: Yann Braga <yannbf@gmail.com>
Co-authored-by: Yann Braga <yannbf@gmail.com>
Co-authored-by: Yann Braga <yannbf@gmail.com>
Co-authored-by: Yann Braga <yannbf@gmail.com>
Co-authored-by: Yann Braga <yannbf@gmail.com>
This was referenced Jul 31, 2024
Merged
kasperpeulen
added a commit
that referenced
this pull request
Aug 1, 2024
Core: Introduce run over play in portable stories, and revert back play changes of 8.2 (cherry picked from commit 3b65e72)
github-actions
bot
added
the
patch:done
4 tasks
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
We overloaded the
playfunction in 8.2, so that it could be used to run the whole story whentestingLibraryRenderis set.However, we found out that this design is hard to understand and doesn't work when you want to reuse a play function of one story in another story. Especially when we would move to CSF4 where every story will be portable by default.
Therefore we are introducing a new method of
composeStoriescalledrun. Which is not overloaded, and will always run the whole story, includingloaders,beforeEach,mountandplay.We are reverting that change. If you are already started using
testingLibraryRenderin combination withplayit means that you need to move from using.playto.run.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/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>