Release Beta #458

kentcdodds · 2020-03-04T18:37:16Z

What: Release the beta branch as stable

Why: Because we have needed breaking changes

How: Please see the commits for granular changes

Checklist:

Documentation added to the docs site
I've prepared a PR for types targeting DefinitelyTyped
Tests
Ready to be merged

Please test this in your projects:

npm install @testing-library/dom@beta
# yarn add @testing-library/dom@beta

codesandbox-ci · 2020-03-04T18:38:19Z

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 8214a50:

Sandbox	Source
friendly-jennings-2zz95	Configuration

weyert · 2020-03-04T18:41:44Z

package.json

@@ -61,7 +59,8 @@
    "rules": {
      "import/prefer-default-export": "off",
      "import/no-unassigned-import": "off",
-      "import/no-useless-path-segments": "off"
+      "import/no-useless-path-segments": "off",
+      "no-console": "off"


Any reason why you globally disable no-console-rule? I am curious if you couldn't disable for only the specific files?

I did and it was annoying.

Once of those things where I'd like a different set of rules for local dev. Basically a set of rules for prod and dev. Because we do like to catch dangling debug statements but we do sometimes need them for debugging locally.

codecov · 2020-03-04T18:42:40Z

Codecov Report

Merging #458 into master will not change coverage.
The diff coverage is 100%.

@@          Coverage Diff          @@
##           master   #458   +/-   ##
=====================================
  Coverage     100%   100%           
=====================================
  Files          22     22           
  Lines         404    420   +16     
  Branches       95    100    +5     
=====================================
+ Hits          404    420   +16

Impacted Files	Coverage Δ
src/pretty-dom.js	`100% <ø> (ø)`	⬆️
src/helpers.js	`100% <ø> (ø)`	⬆️
src/events.js	`100% <ø> (ø)`	⬆️
src/wait.js	`100% <100%> (ø)`	⬆️
src/config.js	`100% <100%> (ø)`	⬆️
src/wait-for-dom-change.js	`100% <100%> (ø)`	⬆️
src/wait-for-element.js	`100% <100%> (ø)`	⬆️
src/role-helpers.js	`100% <100%> (ø)`	⬆️
src/wait-for-element-to-be-removed.js	`100% <100%> (ø)`	⬆️
src/queries/label-text.js	`100% <100%> (ø)`	⬆️

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 bb4a1ed...8214a50. Read the comment docs.

eps1lon

Looks good. Only test that failed for us was due to A11yance/aria-query#42 which isn't harmful at all.

timdeschryver · 2020-03-05T21:15:25Z

I encountered a small (non blocking) typing problem with Angular Testing Library, because @types/testing-library__dom hasn't been updated with the latest changes.

I'm not really comfortable with @types, but do they also publish beta versions or should we wait until this version gets released?

For the rest, the example tests in the repo, were all green. 👍

kentcdodds · 2020-03-05T21:18:18Z

I don't know how DefinitelyTyped handles beta versions. I'm not going to bother. We'll be merging this before too long.

kentcdodds · 2020-03-08T03:27:01Z

Just an update. I'll planning on working on this and doing the release next Tuesday or Wednesday. 👍👍

kentcdodds · 2020-03-11T21:50:50Z

I'm ready to release this tomorrow. I'd like to get the green light from as many maintainers as possible. Please leave a review @testing-library/all-maintainers!

kentcdodds · 2020-03-11T21:51:20Z

Keep in mind that we like to avoid major releases like this, so if there's anything you have in mind for a breaking change, please speak now or forever hold your peace... well, maybe not forever, but yeah.

timdeschryver · 2020-03-12T06:27:08Z

👍 for Angular Testing Library

afontcu · 2020-03-12T11:23:06Z

I'm giving it a go right now in Vue Testing Lib: testing-library/vue-testing-library#125

would appreciate your input on both the empty callback when using wait, and also the failing stopwatch tests (source). Not sure how to implement it now 🤔 (it's failing on empty callback for wait, but I guess I need to rethink the whole test case)

benmonro · 2020-03-12T12:56:11Z

ok a few questions:

Given that the no op option for wait was removed is there a work around for folks that have usages of it? That one seems like it would cause a lot of breaking tests that would have to be fixed one by one. Which is probably worth doing but my 2 cents would be to give a deprecation warning on that before removing it like the other async functions.
Speaking of which, why get rid of wait for element and wait for element to be removed? I think they really improve the readability of tests. I get they can be done with wait or find* but for me it does improve the style of the test when you don't need to do an expect on those things.
While I understand and agree w/ the reasoning behind deprecating waitForDomChange, I do find it to be a very useful debugging tool when writing/debugging tests. I have often found myself starting w/ that, and then getting rid of it. Much the same way I'll start with debug() and remove that as well. This is especially true when converting enzyme tests to RTL (of which we have many) Why not just keep waitForDomChange and then just adding a lint rule for it?

kentcdodds · 2020-03-12T20:16:58Z

Alright, I'm working on this now: https://twitter.com/kentcdodds/status/1238197276465483776

benmonro · 2020-03-12T20:18:11Z

@kentcdodds any thoughts on my questions before you release? :)

kentcdodds · 2020-03-12T20:18:26Z

Yes, that's what I'm doing in the livestream 😉

benmonro · 2020-03-12T20:18:42Z

damn i'm in meetings. i can't make it

kentcdodds · 2020-03-12T20:25:36Z

i'm in meetings. i can't make it

Don't worry, what I meant was, I'm typing out the answer in the livestream :)

