chore: Release v8 as stable #979

eps1lon · 2021-06-13T20:53:24Z

Recommendations:

If you're using jest fake timers make sure you use modern timers
jest 27:

-jest.useFakeTimers('legacy')
+jest.useFakeTimers('modern')
 // jest.config.js
-"timers": "legacy",
+"timers": "modern",

jest 26:

-jest.useFakeTimers()
+jest.useFakeTimers('modern')
 // jest.config.js
-"timers": "legacy",
+"timers": "modern",

BREAKING CHANGE: Remove deprecated waitFormDOMChange

BREAKING CHANGE: Remove deprecated waitForElement

BREAKING CHANGE: The timeout in waitFor(callback, { interval, timeout } ) now uses the same clock as interval. Previously timeout was always using the real clock while interval was using the global clock which could've been mocked out. For the old behavior I'd recommend waitFor(callback, { interval, timeout: Number.POSITIVE_INFINITY }) and rely on your test runner to timeout considering real timers.

BREAKING CHANGE: <script />, <style /> and comment nodes are now ignored by default in prettyDOM .If you whish to return to the old behavior, use a custom filterNode function. In this case prettyDOM(element, { filterNode: () => true }).

BREAKING CHANGE: node 10 is no longer supported. It reached its end-of-life on 30.04.2021.

What:

Prepare new major release

Why:

Ran promising tests in

