Skip to content

fix(no-wait-for-side-effects): detect userEvent.setup() instances and void-wrapped side effects #1402

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
AmineBenzaazaa wants to merge 1 commit into
base: main
Choose a base branch
from
+126 −17
Open

fix(no-wait-for-side-effects): detect userEvent.setup() instances and void-wrapped side effects #1402

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
57 changes: 40 additions & 17 deletions src/rules/no-wait-for-side-effects.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
import { AST_NODE_TYPES, ASTUtils } from '@typescript-eslint/utils';
import { isAwaitExpression } from '@typescript-eslint/utils/ast-utils';

import { createTestingLibraryRule } from '../create-testing-library-rule';
Expand All @@ -7,6 +8,7 @@ import {
isVariableDeclaration,
isAssignmentExpression,
isCallExpression,
isMemberExpression,
isSequenceExpression,
hasThenProperty,
} from '../node-utils';
Expand Down Expand Up @@ -44,6 +46,32 @@ export default createTestingLibraryRule<Options, MessageIds>({
create(context, _, helpers) {
const sourceCode = getSourceCode(context);

// Variables holding a `userEvent.setup()` instance, e.g. `const user = userEvent.setup()`
const userEventSetupVars = new Set<string>();

function isSideEffectUtil(identifier: TSESTree.Identifier): boolean {
return (
helpers.isFireEventUtil(identifier) ||
helpers.isUserEventUtil(identifier) ||
userEventSetupVars.has(identifier.name) ||
helpers.isRenderUtil(identifier)
);
}

function trackUserEventSetupVar(node: TSESTree.VariableDeclarator) {
if (
ASTUtils.isIdentifier(node.id) &&
isCallExpression(node.init) &&
isMemberExpression(node.init.callee) &&
ASTUtils.isIdentifier(node.init.callee.object) &&
ASTUtils.isIdentifier(node.init.callee.property) &&
node.init.callee.property.name === 'setup' &&
helpers.isUserEventUtil(node.init.callee.object)
) {
userEventSetupVars.add(node.id.name);
}
}

function isCallerWaitFor(
node:
| TSESTree.AssignmentExpression
Expand Down Expand Up @@ -149,11 +177,7 @@ export default createTestingLibraryRule<Options, MessageIds>({
return false;
}

return (
helpers.isFireEventUtil(test) ||
helpers.isUserEventUtil(test) ||
helpers.isRenderUtil(test)
);
return isSideEffectUtil(test);
}
return false;
});
Expand Down Expand Up @@ -181,17 +205,20 @@ export default createTestingLibraryRule<Options, MessageIds>({
return true;
}

const expressionIdentifier = getPropertyIdentifierNode(node);
// unwrap `void userEvent.click(el)`
const expressionIdentifier = getPropertyIdentifierNode(
isExpressionStatement(node) &&
node.expression.type === AST_NODE_TYPES.UnaryExpression &&
node.expression.operator === 'void'
? node.expression.argument
: node
);

if (!expressionIdentifier) {
return false;
}

return (
helpers.isFireEventUtil(expressionIdentifier) ||
helpers.isUserEventUtil(expressionIdentifier) ||
helpers.isRenderUtil(expressionIdentifier)
);
return isSideEffectUtil(expressionIdentifier);
}) as TSESTree.ExpressionStatement[];
}

Expand Down Expand Up @@ -301,12 +328,7 @@ export default createTestingLibraryRule<Options, MessageIds>({
return;
}

if (
expressionIdentifier &&
!helpers.isFireEventUtil(expressionIdentifier) &&
!helpers.isUserEventUtil(expressionIdentifier) &&
!helpers.isRenderUtil(expressionIdentifier)
) {
if (expressionIdentifier && !isSideEffectUtil(expressionIdentifier)) {
return;
}

Expand All @@ -325,6 +347,7 @@ export default createTestingLibraryRule<Options, MessageIds>({
}

return {
VariableDeclarator: trackUserEventSetupVar,
'CallExpression > ArrowFunctionExpression > BlockStatement':
reportSideEffects,
'CallExpression > ArrowFunctionExpression > CallExpression':
Expand Down
86 changes: 86 additions & 0 deletions tests/rules/no-wait-for-side-effects.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -341,6 +341,23 @@ ruleTester.run(rule.name, rule, {
await waitFor(() => result = render(<App />))
`,
},
...SUPPORTED_TESTING_FRAMEWORKS.flatMap<RuleValidTestCase>(
(testingFramework) => [
{
code: `
import { waitFor } from '${testingFramework}';
import userEvent from '@testing-library/user-event'

it("some test", async () => {
const user = createUser();
await waitFor(() => {
user.click(button);
});
});
`,
},
]
),
],
invalid: [
// render
Expand Down Expand Up @@ -1296,6 +1313,75 @@ ruleTester.run(rule.name, rule, {
it("some test", async () => {
await fireEvent.click(screen.getByTestId("something"));
});
`,
},
]
),
...SUPPORTED_TESTING_FRAMEWORKS.flatMap<InvalidTestCase<MessageIds, []>>(
(testingFramework) => [
{
code: `
import { waitFor } from '${testingFramework}';
import userEvent from '@testing-library/user-event'

it("some test", async () => {
const user = userEvent.setup();
await waitFor(async () => {
await user.click(screen.getByTestId("something"));
});
});
`,
errors: [{ line: 8, column: 13, messageId: 'noSideEffectsWaitFor' }],
output: `
import { waitFor } from '${testingFramework}';
import userEvent from '@testing-library/user-event'

it("some test", async () => {
const user = userEvent.setup();
await user.click(screen.getByTestId("something"));
});
`,
},
{
code: `
import { waitFor } from '${testingFramework}';
import userEvent from '@testing-library/user-event'

it("some test", async () => {
const user = userEvent.setup();
await waitFor(() => user.click(button));
});
`,
errors: [{ line: 7, column: 31, messageId: 'noSideEffectsWaitFor' }],
output: `
import { waitFor } from '${testingFramework}';
import userEvent from '@testing-library/user-event'

it("some test", async () => {
const user = userEvent.setup();
user.click(button);
});
`,
},
{
code: `
import { waitFor } from '${testingFramework}';
import userEvent from '@testing-library/user-event'

it("some test", async () => {
await waitFor(() => {
void userEvent.click(button);
});
});
`,
errors: [{ line: 7, column: 13, messageId: 'noSideEffectsWaitFor' }],
output: `
import { waitFor } from '${testingFramework}';
import userEvent from '@testing-library/user-event'

it("some test", async () => {
void userEvent.click(button);
});
`,
},
]
Expand Down