Skip to content

fix(await-async-event): prevent adding async/await in forEach loops #1075

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

Merged
merged 3 commits into from
Sep 24, 2025
Merged

fix(await-async-event): prevent adding async/await in forEach loops #1075

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8cf41e0
feat: add support for handling 'forEach' in async event method detection
y-hsgw Sep 3, 2025
5d0ec0d
test: add test case for handling 'forEach' with userEvent clicks
y-hsgw Sep 3, 2025
98e2650
Merge branch 'main' into fix/await-async-events
Belco90 Sep 24, 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
8 changes: 8 additions & 0 deletions lib/rules/await-async-events.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ import { createTestingLibraryRule } from '../create-testing-library-rule';
import {
findClosestCallExpressionNode,
findClosestFunctionExpressionNode,
getDeepestIdentifierNode,
getFunctionName,
getInnermostReturningFunction,
getVariableReferences,
Expand Down Expand Up @@ -153,6 +154,13 @@ export default createTestingLibraryRule<Options, MessageIds>({
findClosestFunctionExpressionNode(node);

if (functionExpression) {
const deepestCalleeIdentifier = getDeepestIdentifierNode(
functionExpression.parent
);
if (deepestCalleeIdentifier?.name === 'forEach') {
return null;
}

const memberExpressionFixer = fixer.insertTextBefore(
node.parent,
'await '
Expand Down
19 changes: 19 additions & 0 deletions tests/lib/rules/await-async-events.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1269,5 +1269,24 @@ ruleTester.run(RULE_NAME, rule, {
})
`,
},
{
code: `
import userEvent from '${USER_EVENT_ASYNC_FRAMEWORKS[0]}'
test('setup method called is valid', () => {
const foo = [];
foo.forEach(() => {
userEvent.click();
});
})
`,
errors: [
{
line: 6,
column: 6,
messageId: 'awaitAsyncEvent',
data: { name: 'click' },
},
],
},
],
});