-
-
Notifications
You must be signed in to change notification settings - Fork 9.4k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Addon-Test: Add telemetry data for Focused Tests #30568
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
2 file(s) reviewed, 3 comment(s)
Edit PR Review Bot Settings | Greptile
@@ -17,6 +17,8 @@ import { VitestManager } from './vitest-manager'; | |||
export class TestManager { | |||
vitestManager: VitestManager; | |||
|
|||
selectedStoryCountForLastestRun = 0; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
syntax: Typo in variable name 'selectedStoryCountForLastestRun' ('Lastest' should be 'Latest')
selectedStoryCountForLastestRun = 0; | |
selectedStoryCountForLatestRun = 0; |
if ( | ||
((status === 'success' || status === 'cancelled') && progress?.finishedAt) || | ||
status === 'failed' | ||
) { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
logic: Race condition possible here - if a new test run starts before the previous one finishes, the count could be reset prematurely
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
correct, but highly unlikely. the window of timing is very small here.
@@ -96,6 +98,8 @@ export class TestManager { | |||
await this.vitestManager.vitestRestartPromise; | |||
} | |||
|
|||
this.selectedStoryCountForLastestRun = payload.storyIds?.length ?? 0; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
style: Setting selectedStoryCount after temporarilyDisableCoverage check means the count won't be reset if the check fails
View your CI Pipeline Execution ↗ for commit 81f28af.
☁️ Nx Cloud last updated this comment at |
083c086
to
81f28af
Compare
What I did
This PR adds data about how many stories were selected for the run, when sending telemetry on completed test runs.
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: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
Added telemetry tracking to capture the number of selected stories during test runs in the Storybook test addon.
selectedStoryCountForLastestRun
property incode/addons/test/src/node/test-manager.ts
to track focused test countnumSelectedStories
field to telemetry data incode/addons/test/src/preset.ts
for completed and failed test runs