Addon Vitest: Fix error message logic in set up file #28906
Conversation
☁️ Nx Cloud ReportCI is running/has finished running commands for commit 53d295d. 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. |
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
There was a problem hiding this comment.
LGTM
4 file(s) reviewed, no comment(s)
Edit PR Review Bot Settings
| @@ -33,7 +33,7 @@ export default mergeConfig( | |||
| include: [ | |||
| // TODO: test all core and addon stories later | |||
| // './core/**/components/**/*.{story,stories}.?(c|m)[jt]s?(x)', | |||
| '../addons/interactions/src/**/*.{story,stories}.?(c|m)[jt]s?(x)', | |||
| '../addons/**/src/**/*.{story,stories}.?(c|m)[jt]s?(x)', | |||
There was a problem hiding this comment.
All of them work now ?!?
There was a problem hiding this comment.
The addons, yes! There was a flake but I fixed it.
Most of the problems come from the other part (core) which is not enabled yet
| afterAll((suite) => { | ||
| suite.tasks.forEach(modifyErrorMessage); | ||
| }); | ||
| afterEach(modifyErrorMessage); |
There was a problem hiding this comment.
Actually, we don't need the meta anymore, because the story.id is available on the afterEach context.
There was a problem hiding this comment.
We could refactor this function to use story from context, but we should keep meta.storyId mutation in the file transformation because that is what goes in the json reports (and not the test context)
shilman
changed the title
Closes #28903
What I did
Before, the set up file was only overwriting the error message of the last failure if multiple stories failed. Now it is attached per test run, so it works in all occasions.
I also added a small optimization on the channel mocks
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>Greptile Summary
This PR improves error handling and test coverage for the Storybook Vitest addon, focusing on more accurate error reporting and expanded test inclusion for addons.
code/addons/vitest/src/plugin/setup-file.tsto useafterEachhook for more timely error reportingcode/.storybook/vitest.config.tsto include all addon stories in testingHighlightElement.stories.tsxwithwaitForfunction for improved test reliabilitystorybook:vitestscript inpackage.jsonto useyarn test:watchfor continuous testing