Skip to content

fix(prefer-find-by): ensure autofix wraps findBy* call inside expect(await …) when assertion is involved #1107

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

fix(prefer-find-by): ensure autofix wraps findBy* call inside expect(await …) when assertion is involved #1107

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8344322
fix: replace waitFor screen presence with await findBy
y-hsgw Oct 23, 2025
fb614f7
test: add tests
y-hsgw Oct 23, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 29 additions & 17 deletions lib/rules/prefer-find-by.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
import { ASTUtils } from '@typescript-eslint/utils';
import { isIdentifier } from '@typescript-eslint/utils/ast-utils';

import { createTestingLibraryRule } from '../create-testing-library-rule';
import {
Expand Down Expand Up @@ -409,7 +410,8 @@ export default createTestingLibraryRule<Options, MessageIds>({
return;
}

if (!isCallExpression(argument.body)) {
const argumentBody = argument.body;
if (!isCallExpression(argumentBody)) {
return;
}

Expand Down Expand Up @@ -438,29 +440,42 @@ export default createTestingLibraryRule<Options, MessageIds>({
}

const queryVariant = getFindByQueryVariant(fullQueryMethod);
const callArguments = getQueryArguments(argument.body);
const callArguments = getQueryArguments(argumentBody);
const queryMethod = fullQueryMethod.split('By')[1];

if (!queryMethod) {
return;
}

reportInvalidUsage(node, {
queryMethod,
queryVariant,
prevQuery: fullQueryMethod,
fix(fixer) {
const property = (
(argument.body as TSESTree.CallExpression)
.callee as TSESTree.MemberExpression
).property;
if (helpers.isCustomQuery(property as TSESTree.Identifier)) {
return null;
}
const newCode = `${caller}.${queryVariant}${queryMethod}(${callArguments
const findByCallText = `${caller}.${queryVariant}${queryMethod}(${callArguments
.map((callArgNode) => sourceCode.getText(callArgNode))
.join(', ')}${waitOptionsSourceCode})`;
return fixer.replaceText(node, newCode);

if (!isMemberExpression(argumentBody.callee)) return null;

const { property, object } = argumentBody.callee;
if (ASTUtils.isVariableDeclarator(node.parent.parent)) {
if (isIdentifier(property) && helpers.isCustomQuery(property)) {
return null;
}
return fixer.replaceText(node, findByCallText);
}

if (!isCallExpression(object)) return null;

const originalExpect = sourceCode.getText(argumentBody);
const awaited = `await ${findByCallText}`;
const newExpect = originalExpect.replace(
sourceCode.getText(object.arguments[0]),
awaited
);
const output = originalExpect.replace(originalExpect, newExpect);

return fixer.replaceText(node.parent, output);
},
});
return;
Expand All @@ -481,7 +496,7 @@ export default createTestingLibraryRule<Options, MessageIds>({

const queryMethod = fullQueryMethod.split('By')[1];
const queryVariant = getFindByQueryVariant(fullQueryMethod);
const callArguments = getQueryArguments(argument.body);
const callArguments = getQueryArguments(argumentBody);

reportInvalidUsage(node, {
queryMethod,
Expand All @@ -490,10 +505,7 @@ export default createTestingLibraryRule<Options, MessageIds>({
fix(fixer) {
// we know from above callee is an Identifier
if (
helpers.isCustomQuery(
(argument.body as TSESTree.CallExpression)
.callee as TSESTree.Identifier
)
helpers.isCustomQuery(argumentBody.callee as TSESTree.Identifier)
) {
return null;
}
Expand Down
58 changes: 58 additions & 0 deletions tests/lib/rules/prefer-find-by.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -691,6 +691,64 @@ ruleTester.run(RULE_NAME, rule, {
})
`,
})),
...createScenario((waitMethod, queryMethod) => ({
code: `
import { screen } from '${testingFramework}';

it('tests', async () => {
await ${waitMethod}(() => expect(screen.${queryMethod}('button', { name: 'Count is: 0' })).toBeInTheDocument())
})
`,
errors: [
{
line: 5,
column: 11,
messageId: 'preferFindBy',
data: {
queryVariant: getFindByQueryVariant(queryMethod),
queryMethod: queryMethod.split('By')[1],
prevQuery: queryMethod,
waitForMethodName: waitMethod,
},
},
],
output: `
import { screen } from '${testingFramework}';

it('tests', async () => {
expect(await screen.${buildFindByMethod(queryMethod)}('button', { name: 'Count is: 0' })).toBeInTheDocument()
})
`,
})),
...createScenario((waitMethod, queryMethod) => ({
code: `
import { screen } from '${testingFramework}';

it('tests', async () => {
await ${waitMethod}(() => expect(screen.${queryMethod}('button', { name: 'Count is: 0' })).toBeInTheDocument(), { timeout: 100, interval: 200 })
})
`,
errors: [
{
line: 5,
column: 11,
messageId: 'preferFindBy',
data: {
queryVariant: getFindByQueryVariant(queryMethod),
queryMethod: queryMethod.split('By')[1],
prevQuery: queryMethod,
waitForMethodName: waitMethod,
},
},
],
output: `
import { screen } from '${testingFramework}';

it('tests', async () => {
expect(await screen.${buildFindByMethod(queryMethod)}('button', { name: 'Count is: 0' }, { timeout: 100, interval: 200 })).toBeInTheDocument()
})
`,
})),
// Issue #579, https://github.com/testing-library/eslint-plugin-testing-library/issues/579
// findBy can have two sets of options: await screen.findByText('text', queryOptions, waitForOptions)
...createScenario((waitMethod, queryMethod) => ({
Expand Down