Addon Vitest: Add status update prototype #28926
Conversation
☁️ Nx Cloud ReportCI is running/has finished running commands for commit 34769c0. 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.
8 file(s) reviewed, 8 comment(s)
Edit PR Review Bot Settings
| pending: 'pending', | ||
| }; | ||
|
|
||
| function processTestReport(report: TestReport, onClick: any) { |
There was a problem hiding this comment.
style: Consider adding type annotation for onClick parameter
| const openInteractionsPanel = () => { | ||
| api.setSelectedPanel('storybook/interactions/panel'); | ||
| api.togglePanel(true); | ||
| }; |
There was a problem hiding this comment.
style: Consider extracting this function outside the change event handler for better performance
| if(err.code === 'ENOENT') { | ||
| console.log('File got deleted/renamed. What should we do?'); | ||
| return; |
There was a problem hiding this comment.
logic: Implement proper error handling for file deletion/renaming instead of just logging.
| const testReportState = SharedState.subscribe<TestReport>('TEST_RESULTS', channel); | ||
|
|
||
| watchTestReportDirectory(reportFile, async (results) => { | ||
| console.log('Updating test results:', Object.keys(results.testResults).length); |
There was a problem hiding this comment.
style: Consider using a more descriptive logging method, such as console.debug or a custom logger.
| failure: boolean; | ||
| filesAdded: number; | ||
| filesRemoved: number; | ||
| filesRemovedList: any[]; |
There was a problem hiding this comment.
style: Consider using a more specific type than any[] for filesRemovedList
| matched: number; | ||
| total: number; | ||
| unchecked: number; | ||
| uncheckedKeysByFile: any[]; |
There was a problem hiding this comment.
style: Consider using a more specific type than any[] for uncheckedKeysByFile
Closes #
What I did
This brings back the implementation from #28749 regarding updating Storybook's sidebar based on test reports, this time not using JUnit but rather json reports, which include test meta (we need it to extract the storyId).
It also introduces a storybook reporter from vitest addon, so that the json file is written in the right location.
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 implements a status update prototype for the Vitest addon in Storybook, enhancing test result integration.
src/plugin/reporter.tsfor JSON test report generationsrc/utils/shared-state.tsfor managing state across addon componentssrc/preset.tsfor watching and processing test reportssrc/manager.tsxto display real-time test statuses in Storybook's sidebarvitest.config.tsto include the new Storybook reporter for Vitest