feat: upgrade aria-query to 5.3.0 #1241

jlp-craigmorten · 2023-06-25T11:13:30Z

What: Upgrade aria-query to version 5.3.0.

Why: Receive latest specification updates for role / element mappings to align with WAI ARIA 1.2.

Fixes #1100
Fixes #1150
Fixes #1201
Fixes #1234
Fixes #1239

How: Upgrading version in package.json. Updating tests to mirror changes.

Checklist:

Documentation added to the - N/A
docs site
Tests
TypeScript definitions updated - N/A
Ready to be merged

There are a couple changes of note as a result of this upgrade, namely:

The menuitem element no longer has associated roles. This also removes the only example of an element with two role mappings.
Many elements such as p and em now have dedicated roles (paragraph and emphasis respectively) inline with HTML-ARIA / WAI-ARIA 1.2. Associated tests have been updated / modified to suit.
The introduction of the generic role also results in some changes. E.g. anchor tags with no href are now generic under HTML-ARIA.

There are several other role / element mapping changes as a result of this change to align with specifications.

Given the number of role additions, removals, and modifications (including changes to role and/or changes to the constraints for a particular role) this should be considered a breaking change.

codesandbox-ci · 2023-06-25T11:21:36Z

This pull request is automatically built and testable in CodeSandbox.

To see build info of the built libraries, click here or the icon next to each commit SHA.

Latest deployment of this branch, based on commit 69d966a:

Sandbox	Source
react-testing-library-examples	Configuration
fail to find role code	Issue #1100
react-testing-library demo	Issue #1100
react-testing-library demo (forked)	Issue #1201
react-testing-library demo (forked)	Issue #1234
react-testing-library demo	Issue #1234

codecov · 2023-06-25T11:22:34Z

Codecov Report

Merging #1241 (69d966a) into alpha (452097b) will not change coverage.
The diff coverage is 100.00%.

@@            Coverage Diff            @@
##             alpha     #1241   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           24        24           
  Lines         1038      1041    +3     
  Branches       349       349           
=========================================
+ Hits          1038      1041    +3

Flag	Coverage Δ
node-18	`100.00% <100.00%> (ø)`
node-20	`100.00% <100.00%> (ø)`

Flags with carried forward coverage won't be shown. Click here to find out more.

Files Changed	Coverage Δ
src/role-helpers.js	`100.00% <100.00%> (ø)`

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

MatanBobi · 2023-06-25T11:25:19Z

Hi @jlp-craigmorten!
Thanks for taking the time to create this and the corresponding fix in aria-query, this is extremely appreciated.
I'll try to look into the changes later on today, in the meantime, I pushed a change to fix the CI issues we had.

cmorten · 2023-06-25T11:26:23Z

Hi @jlp-craigmorten!
Thanks for taking the time to create this and the corresponding fix in aria-query, this is extremely appreciated.
I'll try to look into the changes later on today, in the meantime, I pushed a change to fix the CI issues we had.

Appreciate it - I’ve just raised #1242 r.e. the CI issue

MatanBobi

That looks great, thanks :)
I left a few comments.

src/__tests__/__snapshots__/role-helpers.js.snap

src/__tests__/role-helpers.js

src/__tests__/suggestions.js

src/__tests__/role-helpers.js

package.json

src/role-helpers.js

eps1lon

Looks good to me. @MatanBobi good for you?

MatanBobi

This looks great to me. Thanks a lot for the work :)
@eps1lon do you think we should make this a breaking change?

nickserv · 2023-07-12T01:00:36Z

My understanding of SemVer is that we only need to publish breaking changes in a major release if we upgrade to a version of a spec that's no longer back compatible with a version that we've documented supporting.

Here are the specification versions we link to, organized by our APIs:

API	Specification
`ByRole` option `description`	Accessible Name and Description Computation 1.1
`ByRole` API	Accessible Rich Internet Applications 1.2
`ByRole` option `description`	Accessible Rich Internet Applications 1.1
`isInaccessible`	Accessible Rich Internet Applications 1.2

MatanBobi · 2023-07-17T06:43:13Z

My understanding of SemVer is that we only need to publish breaking changes in a major release if we upgrade to a version of a spec that's no longer back compatible with a version that we've documented supporting.

Here are the specification versions we link to, organized by our APIs:

API Specification

ByRole option description Accessible Name and Description Computation 1.1

ByRole API Accessible Rich Internet Applications 1.2

ByRole option description Accessible Rich Internet Applications 1.1

isInaccessible Accessible Rich Internet Applications 1.2

Thanks @nickmccurdy!
Where were these documented? I'm not sure they are correct.
The thing is, we have some role definition that have changed in 1.2, so people might look for role="img" for example and not get the elements they used to get.

package.json

