Skip to content
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

Merged
merged 1 commit into from
Feb 18, 2025

Conversation

JReinhold
Copy link
Contributor

@JReinhold JReinhold commented Feb 18, 2025

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:

  • stories
  • unit tests
  • integration tests
  • end-to-end tests

Manual testing

This section is mandatory for all contributions. If you believe no manual test is necessary, please state so explicitly. Thanks!

Documentation

  • Add or update documentation reflecting your changes
  • If you are deprecating/removing a feature, make sure to update
    MIGRATION.MD

Checklist for Maintainers

  • When this PR is ready for testing, make sure to add ci:normal, ci:merged or ci:daily GH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found in code/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>

name before after diff z %
createSize 0 B 0 B 0 B - -
generateSize 80.6 MB 80.6 MB 0 B 0.5 0%
initSize 80.6 MB 80.6 MB 0 B 0.5 0%
diffSize 97 B 97 B 0 B - 0%
buildSize 7.31 MB 7.31 MB 0 B 0.49 0%
buildSbAddonsSize 1.9 MB 1.9 MB 0 B - 0%
buildSbCommonSize 195 kB 195 kB 0 B - 0%
buildSbManagerSize 1.88 MB 1.88 MB 0 B 0.58 0%
buildSbPreviewSize 0 B 0 B 0 B - -
buildStaticSize 0 B 0 B 0 B - -
buildPrebuildSize 3.97 MB 3.97 MB 0 B 0.58 0%
buildPreviewSize 3.34 MB 3.34 MB 0 B 0.48 0%
testBuildSize 0 B 0 B 0 B - -
testBuildSbAddonsSize 0 B 0 B 0 B - -
testBuildSbCommonSize 0 B 0 B 0 B - -
testBuildSbManagerSize 0 B 0 B 0 B - -
testBuildSbPreviewSize 0 B 0 B 0 B - -
testBuildStaticSize 0 B 0 B 0 B - -
testBuildPrebuildSize 0 B 0 B 0 B - -
testBuildPreviewSize 0 B 0 B 0 B - -
name before after diff z %
createTime 6.6s 21.6s 14.9s 0.82 69.2%
generateTime 17.6s 23.9s 6.3s 2.34 🔺26.4%
initTime 4.3s 5.1s 821ms 1.11 16%
buildTime 8.3s 12.2s 3.9s 3.16 🔺32%
testBuildTime 0ms 0ms 0ms - -
devPreviewResponsive 6.3s 5s -1s -286ms -0.78 -25.5%
devManagerResponsive 4.8s 3.7s -1s -154ms -1.02 -31%
devManagerHeaderVisible 854ms 712ms -142ms -0.75 -19.9%
devManagerIndexVisible 871ms 780ms -91ms -0.4 -11.7%
devStoryVisibleUncached 4.2s 4s -217ms 0.22 -5.4%
devStoryVisible 946ms 804ms -142ms -0.44 -17.7%
devAutodocsVisible 923ms 697ms -226ms -0.89 -32.4%
devMDXVisible 837ms 684ms -153ms -0.96 -22.4%
buildManagerHeaderVisible 880ms 589ms -291ms -1.7 🔰-49.4%
buildManagerIndexVisible 947ms 602ms -345ms -1.9 🔰-57.3%
buildStoryVisible 856ms 555ms -301ms -1.85 🔰-54.2%
buildAutodocsVisible 845ms 473ms -372ms -1.39 🔰-78.6%
buildMDXVisible 662ms 503ms -159ms -1.63 🔰-31.6%

Greptile Summary

Added telemetry tracking to capture the number of selected stories during test runs in the Storybook test addon.

  • Added selectedStoryCountForLastestRun property in code/addons/test/src/node/test-manager.ts to track focused test count
  • Added numSelectedStories field to telemetry data in code/addons/test/src/preset.ts for completed and failed test runs
  • Reset story count after test runs complete in test manager
  • Included selected story count in progress report details

Copy link
Contributor

@greptile-apps greptile-apps bot left a 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;
Copy link
Contributor

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')

Suggested change
selectedStoryCountForLastestRun = 0;
selectedStoryCountForLatestRun = 0;

Comment on lines +134 to +137
if (
((status === 'success' || status === 'cancelled') && progress?.finishedAt) ||
status === 'failed'
) {
Copy link
Contributor

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

Copy link
Contributor Author

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;
Copy link
Contributor

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

Copy link

nx-cloud bot commented Feb 18, 2025

View your CI Pipeline Execution ↗ for commit 81f28af.

Command Status Duration Result
nx affected -t check -c production --parallel=7 ✅ Succeeded <1s View ↗
nx run-many -t build -c production --parallel=3 ✅ Succeeded 3s View ↗

☁️ Nx Cloud last updated this comment at 2025-02-18 14:05:58 UTC

@shilman shilman added ci:normal maintenance User-facing maintenance tasks and removed ci:normal bug labels Feb 18, 2025
@shilman shilman merged commit 6c2fef8 into next Feb 18, 2025
74 of 77 checks passed
@shilman shilman deleted the jeppe/fix-focused-tests-telemetry branch February 18, 2025 14:40
@github-actions github-actions bot mentioned this pull request Feb 18, 2025
7 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants