fix(event): be robust against incomplete event implementations #1009

ph-fritsche · 2022-08-02T11:58:31Z

What:

Assign the specific event properties and methods on the events instead of relying on the event constructors.

Why:

Some DOM implementations are incomplete. E.g. Jsdom lacks support for PointerEvent and it won't be implemented any time soon.
While initializing the events should be out of scope, events lacking the properties we correctly provide for init makes for a bad user experience and simply assigning the properties seems sufficient.

Closes #926

Return correct modifier state for Alt, Control, Meta and Shift per getModifierState.

How:

Replace the createEvent imported from @testing-library/dom with own implementation.

Checklist:

Tests
Ready to be merged

codesandbox-ci · 2022-08-02T11:59:08Z

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 cb9e056:

Sandbox	Source
userEvent-dom	Configuration
userEvent-react	Configuration
heuristic-fermi-3hxbd6	Issue #926

codecov · 2022-08-02T12:01:13Z

Codecov Report

Merging #1009 (a46b4d7) into main (a46b4d7) will not change coverage.
The diff coverage is n/a.

❗ Current head a46b4d7 differs from pull request most recent head cb9e056. Consider uploading reports for the commit cb9e056 to get more accurate results

@@            Coverage Diff            @@
##              main     #1009   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           85        85           
  Lines         2068      2068           
  Branches       709       709           
=========================================
  Hits          2068      2068

Help us with your feedback. Take ten seconds to tell us how you rate us.

github-actions · 2022-08-02T12:48:26Z

🎉 This PR is included in version 14.4.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