jlp-craigmorten · 2023-08-09T08:30:57Z

This is now blocked behind #1242

(as is any other changes to this repo)

MatanBobi · 2023-08-10T17:53:19Z

I agree with @timdeschryver about this being a breaking change that should cause a major version release.
If that's the path we're going with, we can merge these two together (this one and #1242) and create a major release. That way we'll be sure we're not breaking something with the op_mobile change and with this one.
What do you all think?

timdeschryver · 2023-08-12T15:26:36Z

@MatanBobi that would mean to drop support for Node v14, right?
I like that, because also end of life.

MatanBobi · 2023-08-12T16:14:39Z

@MatanBobi that would mean to drop support for Node v14, right?

I like that, because also end of life.

Yes, definitely. In this major we'll also drop support for node 14 with these changes.

@eps1lon do you have any concerns?

MatanBobi · 2023-09-09T17:28:28Z

Hi @jlp-craigmorten :)
Since we're creating a new major version (due to the fact we're dropping support for node 14 and 16), we'll probably get this into alpha version first.
We're trying to gather a list of the changes for the change log, do you happen to know if there's a full list somewhere?

Thanks again for the effort you've put into this one!

nickserv · 2023-09-10T03:56:39Z

My understanding of SemVer is that we only need to publish breaking changes in a major release if we upgrade to a version of a spec that's no longer back compatible with a version that we've documented supporting.

Here are the specification versions we link to, organized by our APIs:

API Specification

ByRole option description Accessible Name and Description Computation 1.1

ByRole API Accessible Rich Internet Applications 1.2

ByRole option description Accessible Rich Internet Applications 1.1

isInaccessible Accessible Rich Internet Applications 1.2

Thanks @nickmccurdy!
Where were these documented? I'm not sure they are correct.
The thing is, we have some role definition that have changed in 1.2, so people might look for role="img" for example and not get the elements they used to get.

I was referring to the docs, I've added links above to give more context.

That being said, it seems like we've already decided on a major version, which I support.

nickserv · 2023-09-10T06:48:33Z

If you merge in from alpha CI should be fixed by #1255.

MatanBobi · 2023-09-10T07:08:57Z

I was referring to the docs, I've added links above to give more context.

Thanks @nickmccurdy, we'll probably need to update the places where we direct to 1.1 as part of the major release :)

* chore: add accessibility-alt-text-bot * fix formatting issues

jlp-craigmorten · 2023-09-10T16:44:19Z

Hi @jlp-craigmorten :) Since we're creating a new major version (due to the fact we're dropping support for node 14 and 16), we'll probably get this into alpha version first. We're trying to gather a list of the changes for the change log, do you happen to know if there's a full list somewhere?

Thanks again for the effort you've put into this one!

Just done a scan through the aria-query changeset from 5.1.3 to 5.3.0 and believe these are the pertinent changes:

feat: blockquote element now has an implicit blockquote role
fix: input element of type checkbox with a set aria-pressed attribute no longer has an implicit button role
fix: summary element with aria-expanded set to false no longer has an implicit button role
fix: summary element with aria-expanded set to true no longer has an implicit button role
feat: caption element now has an implicit caption role
feat: code element now has an implicit code role
fix: th element now has implicit columnheader role regardless of scope attribute
fix: select element with undefined multiple attribute and a size attribute with value 1 is no longer has an implicit combobox role
feat: menuitem element no longer has an implicit command role
feat: aside element with a set aria-label attribute now has an implicit complementary role
feat: aside element with a set aria-labelledby attribute now has an implicit complementary role
feat: del element now has an implicit deletion role
fix: doc-backlink element now get's it's accessible name from contents
fix: body element no longer has an implicit document role
fix: html element now has an implicit document role
feat: em element now has an implicit emphasis role
feat: a element with no href attribute now has an implicit generic role
feat: area element with no href attribute now has an implicit generic role
feat: aside element with no label attribute now has an implicit generic role
feat: b element now has an implicit generic role
feat: bdo element now has an implicit generic role
feat: body element now has an implicit generic role
feat: data element now has an implicit generic role
~~- feat: footer element (not scoped to the body element) now has an implicit generic role~~
~~- feat: header element (not scoped to the body element) now has an implicit generic role~~
feat: hgroup element now has an implicit generic role
feat: i element now has an implicit generic role
feat: pre element now has an implicit generic role
feat: q element now has an implicit generic role
feat: samp element now has an implicit generic role
feat: section element with no label attribute now has an implicit generic role
feat: small element now has an implicit generic role
feat: span element now has an implicit generic role
feat: u element now has an implicit generic role
feat: address element now has an implicit group role
feat: ins element now has an implicit insertion role
fix: a element now requires a set href attribute to have an implicit link role
fix: area element now requires a set href attribute to have an implicit link role
fix: link element with an href attribute no longer has an implicit link role
fix: select element no longer requires a set multiple attribute to have an implicit listbox role if it has a size attribute with value greater than 1
feat: mark element now has an implicit mark role
feat: menuitem element no longer has an implicit menuitem role
feat: meter element now has an implicit meter role
feat: p element now has an implicit paragraph role
fix: img element with an empty alt attribute now has an implicit presentation role
fix: frame element no longer has an implicit region role
fix: rel element no longer has an implicit roletype role
feat: strong element now has an implicit strong role
feat: sub element now has an implicit subscript role
feat: sup element now has an implicit superscript role
feat: time element now has an implicit time role