mui-org/material-ui Bump @testing-library/* mui/material-ui#26740
reduxjs/react-redux https://github.com/eps1lon/react-redux/tree/test/bump-testing-library-alpha
adobe/react-spectrum https://github.com/eps1lon/react-spectrum/tree/test/bump-testing-library
This revealed test(waitFor): Add current behavior for legacy fake timers and requestAnimationFrame #978 which only affects legacy fake timers in jest 26 i.e. latest jest releases are unaffected
How:

Merge (not squash&merge) alpha into main

Checklist:

Documentation added to the
docs site
docs(dom): Document breaking changes of v8 testing-library-docs#866
Tests
Typescript definitions updated
Ready to be merged

BREAKING CHANGE: Remove deprecated `waitFormDOMChange` BREAKING CHANGE: The `timeout` in `waitFor(callback, { interval, timeout } )` now uses the same clock as `interval`. Previously `timeout` was always using the real clock while `interval` was using the global clock which could've been mocked out. For the old behavior I'd recommend `waitFor(callback, { interval, timeout: Number.PositiveInfinity })` and rely on your test runner to timeout considering real timers.

BREAKING CHANGE: Remove deprecated `waitForElement`

Co-authored-by: Tim Deschryver <[email protected]>

BREAKING CHANGE: node 10 is no longer supported. It reached its end-of-life on 30.04.2021.

codesandbox-ci · 2021-06-13T20:54:24Z

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 5b15f6f:

Sandbox	Source
react-testing-library-examples	Configuration

codecov · 2021-06-13T20:54:27Z

Codecov Report

Merging #979 (5b15f6f) into main (56a4c75) will not change coverage.
The diff coverage is 100.00%.

@@            Coverage Diff            @@
##              main      #979   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           26        25    -1     
  Lines          966       914   -52     
  Branches       298       281   -17     
=========================================
- Hits           966       914   -52

Flag	Coverage Δ
node-10.14.2	`?`
node-12	`100.00% <100.00%> (ø)`
node-14	`100.00% <100.00%> (ø)`
node-15	`?`
node-16	`100.00% <100.00%> (ø)`

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

Impacted Files	Coverage Δ
src/role-helpers.js	`100.00% <ø> (ø)`
src/suggestions.js	`100.00% <ø> (ø)`
src/config.ts	`100.00% <100.00%> (ø)`
src/get-user-code-frame.js	`100.00% <100.00%> (ø)`
src/helpers.js	`100.00% <100.00%> (ø)`
src/pretty-dom.js	`100.00% <100.00%> (ø)`
src/queries/role.js	`100.00% <100.00%> (ø)`
src/queries/text.ts	`100.00% <100.00%> (ø)`
src/queries/title.ts	`100.00% <100.00%> (ø)`
src/query-helpers.js	`100.00% <100.00%> (ø)`
... and 3 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 56a4c75...5b15f6f. Read the comment docs.

timdeschryver

Should we also add a note that OptionsReceived is replaced with PrettyFormatOptions ?
I bumped against this problem while I was preparing the upgrade for Angular Testing Library.

eps1lon · 2021-06-17T06:45:52Z

Should we also add a note that OptionsReceived is replaced with PrettyFormatOptions ?

It's not a breaking change, no. You can still pass prettyFormat.OptionsReceived.

But we should rename it to PrettyDOMOptions. They're not options to pretty-format anymore.

Edit:
Make sure you're also using [email protected].

…tAnimationFrame (#978)

kentcdodds · 2021-06-21T19:19:17Z

I'm currently testing the impact this will have on https://github.com/kentcdodds/bookshelf as well as another final test before giving this the green light.

kentcdodds · 2021-06-21T19:29:56Z

As usual, react-query + jest fake timers is an issue (don't worry about the long time the test is taking, my computer is currently doing some other resource intensive video conversion):

I tried my react-query v3 branch and had the same issue. In both cases, if I remove the fake timers then the test passes just fine.

If I try to upgrade to jest 27, I get an error because this is a CRA app.

I'm guessing this means that the combination of these tools/versions is problematic, so I'll probably just need to lock the versions if I don't want to make some major changes which is ultimately inevitable anyway, so I will not block this release on that.

All the other tests for that app work without trouble.

Once this is ready to merge then I think we're good.

eps1lon · 2021-06-21T22:00:43Z

I think ultimately jest is missing an API for flushing the microtask queue. We were kind of hacking it with Promise.resolve + setImmediate which isn't even something that's available in a browser. The current hack isn't better though.

I'm hoping that we can offer a workaround in a feature release where people can implement their own clock and therefore go back to the old Promise.resolve(resolve => setImmediate(resolve)) implementation for flushing microtasks if they need to.

The main goal of this major is to make the behavior more predictable (e.g. no more mixing of clocks, no more usage of setImmediate which isn't even available in browsers).

Thanks for the hint about react-query though. I'll take that repo and your bookshelf app into consideration for future integration testing. I was focusing too much on libraries.

timdeschryver

I tested the latest alpha release in ATL and all tests are passing, using Jest 26.

github-actions · 2021-06-23T06:20:58Z

🎉 This PR is included in version 8.0.0 🎉

The release is available on:

npm package (@latest dist-tag)
GitHub release

Your semantic-release bot 📦🚀

eps1lon and others added 7 commits June 3, 2021 06:27

fix: Consider <output /> labelable (#968)

ce06299

fix(types): remove wait types (#971)

0f8d912

chore: Update kcd-scripts to 11.x (#962)

c9748e9

feat: Remove waitForElement (#969)

532106b

BREAKING CHANGE: Remove deprecated `waitForElement`

feat: Add filterNode option to prettyDOM (#907)

9410e11

Co-authored-by: Tim Deschryver <[email protected]>

feat: Drop support for node 10 (#976)

fa3b91c

BREAKING CHANGE: node 10 is no longer supported. It reached its end-of-life on 30.04.2021.

eps1lon added the BREAKING CHANGE This change will require a major version bump label Jun 13, 2021

timdeschryver reviewed Jun 16, 2021

View reviewed changes

test(waitFor): Add current behavior for legacy fake timers and reques…

f78d289

…tAnimationFrame (#978)

This was referenced Jun 20, 2021

docs(dom): Document breaking changes of v8 testing-library/testing-library-docs#866

Merged

chore: PrettyFormatOptions -> PrettyDOMOptions #984

Merged

chore: PrettyFormatOptions -> PrettyDOMOptions (#984)

4c58bc9

eps1lon changed the title ~~chore: Release alpha as stable~~ chore: Release v8 as stable Jun 20, 2021

eps1lon marked this pull request as ready for review June 20, 2021 08:08

Merge branch 'main' into alpha

5b15f6f

eps1lon requested review from kentcdodds and alexkrolick June 20, 2021 08:13

eps1lon mentioned this pull request Jun 21, 2021

global is not defined #985

Closed

kentcdodds approved these changes Jun 21, 2021

View reviewed changes

timdeschryver approved these changes Jun 22, 2021

View reviewed changes

eps1lon merged commit d347302 into main Jun 23, 2021

eps1lon deleted the alpha branch June 23, 2021 05:58

github-actions bot added the released label Jun 23, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore: Release v8 as stable #979

chore: Release v8 as stable #979

eps1lon commented Jun 13, 2021 •

edited

Loading

codesandbox-ci bot commented Jun 13, 2021 •

edited

Loading

codecov bot commented Jun 13, 2021 •

edited

Loading

timdeschryver left a comment

eps1lon commented Jun 17, 2021 •

edited

Loading

kentcdodds commented Jun 21, 2021

kentcdodds commented Jun 21, 2021

eps1lon commented Jun 21, 2021

timdeschryver left a comment

github-actions bot commented Jun 23, 2021

chore: Release v8 as stable #979

chore: Release v8 as stable #979

Conversation

eps1lon commented Jun 13, 2021 • edited Loading

codesandbox-ci bot commented Jun 13, 2021 • edited Loading

codecov bot commented Jun 13, 2021 • edited Loading

Codecov Report

timdeschryver left a comment

Choose a reason for hiding this comment

eps1lon commented Jun 17, 2021 • edited Loading

kentcdodds commented Jun 21, 2021

kentcdodds commented Jun 21, 2021

eps1lon commented Jun 21, 2021

timdeschryver left a comment

Choose a reason for hiding this comment

github-actions bot commented Jun 23, 2021

eps1lon commented Jun 13, 2021 •

edited

Loading

codesandbox-ci bot commented Jun 13, 2021 •

edited

Loading

codecov bot commented Jun 13, 2021 •

edited

Loading

eps1lon commented Jun 17, 2021 •

edited

Loading