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.

Sign up for GitHub

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

fix(engine): Fix issues related to accessible name concatenation and deprecate aria_search_label_unique rule V4 #2178

Merged
merged 9 commits into from
Feb 4, 2025
Merged

fix(engine): Fix issues related to accessible name concatenation and deprecate aria_search_label_unique rule V4 #2178

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
43900d4
Bump path-to-regexp and express in /rule-server (#2128)
dependabot[bot] Dec 16, 2024
de7c45d
fix dark mode react portal pop-up (#2138)
nam-singh Jan 2, 2025
6946ed2
fix(extension):Fix reset filter link #1877 (#2136)
nam-singh Jan 2, 2025
f4cf742
fix(extension): Don't show full data:text/html content on generated H…
nam-singh Jan 2, 2025
83eaa93
chore(extension): carbon package update and use new carbon combobutt…
nam-singh Jan 2, 2025
a474cee
update the rule logic and add new test cases #2122
shunguoy Jan 27, 2025
b3a71d8
update act mapping #dev-2122-new
shunguoy Jan 27, 2025
fb8b7dc
Merge branch 'dev-2122-new' into dev-2122-v4
shunguoy Jan 28, 2025
a1b05fb
Merge branch 'main-4.x' into dev-2122-v4
tombrunet Feb 4, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 10 additions & 2 deletions accessibility-checker-engine/src/v4/rules/aria_search_label_unique.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
limitations under the License.
*****************************************************************************/

import { Rule, RuleResult, RuleFail, RuleContext, RulePotential, RuleManual, RulePass, RuleContextHierarchy } from "../api/IRule";
import { Rule, RuleResult, RuleFail, RuleContext, RulePass, RuleContextHierarchy } from "../api/IRule";
import { eRulePolicy, eToolkitLevel } from "../api/IRule";
import { AriaUtil } from "../util/AriaUtil";
import { CommonUtil } from "../util/CommonUtil";
Expand Down Expand Up @@ -39,11 +39,19 @@ export const aria_search_label_unique: Rule = {
"group": "Each element with \"search\" role must have a unique label that describes its purpose"
}
},
rulesets: [{
/**
* deprecated the rule on 01/27/2025
* rulesets: [{
"id": ["IBM_Accessibility", "IBM_Accessibility_next", "WCAG_2_1", "WCAG_2_0", "WCAG_2_2"],
"num": ["2.4.1"],
"level": eRulePolicy.VIOLATION,
"toolkitLevel": eToolkitLevel.LEVEL_THREE
}],*/
rulesets: [{
"id": [],
"num": ["2.4.1"],
"level": eRulePolicy.VIOLATION,
"toolkitLevel": eToolkitLevel.LEVEL_THREE
}],
act: [],
run: (context: RuleContext, options?: {}, contextHierarchies?: RuleContextHierarchy): RuleResult | RuleResult[] => {
Expand Down
1 change: 0 additions & 1 deletion accessibility-checker-engine/src/v4/rules/label_name_visible.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,6 @@ import { FragmentUtil } from "../../v2/checker/accessibility/util/fragment";
import { VisUtil } from "../util/VisUtil";
import { CSSUtil } from "../util/CSSUtil";
import { DOMWalker } from "../../v2/dom/DOMWalker";
import { AccNameUtil } from "../util/AccNameUtil";

export const label_name_visible: Rule = {
id: "label_name_visible",
Expand Down
4 changes: 2 additions & 2 deletions accessibility-checker-engine/src/v4/rules/meta_viewport_zoomable.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,8 +45,8 @@ export const meta_viewport_zoomable: Rule = {
}],
act: [{
"b4f0c3": {
"Pass_0": "pass",
"Potential_1": "fail"
"pass": "pass",
"potential_zoomable": "fail"
}
}],
run: (context: RuleContext, options?: {}, contextHierarchies?: RuleContextHierarchy): RuleResult | RuleResult[] => {
Expand Down
8 changes: 4 additions & 4 deletions accessibility-checker-engine/src/v4/util/CommonUtil.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1207,15 +1207,15 @@ export class CommonUtil {
if (nw.bEndTag) continue;
if ((nw.node.nodeType === 1 && (VisUtil.hiddenByDefaultElements.includes(nw.node.nodeName.toLowerCase())) || !VisUtil.isNodeVisible(nw.node) || VisUtil.isElementOffscreen(nw.node as HTMLElement))) {
if (nw.node.nextSibling) {
if (nw.node.nextSibling.nodeType === 3 && nw.node.nextSibling.nodeValue !== null)
text += nw.node.nextSibling.nodeValue;
if (nw.node.nextSibling.nodeType === 3 && nw.node.nextSibling.nodeValue && nw.node.nextSibling.nodeValue.trim() !== '')
text += ' ' + nw.node.nextSibling.nodeValue.trim();
nw.node = nw.node.nextSibling;
continue;
} else
break;
}
if (nw.node.nodeType === 3 && nw.node.nodeValue !== null) {
text += nw.node.nodeValue.trim();
if (nw.node.nodeType === 3 && nw.node.nodeValue && nw.node.nodeValue.trim() !== '') {
text += ' ' + nw.node.nodeValue.trim();
}
}
return text.trim();
Expand Down
40 changes: 40 additions & 0 deletions ...ne/test/v2/checker/accessibility/rules/label_name_visible_ruleunit/button-label-pass.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
<!DOCTYPE html>
<html lang="en">
<head>
<title>Test case</title>
</head>
<body>
<button
aria-expanded="false"
aria-controls="id-:re:"
aria-label="AI Text goes here"
type="button">
<span class="cds--ai-label__text">AI</span>
<span class="cds--ai-label__additional-text">Text goes here</span>
</button>

<script>
UnitTest = {
ruleIds: ["label_name_visible"],
results: [
{
"ruleId": "label_name_visible",
"value": [
"INFORMATION",
"PASS"
],
"path": {
"dom": "/html[1]/body[1]/button[1]",
"aria": "/document[1]/button[1]"
},
"reasonId": "Pass_0",
"message": "Accessible name matches or contains the visible label text",
"messageArgs": [],
"apiArgs": [],
"category": "Accessibility"
}
]
};
</script>
</body>
</html>
46 changes: 46 additions & 0 deletions ...e/test/v2/checker/accessibility/rules/label_name_visible_ruleunit/button-label-pass2.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
<!DOCTYPE html>
<html lang="en">

<head>
<title>Test case</title>
</head>

<body>
<button type="button" id="count-badge-1-button" title="Click here to see notification. 2 Notification available."
aria-label="Click here to see notification. 2 Notification available."> <span> <svg width="24" height="24"
xmlns="http://www.w3.org/2000/svg" aria-hidden="true" color="primary" viewBox="0 0 24 24"
style="width: 24px; height: 24px">
<g fill="none" fill-rule="evenodd">
<path d="M0 0h24v24H0z"></path>
<path
d="M16 16.5H8v-6C8 8.02 9.51 6 12 6s4 2.02 4 4.5v6zm2 0v-6c0-3.07-1.63-5.64-4.5-6.32V3.5c0-.83-.67-1.5-1.5-1.5s-1.5.67-1.5 1.5v.68C7.64 4.86 6 7.42 6 10.5v6H4.99a.99.99 0 00-.99.99v.02c0 .547.443.99.99.99h14.02a.99.99 0 00.99-.99v-.02a.99.99 0 00-.99-.99H18zm-6 5c1.1 0 2-.9 2-2h-4c0 1.1.9 2 2 2z"
fill="#000"></path>
</g>
</svg><span>2</span></span> Notification</button>

<script>
UnitTest = {
ruleIds: ["label_name_visible"],
results: [
{
"ruleId": "label_name_visible",
"value": [
"INFORMATION",
"PASS"
],
"path": {
"dom": "/html[1]/body[1]/button[1]",
"aria": "/document[1]/button[1]"
},
"reasonId": "Pass_0",
"message": "Accessible name matches or contains the visible label text",
"messageArgs": [],
"apiArgs": [],
"category": "Accessibility"
}
]
};
</script>
</body>

</html>