Skip to content

feat(no-wait-for-side-effects): report render in waitFor #363

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 12 commits into from
May 3, 2021
Merged

feat(no-wait-for-side-effects): report render in waitFor #363

Show file tree
Hide file tree
Changes from 7 commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
256cd21
feat(no-wait-for-side-effects): report render in waitFor
zaicevas May 1, 2021
c39015e
refactor: move null check into isTestingLibraryUtil
zaicevas May 1, 2021
e8eb471
refactor: move null check into assignment
zaicevas May 1, 2021
3986cdd
refactor: add brackets around null check
zaicevas May 1, 2021
f1e5237
refactor: introduce early returns in getSideEffectNodes()
zaicevas May 2, 2021
706ee2a
refactor: remove newlines
zaicevas May 2, 2021
ce75220
refactor: move checks to separate functions to improve readability
zaicevas May 2, 2021
d4c3bb5
refactor: merge multiple if statements into one
zaicevas May 2, 2021
5518751
refactor: remove null types in utils
zaicevas May 2, 2021
e149eed
refactor: merge two functions into one, add missing test case
zaicevas May 3, 2021
8061a6c
feat: add docs entry
zaicevas May 3, 2021
8fb2a07
refactor: pass function arg without wrapping it
zaicevas May 3, 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
16 changes: 10 additions & 6 deletions lib/create-testing-library-rule/detect-testing-library-utils.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ type IsAsyncUtilFn = (
) => boolean;
type IsFireEventMethodFn = (node: TSESTree.Identifier) => boolean;
type IsUserEventMethodFn = (node: TSESTree.Identifier) => boolean;
type IsRenderUtilFn = (node: TSESTree.Identifier) => boolean;
type IsRenderUtilFn = (node: TSESTree.Identifier | null) => boolean;
type IsRenderVariableDeclaratorFn = (
node: TSESTree.VariableDeclarator
) => boolean;
Expand Down Expand Up @@ -105,8 +105,8 @@ export interface DetectionHelpers {
isCustomQuery: IsCustomQueryFn;
isBuiltInQuery: IsBuiltInQueryFn;
isAsyncUtil: IsAsyncUtilFn;
isFireEventUtil: (node: TSESTree.Identifier) => boolean;
isUserEventUtil: (node: TSESTree.Identifier) => boolean;
isFireEventUtil: (node: TSESTree.Identifier | null) => boolean;
isUserEventUtil: (node: TSESTree.Identifier | null) => boolean;
isFireEventMethod: IsFireEventMethodFn;
isUserEventMethod: IsUserEventMethodFn;
isRenderUtil: IsRenderUtilFn;
Expand Down Expand Up @@ -173,7 +173,7 @@ export function detectTestingLibraryUtils<
* reporting)
*/
function isTestingLibraryUtil(
node: TSESTree.Identifier,
node: TSESTree.Identifier | null,
isUtilCallback: (
identifierNodeName: string,
originalNodeName?: string
Expand Down Expand Up @@ -429,7 +429,7 @@ export function detectTestingLibraryUtils<
*
* Not to be confused with {@link isFireEventMethod}
*/
const isFireEventUtil = (node: TSESTree.Identifier): boolean => {
const isFireEventUtil = (node: TSESTree.Identifier | null): boolean => {
return isTestingLibraryUtil(
node,
(identifierNodeName, originalNodeName) => {
Expand All @@ -443,7 +443,11 @@ export function detectTestingLibraryUtils<
*
* Not to be confused with {@link isUserEventMethod}
*/
const isUserEventUtil = (node: TSESTree.Identifier): boolean => {
const isUserEventUtil = (node: TSESTree.Identifier | null): boolean => {
if (!node) {
return false;
}

const userEvent = findImportedUserEventSpecifier();
let userEventName: string | undefined;

Expand Down
9 changes: 9 additions & 0 deletions lib/node-utils/is-node-of-type.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,15 @@ export const isCallExpression = isNodeOfType(AST_NODE_TYPES.CallExpression);
export const isExpressionStatement = isNodeOfType(
AST_NODE_TYPES.ExpressionStatement
);
export const isVariableDeclaration = isNodeOfType(
AST_NODE_TYPES.VariableDeclaration
);
export const isAssignmentExpression = isNodeOfType(
AST_NODE_TYPES.AssignmentExpression
);
export const isSequenceExpression = isNodeOfType(
AST_NODE_TYPES.SequenceExpression
);
export const isImportDeclaration = isNodeOfType(
AST_NODE_TYPES.ImportDeclaration
);
Expand Down
82 changes: 70 additions & 12 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 @@ -2,6 +2,10 @@ import { TSESTree } from '@typescript-eslint/experimental-utils';
import {
getPropertyIdentifierNode,
isExpressionStatement,
isVariableDeclaration,
isAssignmentExpression,
isCallExpression,
isSequenceExpression,
} from '../node-utils';
import { createTestingLibraryRule } from '../create-testing-library-rule';

Expand Down Expand Up @@ -32,7 +36,11 @@ export default createTestingLibraryRule<Options, MessageIds>({
defaultOptions: [],
create: function (context, _, helpers) {
function isCallerWaitFor(
node: TSESTree.BlockStatement | TSESTree.CallExpression
node:
| TSESTree.BlockStatement
| TSESTree.CallExpression
| TSESTree.AssignmentExpression
| TSESTree.SequenceExpression
): boolean {
if (!node.parent) {
return false;
Expand All @@ -48,22 +56,63 @@ export default createTestingLibraryRule<Options, MessageIds>({
);
}

function isRenderInVariableDeclaration(node: TSESTree.Node) {
return (
isVariableDeclaration(node) &&
node.declarations.some((declaration) =>
helpers.isRenderVariableDeclarator(declaration)
)
);
}

function isRenderInAssignment(node: TSESTree.Node) {
return (
isExpressionStatement(node) &&
isAssignmentExpression(node.expression) &&
helpers.isRenderUtil(getPropertyIdentifierNode(node.expression.right))
);
}

function isRenderInImplicitReturnAssignment(node: TSESTree.Node) {
return (
isAssignmentExpression(node) &&
helpers.isRenderUtil(getPropertyIdentifierNode(node.right))
);
}

function isRenderInSequenceAssignment(node: TSESTree.Node) {
return (
isSequenceExpression(node) &&
node.expressions.some(
(expression) =>
isAssignmentExpression(expression) &&
helpers.isRenderUtil(getPropertyIdentifierNode(expression.right))
)
);
}

function getSideEffectNodes(
body: TSESTree.Node[]
): TSESTree.ExpressionStatement[] {
return body.filter((node) => {
if (!isExpressionStatement(node)) {
if (!isExpressionStatement(node) && !isVariableDeclaration(node)) {
return false;
}

const expressionIdentifier = getPropertyIdentifierNode(node);
if (!expressionIdentifier) {
return false;
if (isRenderInVariableDeclaration(node)) {
return true;
}

if (isRenderInAssignment(node)) {
return true;
}

const expressionIdentifier = getPropertyIdentifierNode(node);

return (
helpers.isFireEventUtil(expressionIdentifier) ||
helpers.isUserEventUtil(expressionIdentifier)
helpers.isUserEventUtil(expressionIdentifier) ||
helpers.isRenderUtil(expressionIdentifier)
);
}) as TSESTree.ExpressionStatement[];
}
Expand All @@ -86,19 +135,26 @@ export default createTestingLibraryRule<Options, MessageIds>({
}
}

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

const expressionIdentifier = getPropertyIdentifierNode(node.callee);
if (!expressionIdentifier) {
return;
}
const expressionIdentifier = isCallExpression(node)
? getPropertyIdentifierNode(node.callee)
: null;

if (
!helpers.isFireEventUtil(expressionIdentifier) &&
!helpers.isUserEventUtil(expressionIdentifier)
!helpers.isUserEventUtil(expressionIdentifier) &&
!helpers.isRenderUtil(expressionIdentifier) &&
!isRenderInImplicitReturnAssignment(node) &&
!isRenderInSequenceAssignment(node)
) {
return;
}
Expand All @@ -112,6 +168,8 @@ export default createTestingLibraryRule<Options, MessageIds>({
return {
'CallExpression > ArrowFunctionExpression > BlockStatement': reportSideEffects,
'CallExpression > ArrowFunctionExpression > CallExpression': reportImplicitReturnSideEffect,
'CallExpression > ArrowFunctionExpression > AssignmentExpression': reportImplicitReturnSideEffect,
'CallExpression > ArrowFunctionExpression > SequenceExpression': reportImplicitReturnSideEffect,
'CallExpression > FunctionExpression > BlockStatement': reportSideEffects,
};
},
Expand Down
Loading