React: Use Act wrapper in Storybook for component rendering #30037
+121
−86
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
☁️ Nx Cloud ReportCI is running/has finished running commands for commit a52aec2. 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 2 targetsSent with 💌 from NxCloud. |
valentinpalkovic
force-pushed
the
valentin/act-wrapping-of-components
branch
from
b4a1714 to
4c40b5f
Compare
valentinpalkovic
added
the
ci:daily
valentinpalkovic
force-pushed
the
valentin/act-wrapping-of-components
branch
from
4c40b5f to
95e2429
Compare
valentinpalkovic
force-pushed
the
valentin/act-wrapping-of-components
branch
from
95e2429 to
13e3869
Compare
Package BenchmarksCommit: No significant changes detected, all good. 👏 |
…ENV handling in build scripts
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
There was a problem hiding this comment.
5 file(s) reviewed, 5 comment(s)
Edit PR Review Bot Settings | Greptile
Comment on lines
+70
to
+75
| let result; | ||
| act(() => { | ||
| result = cb(); | ||
| return result; | ||
| }); | ||
| return result; |
There was a problem hiding this comment.
logic: result variable could be undefined if act throws an error
valentinpalkovic
force-pushed
the
valentin/act-wrapping-of-components
branch
2 times, most recently
from
76e10e5 to
32b52ee
Compare
valentinpalkovic
force-pushed
the
valentin/act-wrapping-of-components
branch
from
32b52ee to
a52aec2
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 #
What I did
Previously, we have wrapped mounting and unmounting of React component, as well as test interactions via userEvent by
actin a portable stories environment. Now we are adapting this behaviour to configure@storybook/testto wrap all component interactions and mounting/unmounting withact. This will make sure, that we can actually await a components rendering properly before we continue to the next Storybook render lifecycle phase.Background:
The A11y addon has issues to find the right timing to trigger an automated test run if a component uses Suspense (e.g. RSC). With
actwe can actually properly await the complete rendering of a React component also in the Storybook preview, so that addon a11y can properly await its final rendering to trigger an a11y test 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-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-30037-sha-13e3869b. 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-30037-sha-13e3869bvalentin/act-wrapping-of-components13e3869b1734009036)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=30037Greptile Summary
Based on the provided files and changes, here's a concise summary of the pull request:
Implements proper React act() wrapping for component rendering in Storybook, ensuring consistent behavior between development and testing environments.
act-compat.tsto skip act wrapping in production buildsrenderToCanvas.tsxto wrap both render and unmount operations in act() for proper component lifecycle handling__isPortableStoryflag in render context to control act wrapping behavior