Addon-vitest: Fix wrong test count in telemetry #31504
Merged
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 #31493
What I did
selectedStoryCount
, as it was both confusing and not that usefulTest case results continuously come in from Vitest in a steady stream. We throttle the handling of them, because otherwise it consistently chokes our websocket connection for some reason. (this is very unfortunate, because seeing the test ran count go brrr is really great UX, but for some reason it's too many events for our channel). The problem here, was that when all tests completed we would emit
TEST_RUN_COMPLETED
immediately, even though there were still unhandled test case results left because of the throttled handling. This would result in the unhandled results not being part of the telemetry being emitted.Now, when Vitest calls the
onTestRunEnd
lifecycle hook - which happens just beforerunTestSpecifications
finishes and thus our test run - we flush the throttle function, meaning that we force handle any test case results that are left. Then the test run actually finishes, and we send the telemetry event will all test case results.Checklist for Contributors
Testing
The changes in this PR are covered in the following automated tests:
Manual testing
scripts
runyarn jiti ./event-log-collector.ts
STORYBOOK_TELEMETRY_URL="http://localhost:6007/event-log" yarn storybook
http://localhost:6007/event-log
and check that the last event has the same number of tests as those reported in the testing widgetThis 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:merged
orci:daily
GH 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.ts
Make 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/core
team 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
Fixed incorrect test count reporting in telemetry data for the Vitest addon by ensuring all test results are properly processed before sending completion events.
flush()
call incode/addons/vitest/src/node/test-manager.ts
to process pending throttled test results before emitting completion eventselectedStoryCount
metric from telemetry data incode/addons/vitest/src/preset.ts