Skip to content

fix(no-wait-for-side-effects): catch implicit arrow function return #352

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 6 commits into from
Apr 25, 2021
Merged

fix(no-wait-for-side-effects): catch implicit arrow function return #352

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
bd532dd
fix(no-wait-for-side-effects): yield error with implicit arrow return
zaicevas Apr 23, 2021
9a12ce9
refactor: simplify functions
zaicevas Apr 23, 2021
71c79fc
fix: call a function
zaicevas Apr 23, 2021
b08d377
refactor: consist return type
zaicevas Apr 23, 2021
8e6044a
refactor: isCallerWaitFor function
zaicevas Apr 23, 2021
e991eed
test: add more cases
zaicevas Apr 25, 2021
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
55 changes: 42 additions & 13 deletions lib/rules/no-wait-for-side-effects.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,23 @@ export default createTestingLibraryRule<Options, MessageIds>({
},
defaultOptions: [],
create: function (context, _, helpers) {
function isCallerWaitFor(
node: TSESTree.BlockStatement | TSESTree.CallExpression
): boolean {
if (!node.parent) {
return false;
}
const callExpressionNode = node.parent.parent as TSESTree.CallExpression;
const callExpressionIdentifier = getPropertyIdentifierNode(
callExpressionNode
);

return (
!!callExpressionIdentifier &&
helpers.isAsyncUtil(callExpressionIdentifier, ['waitFor'])
);
}

function getSideEffectNodes(
body: TSESTree.Node[]
): TSESTree.ExpressionStatement[] {
Expand All @@ -47,19 +64,7 @@ export default createTestingLibraryRule<Options, MessageIds>({
}

function reportSideEffects(node: TSESTree.BlockStatement) {
if (!node.parent) {
return;
}
const callExpressionNode = node.parent.parent as TSESTree.CallExpression;
const callExpressionIdentifier = getPropertyIdentifierNode(
callExpressionNode
);

if (!callExpressionIdentifier) {
return;
}

if (!helpers.isAsyncUtil(callExpressionIdentifier, ['waitFor'])) {
if (!isCallerWaitFor(node)) {
return;
}

Expand All @@ -76,8 +81,32 @@ export default createTestingLibraryRule<Options, MessageIds>({
}
}

function reportImplicitReturnSideEffect(node: TSESTree.CallExpression) {
if (!isCallerWaitFor(node)) {
return;
}

const expressionIdentifier = getPropertyIdentifierNode(node.callee);
if (!expressionIdentifier) {
return;
}

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

context.report({
node,
messageId: 'noSideEffectsWaitFor',
});
}

return {
'CallExpression > ArrowFunctionExpression > BlockStatement': reportSideEffects,
'CallExpression > ArrowFunctionExpression > CallExpression': reportImplicitReturnSideEffect,
'CallExpression > FunctionExpression > BlockStatement': reportSideEffects,
};
},
Expand Down
48 changes: 46 additions & 2 deletions tests/lib/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 @@ -158,12 +158,49 @@ ruleTester.run(RULE_NAME, rule, {
})
`,
},
{
settings: { 'testing-library/utils-module': 'test-utils' },
code: `
import { waitFor } from 'somewhere-else';
await waitFor(() => fireEvent.keyDown(input, {key: 'ArrowDown'}))
`,
},
{
settings: { 'testing-library/utils-module': 'test-utils' },
code: `
import { waitFor } from 'somewhere-else';
import { userEvent } from '@testing-library/react';
await waitFor(() => userEvent.click(button))
`,
},
{
settings: { 'testing-library/utils-module': '~/test-utils' },
code: `
import { waitFor, userEvent } from '~/test-utils';
await waitFor(() => userEvent.click(button))
`,
},
],
invalid: [
// fireEvent
{
code: `
import { waitFor } from '@testing-library/react';
import { waitFor } from '@testing-library/react';
await waitFor(() => fireEvent.keyDown(input, {key: 'ArrowDown'}))
`,
errors: [{ line: 3, column: 29, messageId: 'noSideEffectsWaitFor' }],
},
{
settings: { 'testing-library/utils-module': '~/test-utils' },
code: `
import { waitFor, fireEvent } from '~/test-utils';
await waitFor(() => fireEvent.keyDown(input, {key: 'ArrowDown'}))
`,
errors: [{ line: 3, column: 29, messageId: 'noSideEffectsWaitFor' }],
},
{
code: `
import { waitFor } from '@testing-library/react';
await waitFor(() => {
fireEvent.keyDown(input, {key: 'ArrowDown'})
})
Expand Down Expand Up @@ -241,7 +278,14 @@ ruleTester.run(RULE_NAME, rule, {
// userEvent
{
code: `
import { waitFor } from '@testing-library/react';
import { waitFor } from '@testing-library/react';
await waitFor(() => userEvent.click(button))
`,
errors: [{ line: 3, column: 29, messageId: 'noSideEffectsWaitFor' }],
},
{
code: `
import { waitFor } from '@testing-library/react';
await waitFor(() => {
userEvent.click(button)
})
Expand Down