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

Build: Raise Chromatic threshold for inconsistent snapshot of monospace text #28778

Merged
merged 4 commits into from
Aug 1, 2024

Conversation

ghengeveld
Copy link
Member

@ghengeveld ghengeveld commented Aug 1, 2024

What I did

This raised the Chromatic threshold from 0.63 to 0.65 in order for subtle font rendering changes on this story to be ignored.

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 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 76.3 MB 76.3 MB 0 B -2.93 0%
initSize 198 MB 198 MB 0 B -0.07 0%
diffSize 122 MB 122 MB 0 B 0.51 0%
buildSize 7.6 MB 7.6 MB 0 B 1.44 0%
buildSbAddonsSize 1.63 MB 1.63 MB 0 B 1.71 0%
buildSbCommonSize 195 kB 195 kB 0 B - 0%
buildSbManagerSize 2.3 MB 2.3 MB 0 B -3 0%
buildSbPreviewSize 349 kB 349 kB 0 B 1.73 0%
buildStaticSize 0 B 0 B 0 B - -
buildPrebuildSize 4.47 MB 4.47 MB 0 B 1.67 0%
buildPreviewSize 3.12 MB 3.12 MB 0 B 0.73 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 7.5s 23.1s 15.6s 1.38 🔺67.4%
generateTime 24.8s 19.9s -4s -886ms -1.42 🔰-24.5%
initTime 25.6s 20.3s -5s -235ms -1.57 🔰-25.7%
buildTime 16.2s 14.5s -1s -780ms 0.21 -12.3%
testBuildTime 0ms 0ms 0ms - -
devPreviewResponsive 8.3s 10.8s 2.5s 0.55 23.4%
devManagerResponsive 5.4s 6.2s 783ms 0.1 12.6%
devManagerHeaderVisible 845ms 1.1s 345ms 1.77 🔺29%
devManagerIndexVisible 871ms 1.2s 349ms 1.71 🔺28.6%
devStoryVisibleUncached 1.4s 1.8s 400ms 1.15 22.1%
devStoryVisible 893ms 1.2s 353ms 1.69 🔺28.3%
devAutodocsVisible 784ms 874ms 90ms 0.42 10.3%
devMDXVisible 740ms 796ms 56ms 0.39 7%
buildManagerHeaderVisible 876ms 791ms -85ms -0.52 -10.7%
buildManagerIndexVisible 877ms 837ms -40ms -0.22 -4.8%
buildStoryVisible 918ms 851ms -67ms -0.51 -7.9%
buildAutodocsVisible 794ms 709ms -85ms -0.67 -12%
buildMDXVisible 689ms 783ms 94ms 0.33 12%

Greptile Summary

Added chromatic-ignore class to error stack traces to fix inconsistent Chromatic snapshots.

  • Modified code/core/assets/server/base-preview-body.html to add chromatic-ignore class to error stack trace element.
  • Updated test-storybooks/standalone-preview/storybook.html to include chromatic-ignore class in the pre tag containing the error stack trace.

@ghengeveld ghengeveld added build Internal-facing build tooling & test updates ci:normal labels Aug 1, 2024
@ghengeveld ghengeveld requested a review from yannbf August 1, 2024 15:17
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

2 file(s) reviewed, no comment(s)
Edit PR Review Bot Settings

Copy link

nx-cloud bot commented Aug 1, 2024

☁️ Nx Cloud Report

CI is running/has finished running commands for commit 12f8343. 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 changed the title Build: Ignore code block in Chromatic to fix inconsistent snapshots Build: Raise Chromatic threshold for inconsistent snapshot of monospace text Aug 1, 2024
Copy link
Member

@yannbf yannbf left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you so much for taking care of this!!

@ghengeveld ghengeveld merged commit d419bc6 into next Aug 1, 2024
53 checks passed
@ghengeveld ghengeveld deleted the chromatic-ignore-stacktrace branch August 1, 2024 21:43
@github-actions github-actions bot mentioned this pull request Aug 1, 2024
14 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
build Internal-facing build tooling & test updates ci:normal
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants