Skip to content

Commit c0b01b0

Browse files
Belco90Belco90
authored
refactor: remove remaining support for old async utils (testing-library#706)
1 parent 9316c3a commit c0b01b0

17 files changed

+83
-524
lines changed

‎README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
<a href="https://testing-library.com/">
66
<img width="150" height="150" src="https://raw.githubusercontent.com/testing-library/dom-testing-library/master/other/octopus.png">
77
</a>
8+
89
<h1>eslint-plugin-testing-library</h1>
910
<p>ESLint plugin to follow best practices and anticipate common mistakes when writing tests with Testing Library</p>
1011
</div>
@@ -222,7 +223,6 @@ To enable this configuration use the `extends` property in your
222223
| [no-promise-in-fire-event](docs/rules/no-promise-in-fire-event.md) | Disallow the use of promises passed to a `fireEvent` method | ![badge-angular][] ![badge-dom][] ![badge-marko][] ![badge-react][] ![badge-vue][] | | |
223224
| [no-render-in-lifecycle](docs/rules/no-render-in-lifecycle.md) | Disallow the use of `render` in testing frameworks setup functions | ![badge-angular][] ![badge-marko][] ![badge-react][] ![badge-vue][] | | |
224225
| [no-unnecessary-act](docs/rules/no-unnecessary-act.md) | Disallow wrapping Testing Library utils or empty callbacks in `act` | ![badge-marko][] ![badge-react][] | | |
225-
| [no-wait-for-empty-callback](docs/rules/no-wait-for-empty-callback.md) | Disallow empty callbacks for `waitFor` and `waitForElementToBeRemoved` | ![badge-angular][] ![badge-dom][] ![badge-marko][] ![badge-react][] ![badge-vue][] | | |
226226
| [no-wait-for-multiple-assertions](docs/rules/no-wait-for-multiple-assertions.md) | Disallow the use of multiple `expect` calls inside `waitFor` | ![badge-angular][] ![badge-dom][] ![badge-marko][] ![badge-react][] ![badge-vue][] | | |
227227
| [no-wait-for-side-effects](docs/rules/no-wait-for-side-effects.md) | Disallow the use of side effects in `waitFor` | ![badge-angular][] ![badge-dom][] ![badge-marko][] ![badge-react][] ![badge-vue][] | | |
228228
| [no-wait-for-snapshot](docs/rules/no-wait-for-snapshot.md) | Ensures no snapshot is generated inside of a `waitFor` call | ![badge-angular][] ![badge-dom][] ![badge-marko][] ![badge-react][] ![badge-vue][] | | |

‎docs/migration-guides/v6.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ If you are not on v5 yet, we recommend first following the [v5 migration guide](
55
## Overview
66

77
- `prefer-wait-for` was removed
8+
- `no-wait-for-empty-callback` was removed
89
- `await-fire-event` is now called `await-async-events` with support for an `eventModule` option with `userEvent` and/or `fireEvent`
910
- `await-async-events` is now enabled by default for `fireEvent` in Vue and Marko shared configs
1011
- `await-async-events` is now enabled by default for `userEvent` in all shared configs
@@ -21,6 +22,7 @@ If you are not on v5 yet, we recommend first following the [v5 migration guide](
2122
## Steps to upgrade
2223

2324
- Removing `testing-library/prefer-wait-for` if you were referencing it manually somewhere
25+
- Removing `testing-library/no-wait-for-empty-callback` if you were referencing it manually somewhere
2426
- Renaming `testing-library/await-fire-event` to `testing-library/await-async-events` if you were referencing it manually somewhere
2527
- Renaming `testing-library/await-async-query` to `testing-library/await-async-queries` if you were referencing it manually somewhere
2628
- Renaming `testing-library/no-await-async-query` to `testing-library/no-await-async-queries` if you were referencing it manually somewhere

‎docs/rules/await-async-utils.md

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,8 @@ Ensure that promises returned by async utils are handled properly.
1010

1111
Testing library provides several utilities for dealing with asynchronous code. These are useful to wait for an element until certain criteria or situation happens. The available async utils are:
1212

13-
- `waitFor` _(introduced since dom-testing-library v7)_
13+
- `waitFor`
1414
- `waitForElementToBeRemoved`
15-
- `wait` _(**deprecated** since dom-testing-library v7)_
16-
- `waitForElement` _(**deprecated** since dom-testing-library v7)_
17-
- `waitForDomChange` _(**deprecated** since dom-testing-library v7)_
1815

1916
This rule aims to prevent users from forgetting to handle the returned
2017
promise from async utils, which could lead to

‎docs/rules/no-wait-for-empty-callback.md

Lines changed: 0 additions & 45 deletions
This file was deleted.

‎docs/rules/no-wait-for-snapshot.md

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -29,14 +29,6 @@ const bar = async () => {
2929
await waitFor(() => expect(container).toMatchInlineSnapshot());
3030
// ...
3131
};
32-
33-
const baz = async () => {
34-
// ...
35-
await wait(() => {
36-
expect(container).toMatchSnapshot();
37-
});
38-
// ...
39-
};
4032
```
4133

4234
Examples of **correct** code for this rule:

‎docs/rules/prefer-find-by.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010

1111
## Rule details
1212

13-
This rule aims to use `findBy*` or `findAllBy*` queries to wait for elements, rather than using `waitFor`, or the deprecated methods `waitForElement` and `wait`.
13+
This rule aims to use `findBy*` or `findAllBy*` queries to wait for elements, rather than using `waitFor`.
1414
This rule analyzes those cases where `waitFor` is used with just one query method, in the form of an arrow function with only one statement (that is, without a block of statements). Given the callback could be more complex, this rule does not consider function callbacks or arrow functions with blocks of code.
1515

1616
Examples of **incorrect** code for this rule

‎lib/configs/angular.ts

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,6 @@ export = {
2020
'testing-library/no-node-access': 'error',
2121
'testing-library/no-promise-in-fire-event': 'error',
2222
'testing-library/no-render-in-lifecycle': 'error',
23-
'testing-library/no-wait-for-empty-callback': 'error',
2423
'testing-library/no-wait-for-multiple-assertions': 'error',
2524
'testing-library/no-wait-for-side-effects': 'error',
2625
'testing-library/no-wait-for-snapshot': 'error',

‎lib/configs/dom.ts

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,6 @@ export = {
1616
'testing-library/no-global-regexp-flag-in-query': 'error',
1717
'testing-library/no-node-access': 'error',
1818
'testing-library/no-promise-in-fire-event': 'error',
19-
'testing-library/no-wait-for-empty-callback': 'error',
2019
'testing-library/no-wait-for-multiple-assertions': 'error',
2120
'testing-library/no-wait-for-side-effects': 'error',
2221
'testing-library/no-wait-for-snapshot': 'error',

‎lib/configs/marko.ts

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,6 @@ export = {
2020
'testing-library/no-promise-in-fire-event': 'error',
2121
'testing-library/no-render-in-lifecycle': 'error',
2222
'testing-library/no-unnecessary-act': 'error',
23-
'testing-library/no-wait-for-empty-callback': 'error',
2423
'testing-library/no-wait-for-multiple-assertions': 'error',
2524
'testing-library/no-wait-for-side-effects': 'error',
2625
'testing-library/no-wait-for-snapshot': 'error',

‎lib/configs/react.ts

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,6 @@ export = {
2222
'testing-library/no-promise-in-fire-event': 'error',
2323
'testing-library/no-render-in-lifecycle': 'error',
2424
'testing-library/no-unnecessary-act': 'error',
25-
'testing-library/no-wait-for-empty-callback': 'error',
2625
'testing-library/no-wait-for-multiple-assertions': 'error',
2726
'testing-library/no-wait-for-side-effects': 'error',
2827
'testing-library/no-wait-for-snapshot': 'error',

‎lib/configs/vue.ts

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,6 @@ export = {
2020
'testing-library/no-node-access': 'error',
2121
'testing-library/no-promise-in-fire-event': 'error',
2222
'testing-library/no-render-in-lifecycle': 'error',
23-
'testing-library/no-wait-for-empty-callback': 'error',
2423
'testing-library/no-wait-for-multiple-assertions': 'error',
2524
'testing-library/no-wait-for-side-effects': 'error',
2625
'testing-library/no-wait-for-snapshot': 'error',

‎lib/rules/no-wait-for-empty-callback.ts

Lines changed: 0 additions & 100 deletions
This file was deleted.

‎lib/rules/prefer-find-by.ts

Lines changed: 4 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,6 @@ export const RULE_NAME = 'prefer-find-by';
1414
export type MessageIds = 'preferFindBy';
1515
type Options = [];
1616

17-
export const WAIT_METHODS = ['waitFor', 'waitForElement', 'wait'] as const;
18-
1917
export function getFindByQueryVariant(
2018
queryMethod: string
2119
): 'findAllBy' | 'findBy' {
@@ -63,7 +61,7 @@ export default createTestingLibraryRule<Options, MessageIds>({
6361
},
6462
messages: {
6563
preferFindBy:
66-
'Prefer `{{queryVariant}}{{queryMethod}}` query over using `{{waitForMethodName}}` + `{{prevQuery}}`',
64+
'Prefer `{{queryVariant}}{{queryMethod}}` query over using `waitFor` + `{{prevQuery}}`',
6765
},
6866
fixable: 'code',
6967
schema: [],
@@ -75,12 +73,11 @@ export default createTestingLibraryRule<Options, MessageIds>({
7573

7674
/**
7775
* Reports the invalid usage of wait* plus getBy/QueryBy methods and automatically fixes the scenario
78-
* @param node - The CallExpresion node that contains the wait* method
76+
* @param node - The CallExpression node that contains the waitFor method
7977
* @param replacementParams - Object with info for error message and autofix:
8078
* @param replacementParams.queryVariant - The variant method used to query: findBy/findAllBy.
8179
* @param replacementParams.prevQuery - The query originally used inside `waitFor`
8280
* @param replacementParams.queryMethod - Suffix string to build the query method (the query-part that comes after the "By"): LabelText, Placeholder, Text, Role, Title, etc.
83-
* @param replacementParams.waitForMethodName - wait for method used: waitFor/wait/waitForElement
8481
* @param replacementParams.fix - Function that applies the fix to correct the code
8582
*/
8683
function reportInvalidUsage(
@@ -89,20 +86,17 @@ export default createTestingLibraryRule<Options, MessageIds>({
8986
queryVariant: 'findAllBy' | 'findBy';
9087
queryMethod: string;
9188
prevQuery: string;
92-
waitForMethodName: string;
9389
fix: TSESLint.ReportFixFunction;
9490
}
9591
) {
96-
const { queryMethod, queryVariant, prevQuery, waitForMethodName, fix } =
97-
replacementParams;
92+
const { queryMethod, queryVariant, prevQuery, fix } = replacementParams;
9893
context.report({
9994
node,
10095
messageId: 'preferFindBy',
10196
data: {
10297
queryVariant,
10398
queryMethod,
10499
prevQuery,
105-
waitForMethodName,
106100
},
107101
fix,
108102
});
@@ -336,7 +330,7 @@ export default createTestingLibraryRule<Options, MessageIds>({
336330
'AwaitExpression > CallExpression'(node: TSESTree.CallExpression) {
337331
if (
338332
!ASTUtils.isIdentifier(node.callee) ||
339-
!helpers.isAsyncUtil(node.callee, WAIT_METHODS)
333+
!helpers.isAsyncUtil(node.callee, ['waitFor'])
340334
) {
341335
return;
342336
}
@@ -350,8 +344,6 @@ export default createTestingLibraryRule<Options, MessageIds>({
350344
return;
351345
}
352346

353-
const waitForMethodName = node.callee.name;
354-
355347
// ensure here it's one of the sync methods that we are calling
356348
if (isScreenSyncQuery(argument)) {
357349
const caller = getCaller(argument);
@@ -386,7 +378,6 @@ export default createTestingLibraryRule<Options, MessageIds>({
386378
queryMethod,
387379
queryVariant,
388380
prevQuery: fullQueryMethod,
389-
waitForMethodName,
390381
fix(fixer) {
391382
const property = (
392383
(argument.body as TSESTree.CallExpression)
@@ -423,7 +414,6 @@ export default createTestingLibraryRule<Options, MessageIds>({
423414
queryMethod,
424415
queryVariant,
425416
prevQuery: fullQueryMethod,
426-
waitForMethodName,
427417
fix(fixer) {
428418
// we know from above callee is an Identifier
429419
if (

‎lib/utils/index.ts

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -59,13 +59,7 @@ const ALL_QUERIES_COMBINATIONS = [
5959
...ASYNC_QUERIES_COMBINATIONS,
6060
];
6161

62-
const ASYNC_UTILS = [
63-
'waitFor',
64-
'waitForElementToBeRemoved',
65-
'wait',
66-
'waitForElement',
67-
'waitForDomChange',
68-
] as const;
62+
const ASYNC_UTILS = ['waitFor', 'waitForElementToBeRemoved'] as const;
6963

7064
const DEBUG_UTILS = [
7165
'debug',

‎tests/index.test.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ import { resolve } from 'path';
33

44
import plugin from '../lib';
55

6-
const numberOfRules = 26;
6+
const numberOfRules = 25;
77
const ruleNames = Object.keys(plugin.rules);
88

99
// eslint-disable-next-line jest/expect-expect

0 commit comments

Comments
 (0)