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: Show errors of axe properly #30050

Merged
merged 4 commits into from
Dec 16, 2024
Merged

Addon A11y: Show errors of axe properly #30050

merged 4 commits into from
Dec 16, 2024

Conversation

kasperpeulen
Copy link
Contributor

@kasperpeulen kasperpeulen commented Dec 12, 2024

Closes #

What I did

image

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 48 B 1.11 0%
initSize 136 MB 136 MB 48 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 9.2s 1.2s -0.67 13.4%
generateTime 20.2s 22.5s 2.2s 1.75 🔺10.2%
initTime 14.5s 13.6s -920ms -0.47 -6.7%
buildTime 11.9s 8.9s -2s -962ms -0.43 -33.1%
testBuildTime 0ms 0ms 0ms - -
devPreviewResponsive 5.6s 4.9s -726ms -0.35 -14.8%
devManagerResponsive 4.1s 3.8s -283ms 0.06 -7.3%
devManagerHeaderVisible 748ms 571ms -177ms -0.27 -31%
devManagerIndexVisible 770ms 612ms -158ms -0.4 -25.8%
devStoryVisibleUncached 1.9s 1.8s -99ms 0.37 -5.3%
devStoryVisible 792ms 613ms -179ms -0.39 -29.2%
devAutodocsVisible 501ms 550ms 49ms 0.47 8.9%
devMDXVisible 578ms 568ms -10ms 0.49 -1.8%
buildManagerHeaderVisible 642ms 604ms -38ms 0.12 -6.3%
buildManagerIndexVisible 744ms 688ms -56ms -0.06 -8.1%
buildStoryVisible 603ms 558ms -45ms 0.15 -8.1%
buildAutodocsVisible 504ms 531ms 27ms 1.6 🔺5.1%
buildMDXVisible 475ms 491ms 16ms 0.57 3.3%

Greptile Summary

Based on the provided information, I'll create a concise summary of the changes to the A11YPanel component:

Improved error message formatting in the A11Y addon by adding better error type handling and display logic in the A11YPanel component.

  • Added type-specific error handling in code/addons/a11y/src/components/A11YPanel.tsx to properly display Error objects using toString()
  • Enhanced error message readability by using appropriate string conversion based on error type (string, Error, or object)
  • Maintained existing error state handling while improving the display format
  • Added test coverage for different error type scenarios in A11YPanel.test.tsx

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

Comment on lines +136 to 141
{typeof error === 'string'
? error
: error instanceof Error
? error.toString()
: JSON.stringify(error)}
</>
Copy link
Contributor

Choose a reason for hiding this comment

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

style: consider adding error?.message check before toString() to get cleaner error messages when available

Copy link

nx-cloud bot commented Dec 12, 2024

☁️ Nx Cloud Report

CI is running/has finished running commands for commit 46d8d0a. 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 changed the title A11y: Show errors of axe properly Addon A11y: Show errors of axe properly Dec 13, 2024
@kasperpeulen kasperpeulen merged commit 29f4573 into next Dec 16, 2024
58 checks passed
@kasperpeulen kasperpeulen deleted the kasper/a11y-errors branch December 16, 2024 14:37
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