Addon Test: Fix error reporting for vitest crashes
#29751
Merged
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
ndelangen
changed the title
vitest crashes
…rage-error-reporting-improvements
☁️ Nx Cloud ReportCI is running/has finished running commands for commit 35714f8. 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
approved these changes
Nov 29, 2024
ndelangen
deleted the
norbert/vitest-coverage-error-reporting-improvements
branch
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
There was a problem hiding this comment.
2 file(s) reviewed, 2 comment(s)
Edit PR Review Bot Settings | Greptile
Comment on lines
+83
to
+87
| try { | ||
| await this.vitest.init(); | ||
| } catch (e) { | ||
| this.testManager.reportFatalError('Failed to init Vitest', e); | ||
| } |
There was a problem hiding this comment.
logic: vitest instance may be in an invalid state after init failure. Consider setting this.vitest = null in catch block to prevent subsequent operations on failed instance.
Comment on lines
124
to
126
| api.updateTestProviderState(providerId, { | ||
| details, | ||
| error: { name: 'Crashed!', message: details.error.message }, | ||
| running: false, |
There was a problem hiding this comment.
style: Consider preserving the original error name from details.error.name instead of hardcoding 'Crashed!'
11 tasks
shilman
changed the title
vitest crashesvitest crashes
shilman
changed the title
vitest crashesvitest crashes
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 #29721
What I did
When vitest fails to initialize, we should report this problem properly to the UI.
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 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
Based on the provided files and context, here's a concise summary of the changes:
Improves error handling and reporting for Vitest crashes in Storybook's testing module, particularly focusing on initialization failures and coverage dependency issues.
vitest-manager.tsto capture initialization failures and report them throughtestManager.reportFatalError()SidebarBottom.tsxto standardize error format with{ name: 'Crashed!', message: details.error.message }updateTestProviderStateAPIThe changes provide better visibility and more graceful handling of Vitest-related errors, particularly addressing issue #29721 regarding coverage dependency requirements.