fix: Reduce noise in ChromiumComponentsShouldUseWebScanner rule #931
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
DaveTryon
commented
Jun 1, 2023
| @@ -38,17 +39,19 @@ private static Condition CreateSecondChildCondition() | |||
| private static bool MatchOrderInSiblings(IA11yElement e, int index) | |||
| { | |||
| if (e == null) throw new ArgumentNullException(nameof(e)); | |||
| if (e.Parent == null || e.Parent.Children == null) return false; | |||
There was a problem hiding this comment.
Old code evaluated e.Parent up to 4 times, and e.Parent.Children up to 3 times. Updated code maxes out at once for each.
DaveTryon
commented
Jun 1, 2023
|
|
||
| var count = (from c in e.Parent.Children |
There was a problem hiding this comment.
Old code evaluated e.Parent up to twice. New code maxes out at once.
DaveTryon
commented
Jun 1, 2023
| @@ -66,9 +69,10 @@ private static bool MatchParent(Condition c, IA11yElement e) | |||
| { | |||
| if (c == null) throw new ArgumentNullException(nameof(c)); | |||
| if (e == null) throw new ArgumentNullException(nameof(e)); | |||
| if (e.Parent == null) return false; | |||
There was a problem hiding this comment.
Old code evaluated e.Parent up to twice. New code maxes out at once.
codeofdusk
approved these changes
Jun 2, 2023
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
microsoft/accessibility-insights-windows#1625 points out that the
ChromiumComponentsShouldUseWebScannerrule is flagging items that are outside the context of a web page, which goes against the rule's primary purpose. This change limits theChromiumComponentsShouldUseWebScannerrule to elements within a HTML document (including the document itself).While working on this, we discovered a bug in WebView2, which is tracked at MicrosoftEdge/WebView2Feedback#3530.
Motivation
Address microsoft/accessibility-insights-windows#1625
Before & after
Text results using Edge
As expected, only the
ChromiumComponentsShouldUseWebScannerrule is impactedScreenshots using Edge
These screenshots are limited to just the
ChromiumComponentsShouldUseWebScannerrule:Context
This includes an opportunistic optimization to some of the code in
Relationships, because the unit test code looked odd with arbitrary multipliers to compensate for hoeRelationshipsis coded. This could be a separate PR if that's preferred.Pull request checklist