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 A11y: Add conditional rendering for a11y violation number in Testing Module #30073

Merged
merged 1 commit into from
Dec 16, 2024

Conversation

valentinpalkovic
Copy link
Contributor

@valentinpalkovic valentinpalkovic commented Dec 16, 2024

Closes #

What I did

I have removed the a11y violation count on a story in the sidebar because in the case of a a11y violation, it was always showing 1. The status icon on the left already indicates whether the story has a11y violations.

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 77.7 MB 77.7 MB 0 B 1.11 0%
initSize 136 MB 136 MB 0 B 1.11 0%
diffSize 58.4 MB 58.4 MB 0 B 1.11 0%
buildSize 7.24 MB 7.24 MB 0 B 0.9 0%
buildSbAddonsSize 1.88 MB 1.88 MB 0 B 0.9 0%
buildSbCommonSize 195 kB 195 kB 0 B - 0%
buildSbManagerSize 1.86 MB 1.86 MB 0 B 0.83 0%
buildSbPreviewSize 0 B 0 B 0 B - -
buildStaticSize 0 B 0 B 0 B - -
buildPrebuildSize 3.93 MB 3.93 MB 0 B 0.9 0%
buildPreviewSize 3.3 MB 3.3 MB 0 B 0.89 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 8s 7.8s -145ms -0.84 -1.8%
generateTime 20.2s 22s 1.7s 1.33 🔺8.1%
initTime 14.5s 14.7s 169ms 0.4 1.1%
buildTime 11.9s 10s -1s -855ms 0.25 -18.5%
testBuildTime 0ms 0ms 0ms - -
devPreviewResponsive 5.6s 4.8s -759ms -0.41 -15.5%
devManagerResponsive 4.1s 3.7s -420ms -0.25 -11.2%
devManagerHeaderVisible 748ms 599ms -149ms 0.08 -24.9%
devManagerIndexVisible 770ms 629ms -141ms -0.18 -22.4%
devStoryVisibleUncached 1.9s 1.9s -59ms 0.53 -3.1%
devStoryVisible 792ms 630ms -162ms -0.18 -25.7%
devAutodocsVisible 501ms 423ms -78ms -1.71 🔰-18.4%
devMDXVisible 578ms 552ms -26ms 0.29 -4.7%
buildManagerHeaderVisible 642ms 655ms 13ms 0.86 2%
buildManagerIndexVisible 744ms 779ms 35ms 1.12 4.5%
buildStoryVisible 603ms 617ms 14ms 1.1 2.3%
buildAutodocsVisible 504ms 443ms -61ms -0.14 -13.8%
buildMDXVisible 475ms 477ms 2ms 0.35 0.4%

Greptile Summary

This PR modifies the TestProviderRender component to conditionally hide accessibility test counts when viewing individual stories in Storybook.

  • Added conditional check in code/addons/test/src/components/TestProviderRender.tsx to hide a11y test counts when entryId contains '--'
  • Potential code duplication in story entry detection logic (lines 117 and 161)
  • Missing test coverage for new conditional rendering behavior
  • Could impact accessibility issue tracking workflow for individual story views

@valentinpalkovic valentinpalkovic changed the title Add conditional rendering for a11yNotPassedAmount based on story entry Addon A11y: Add conditional rendering for a11yNotPassedAmount based on story entry Dec 16, 2024
@valentinpalkovic valentinpalkovic changed the title Addon A11y: Add conditional rendering for a11yNotPassedAmount based on story entry Addon A11y: Add conditional rendering for a11y violation number in Testing Module Dec 16, 2024
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.

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

Copy link

nx-cloud bot commented Dec 16, 2024

☁️ Nx Cloud Report

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

@valentinpalkovic valentinpalkovic force-pushed the valentin/remove-test-count-from-status branch from 7e2821f to d09ea61 Compare December 16, 2024 11:59
@valentinpalkovic valentinpalkovic merged commit faaf253 into next Dec 16, 2024
58 checks passed
@valentinpalkovic valentinpalkovic deleted the valentin/remove-test-count-from-status branch December 16, 2024 14:10
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