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: Throttle Vitest progress updates more heavily #29482

Merged
merged 1 commit into from
Oct 30, 2024

Conversation

ghengeveld
Copy link
Member

@ghengeveld ghengeveld commented Oct 30, 2024

Increases the throttle time from 200 ms to 1 second for progress updates from Vitest, because it was seemingly interfering with other websocket events, specifically the VTA connection check heartbeat.

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/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 pull request has been released as version 0.0.0-pr-29482-sha-5d433a45. Try it out in a new sandbox by running npx storybook@0.0.0-pr-29482-sha-5d433a45 sandbox or in an existing project with npx storybook@0.0.0-pr-29482-sha-5d433a45 upgrade.

More information
Published version 0.0.0-pr-29482-sha-5d433a45
Triggered by @valentinpalkovic
Repository storybookjs/storybook
Branch throttle-vitest-progress-updates
Commit 5d433a45
Datetime Wed Oct 30 10:54:07 UTC 2024 (1730285647)
Workflow run 11591737579

To request a new release of this pull request, mention the @storybookjs/core team.

core team members can create a new canary release here or locally with gh workflow run --repo storybookjs/storybook canary-release-pr.yml --field pr=29482

name before after diff z %
createSize 0 B 0 B 0 B - -
generateSize 77.7 MB 77.7 MB 0 B 0.96 0%
initSize 143 MB 143 MB -215 B -0.9 0%
diffSize 65.1 MB 65.1 MB -215 B -0.9 0%
buildSize 6.87 MB 6.87 MB 6 B 1 0%
buildSbAddonsSize 1.51 MB 1.51 MB 0 B 0.92 0%
buildSbCommonSize 195 kB 195 kB 0 B - 0%
buildSbManagerSize 1.9 MB 1.9 MB 6 B 1 0%
buildSbPreviewSize 271 kB 271 kB 0 B - 0%
buildStaticSize 0 B 0 B 0 B - -
buildPrebuildSize 3.88 MB 3.88 MB 6 B 1 0%
buildPreviewSize 3 MB 3 MB 0 B - 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 22.1s 6.3s -15s -730ms -0.98 -246.8%
generateTime 19.4s 19.8s 365ms -1.17 1.8%
initTime 13.7s 13.6s -120ms -0.95 -0.9%
buildTime 8.9s 11.2s 2.3s 2.19 🔺20.7%
testBuildTime 0ms 0ms 0ms - -
devPreviewResponsive 6.6s 6.8s 215ms -0.03 3.1%
devManagerResponsive 4.2s 4.4s 199ms 0 4.4%
devManagerHeaderVisible 593ms 663ms 70ms 0.15 10.6%
devManagerIndexVisible 621ms 741ms 120ms 0.22 16.2%
devStoryVisibleUncached 1.2s 775ms -501ms -1.25 🔰-64.6%
devStoryVisible 620ms 704ms 84ms -0.01 11.9%
devAutodocsVisible 541ms 637ms 96ms 0.34 15.1%
devMDXVisible 593ms 660ms 67ms 0.61 10.2%
buildManagerHeaderVisible 667ms 613ms -54ms -0.14 -8.8%
buildManagerIndexVisible 696ms 634ms -62ms -0.1 -9.8%
buildStoryVisible 669ms 611ms -58ms -0.13 -9.5%
buildAutodocsVisible 518ms 509ms -9ms -0.32 -1.8%
buildMDXVisible 495ms 513ms 18ms -0.09 3.5%

Greptile Summary

Increased throttle time for Vitest progress updates from 200ms to 1000ms in the experimental test addon to reduce interference with websocket events, particularly VTA connection check heartbeat.

  • Modified throttle timing in code/addons/test/src/node/reporter.ts from 200ms to 1000ms for test progress reporting
  • Change may impact UI responsiveness and test feedback latency, requiring manual verification
  • Addresses potential websocket event conflicts with VTA connection heartbeat

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.

LGTM

1 file(s) reviewed, no comment(s)
Edit PR Review Bot Settings | Greptile

Copy link

nx-cloud bot commented Oct 30, 2024

☁️ Nx Cloud Report

CI is running/has finished running commands for commit 5d433a4. 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 target

Sent with 💌 from NxCloud.

@ghengeveld ghengeveld merged commit a35074b into next Oct 30, 2024
60 of 65 checks passed
@ghengeveld ghengeveld deleted the throttle-vitest-progress-updates branch October 30, 2024 11:04
@github-actions github-actions bot mentioned this pull request Oct 30, 2024
8 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants