Skip to content

Playwright is a framework for Web Testing and Automation. It allows testing Chromium, Firefox and WebKit with a single API.

chore: allow accessible-error on all roles (#36108)

Pavel Feldmanb5d4d3b55c57
diff --git a/packages/injected/src/roleUtils.ts b/packages/injected/src/roleUtils.ts
index d1e2c91f49..b9bdd333a0 100644
--- a/packages/injected/src/roleUtils.ts
+++ b/packages/injected/src/roleUtils.ts
@@ -515,13 +515,10 @@ export function getElementAccessibleDescription(element: Element, includeHidden:
return accessibleDescription;
}
-// https://www.w3.org/TR/wai-aria-1.2/#aria-invalid
-const kAriaInvalidRoles = ['application', 'checkbox', 'combobox', 'gridcell', 'listbox', 'radiogroup', 'slider', 'spinbutton', 'textbox', 'tree', 'columnheader', 'rowheader', 'searchbox', 'switch', 'treegrid'];
-
function getAriaInvalid(element: Element): 'false' | 'true' | 'grammar' | 'spelling' {
- const role = getAriaRole(element) || '';
- if (!role || !kAriaInvalidRoles.includes(role))
- return 'false';
+ // https://www.w3.org/TR/wai-aria-1.2/#aria-invalid
+ // This state is being deprecated as a global state in ARIA 1.2.
+ // In future versions it will only be allowed on roles where it is specifically supported.
const ariaInvalid = element.getAttribute('aria-invalid');
if (!ariaInvalid || ariaInvalid.trim() === '' || ariaInvalid.toLocaleLowerCase() === 'false')
return 'false';
diff --git a/tests/page/expect-misc.spec.ts b/tests/page/expect-misc.spec.ts
index b60968331d..bf963f36fe 100644
--- a/tests/page/expect-misc.spec.ts
+++ b/tests/page/expect-misc.spec.ts
@@ -512,179 +512,3 @@ test('toHaveText that does not match should not produce logs twice', async ({ pa
expect(error.message).not.toContain('locator resolved to');
expect(error.message.replace(waitingForMessage, '<redacted>')).not.toContain(waitingForMessage);
});
-
-test('toHaveAccessibleName', async ({ page }) => {
- await page.setContent(`
- <div role="button" aria-label="Hello"></div>
- `);
- await expect(page.locator('div')).toHaveAccessibleName('Hello');
- await expect(page.locator('div')).not.toHaveAccessibleName('hello');
- await expect(page.locator('div')).toHaveAccessibleName('hello', { ignoreCase: true });
- await expect(page.locator('div')).toHaveAccessibleName(/ell\w/);
- await expect(page.locator('div')).not.toHaveAccessibleName(/hello/);
- await expect(page.locator('div')).toHaveAccessibleName(/hello/, { ignoreCase: true });
-
- await page.setContent(`<button>foo&nbsp;bar\nbaz</button>`);
- await expect(page.locator('button')).toHaveAccessibleName('foo bar baz');
-});
-
-test('toHaveAccessibleDescription', async ({ page }) => {
- await page.setContent(`
- <div role="button" aria-description="Hello"></div>
- `);
- await expect(page.locator('div')).toHaveAccessibleDescription('Hello');
- await expect(page.locator('div')).not.toHaveAccessibleDescription('hello');
- await expect(page.locator('div')).toHaveAccessibleDescription('hello', { ignoreCase: true });
- await expect(page.locator('div')).toHaveAccessibleDescription(/ell\w/);
- await expect(page.locator('div')).not.toHaveAccessibleDescription(/hello/);
- await expect(page.locator('div')).toHaveAccessibleDescription(/hello/, { ignoreCase: true });
-
- await page.setContent(`
- <div role="button" aria-describedby="desc"></div>
- <span id="desc">foo&nbsp;bar\nbaz</span>
- `);
- await expect(page.locator('div')).toHaveAccessibleDescription('foo bar baz');
-});
-
-test('toHaveAccessibleErrorMessage', async ({ page }) => {
- await page.setContent(`
- <form>
- <input role="textbox" aria-invalid="true" aria-errormessage="error-message" />
- <div id="error-message">Hello</div>
- <div id="irrelevant-error">This should not be considered.</div>
- </form>
- `);
-
- const locator = page.locator('input[role="textbox"]');
- await expect(locator).toHaveAccessibleErrorMessage('Hello');
- await expect(locator).not.toHaveAccessibleErrorMessage('hello');
- await expect(locator).toHaveAccessibleErrorMessage('hello', { ignoreCase: true });
- await expect(locator).toHaveAccessibleErrorMessage(/ell\w/);
- await expect(locator).not.toHaveAccessibleErrorMessage(/hello/);
- await expect(locator).toHaveAccessibleErrorMessage(/hello/, { ignoreCase: true });
- await expect(locator).not.toHaveAccessibleErrorMessage('This should not be considered.');
-});
-
-test('toHaveAccessibleErrorMessage should handle multiple aria-errormessage references', async ({ page }) => {
- await page.setContent(`
- <form>
- <input role="textbox" aria-invalid="true" aria-errormessage="error1 error2" />
- <div id="error1">First error message.</div>
- <div id="error2">Second error message.</div>
- <div id="irrelevant-error">This should not be considered.</div>
- </form>
- `);
-
- const locator = page.locator('input[role="textbox"]');
-
- await expect(locator).toHaveAccessibleErrorMessage('First error message. Second error message.');
- await expect(locator).toHaveAccessibleErrorMessage(/first error message./i);
- await expect(locator).toHaveAccessibleErrorMessage(/second error message./i);
- await expect(locator).not.toHaveAccessibleErrorMessage(/This should not be considered./i);
-});
-
-test.describe('toHaveAccessibleErrorMessage should handle aria-invalid attribute', () => {
- const errorMessageText = 'Error message';
-
- async function setupPage(page, ariaInvalidValue: string | null) {
- const ariaInvalidAttr = ariaInvalidValue === null ? '' : `aria-invalid="${ariaInvalidValue}"`;
- await page.setContent(`
- <form>
- <input id="node" role="textbox" ${ariaInvalidAttr} aria-errormessage="error-msg" />
- <div id="error-msg">${errorMessageText}</div>
- </form>
- `);
- return page.locator('#node');
- }
-
- test.describe('evaluated in false', () => {
- test('no aria-invalid attribute', async ({ page }) => {
- const locator = await setupPage(page, null);
- await expect(locator).not.toHaveAccessibleErrorMessage(errorMessageText);
- });
- test('aria-invalid="false"', async ({ page }) => {
- const locator = await setupPage(page, 'false');
- await expect(locator).not.toHaveAccessibleErrorMessage(errorMessageText);
- });
- test('aria-invalid="" (empty string)', async ({ page }) => {
- const locator = await setupPage(page, '');
- await expect(locator).not.toHaveAccessibleErrorMessage(errorMessageText);
- });
- });
- test.describe('evaluated in true', () => {
- test('aria-invalid="true"', async ({ page }) => {
- const locator = await setupPage(page, 'true');
- await expect(locator).toHaveAccessibleErrorMessage(errorMessageText);
- });
- test('aria-invalid="foo" (unrecognized value)', async ({ page }) => {
- const locator = await setupPage(page, 'foo');
- await expect(locator).toHaveAccessibleErrorMessage(errorMessageText);
- });
- });
-});
-
-test.describe('toHaveAccessibleErrorMessage should handle validity state with aria-invalid', () => {
- const errorMessageText = 'Error message';
-
- test('should show error message when validity is false and aria-invalid is true', async ({ page }) => {
- await page.setContent(`
- <form>
- <input id="node" role="textbox" type="number" min="1" max="100" aria-invalid="true" aria-errormessage="error-msg" />
- <div id="error-msg">${errorMessageText}</div>
- </form>
- `);
- const locator = page.locator('#node');
- await locator.fill('101');
- await expect(locator).toHaveAccessibleErrorMessage(errorMessageText);
- });
-
- test('should show error message when validity is true and aria-invalid is true', async ({ page }) => {
- await page.setContent(`
- <form>
- <input id="node" role="textbox" type="number" min="1" max="100" aria-invalid="true" aria-errormessage="error-msg" />
- <div id="error-msg">${errorMessageText}</div>
- </form>
- `);
- const locator = page.locator('#node');
- await locator.fill('99');
- await expect(locator).toHaveAccessibleErrorMessage(errorMessageText);
- });
-
- test('should show error message when validity is false and aria-invalid is false', async ({ page }) => {
- await page.setContent(`
- <form>
- <input id="node" role="textbox" type="number" min="1" max="100" aria-invalid="false" aria-errormessage="error-msg" />
- <div id="error-msg">${errorMessageText}</div>
- </form>
- `);
- const locator = page.locator('#node');
- await locator.fill('101');
- await expect(locator).toHaveAccessibleErrorMessage(errorMessageText);
- });
-
- test('should not show error message when validity is true and aria-invalid is false', async ({ page }) => {
- await page.setContent(`
- <form>
- <input id="node" role="textbox" type="number" min="1" max="100" aria-invalid="false" aria-errormessage="error-msg" />
- <div id="error-msg">${errorMessageText}</div>
- </form>
- `);
- const locator = page.locator('#node');
- await locator.fill('99');
- await expect(locator).not.toHaveAccessibleErrorMessage(errorMessageText);
- });
-});
-
-
-test('toHaveRole', async ({ page }) => {
- await page.setContent(`<div role="button">Button!</div>`);
- await expect(page.locator('div')).toHaveRole('button');
- await expect(page.locator('div')).not.toHaveRole('checkbox');
- try {
- // @ts-expect-error
- await expect(page.locator('div')).toHaveRole(/button|checkbox/);
- expect(1, 'Must throw when given a regular expression').toBe(2);
- } catch (error) {
- expect(error.message).toBe(`"role" argument in toHaveRole must be a string`);
- }
-});
diff --git a/tests/page/expect-to-have-accessible.spec.ts b/tests/page/expect-to-have-accessible.spec.ts
new file mode 100644
index 0000000000..f3bd3083c9
--- /dev/null
+++ b/tests/page/expect-to-have-accessible.spec.ts
@@ -0,0 +1,200 @@
+/**
+ * Copyright (c) Microsoft Corporation.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { test, expect } from './pageTest';
+
+test('toHaveAccessibleName', async ({ page }) => {
+ await page.setContent(`
+ <div role="button" aria-label="Hello"></div>
+ `);
+ await expect(page.locator('div')).toHaveAccessibleName('Hello');
+ await expect(page.locator('div')).not.toHaveAccessibleName('hello');
+ await expect(page.locator('div')).toHaveAccessibleName('hello', { ignoreCase: true });
+ await expect(page.locator('div')).toHaveAccessibleName(/ell\w/);
+ await expect(page.locator('div')).not.toHaveAccessibleName(/hello/);
+ await expect(page.locator('div')).toHaveAccessibleName(/hello/, { ignoreCase: true });
+
+ await page.setContent(`<button>foo&nbsp;bar\nbaz</button>`);
+ await expect(page.locator('button')).toHaveAccessibleName('foo bar baz');
+});
+
+test('toHaveAccessibleDescription', async ({ page }) => {
+ await page.setContent(`
+ <div role="button" aria-description="Hello"></div>
+ `);
+ await expect(page.locator('div')).toHaveAccessibleDescription('Hello');
+ await expect(page.locator('div')).not.toHaveAccessibleDescription('hello');
+ await expect(page.locator('div')).toHaveAccessibleDescription('hello', { ignoreCase: true });
+ await expect(page.locator('div')).toHaveAccessibleDescription(/ell\w/);
+ await expect(page.locator('div')).not.toHaveAccessibleDescription(/hello/);
+ await expect(page.locator('div')).toHaveAccessibleDescription(/hello/, { ignoreCase: true });
+
+ await page.setContent(`
+ <div role="button" aria-describedby="desc"></div>
+ <span id="desc">foo&nbsp;bar\nbaz</span>
+ `);
+ await expect(page.locator('div')).toHaveAccessibleDescription('foo bar baz');
+});
+
+test('toHaveAccessibleErrorMessage', async ({ page }) => {
+ await page.setContent(`
+ <form>
+ <input role="textbox" aria-invalid="true" aria-errormessage="error-message" />
+ <div id="error-message">Hello</div>
+ <div id="irrelevant-error">This should not be considered.</div>
+ </form>
+ `);
+
+ const locator = page.locator('input[role="textbox"]');
+ await expect(locator).toHaveAccessibleErrorMessage('Hello');
+ await expect(locator).not.toHaveAccessibleErrorMessage('hello');
+ await expect(locator).toHaveAccessibleErrorMessage('hello', { ignoreCase: true });
+ await expect(locator).toHaveAccessibleErrorMessage(/ell\w/);
+ await expect(locator).not.toHaveAccessibleErrorMessage(/hello/);
+ await expect(locator).toHaveAccessibleErrorMessage(/hello/, { ignoreCase: true });
+ await expect(locator).not.toHaveAccessibleErrorMessage('This should not be considered.');
+});
+
+test('toHaveAccessibleErrorMessage should handle multiple aria-errormessage references', async ({ page }) => {
+ await page.setContent(`
+ <form>
+ <input role="textbox" aria-invalid="true" aria-errormessage="error1 error2" />
+ <div id="error1">First error message.</div>
+ <div id="error2">Second error message.</div>
+ <div id="irrelevant-error">This should not be considered.</div>
+ </form>
+ `);
+
+ const locator = page.locator('input[role="textbox"]');
+
+ await expect(locator).toHaveAccessibleErrorMessage('First error message. Second error message.');
+ await expect(locator).toHaveAccessibleErrorMessage(/first error message./i);
+ await expect(locator).toHaveAccessibleErrorMessage(/second error message./i);
+ await expect(locator).not.toHaveAccessibleErrorMessage(/This should not be considered./i);
+});
+
+test.describe('toHaveAccessibleErrorMessage should handle aria-invalid attribute', () => {
+ const errorMessageText = 'Error message';
+
+ async function setupPage(page, ariaInvalidValue: string | null) {
+ const ariaInvalidAttr = ariaInvalidValue === null ? '' : `aria-invalid="${ariaInvalidValue}"`;
+ await page.setContent(`
+ <form>
+ <input id="node" role="textbox" ${ariaInvalidAttr} aria-errormessage="error-msg" />
+ <div id="error-msg">${errorMessageText}</div>
+ </form>
+ `);
+ return page.locator('#node');
+ }
+
+ test.describe('evaluated in false', () => {
+ test('no aria-invalid attribute', async ({ page }) => {
+ const locator = await setupPage(page, null);
+ await expect(locator).not.toHaveAccessibleErrorMessage(errorMessageText);
+ });
+ test('aria-invalid="false"', async ({ page }) => {
+ const locator = await setupPage(page, 'false');
+ await expect(locator).not.toHaveAccessibleErrorMessage(errorMessageText);
+ });
+ test('aria-invalid="" (empty string)', async ({ page }) => {
+ const locator = await setupPage(page, '');
+ await expect(locator).not.toHaveAccessibleErrorMessage(errorMessageText);
+ });
+ });
+ test.describe('evaluated in true', () => {
+ test('aria-invalid="true"', async ({ page }) => {
+ const locator = await setupPage(page, 'true');
+ await expect(locator).toHaveAccessibleErrorMessage(errorMessageText);
+ });
+ test('aria-invalid="foo" (unrecognized value)', async ({ page }) => {
+ const locator = await setupPage(page, 'foo');
+ await expect(locator).toHaveAccessibleErrorMessage(errorMessageText);
+ });
+ });
+});
+
+const errorMessageText = 'Error message';
+
+test('should show error message when validity is false and aria-invalid is true', async ({ page }) => {
+ await page.setContent(`
+ <form>
+ <input id="node" role="textbox" type="number" min="1" max="100" aria-invalid="true" aria-errormessage="error-msg" />
+ <div id="error-msg">${errorMessageText}</div>
+ </form>
+ `);
+ const locator = page.locator('#node');
+ await locator.fill('101');
+ await expect(locator).toHaveAccessibleErrorMessage(errorMessageText);
+});
+
+test('should show error message when validity is true and aria-invalid is true', async ({ page }) => {
+ await page.setContent(`
+ <form>
+ <input id="node" role="textbox" type="number" min="1" max="100" aria-invalid="true" aria-errormessage="error-msg" />
+ <div id="error-msg">${errorMessageText}</div>
+ </form>
+ `);
+ const locator = page.locator('#node');
+ await locator.fill('99');
+ await expect(locator).toHaveAccessibleErrorMessage(errorMessageText);
+});
+
+test('should show error message when validity is false and aria-invalid is false', async ({ page }) => {
+ await page.setContent(`
+ <form>
+ <input id="node" role="textbox" type="number" min="1" max="100" aria-invalid="false" aria-errormessage="error-msg" />
+ <div id="error-msg">${errorMessageText}</div>
+ </form>
+ `);
+ const locator = page.locator('#node');
+ await locator.fill('101');
+ await expect(locator).toHaveAccessibleErrorMessage(errorMessageText);
+});
+
+test('should not show error message when validity is true and aria-invalid is false', async ({ page }) => {
+ await page.setContent(`
+ <form>
+ <input id="node" role="textbox" type="number" min="1" max="100" aria-invalid="false" aria-errormessage="error-msg" />
+ <div id="error-msg">${errorMessageText}</div>
+ </form>
+ `);
+ const locator = page.locator('#node');
+ await locator.fill('99');
+ await expect(locator).not.toHaveAccessibleErrorMessage(errorMessageText);
+});
+
+test('should show error message for all roles', async ({ page }) => {
+ await page.setContent(`
+ <label for="file">File input</label>
+ <input id="file" aria-invalid="true" aria-errormessage="file-error-id" type="file" />
+ <p id="file-error-id" role="alert">File is incorrect</p>
+ `);
+ const locator = page.getByLabel('File input');
+ await expect(locator).toHaveAccessibleErrorMessage('File is incorrect');
+});
+
+test('toHaveRole', async ({ page }) => {
+ await page.setContent(`<div role="button">Button!</div>`);
+ await expect(page.locator('div')).toHaveRole('button');
+ await expect(page.locator('div')).not.toHaveRole('checkbox');
+ try {
+ // @ts-expect-error
+ await expect(page.locator('div')).toHaveRole(/button|checkbox/);
+ expect(1, 'Must throw when given a regular expression').toBe(2);
+ } catch (error) {
+ expect(error.message).toBe(`"role" argument in toHaveRole must be a string`);
+ }
+});