feat(aria): extend toHaveAccessibleName() to accept an array of expected accessible names #33277

aairiian · 2024-10-24T16:56:57Z

extend toHaveAccessibleName() to accept an array of expected accessible names and write the tests for the type

…ted accessible names This commit extends the toHaveAccessibleName() matcher to support an array References microsoft#32593

This commit includes the handling accessible.name.array References microsoft#32593

The expected string can be asserting softly without being equivalent to the actual string References microsoft#32593

aairiian · 2024-10-25T05:36:48Z

@aairiian please read the following Contributor License Agreement(CLA). If you agree with the CLA, please reply with the following information.
@microsoft-github-policy-service agree [company="{your company}"]
Options:

(default - no company specified) I have sole ownership of intellectual property rights to my Submissions and I am not making Submissions in the course of work for my employer.
@microsoft-github-policy-service agree
(when company given) I am making Submissions in the course of work for my employer (or my employer has intellectual property rights in my Submissions by contract or applicable law). I have permission from my employer to make Submissions and enter into this Agreement on behalf of my employer. By signing below, the defined term “You” includes me and my employer.
@microsoft-github-policy-service agree company="Microsoft"
Contributor License Agreement

@microsoft-github-policy-service agree

Update type in the doc References microsoft#32593

Skn0tt

Thanks for the PR, this looks great! I'll discuss with the team tonight to see if there's anything we need to pay close attention to.

Skn0tt · 2024-10-28T14:05:16Z

packages/playwright/src/matchers/matchers.ts