benmonro · 2020-03-12T20:26:30Z

ok posted some comments in the youtube comments

kentcdodds · 2020-03-12T20:30:21Z

For the empty callback with wait the solution is quite simple:

- await wait()
+ await wait(() => {})

So that can be a find/replace update, and then the recommendation would be for people to go through and put assertions in that callback instead of having an empty callback.

As for waitForElementToBeRemoved, that is not getting deprecated or removed. But waitForDomChange is removed because that's basically what wait does now, and waitForElement is what find* queries do and if you can't use a query, then wait does that now.

So the solution for those will be:

- const element = await waitForElement(() => container.querySelector('.loading'))
+ const element = await wait(() => container.querySelector('.loading'))

- await waitForDomChange()
+ await wait(() => {})

- await waitForDomChange(mutationObserverOptions)
+ await wait(() => {}, mutationObserverOptions)

So that's actually pretty straightforward. Most of those should be find/replace. The idea is, because wait now supports mutation observer (as well as the interval), we no longer need these one-offs. Also waitForDomChange was testing implementation details (the user doesn't care about any old DOM change, they care about specific DOM changes), and the wait with a no-op callback is also implementation details (because the user doesn't care how many ticks of the event loop something takes, they just care about waiting for something specific to happen).

Regarding readability, I don't think they're any more readable personally. Especially since you shouldn't be using waitForElement very often (you should use a query). In the above diff, I don't see waitForElement being any more understandable than the wait version.

waitForElementToBeRemoved is kept around because it's harder to implement what it does in userland. So it provides some actual utility.

For waitForDomChange I'm not a huge fan of including things and linting against them. debug is special because it logs something to the terminal that people wouldn't need a lint rule to tell them to remove. waitForDomChange is something that you could use to make your test pass, so you may decide to use it to do that. If your really like it for your workflow, then you can copy/paste what we have now and move it to your project, but I really don't want to encourage anyone to rely on specific and single DOM changes in their tests without waiting for a specific thing to happen (ie an assertion to pass).

benmonro · 2020-03-12T20:45:18Z

I guess one thing i'm hung up on is the naming, instead of wait what about naming it waitFor

I've been teaching folks on my team not to use wait because of the fact that it doesn't use mutation observers. now i'm going to have to teach them to use it. waitFor also solves the readability issue imo

kentcdodds · 2020-03-12T20:47:22Z

The library we used to use was called waitForExpect and I didn't like that because it was too specific to expect. waitFor sounds pretty good and I don't really have arguments against it. I'd really like to hear what other people have to say about it.

Maybe I'll do a twitter poll too 😅

kentcdodds · 2020-03-12T20:50:37Z

Hmmm... What if we alias wait to waitFor and then in the next major version bump we switch it?

I don't really like that but it's an idea.

benmonro · 2020-03-12T20:53:12Z

not sure how i feel about the alias. like we're already breaking changes anyway. people are already going to have to replace waitForElement and waitForDomChange.

kentcdodds · 2020-03-12T20:57:07Z

Yeah, let's not do the alias... I'm leaning toward renaming to waitFor though... Just not excited about the fallout... Don't want to rock the boat too much for something small like this.

kentcdodds · 2020-03-12T21:06:32Z

Alright, I'm not excited about making this change, but I think it's for the best, so we'll be renaming wait (as it is in this PR) to waitFor (also, here's the poll where waitFor is coming out with a big lead anyway: https://twitter.com/benmonro/status/1238209158622535680)

kentcdodds · 2020-03-12T21:18:35Z

Some people are suggesting: await until(() => expect(foo).toBe(true)).

Curious what others have to say. I'm still leaning toward waitFor...

benmonro · 2020-03-12T21:23:10Z

I don't hate until, but I think i still prefer waitFor as that's more in line w/ the other helpers & history of the library

Closes #430 BREAKING CHANGE: This drops support for Node 8. Node 10 or greater is now required.

Closes #372 BREAKING CHANGE: If you used the `selector` option in `ByLabelText` queries, then you will probably need to update that code to be able to find the label you're looking for.

Closes #376 Closes #416 BREAKING CHANGE: wait is now deprecated in favor of waitFor (which has basically the same API except it requires a callback and it also accepts optional mutation observer arguments). BREAKING CHANGE: `waitForElement` is deprecated in favor of `find*` queries or `wait`. BREAKING CHANGE: `waitForDomChange` is deprecated in favor of `wait` BREAKING CHANGE: default timeout for async utilities is now 1000ms rather than 4500ms. This can be configured: https://testing-library.com/docs/dom-testing-library/api-configuration

Closes #413 Closes #357 BREAKING CHANGE: MutationObserver is supported by all major browsers and recent versions of JSDOM. If you need, you can create your own shim (using @sheerun/mutationobserver-shim) and attach it to the window.

…460)

