Maintenance: Add assertions outside step incorrectly nested in interactions panel#34296
Merged
valentinpalkovic merged 2 commits intoMar 27, 2026
Conversation
…anel The bug where assertions outside of a Step appeared nested inside the Step (storybookjs#19401) has been resolved by the core restructuring. Add regression tests to guard against the issue recurring: - Instrumenter test: verify calls after an interceptable async step have correct ancestors (not nested under the step) - Panel test: verify collapsing a step does not hide subsequent waitFor and its children Signed-off-by: majiayu000 <1835304752@qq.com>
Contributor
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (2)
📝 WalkthroughWalkthroughTwo test cases are added to verify interaction handling behavior: one for collapse interactions hiding only direct child steps, and another for ensuring calls after an interceptable step are not nested within that step's context. Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~25 minutes Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Package BenchmarksCommit: No significant changes detected, all good. 👏 |
18 tasks
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 #19401
What I did
Added regression tests for the step/waitFor nesting bug in the interactions panel. When a play function uses
await step('name', callback)followed byawait waitFor(() => expect(...)), assertions insidewaitForcould appear nested under the collapsed step instead of underwaitFor.After investigation, the significant code restructuring (moving instrumenter from
addons/interactionstocode/core, refactoring the instrumenter) appears to have fixed the underlying bug. The instrumenter now correctly restores theancestorsstate after async step callbacks complete, sowaitForcalls that follow a step no longer inherit the step's call ID in their ancestors.These tests serve as regression guards to ensure the fix stays in place:
waitForafter astephave correct ancestors (onlywaitForID, not step ID), including retry scenarios.waitForcalls and their children.Checklist for Contributors
Testing
The changes in this PR are covered in the following automated tests:
Manual testing
No manual testing required — this PR only adds regression tests. The tests verify correct behavior by asserting on the
ancestorsarray of instrumented calls and on theisHiddenstate of panel rows.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 publish.yml --field pr=<PR_NUMBER>Summary by CodeRabbit