This PR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [@testing-library/user-event](https://github.com/testing-library/user-event) | dependencies | minor | [`14.1.1` -> `14.5.2`](https://renovatebot.com/diffs/npm/@testing-library%2fuser-event/14.1.1/14.5.2) | --- ### Release Notes <details> <summary>testing-library/user-event (@testing-library/user-event)</summary> ### [`v14.5.2`](https://github.com/testing-library/user-event/releases/tag/v14.5.2) [Compare Source](testing-library/user-event@v14.5.1...v14.5.2) ##### Bug Fixes - remove interop and deep DTL imports ([6a3c896](testing-library/user-event@6a3c896)) ### [`v14.5.1`](https://github.com/testing-library/user-event/releases/tag/v14.5.1) [Compare Source](testing-library/user-event@v14.5.0...v14.5.1) ##### Bug Fixes - incorrect default import from [@testing-library/dom](https://github.com/testing-library/dom) ([#1162](testing-library/user-event#1162)) ([d7483f0](testing-library/user-event@d7483f0)) ### [`v14.5.0`](https://github.com/testing-library/user-event/releases/tag/v14.5.0) [Compare Source](testing-library/user-event@v14.4.3...v14.5.0) ##### Bug Fixes - **exports:** add a named export for userEvent ([4019cee](testing-library/user-event@4019cee)), closes [#1146](testing-library/user-event#1146) ##### Features - **types:** Add additional type exports for UserEvent & Options ([#1112](testing-library/user-event#1112)) ([da00e8d](testing-library/user-event@da00e8d)) ### [`v14.4.3`](https://github.com/testing-library/user-event/releases/tag/v14.4.3) [Compare Source](testing-library/user-event@v14.4.2...v14.4.3) ##### Bug Fixes - **build:** add `types` field in `exports` ([#1029](testing-library/user-event#1029)) ([5bed8c6](testing-library/user-event@5bed8c6)) - remove circular dependencies ([#1027](testing-library/user-event#1027)) ([1aa2027](testing-library/user-event@1aa2027)) ### [`v14.4.2`](https://github.com/testing-library/user-event/releases/tag/v14.4.2) [Compare Source](testing-library/user-event@v14.4.1...v14.4.2) ##### Bug Fixes - **build:** add `exports` field ([#1022](testing-library/user-event#1022)) ([7839e29](testing-library/user-event@7839e29)) ### [`v14.4.1`](https://github.com/testing-library/user-event/releases/tag/v14.4.1) [Compare Source](testing-library/user-event@v14.4.0...v14.4.1) ##### Bug Fixes - **build:** transpile to es2019 syntax ([#1016](testing-library/user-event#1016)) ([4291cb8](testing-library/user-event@4291cb8)) ### [`v14.4.0`](https://github.com/testing-library/user-event/releases/tag/v14.4.0) [Compare Source](testing-library/user-event@v14.3.0...v14.4.0) ##### Features - **pointer**: dispatch `auxclick` events ([#1003](testing-library/user-event#1003)) ([2852509](testing-library/user-event@2852509)) ##### Bug Fixes - **event:** be robust against incomplete event implementations ([#1009](testing-library/user-event#1009)) ([289828b](testing-library/user-event@289828b)) - **upload:** be robust against missing FileList implementation ([#1007](testing-library/user-event#1007)) ([a46b4d7](testing-library/user-event@a46b4d7)) - **keyboard**: switch modifier state of lock keys on the correct event ([#1003](testing-library/user-event#1003)) ([2852509](testing-library/user-event@2852509)) - **keyboard**: remove platform-specific additional key events for `Control` on `AltGraph` ([#1003](testing-library/user-event#1003)) ([2852509](testing-library/user-event@2852509)) - **pointer**: dispatch `contextmenu` events with `detail: 0` ([#1003](testing-library/user-event#1003)) ([2852509](testing-library/user-event@2852509)) - **pointer**: always set `PointerEvent.isPrimary` ([#1003](testing-library/user-event#1003)) ([2852509](testing-library/user-event@2852509)) - **pointer**: set `button` property on pointer events separately from legacy mouse events ([#1003](testing-library/user-event#1003)) ([2852509](testing-library/user-event@2852509)) - **pointer**: click closest common ancestor if `mousedown` and `mouseup` happen on different elements ([#1003](testing-library/user-event#1003)) ([2852509](testing-library/user-event@2852509)) - **pointer**: omit click event on release if another button is released first ([#1003](testing-library/user-event#1003)) ([2852509](testing-library/user-event@2852509)) - **pointer**: dispatch `mouseover`, `mouseenter` and `mousemove` on disabled elements ([#1003](testing-library/user-event#1003)) ([2852509](testing-library/user-event@2852509)) - **pointer**: prevent `mouse*` events per `pointerdown` event handler ([#1003](testing-library/user-event#1003)) ([2852509](testing-library/user-event@2852509)) - **pointer**: dispatch `*out` and `*over` events when moving into / out of nested elements ([#1003](testing-library/user-event#1003)) ([2852509](testing-library/user-event@2852509)) - **pointer**: dispatch `*enter` and `*leave` events on ancestors ([#1003](testing-library/user-event#1003)) ([2852509](testing-library/user-event@2852509)) ### [`v14.3.0`](https://github.com/testing-library/user-event/releases/tag/v14.3.0) [Compare Source](testing-library/user-event@v14.2.6...v14.3.0) ##### Features - **keyboard:** change radio group per arrow keys ([#995](testing-library/user-event#995)) ([e1c22af](testing-library/user-event@e1c22af)) ### [`v14.2.6`](https://github.com/testing-library/user-event/releases/tag/v14.2.6) [Compare Source](testing-library/user-event@v14.2.5...v14.2.6) ##### Bug Fixes - **document:** reduce impact of React@17 workaround ([#992](testing-library/user-event#992)) ([9816d38](testing-library/user-event@9816d38)) - **pointer:** do not throw for `pointer-events: none` on previous target ([#991](testing-library/user-event#991)) ([6e4058b](testing-library/user-event@6e4058b)) ### [`v14.2.5`](https://github.com/testing-library/user-event/releases/tag/v14.2.5) [Compare Source](testing-library/user-event@v14.2.4...v14.2.5) ##### Bug Fixes - **document:** do not track `value` on `HTMLSelectElement` ([#989](testing-library/user-event#989)) ([77a7fa8](testing-library/user-event@77a7fa8)) ### [`v14.2.4`](https://github.com/testing-library/user-event/releases/tag/v14.2.4) [Compare Source](testing-library/user-event@v14.2.3...v14.2.4) ##### Bug Fixes - use `window.FileList` instead of implicit global ([c88865d](testing-library/user-event@c88865d)) ### [`v14.2.3`](https://github.com/testing-library/user-event/releases/tag/v14.2.3) [Compare Source](testing-library/user-event@v14.2.2...v14.2.3) ##### Bug Fixes - **document:** use setters/methods on element as default ([#987](testing-library/user-event#987)) ([c40e614](testing-library/user-event@c40e614)) ### [`v14.2.2`](https://github.com/testing-library/user-event/releases/tag/v14.2.2) [Compare Source](testing-library/user-event@v14.2.1...v14.2.2) ##### Bug Fixes - **document:** track `HTMLInputElement.setRangeText()` ([#984](testing-library/user-event#984)) ([73443ec](testing-library/user-event@73443ec)) ### [`v14.2.1`](https://github.com/testing-library/user-event/releases/tag/v14.2.1) [Compare Source](testing-library/user-event@v14.2.0...v14.2.1) ##### Performance Improvements - **tab:** avert visibility check on irrelevant elements ([#967](testing-library/user-event#967)) ([d2d8a39](testing-library/user-event@d2d8a39)) ### [`v14.2.0`](https://github.com/testing-library/user-event/releases/tag/v14.2.0) [Compare Source](testing-library/user-event@v14.1.1...v14.2.0) ##### Features - report element with declaration in `pointerEventsCheck` ([#950](testing-library/user-event#950)) ([31b7091](testing-library/user-event@31b7091)) ##### Bug Fixes - guard against selection without range ([#953](testing-library/user-event#953)) ([ab78f3f](testing-library/user-event@ab78f3f)) - **selectOptions:** wait after each click ([#951](testing-library/user-event#951)) ([7ea7a77](testing-library/user-event@7ea7a77)) - wait after each method before leaving `asyncWrapper` ([#952](testing-library/user-event#952)) ([6f55fee](testing-library/user-event@6f55fee)) </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Enabled. ♻ **Rebasing**: Whenever PR is behind base branch, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] If you want to rebase/retry this PR, check this box --- This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).  Reviewed-on: https://gitea.bruyant.xyz/alexandre/PaletteSwitcher/pulls/47 Co-authored-by: Renovate <renovate@bruyant.xyz> Co-committed-by: Renovate <renovate@bruyant.xyz>

fix(event): be robust against incomplete event implementations

cb9e056

ph-fritsche force-pushed the fix-event branch from 5d3003e to cb9e056 Compare August 2, 2022 12:34

ph-fritsche merged commit 289828b into main Aug 2, 2022

ph-fritsche deleted the fix-event branch August 2, 2022 12:44

github-actions bot added the released label Aug 2, 2022

anilanar mentioned this pull request Nov 14, 2022

Firefox: userEvent.click does not submit forms #1075

Open

This was referenced Jun 19, 2024

[Snyk] Upgrade @testing-library/user-event from 13.5.0 to 14.5.2 YoutacRandS-VA/create-react-app#6

Open

[Snyk] Upgrade @testing-library/user-event from 13.5.0 to 14.5.2 YoutacRandS-VA/Web-Design#2

Open

aravindbuilt mentioned this pull request Jul 17, 2024

[Snyk] Upgrade @testing-library/user-event from 13.5.0 to 14.5.2 contentstack/contentstack-getting-started-react-app#16

Open

Harshi-99 mentioned this pull request Jul 19, 2024

[Snyk] Upgrade @testing-library/user-event from 13.5.0 to 14.5.2 Harshi-99/LittleLemonCouseraAssigment#2

Open

harykryshnan-Master mentioned this pull request Jul 24, 2024

[Snyk] Upgrade @testing-library/user-event from 13.5.0 to 14.5.2 harykryshnan-Master/Food-Clone-App-eks-argocd#3

Open

This was referenced Oct 23, 2024

[Snyk] Upgrade @testing-library/user-event from 13.5.0 to 14.5.2 | Upgrade user-event for improved testing compatibility nerdy-tech-com-gitub/supabass#1

Open

[Snyk] Upgrade @testing-library/user-event from 13.5.0 to 14.5.2 nerdy-tech-com-gitub/stract#7

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix(event): be robust against incomplete event implementations #1009

fix(event): be robust against incomplete event implementations #1009

ph-fritsche commented Aug 2, 2022 •

edited

Loading

codesandbox-ci bot commented Aug 2, 2022 •

edited

Loading

codecov bot commented Aug 2, 2022 •

edited

Loading

github-actions bot commented Aug 2, 2022

fix(event): be robust against incomplete event implementations #1009

fix(event): be robust against incomplete event implementations #1009

Conversation

ph-fritsche commented Aug 2, 2022 • edited Loading

codesandbox-ci bot commented Aug 2, 2022 • edited Loading

codecov bot commented Aug 2, 2022 • edited Loading

Codecov Report

github-actions bot commented Aug 2, 2022

ph-fritsche commented Aug 2, 2022 •

edited

Loading

codesandbox-ci bot commented Aug 2, 2022 •

edited

Loading

codecov bot commented Aug 2, 2022 •

edited

Loading