-  }, expected, options);
+  if (Array.isArray(expected)) {
+    return toEqual.call(this, 'toHaveAccessibleName', locator, 'Locator', async (isNot, timeout) => {
+      const expectedText = serializeExpectedTextValues(expected, { matchSubstring: true, normalizeWhiteSpace: true, ignoreCase: options.ignoreCase });


I'd prefer the changes to normalizeWhiteSpace and matchSubstring to be in a separate PR, and discuss them in an issue first - especially the matchSubstring one sounds breaking to me.

Let's keep this PR strictly about accepting an array.

+1, let's only land the array aspect.

I excluded the matchSubstring option from the string serialization

Skn0tt · 2024-10-29T07:58:32Z

I'll discuss with the team tonight.

We're happy to go forward with this. We have a related feature in the works that's about ARIA snapshots, and that should be strictly better than the array forms of toMatchText, toHaveAccessibleName et al. So just to let you know - if we end up shipping that in this or one of the following releases, we'll drop this PR in favour of that.

aairiian · 2024-10-30T16:45:01Z

I'll discuss with the team tonight.

We're happy to go forward with this. We have a related feature in the works that's about ARIA snapshots, and that should be strictly better than the array forms of toMatchText, toHaveAccessibleName et al. So just to let you know - if we end up shipping that in this or one of the following releases, we'll drop this PR in favour of that.

Thank you for getting back to me. I appreciate the time you've taken to review my PR and consider it 😌🙏🏻

pavelfeldman · 2024-11-11T21:30:46Z

docs/src/api/class-locatorassertions.md

@@ -1236,7 +1236,7 @@ await Expect(locator).toHaveAccessibleNameAsync("Save to disk");

 ### param: LocatorAssertions.toHaveAccessibleName.name
 * since: v1.44
- `name` <[string]|[RegExp]>
+- `name` <[string]|[RegExp]|[Array]<[string]>|[Array]<[RegExp]>>


This should be [Array]<[string]|[RegExp]>

Fixed the type format

pavelfeldman · 2024-11-11T21:31:39Z

packages/playwright/src/matchers/matchers.ts

-  }, expected, options);
+  if (Array.isArray(expected)) {
+    return toEqual.call(this, 'toHaveAccessibleName', locator, 'Locator', async (isNot, timeout) => {
+      const expectedText = serializeExpectedTextValues(expected, { matchSubstring: true, normalizeWhiteSpace: true, ignoreCase: options.ignoreCase });


+1, let's only land the array aspect.

Update accessible name check in the matchers.ts References microsoft#32593

Changed type accessible name in the doc file References microsoft#32593

github-actions · 2024-11-17T18:00:26Z

Test results for "tests 1"

2 flaky

⚠️ [installation tests] › playwright-electron-should-work.spec.ts:44:5 › should work when wrapped inside @playwright/test and trace is enabled @package-installations-macos-latest
⚠️ [playwright-test] › ui-mode-test-watch.spec.ts:145:5 › should watch all @windows-latest-node18-1

36917 passed, 650 skipped
✔️✔️✔️

Merge workflow run.

dgozman

Looks great, thank you for the PR!

aairiian added 3 commits October 24, 2024 18:26

feat(aria): extend toHaveAccessibleName() to accept an array of expec…

459914c

…ted accessible names This commit extends the toHaveAccessibleName() matcher to support an array References microsoft#32593

feat(aria): handle array in the injectedScript and write a test

7456dea

This commit includes the handling accessible.name.array References microsoft#32593

feat(aria): make assertion agile and add the tests

988c876

The expected string can be asserting softly without being equivalent to the actual string References microsoft#32593

This comment has been minimized.

Sign in to view

aairiian changed the title ~~[Feature]: Extend toHaveAccessibleName() to accept an array of expected accessible names #32593~~ feat(aria): extend toHaveAccessibleName() to accept an array of expected accessible names #32593 Oct 25, 2024

aairiian added 2 commits October 25, 2024 20:15

feat(aria): update type in the locator assertion file

423b85a

Update type in the doc References microsoft#32593

Merge branch 'main' into extend-type-accessible-name

8224c93

This comment has been minimized.

Sign in to view

Skn0tt reviewed Oct 28, 2024

View reviewed changes

pavelfeldman reviewed Nov 11, 2024

View reviewed changes

aairiian added 2 commits November 17, 2024 17:23

feat(aria): resolved merge conflicts References microsoft#32593

0e54692

feat(aria): get rid of the matchSubstring from the accessible name

bc99d14

Update accessible name check in the matchers.ts References microsoft#32593

This comment has been minimized.

Sign in to view

feat(aria): fix type for the accessible name

6ad67d4

Changed type accessible name in the doc file References microsoft#32593

dgozman changed the title ~~feat(aria): extend toHaveAccessibleName() to accept an array of expected accessible names #32593~~ feat(aria): extend toHaveAccessibleName() to accept an array of expected accessible names Nov 18, 2024

dgozman approved these changes Nov 18, 2024

View reviewed changes

dgozman merged commit 7f054ef into microsoft:main Nov 18, 2024
28 of 29 checks passed

This was referenced Nov 18, 2024

[Ports]: Backport client side changes for 1.50 microsoft/playwright-python#2653

Open

[Ports]: Backport client side changes for 1.50 microsoft/playwright-java#1696

Open

[Ports]: Backport client side changes for 1.50 microsoft/playwright-dotnet#3049

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(aria): extend toHaveAccessibleName() to accept an array of expected accessible names #33277

feat(aria): extend toHaveAccessibleName() to accept an array of expected accessible names #33277

aairiian commented Oct 24, 2024 •

edited by dgozman

Loading

This comment has been minimized.

aairiian commented Oct 25, 2024

This comment has been minimized.

This comment has been minimized.

Skn0tt left a comment

Skn0tt Oct 28, 2024

pavelfeldman Nov 11, 2024

aairiian Nov 17, 2024

Skn0tt commented Oct 29, 2024 •

edited

Loading

aairiian commented Oct 30, 2024

pavelfeldman Nov 11, 2024

aairiian Nov 17, 2024

pavelfeldman Nov 11, 2024

This comment has been minimized.

github-actions bot commented Nov 17, 2024

dgozman left a comment

feat(aria): extend toHaveAccessibleName() to accept an array of expected accessible names #33277

feat(aria): extend toHaveAccessibleName() to accept an array of expected accessible names #33277

Conversation

aairiian commented Oct 24, 2024 • edited by dgozman Loading

This comment has been minimized.

aairiian commented Oct 25, 2024

This comment has been minimized.

This comment has been minimized.

Skn0tt left a comment

Choose a reason for hiding this comment

Skn0tt Oct 28, 2024

Choose a reason for hiding this comment

pavelfeldman Nov 11, 2024

Choose a reason for hiding this comment

aairiian Nov 17, 2024

Choose a reason for hiding this comment

Skn0tt commented Oct 29, 2024 • edited Loading

aairiian commented Oct 30, 2024

pavelfeldman Nov 11, 2024

Choose a reason for hiding this comment

aairiian Nov 17, 2024

Choose a reason for hiding this comment

pavelfeldman Nov 11, 2024

Choose a reason for hiding this comment

This comment has been minimized.

github-actions bot commented Nov 17, 2024

Test results for "tests 1"

dgozman left a comment

Choose a reason for hiding this comment

aairiian commented Oct 24, 2024 •

edited by dgozman

Loading

Skn0tt commented Oct 29, 2024 •

edited

Loading