kentcdodds · 2020-03-12T21:55:35Z

🎉 This PR is included in version 7.0.0 🎉

The release is available on:

npm package (@latest dist-tag)
GitHub release

Your semantic-release bot 📦🚀

timdeschryver · 2020-03-13T23:10:38Z

it should be possible to have eslint fix these occurrences of wait and waitForDomChanges to make the upgrade path easier. See testing-library/eslint-plugin-testing-library#86

weyert reviewed Mar 4, 2020

View reviewed changes

kentcdodds force-pushed the beta branch 2 times, most recently from fd701b4 to 6bb57a9 Compare March 4, 2020 20:34

eps1lon previously approved these changes Mar 4, 2020

View reviewed changes

eps1lon dismissed their stale review via ab6d90f March 4, 2020 22:06

eps1lon previously approved these changes Mar 12, 2020

View reviewed changes

timdeschryver previously approved these changes Mar 12, 2020

View reviewed changes

kentcdodds and others added 5 commits March 12, 2020 15:24

fix: Drop Node 8 (#459)

80becd6

Closes #430 BREAKING CHANGE: This drops support for Node 8. Node 10 or greater is now required.

feat(ByLabelText): change selector to match target (not label) (#373)

13b00ea

Closes #372 BREAKING CHANGE: If you used the `selector` option in `ByLabelText` queries, then you will probably need to update that code to be able to find the label you're looking for.

feat: remove mutationobserver shim (#457)

ab3e691

Closes #413 Closes #357 BREAKING CHANGE: MutationObserver is supported by all major browsers and recent versions of JSDOM. If you need, you can create your own shim (using @sheerun/mutationobserver-shim) and attach it to the window.

feat(waitForElementToBeRemoved): support passing an element directly (#…

8214a50

…460)

kentcdodds dismissed stale reviews from timdeschryver and eps1lon via 8214a50 March 12, 2020 21:31

kentcdodds force-pushed the beta branch from 12b2cf7 to 8214a50 Compare March 12, 2020 21:31

kentcdodds merged commit 1b711a4 into master Mar 12, 2020

kentcdodds deleted the beta branch March 12, 2020 21:51

kentcdodds added the released label Mar 12, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Release Beta #458

Release Beta #458

kentcdodds commented Mar 4, 2020 •

edited

Loading

codesandbox-ci bot commented Mar 4, 2020 •

edited

Loading

weyert Mar 4, 2020 •

edited

Loading

kentcdodds Mar 4, 2020

eps1lon Mar 4, 2020

codecov bot commented Mar 4, 2020 •

edited

Loading

eps1lon left a comment

timdeschryver commented Mar 5, 2020 •

edited

Loading

kentcdodds commented Mar 5, 2020

kentcdodds commented Mar 8, 2020

kentcdodds commented Mar 11, 2020

kentcdodds commented Mar 11, 2020

timdeschryver commented Mar 12, 2020

afontcu commented Mar 12, 2020 •

edited

Loading

benmonro commented Mar 12, 2020 •

edited

Loading

kentcdodds commented Mar 12, 2020

benmonro commented Mar 12, 2020

kentcdodds commented Mar 12, 2020

benmonro commented Mar 12, 2020

kentcdodds commented Mar 12, 2020

benmonro commented Mar 12, 2020

kentcdodds commented Mar 12, 2020

benmonro commented Mar 12, 2020

kentcdodds commented Mar 12, 2020

kentcdodds commented Mar 12, 2020

benmonro commented Mar 12, 2020

kentcdodds commented Mar 12, 2020

kentcdodds commented Mar 12, 2020

kentcdodds commented Mar 12, 2020

benmonro commented Mar 12, 2020

kentcdodds commented Mar 12, 2020

timdeschryver commented Mar 13, 2020

Release Beta #458

Release Beta #458

Conversation

kentcdodds commented Mar 4, 2020 • edited Loading

codesandbox-ci bot commented Mar 4, 2020 • edited Loading

weyert Mar 4, 2020 • edited Loading

Choose a reason for hiding this comment

kentcdodds Mar 4, 2020

Choose a reason for hiding this comment

eps1lon Mar 4, 2020

Choose a reason for hiding this comment

codecov bot commented Mar 4, 2020 • edited Loading

Codecov Report

eps1lon left a comment

Choose a reason for hiding this comment

timdeschryver commented Mar 5, 2020 • edited Loading

kentcdodds commented Mar 5, 2020

kentcdodds commented Mar 8, 2020

kentcdodds commented Mar 11, 2020

kentcdodds commented Mar 11, 2020

timdeschryver commented Mar 12, 2020

afontcu commented Mar 12, 2020 • edited Loading

benmonro commented Mar 12, 2020 • edited Loading

kentcdodds commented Mar 12, 2020

benmonro commented Mar 12, 2020

kentcdodds commented Mar 12, 2020

benmonro commented Mar 12, 2020

kentcdodds commented Mar 12, 2020

benmonro commented Mar 12, 2020

kentcdodds commented Mar 12, 2020

benmonro commented Mar 12, 2020

kentcdodds commented Mar 12, 2020

kentcdodds commented Mar 12, 2020

benmonro commented Mar 12, 2020

kentcdodds commented Mar 12, 2020

kentcdodds commented Mar 12, 2020

kentcdodds commented Mar 12, 2020

benmonro commented Mar 12, 2020

kentcdodds commented Mar 12, 2020

timdeschryver commented Mar 13, 2020

kentcdodds commented Mar 4, 2020 •

edited

Loading

codesandbox-ci bot commented Mar 4, 2020 •

edited

Loading

weyert Mar 4, 2020 •

edited

Loading

codecov bot commented Mar 4, 2020 •

edited

Loading

timdeschryver commented Mar 5, 2020 •

edited

Loading

afontcu commented Mar 12, 2020 •

edited

Loading

benmonro commented Mar 12, 2020 •

edited

Loading