no-unnecessary-act.ts

import { TSESTree, ASTUtils } from '@typescript-eslint/experimental-utils';

import { createTestingLibraryRule } from '../create-testing-library-rule';
import {
  getDeepestIdentifierNode,
  getPropertyIdentifierNode,
  getStatementCallExpression,
  isEmptyFunction,
  isExpressionStatement,
  isReturnStatement,
} from '../node-utils';

export const RULE_NAME = 'no-unnecessary-act';
export type MessageIds =
  | 'noUnnecessaryActEmptyFunction'
  | 'noUnnecessaryActTestingLibraryUtil';
export type Options = [{ isStrict: boolean }];

export default createTestingLibraryRule<Options, MessageIds>({
  name: RULE_NAME,
  meta: {
    type: 'problem',
    docs: {
      description:
        'Disallow wrapping Testing Library utils or empty callbacks in `act`',
      category: 'Possible Errors',
      recommendedConfig: {
        dom: false,
        angular: false,
        react: 'error',
        vue: false,
      },
    },
    messages: {
      noUnnecessaryActTestingLibraryUtil:
        'Avoid wrapping Testing Library util calls in `act`',
      noUnnecessaryActEmptyFunction: 'Avoid wrapping empty function in `act`',
    },
    schema: [
      {
        type: 'object',
        properties: {
          isStrict: {
            type: 'boolean',
          },
        },
      },
    ],
  },
  defaultOptions: [
    {
      isStrict: true,
    },
  ],

  create(context, [{ isStrict = true }], helpers) {
    function getStatementIdentifier(statement: TSESTree.Statement) {
      const callExpression = getStatementCallExpression(statement);

      if (
        !callExpression &&
        !isExpressionStatement(statement) &&
        !isReturnStatement(statement)
      ) {
        return null;
      }

      if (callExpression) {
        return getDeepestIdentifierNode(callExpression);
      }

      if (
        isExpressionStatement(statement) &&
        ASTUtils.isAwaitExpression(statement.expression)
      ) {
        return getPropertyIdentifierNode(statement.expression.argument);
      }

      if (isReturnStatement(statement) && statement.argument) {
        return getPropertyIdentifierNode(statement.argument);
      }

      return null;
    }

    /**
     * Determines whether some call is non Testing Library related for a given list of statements.
     */
    function hasSomeNonTestingLibraryCall(
      statements: TSESTree.Statement[]
    ): boolean {
      return statements.some((statement) => {
        const identifier = getStatementIdentifier(statement);

        if (!identifier) {
          return false;
        }

        return !helpers.isTestingLibraryUtil(identifier);
      });
    }

    function hasTestingLibraryCall(statements: TSESTree.Statement[]) {
      return statements.some((statement) => {
        const identifier = getStatementIdentifier(statement);

        if (!identifier) {
          return false;
        }

        return helpers.isTestingLibraryUtil(identifier);
      });
    }

    function checkNoUnnecessaryActFromBlockStatement(
      blockStatementNode: TSESTree.BlockStatement
    ) {
      const functionNode = blockStatementNode.parent as
        | TSESTree.ArrowFunctionExpression
        | TSESTree.FunctionExpression
        | undefined;
      const callExpressionNode = functionNode?.parent as
        | TSESTree.CallExpression
        | undefined;

      if (!callExpressionNode || !functionNode) {
        return;
      }

      const identifierNode = getDeepestIdentifierNode(callExpressionNode);
      if (!identifierNode) {
        return;
      }

      if (!helpers.isActUtil(identifierNode)) {
        return;
      }

      if (isEmptyFunction(functionNode)) {
        context.report({
          node: identifierNode,
          messageId: 'noUnnecessaryActEmptyFunction',
        });
        return;
      }

      const shouldBeReported = isStrict
        ? hasTestingLibraryCall(blockStatementNode.body)
        : !hasSomeNonTestingLibraryCall(blockStatementNode.body);

      if (shouldBeReported) {
        context.report({
          node: identifierNode,
          messageId: 'noUnnecessaryActTestingLibraryUtil',
        });
      }
    }

    function checkNoUnnecessaryActFromImplicitReturn(
      node: TSESTree.CallExpression
    ) {
      const nodeIdentifier = getDeepestIdentifierNode(node);

      if (!nodeIdentifier) {
        return;
      }

      const parentCallExpression = node.parent?.parent as
        | TSESTree.CallExpression
        | undefined;

      if (!parentCallExpression) {
        return;
      }

      const identifierNode = getDeepestIdentifierNode(parentCallExpression);
      if (!identifierNode) {
        return;
      }

      if (!helpers.isActUtil(identifierNode)) {
        return;
      }

      if (!helpers.isTestingLibraryUtil(nodeIdentifier)) {
        return;
      }

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

    return {
      'CallExpression > ArrowFunctionExpression > BlockStatement':
        checkNoUnnecessaryActFromBlockStatement,
      'CallExpression > FunctionExpression > BlockStatement':
        checkNoUnnecessaryActFromBlockStatement,
      'CallExpression > ArrowFunctionExpression > CallExpression':
        checkNoUnnecessaryActFromImplicitReturn,
    };
  },
});