Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Portable stories: Only provide a play function wrapper if it exists #25974

Merged
merged 1 commit into from
Feb 12, 2024

Conversation

yannbf
Copy link
Member

@yannbf yannbf commented Feb 9, 2024

Closes #

What I did

A recent PR improved the play function in portable stories, however introduced a slight runtime check issue, where if users were to check whether a composed story's play function exists, it would always return true, even if there wasn't one. This PR fixes that, and it also fixes a TypeScript issue where the type of the play function was always defined, even though it could be undefined. This will affect projects that used the play function of a composed story before, and the change is documented in migration notes.

Checklist for Contributors

Testing

The changes in this PR are covered in the following automated tests:

  • stories
  • unit tests
  • integration tests
  • end-to-end tests

Manual testing

This section is mandatory for all contributions. If you believe no manual test is necessary, please state so explicitly. Thanks!

Documentation

  • Add or update documentation reflecting your changes
  • If you are deprecating/removing a feature, make sure to update
    MIGRATION.MD

Checklist for Maintainers

  • When this PR is ready for testing, make sure to add ci:normal, ci:merged or ci:daily GH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found in code/lib/cli/src/sandbox-templates.ts

  • Make 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/core team 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>

@yannbf yannbf force-pushed the yann/improve-play-fn-portable-stories-2 branch from 3783493 to 80267b2 Compare February 12, 2024 10:58
@yannbf yannbf marked this pull request as ready for review February 12, 2024 10:58
Comment on lines +104 to +110
play: story.playFunction
? ((async (extraContext: ComposedStoryPlayContext<TRenderer, TArgs>) =>
story.playFunction!({
...context,
...extraContext,
})) as unknown as ComposedStoryPlayFn<TRenderer, Partial<TArgs>>)
: undefined,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: personally I find this syntax more readable in these cases, but it's totally up to you.

Suggested change
play: story.playFunction
? ((async (extraContext: ComposedStoryPlayContext<TRenderer, TArgs>) =>
story.playFunction!({
...context,
...extraContext,
})) as unknown as ComposedStoryPlayFn<TRenderer, Partial<TArgs>>)
: undefined,
...(story.PlayFunction && { play: ((async (extraContext: ComposedStoryPlayContext<TRenderer, TArgs>) =>
story.playFunction!({
...context,
...extraContext,
})) as unknown as ComposedStoryPlayFn<TRenderer, Partial<TArgs>>) })

@yannbf yannbf merged commit 3ae39b6 into next Feb 12, 2024
55 of 63 checks passed
@yannbf yannbf deleted the yann/improve-play-fn-portable-stories-2 branch February 12, 2024 15:32
@github-actions github-actions bot mentioned this pull request Feb 12, 2024
13 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants