fix(no-unnecessary-act): report userEvent with a different variable name (#1103)

Fixes #758

Author: y-hsgw

lib/rules/no-unnecessary-act.ts

@@ -7,8 +7,10 @@ import {
 	getStatementCallExpression,
 	isEmptyFunction,
 	isExpressionStatement,
+	isMemberExpression,
 	isReturnStatement,
 } from '../node-utils';
+import { resolveToTestingLibraryFn } from '../utils';
 
 import type { TSESTree } from '@typescript-eslint/utils';
 
@@ -58,6 +60,8 @@ export default createTestingLibraryRule<Options, MessageIds>({
 	],
 
 	create(context, [{ isStrict = true }], helpers) {
+		const userEventInstanceNames = new Set<string>();
+
 		function getStatementIdentifier(statement: TSESTree.Statement) {
 			const callExpression = getStatementCallExpression(statement);
 
@@ -87,11 +91,18 @@ export default createTestingLibraryRule<Options, MessageIds>({
 			return null;
 		}
 
-		/**
-		 * Determines whether some call is non Testing Library related for a given list of statements.
-		 */
-		function hasSomeNonTestingLibraryCall(
-			statements: TSESTree.Statement[]
+		function hasUserEventInstanceName(identifier: TSESTree.Identifier) {
+			if (!isMemberExpression(identifier.parent)) {
+				return false;
+			}
+
+			const propertyIdentifier = getPropertyIdentifierNode(identifier.parent);
+			return userEventInstanceNames.has(propertyIdentifier?.name ?? '');
+		}
+
+		function hasStatementReference(
+			statements: TSESTree.Statement[],
+			predicate: (identifier: TSESTree.Identifier) => boolean
 		): boolean {
 			return statements.some((statement) => {
 				const identifier = getStatementIdentifier(statement);
@@ -100,20 +111,31 @@ export default createTestingLibraryRule<Options, MessageIds>({
 					return false;
 				}
 
-				return !helpers.isTestingLibraryUtil(identifier);
+				return predicate(identifier);
 			});
 		}
 
-		function hasTestingLibraryCall(statements: TSESTree.Statement[]) {
-			return statements.some((statement) => {
-				const identifier = getStatementIdentifier(statement);
-
-				if (!identifier) {
-					return false;
-				}
+		/**
+		 * Determines whether some call is non Testing Library related for a given list of statements.
+		 */
+		function hasSomeNonTestingLibraryCall(
+			statements: TSESTree.Statement[]
+		): boolean {
+			return hasStatementReference(
+				statements,
+				(identifier) =>
+					!helpers.isTestingLibraryUtil(identifier) &&
+					!hasUserEventInstanceName(identifier)
+			);
+		}
 
-				return helpers.isTestingLibraryUtil(identifier);
-			});
+		function hasTestingLibraryCall(statements: TSESTree.Statement[]) {
+			return hasStatementReference(
+				statements,
+				(identifier) =>
+					helpers.isTestingLibraryUtil(identifier) ||
+					hasUserEventInstanceName(identifier)
+			);
 		}
 
 		function checkNoUnnecessaryActFromBlockStatement(
@@ -196,7 +218,24 @@ export default createTestingLibraryRule<Options, MessageIds>({
 			});
 		}
 
+		function registerUserEventInstance(
+			node: TSESTree.CallExpression & { parent: TSESTree.VariableDeclarator }
+		) {
+			const propertyIdentifier = getPropertyIdentifierNode(node);
+			const deepestIdentifier = getDeepestIdentifierNode(node);
+			const testingLibraryFn = resolveToTestingLibraryFn(node, context);
+
+			if (
+				propertyIdentifier?.name === testingLibraryFn?.local &&
+				deepestIdentifier?.name === 'setup' &&
+				ASTUtils.isIdentifier(node.parent?.id)
+			) {
+				userEventInstanceNames.add(node.parent.id.name);
+			}
+		}
+
 		return {
+			'VariableDeclarator > CallExpression': registerUserEventInstance,
 			'CallExpression > ArrowFunctionExpression > BlockStatement':
 				checkNoUnnecessaryActFromBlockStatement,
 			'CallExpression > FunctionExpression > BlockStatement':

tests/lib/rules/no-unnecessary-act.test.ts

@@ -63,6 +63,21 @@ const validNonStrictTestCases: RuleValidTestCase[] = [
       });
       `,
 	},
+	{
+		code: `// case: RTL act wrapping both userEvent and non-RTL calls
+      import { act } from '@testing-library/react'
+      import userEvent from '@testing-library/user-event'
+
+      test('valid case', async () => {
+        const user = userEvent.setup();
+
+        await act(async () => {
+          await user.click(element);
+					stuffThatDoesNotUseRTL()
+        });
+      })
+      `,
+	},
 ];
 
 const validTestCases: RuleValidTestCase[] = [
@@ -245,6 +260,28 @@ const invalidStrictTestCases: RuleInvalidTestCase[] =
 				},
 			],
 		},
+		{
+			code: `
+      import { act } from '${testingFramework}'
+      import userEvent from '@testing-library/user-event'
+
+      test('invalid case', async () => {
+        const user = userEvent.setup();
+
+        await act(async () => {
+          await user.click(element);
+					stuffThatDoesNotUseRTL()
+        });
+      })
+      `,
+			errors: [
+				{
+					messageId: 'noUnnecessaryActTestingLibraryUtil',
+					line: 8,
+					column: 15,
+				},
+			],
+		},
 	]);
 
 const invalidTestCases: RuleInvalidTestCase[] = [
@@ -566,6 +603,40 @@ const invalidTestCases: RuleInvalidTestCase[] = [
 			{ messageId: 'noUnnecessaryActEmptyFunction', line: 8, column: 9 },
 		],
 	},
+	{
+		code: `
+      import { act } from '@testing-library/react'
+      import userEvent from '@testing-library/user-event'
+
+      test('invalid case', async () => {
+        const user = userEvent.setup();
+
+        await act(async () => {
+          await user.click(element);
+        });
+      })
+      `,
+		errors: [
+			{ messageId: 'noUnnecessaryActTestingLibraryUtil', line: 8, column: 15 },
+		],
+	},
+	{
+		code: `
+      import { act } from '@testing-library/react'
+      import userEvent from '@testing-library/user-event'
+
+      test('invalid case', async () => {
+        const user = userEvent.setup();
+
+        act(async () => {
+          await user.click(element);
+        });
+      })
+      `,
+		errors: [
+			{ messageId: 'noUnnecessaryActTestingLibraryUtil', line: 8, column: 9 },
+		],
+	},
 	{
 		settings: {
 			'testing-library/utils-module': 'test-utils',