feat(axe-core-4.6): update to axe-core 4.6.3, promote link-in-text-block and meta-viewport #6334
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
dbjorge
commented
Jan 10, 2023
| return axe.run({ include: [options.selector] } as ElementContext, { | ||
| runOnly: { type: 'tag', values: ['wcag2a', 'wcag21a', 'wcag2aa', 'wcag21aa'] }, | ||
| rules: options.rules, | ||
| }); |
There was a problem hiding this comment.
This is a no-op change, required because upstream axe.run typings became more strict in this update
Updated the test file to reference the tracking issues in the axe-core and FluentUI repos
It needs to expect the aria-required-children failure and link to the tracking issue we have
dbjorge
changed the title
…en when we're running axe-core 4.6.3.
Additional e2e snapshot updates
dbjorge
commented
Jan 27, 2023
dbjorge
commented
Jan 30, 2023
There was a problem hiding this comment.
@JGibson2019 and @shanisebarona 's changes since mine LGTM! (can't mark my own PR as approved)
JGibson2019
approved these changes
Jan 30, 2023
7 tasks
dbjorge
added a commit
that referenced
this pull request
Feb 1, 2023
…ard row (#6388) #### Details This PR implements a feature to add a new "Related paths" row to result cards that represent axe-core results which included any check results with `relatedNodes` properties. It adds this information to: * Cards in the fast pass automated checks and needs review results * FastPass exported reports * "axe results" style reports in the report package * "combined" style reports in the report package (what we usually consider as "service reports") - the service already sends enough information for us to populate this Screenshot of FastPass Automated Checks showing an `aria-required-children` violation with Related paths:  Screenshot of FastPass Report Export showing the same info:  Screenshot of FastPass Automated Checks' `color-contrast` results on a page where `axe-core` only reports related paths for some results - note that cards for results where the data is present show it, and results where axe-core didn't report that data omit it.  Screenshot of combined report with related path field:  ##### Motivation This is primarily to improve the actionability of the `aria-required-children` "unknown" violation path which we added support for during our 4.6.3 update in #6334. That path uses a how to fix message of the form `"Element has children which are not allowed (see related nodes)"`, which isn't very actionable without this PR since we don't expose "related nodes" anywhere. This specific message might be updated in a future version of axe-core (see dequelabs/axe-core#3842) This secondarily improves the actionability of a few other rules that axe-core exposes related nodes for - particularly, `color-contrast` violations where axe knows the node that is responsible for the background color of a violation will now present that background node as a "related path". ##### Context In addition to this change, we'll want to make a docs change to https://accessibilityinsights.io/info-examples/web/aria-required-children/ to make this specific form of `aria-required-children` violation easier for a user to understand and take action on. #### Pull request checklist <!-- If a checklist item is not applicable to this change, write "n/a" in the checkbox --> - [x] Addresses an existing issue: 2020748 - [x] Ran `yarn fastpass` - [x] Added/updated relevant unit test(s) (and ran `yarn test`) - [x] Verified code coverage for the changes made. Check coverage report at: `<rootDir>/test-results/unit/coverage` - [x] PR title *AND* final merge commit title both start with a semantic tag (`fix:`, `chore:`, `feat(feature-name):`, `refactor:`). See `CONTRIBUTING.md`. - [x] (UI changes only) Added screenshots/GIFs to description above - [x] (UI changes only) Verified usability with NVDA/JAWS
dbjorge
added a commit
to microsoft/accessibility-insights-service
that referenced
this pull request
Feb 2, 2023
…lock, meta-viewport, and "Related paths" in reports (#2383) #### Details This PR: * Updates `axe-core` to v4.6.3 * Updates `accessibility-insights-report` to corresponding v4.6.3 * Removes `link-in-text-block` and `meta-viewport` from the rule exclusion list, matching the new AI4Web behavior enabling them as automated checks * Enables a new report feature to include "Related paths" for failure cards of axe results with "relatedNodes" info by propogating this axe property in `combined-report-data-converter.ts` * Bumps the `accessibility-insights-scan` minor version to `1.6.0` in anticipation of a corresponding release for that package Screenshot of combined report segment with new Related paths UX generated using the following CLI command in this PR branch: `node C:\repos\accessibility-insights-service\packages\cli\dist\ai-scan-cli.js --crawl --url https://developer.microsoft.com/en-us/fluentui#/controls/web/detailslist --maxUrls 5`  ##### Motivation Keep service rules version in sync with AI4Web, which has begun release validation today for its corresponding release (2.37.0) ##### Context * [web 4.6.3 PR (#6334)](microsoft/accessibility-insights-web#6334) * [web "Related paths" PR with screenshots of new report UI (#6388)](microsoft/accessibility-insights-web#6388) #### Pull request checklist <!-- If a checklist item is not applicable to this change, write "n/a" in the checkbox --> - [x] Addresses an existing issue: 2017450 - [x] Added relevant unit test for your changes. (`yarn test`) - [x] Verified code coverage for the changes made. Check coverage report at: `<rootDir>/test-results/unit/coverage` - [x] Ran precheckin (`yarn precheckin`) - [ ] Validated in an Azure resource group
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Details
This PR updates
axe-coreto its latest version, 4.6.2, from 4.4.1.Notable code changes beyond the simple version bump include:
link-in-text-blockfailures have been promoted from "needs review" to "automated checks" (removed from needs review with explicit code change, added to automated checks implicitly due to new axe-core tagging)meta-viewportfailures have been promoted from "unreported" to "automated checks" (implicitly due to new axe-core tagging)link-in-text-blockincomplete results are staying unreported (not being promoted to "needs review")frame-title-uniqueandno-autoplay-audioare explicitly disabled. They were promoted in axe-core from experimental/best-practice to "wcag-correspondant, but needs-review-only", but we want to omit them from our needs review checks pending further investigationMotivation
See 1960423
Context
aria-required-childrenmessage improvements we've suggested upstream as axe-core#3842 (which would hopefully be removed later once we update to axe-core 4.7). Leaving that for a separate PR.mainwithout this PR - I don't think it's a regression and will be following up separately.Pull request checklist
yarn fastpassyarn test)<rootDir>/test-results/unit/coveragefix:,chore:,feat(feature-name):,refactor:). SeeCONTRIBUTING.md.