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

Fixes #843

Author: y-hsgw

lib/rules/await-async-events.ts

@@ -4,6 +4,7 @@ import { createTestingLibraryRule } from '../create-testing-library-rule';
 import {
 	findClosestCallExpressionNode,
 	findClosestFunctionExpressionNode,
+	getDeepestIdentifierNode,
 	getFunctionName,
 	getInnermostReturningFunction,
 	getVariableReferences,
@@ -250,6 +251,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 '

tests/lib/rules/await-async-events.test.ts

@@ -1460,5 +1460,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' },
+				},
+			],
+		},
 	],
 });