Upgrade user-event to v14 #1605
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
🦋 Changeset detectedLatest commit: f155d81 The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
added 15 commits
June 13, 2022 11:40
- removed the mocked document.createRange. This isn't necessary anymore. See https://github.com/testing-library/user-event/issues/902\#issuecomment-1092886633 - awaited userEvent calls, removed unnecessary act blocks - fixed type errors around icon types - note: there are still act warnings for some tests in the specs, even some not involving any state updates (style snapshots). Probably points to unwanted rerenders. Added a fixme comment.
- exposed the renderHook method from @testing-library/react, meant to replace the onoe from @testing-library/react-hooks, which isn't compatible with React 18. For migration purposes, I'm naming it newRenderHook--I'll remove the legacy method and rename the new one after all specs have been migrated - awaited userEvent calls and removed unnecessary act blocks
The live region wrapping toasts should not be a ul, because uls son't allow the status role (likely because it overrides list semantics anyways. Switched for divs. Found through a better axe test
- await userEvent method calls - added a new render helper to render a component tree including the ToastProvider, to reduce test boilerplate when testing business logic - improved the accesibility test to cover an actual document with a toast instead of the toast UI in isolation
- awaited userEvent methods and removed unnecessary act blocks - migrated useSidePanel to newRenderHook and removed unnecessary actHook blocks - added ariaHideApp=false to default test props in SidePanelContext to silence react-modal warning about the undefined app element - set up userEvent with delay=null in SidePanelContext to address this issue: testing-library/user-event#833 - TODO: two tests using userEvent.keyboard() are still failing. Marked as todo. - TODO: there are two act() warnings left (likely from before) when running `yarn test sidepanel` (all SidePanel-related specs)
This also adds comments on accessibility tests that inconsistently trigger axe warnings. Will be investigated and addressed separately.
Awaited userEvent calls.
Checkbox, CurrencyInput, Selector. Awaited userEvent method calls
Awaited userEvent method calls
- awaited userEvent method calls - set up userEvent with delay=null in ModalContext spec (same as in SidePanelContext)
Hamburger, Pagination, PageList, UtilityLinks, useClickOutside. Awaited userEvent method calls. Does not include the migration to new renderHook for useClickOutside, will be handled separately.
Same as in the ModalProvider and SidePanelProvider
- awaited method calls
- migrated {space} to { }
- TODO: migrate to the new renderHook, will be addressed separately
- await method calls - fix some TS errors
added 3 commits
June 13, 2022 12:08
- replace imports - replace removed waitForNextUpdate by a more explicit waitFor - remove tests covering error logic. Error testing was removed in the renderHook port to RTL and we're not covering this in other components, so I think it's fine to remove. See testing-library/react-testing-library#991 for more context
See testing-library/react-testing-library#991 for context. - replaced import of renderHook to newRenderHook (will be renamed in a follow-up commit) - replaced actHook by act - (edge cases were handled in earlier commits)
robinmetral
force-pushed
the
user-event-14
branch
from
6edfccf to
f52aed2
Compare
Not sure why these specs passed locally before
Codecov Report
@@ Coverage Diff @@
## main #1605 +/- ##
==========================================
+ Coverage 92.69% 92.77% +0.07%
==========================================
Files 194 194
Lines 4026 4026
Branches 1258 1258
==========================================
+ Hits 3732 3735 +3
+ Misses 275 272 -3
Partials 19 19
|
robinmetral
added
♿ accessibility
robinmetral
requested review from
amelako and
connor-baer
and removed request for
a team and
amelako
connor-baer
approved these changes
Jun 13, 2022
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Purpose
Upgrade to
@testing-library/user-eventv14.Approach and changes
@testing-library/user-eventv14user-eventmethods now return promises and need to beawaitedkeyboard()method params were renamed, e.g{esc}👉{Escape};{space}👉{ }user-eventusing{ delay: null }. Issue ref@testing-library/react-hookstorenderHookfrom@testing-library/react. Issue refaxeerror surfaced by an improved accessibility test (likely wasn't an issue, but a bad practice)act()warnings...)Definition of done