feat(await-async-query): add auto-fix #917
There are no files selected for viewing
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -361,6 +361,14 @@ ruleTester.run(RULE_NAME, rule, { | |
| }); | ||
| `, | ||
| errors: [{ messageId: 'awaitAsyncQuery', line: 6, column: 21 }], | ||
| output: `// async queries without await operator or then method are not valid | ||
| import { render } from '${testingFramework}' | ||
|
|
||
| test("An example test", async () => { | ||
| doSomething() | ||
| const foo = await ${query}('foo') | ||
| }); | ||
| `, | ||
| }) as const | ||
| ) | ||
| ), | ||
|
|
@@ -382,6 +390,13 @@ ruleTester.run(RULE_NAME, rule, { | |
| data: { name: query }, | ||
| }, | ||
| ], | ||
| output: `// async screen queries without await operator or then method are not valid | ||
| import { render } from '@testing-library/react' | ||
|
|
||
| test("An example test", async () => { | ||
| await screen.${query}('foo') | ||
| }); | ||
| `, | ||
| }) as const | ||
| ), | ||
| ...ALL_ASYNC_COMBINATIONS_TO_TEST.map( | ||
|
|
@@ -403,6 +418,14 @@ ruleTester.run(RULE_NAME, rule, { | |
| data: { name: query }, | ||
| }, | ||
| ], | ||
| output: ` | ||
| import { render } from '@testing-library/react' | ||
|
|
||
| test("An example test", async () => { | ||
| doSomething() | ||
| const foo = await ${query}('foo') | ||
| }); | ||
| `, | ||
| }) as const | ||
| ), | ||
| ...ALL_ASYNC_COMBINATIONS_TO_TEST.map( | ||
|
|
@@ -425,6 +448,15 @@ ruleTester.run(RULE_NAME, rule, { | |
| data: { name: query }, | ||
| }, | ||
| ], | ||
| output: ` | ||
| import { render } from '@testing-library/react' | ||
|
|
||
| test("An example test", async () => { | ||
| const foo = ${query}('foo') | ||
| expect(await foo).toBeInTheDocument() | ||
| expect(await foo).toHaveAttribute('src', 'bar'); | ||
| }); | ||
| `, | ||
| }) as const | ||
| ), | ||
|
|
||
|
|
@@ -440,6 +472,13 @@ ruleTester.run(RULE_NAME, rule, { | |
| }) | ||
| `, | ||
| errors: [{ messageId: 'awaitAsyncQuery', line: 5, column: 27 }], | ||
| output: ` | ||
| import { render } from "another-library" | ||
|
|
||
| test('An example test', async () => { | ||
| const example = await ${query}("my example") | ||
| }) | ||
| `, | ||
| }) as const | ||
| ), | ||
|
|
||
|
|
@@ -458,11 +497,26 @@ ruleTester.run(RULE_NAME, rule, { | |
| const element = queryWrapper() | ||
| }) | ||
|
|
||
| test("A valid example test", async () => { | ||
| const element = await queryWrapper() | ||
| }) | ||
| `, | ||
| errors: [{ messageId: 'asyncQueryWrapper', line: 9, column: 27 }], | ||
| output: ` | ||
| function queryWrapper() { | ||
| doSomethingElse(); | ||
|
|
||
| return screen.${query}('foo') | ||
| } | ||
|
|
||
| test("An invalid example test", async () => { | ||
| const element = await queryWrapper() | ||
| }) | ||
|
|
||
| test("A valid example test", async () => { | ||
| const element = await queryWrapper() | ||
| }) | ||
| `, | ||
| }) as const | ||
| ), | ||
| // unhandled promise from async query arrow function wrapper is invalid | ||
|
|
@@ -480,11 +534,26 @@ ruleTester.run(RULE_NAME, rule, { | |
| const element = queryWrapper() | ||
| }) | ||
|
|
||
| test("A valid example test", async () => { | ||
| const element = await queryWrapper() | ||
| }) | ||
| `, | ||
| errors: [{ messageId: 'asyncQueryWrapper', line: 9, column: 27 }], | ||
| output: ` | ||
| const queryWrapper = () => { | ||
| doSomethingElse(); | ||
|
|
||
| return ${query}('foo') | ||
| } | ||
|
|
||
| test("An invalid example test", async () => { | ||
| const element = await queryWrapper() | ||
| }) | ||
|
|
||
| test("A valid example test", async () => { | ||
| const element = await queryWrapper() | ||
| }) | ||
| `, | ||
| }) as const | ||
| ), | ||
| // unhandled promise implicitly returned from async query arrow function wrapper is invalid | ||
|
|
@@ -498,11 +567,22 @@ ruleTester.run(RULE_NAME, rule, { | |
| const element = queryWrapper() | ||
| }) | ||
|
|
||
| test("A valid example test", async () => { | ||
| const element = await queryWrapper() | ||
| }) | ||
| `, | ||
| errors: [{ messageId: 'asyncQueryWrapper', line: 5, column: 27 }], | ||
| output: ` | ||
| const queryWrapper = () => screen.${query}('foo') | ||
|
|
||
| test("An invalid example test", async () => { | ||
| const element = await queryWrapper() | ||
| }) | ||
|
|
||
| test("A valid example test", async () => { | ||
| const element = await queryWrapper() | ||
| }) | ||
| `, | ||
| }) as const | ||
| ), | ||
|
|
||
|
|
@@ -517,6 +597,11 @@ ruleTester.run(RULE_NAME, rule, { | |
| }) | ||
| `, | ||
| errors: [{ messageId: 'awaitAsyncQuery', line: 3, column: 25 }], | ||
| output: ` | ||
| test('An invalid example test', () => { | ||
| const element = await findByIcon('search') | ||
| }) | ||
| `, | ||
| }, | ||
|
|
||
| { | ||
|
|
@@ -545,6 +630,30 @@ ruleTester.run(RULE_NAME, rule, { | |
| }) | ||
| `, | ||
| errors: [{ messageId: 'asyncQueryWrapper', line: 19, column: 34 }], | ||
| output: `// similar to issue #359 but forcing an error in no-awaited wrapper | ||
| import { render, screen } from 'mocks/test-utils' | ||
| import userEvent from '@testing-library/user-event' | ||
|
|
||
| const testData = { | ||
| name: 'John Doe', | ||
| email: '[email protected]', | ||
| password: 'extremeSecret', | ||
| } | ||
|
|
||
| const selectors = { | ||
| username: () => screen.findByRole('textbox', { name: /username/i }), | ||
| email: () => screen.findByRole('textbox', { name: /e-mail/i }), | ||
| password: () => screen.findByLabelText(/password/i), | ||
| } | ||
|
|
||
| test('this is a valid case', async () => { | ||
| render(<SomeComponent />) | ||
| userEvent.type(await selectors.username(), testData.name) // <-- unhandled here | ||
| userEvent.type(await selectors.email(), testData.email) | ||
| userEvent.type(await selectors.password(), testData.password) | ||
| // ... | ||
| }) | ||
| `, | ||
| }, | ||
| ], | ||
| }); | ||
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Does it really matter if the parent object is
screen? I think it should work no matter what's the name of its parent is.For example:
In this case,
view.findByTextwouldn't be autofixed, but it should. Can you add this scenario to the tests, and adjust the rule fix accordingly?