Feel free to condense / summarise as feel is best!

There is one other file change in this PR in addition to the changeset from upgrade aria-query which is a fix, but afaik is somewhat an implementation detail to enable a couple of the above points, namely the likes of "fix: img element with an empty alt attribute now has an implicit presentation role", so probably not needing it's own point.

For the footer and header element roles, the "scoped to body element" constraint isn't honoured by dom-testing-library, so may be confusing to include in the description... not sure off top of my head whether this lib would say the implicit role is generic or banner (for header elements) / contentinfo (for footer elements)

Update: so for the header element it is banner (and there was a test already demonstrating this), and for the footer it is contentinfo (and have just pushed a commit to eliminate this ambiguity). Might be worth not including the generic role points for these elements as that isn't something this lib supports.

…as contentinfo

…uery-5.3.0

MatanBobi · 2023-09-14T05:09:34Z

Since we're following the spec with this one, I think it's safe to at least merge to alpha so I'm merging this one :)

* feat: upgrade aria-query to 5.3.0 * fix: correctly handle img with empty alt * feat: pin `aria-query` version * chore: add accessibility-alt-text-bot (testing-library#1240) * chore: add accessibility-alt-text-bot * fix formatting issues * test: add coverage for footer to confirm it's expected implicit role as contentinfo --------- Co-authored-by: Sebastian Silbermann <silbermann.sebastian@gmail.com> Co-authored-by: Matan Borenkraout <Matanbobi@gmail.com>

upgrades `@testing-library/react` from 14 -> 16. upgrades `@testing-library/dom` from 9 -> 10 Notes: - @testing-library/dom is now a peer dependency, have to install - Support for react 19 - Upgrades aria-query to 5.3.0 testing-library/dom-testing-library#1241 - changes getByRole('link') `a element now requires a set href attribute to have an implicit link role`

feat: upgrade aria-query to 5.3.0

8d7c09e

MatanBobi reviewed Jun 26, 2023

View reviewed changes

src/__tests__/__snapshots__/role-helpers.js.snap Show resolved Hide resolved

src/__tests__/role-helpers.js Show resolved Hide resolved

src/__tests__/suggestions.js Show resolved Hide resolved

eps1lon reviewed Jun 26, 2023

View reviewed changes

src/__tests__/role-helpers.js Show resolved Hide resolved

jlp-craigmorten requested review from MatanBobi and eps1lon June 26, 2023 16:51

eps1lon requested changes Jun 26, 2023

View reviewed changes

package.json Outdated Show resolved Hide resolved

eps1lon reviewed Jun 26, 2023

View reviewed changes

src/role-helpers.js Outdated Show resolved Hide resolved

jlp-craigmorten requested a review from eps1lon June 26, 2023 21:26

fix: correctly handle img with empty alt

d89d507

jlp-craigmorten force-pushed the feat/update-aria-query-5.3.0 branch from 848b2be to d89d507 Compare June 26, 2023 21:34

Merge branch 'main' into feat/update-aria-query-5.3.0

0f714fd

eps1lon previously approved these changes Jun 27, 2023

View reviewed changes

MatanBobi previously approved these changes Jun 28, 2023

View reviewed changes

Merge branch 'main' into feat/update-aria-query-5.3.0

256e37a

timdeschryver reviewed Aug 8, 2023

View reviewed changes

package.json Outdated Show resolved Hide resolved

feat: pin aria-query version

47511c6

jlp-craigmorten dismissed stale reviews from MatanBobi and eps1lon via 47511c6 August 9, 2023 08:30

timdeschryver mentioned this pull request Sep 9, 2023

feat: Drop support for Node.js 14.x and Node.js 16.x and add support for Node 20.x #1255

Merged

2 tasks

MatanBobi changed the base branch from main to alpha September 9, 2023 17:27

MatanBobi and others added 3 commits September 10, 2023 10:33

chore: add accessibility-alt-text-bot (testing-library#1240)

336152b

* chore: add accessibility-alt-text-bot * fix formatting issues

Merge remote-tracking branch 'upstream/main'

71d69b1

Merge branch 'main' into feat/update-aria-query-5.3.0

8eab139

jlp-craigmorten added 2 commits September 10, 2023 17:57

test: add coverage for footer to confirm it's expected implicit role …

4a6b595

…as contentinfo

Merge remote-tracking branch 'upstream/alpha' into feat/update-aria-q…

69d966a

…uery-5.3.0

This comment was marked as resolved.

Sign in to view

MatanBobi merged commit 2c57055 into testing-library:alpha Sep 14, 2023
5 checks passed

eps1lon mentioned this pull request Oct 3, 2023

release: 10.0.0 #1269

Merged

MatanBobi mentioned this pull request Oct 29, 2023

Fix role assignment for imgs with alt attribute #1236

Closed

4 tasks

jlp-craigmorten deleted the feat/update-aria-query-5.3.0 branch November 11, 2023 13:08

cmorten mentioned this pull request Mar 14, 2024

Images with an empty alt attribute are not being assigned presentation role (and are still being found by testing library even though they are hidden from the accessibility tree) #1290

Closed

enmanuelduran mentioned this pull request Apr 25, 2024

getByText throwing when throwSuggestions is enforced recommending ambiguous getByRole('paragraph') approach. #1306

Closed

Tasiobg mentioned this pull request May 31, 2024

alt attribute can't be empty #1313

Closed

scttcper mentioned this pull request Jun 5, 2024

deps(ui): Upgrade react testing library dependencies getsentry/sentry#72137

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: upgrade aria-query to 5.3.0 #1241

feat: upgrade aria-query to 5.3.0 #1241

jlp-craigmorten commented Jun 25, 2023 •

edited

Loading

codesandbox-ci bot commented Jun 25, 2023 •

edited

Loading

codecov bot commented Jun 25, 2023 •

edited

Loading

MatanBobi commented Jun 25, 2023

cmorten commented Jun 25, 2023

MatanBobi left a comment

eps1lon left a comment

MatanBobi left a comment

nickserv commented Jul 12, 2023 •

edited

Loading

MatanBobi commented Jul 17, 2023 •

edited by nickserv

Loading

jlp-craigmorten commented Aug 9, 2023 •

edited

Loading

MatanBobi commented Aug 10, 2023

timdeschryver commented Aug 12, 2023

MatanBobi commented Aug 12, 2023

MatanBobi commented Sep 9, 2023 •

edited

Loading

nickserv commented Sep 10, 2023 •

edited

Loading

nickserv commented Sep 10, 2023 •

edited

Loading

MatanBobi commented Sep 10, 2023

jlp-craigmorten commented Sep 10, 2023 •

edited

Loading

This comment was marked as resolved.

This comment was marked as resolved.

MatanBobi commented Sep 14, 2023

feat: upgrade aria-query to 5.3.0 #1241

feat: upgrade aria-query to 5.3.0 #1241

Conversation

jlp-craigmorten commented Jun 25, 2023 • edited Loading

codesandbox-ci bot commented Jun 25, 2023 • edited Loading

codecov bot commented Jun 25, 2023 • edited Loading

Codecov Report

MatanBobi commented Jun 25, 2023

cmorten commented Jun 25, 2023

MatanBobi left a comment

Choose a reason for hiding this comment

eps1lon left a comment

Choose a reason for hiding this comment

MatanBobi left a comment

Choose a reason for hiding this comment

nickserv commented Jul 12, 2023 • edited Loading

MatanBobi commented Jul 17, 2023 • edited by nickserv Loading

jlp-craigmorten commented Aug 9, 2023 • edited Loading

MatanBobi commented Aug 10, 2023

timdeschryver commented Aug 12, 2023

MatanBobi commented Aug 12, 2023

MatanBobi commented Sep 9, 2023 • edited Loading

nickserv commented Sep 10, 2023 • edited Loading

nickserv commented Sep 10, 2023 • edited Loading

MatanBobi commented Sep 10, 2023

jlp-craigmorten commented Sep 10, 2023 • edited Loading

This comment was marked as resolved.

This comment was marked as resolved.

MatanBobi commented Sep 14, 2023

jlp-craigmorten commented Jun 25, 2023 •

edited

Loading

codesandbox-ci bot commented Jun 25, 2023 •

edited

Loading

codecov bot commented Jun 25, 2023 •

edited

Loading

nickserv commented Jul 12, 2023 •

edited

Loading

MatanBobi commented Jul 17, 2023 •

edited by nickserv

Loading

jlp-craigmorten commented Aug 9, 2023 •

edited

Loading

MatanBobi commented Sep 9, 2023 •

edited

Loading

nickserv commented Sep 10, 2023 •

edited

Loading

nickserv commented Sep 10, 2023 •

edited

Loading

jlp-craigmorten commented Sep 10, 2023 •

edited

Loading