refactor(refactor no-debug): migrate to v4 (#293)

* refactor(no-debug): use new rule creator * test(no-debug): improve current invalid error assertions * docs(no-debug): fix typo * refactor(no-debug): report debug call expressions with detection helpers * refactor(no-debug): report debug from renders with detection helpers * refactor(no-debug): remove unnecessary checks
testing-library · Mar 20, 2021 · 9bcf595 · 9bcf595
1 parent ea62638
commit 9bcf595
Show file tree

Hide file tree

Showing 5 changed files with 343 additions and 157 deletions.
diff --git a/docs/rules/no-debug.md b/docs/rules/no-debug.md
@@ -1,6 +1,6 @@
 # Disallow the use of `debug` (no-debug)
 
-Just like `console.log` statements pollutes the browser's output, debug statements also pollutes the tests if one of your team mates forgot to remove it. `debug` statements should be used when you actually want to debug your tests but should not be pushed to the codebase.
+Just like `console.log` statements pollutes the browser's output, debug statements also pollutes the tests if one of your teammates forgot to remove it. `debug` statements should be used when you actually want to debug your tests but should not be pushed to the codebase.
 
 ## Rule Details
 
@@ -28,12 +28,6 @@ const { screen } = require('@testing-library/react');
 screen.debug();
 ```
 
-If you use [custom render functions](https://testing-library.com/docs/example-react-redux) then you can set a config option in your `.eslintrc` to look for these.
-
-```
-   "testing-library/no-debug": ["error", {"renderFunctions":["renderWithRedux", "renderWithRouter"]}],
-```
-
 ## Further Reading
 
 - [debug API in React Testing Library](https://testing-library.com/docs/react-testing-library/api#debug)

diff --git a/lib/detect-testing-library-utils.ts b/lib/detect-testing-library-utils.ts
@@ -69,6 +69,7 @@ type IsAsyncUtilFn = (
 ) => boolean;
 type IsFireEventMethodFn = (node: TSESTree.Identifier) => boolean;
 type IsRenderUtilFn = (node: TSESTree.Identifier) => boolean;
+type IsDebugUtilFn = (node: TSESTree.Identifier) => boolean;
 type IsPresenceAssertFn = (node: TSESTree.MemberExpression) => boolean;
 type IsAbsenceAssertFn = (node: TSESTree.MemberExpression) => boolean;
 type CanReportErrorsFn = () => boolean;
@@ -96,6 +97,7 @@ export interface DetectionHelpers {
   isAsyncUtil: IsAsyncUtilFn;
   isFireEventMethod: IsFireEventMethodFn;
   isRenderUtil: IsRenderUtilFn;
+  isDebugUtil: IsDebugUtilFn;
   isPresenceAssert: IsPresenceAssertFn;
   isAbsenceAssert: IsAbsenceAssertFn;
   canReportErrors: CanReportErrorsFn;
@@ -406,6 +408,17 @@ export function detectTestingLibraryUtils<
       );
     };
 
+    const isDebugUtil: IsDebugUtilFn = (node) => {
+      return isTestingLibraryUtil(
+        node,
+        (identifierNodeName, originalNodeName) => {
+          return [identifierNodeName, originalNodeName]
+            .filter(Boolean)
+            .includes('debug');
+        }
+      );
+    };
+
     /**
      * Determines whether a given MemberExpression node is a presence assert
      *
@@ -549,6 +562,7 @@ export function detectTestingLibraryUtils<
       isAsyncUtil,
       isFireEventMethod,
       isRenderUtil,
+      isDebugUtil,
       isPresenceAssert,
       isAbsenceAssert,
       canReportErrors,

diff --git a/lib/node-utils.ts b/lib/node-utils.ts
@@ -392,7 +392,7 @@ export function getPropertyIdentifierNode(
 }
 
 /**
- * Gets the deepest identifier node from a given node.
+ * Gets the deepest identifier node in the expression from a given node.
  *
  * Opposite of {@link getReferenceNode}
  *
@@ -416,11 +416,15 @@ export function getDeepestIdentifierNode(
     return getDeepestIdentifierNode(node.callee);
   }
 
+  if (ASTUtils.isAwaitExpression(node)) {
+    return getDeepestIdentifierNode(node.argument);
+  }
+
   return null;
 }
 
 /**
- * Gets the farthest node from a given node.
+ * Gets the farthest node in the expression from a given node.
  *
  * Opposite of {@link getDeepestIdentifierNode}
 

diff --git a/lib/rules/no-debug.ts b/lib/rules/no-debug.ts
@@ -1,28 +1,18 @@
 import {
-  ESLintUtils,
-  TSESTree,
-  ASTUtils,
-} from '@typescript-eslint/experimental-utils';
-import {
-  getDocsUrl,
-  LIBRARY_MODULES,
-  hasTestingLibraryImportModule,
-} from '../utils';
-import {
+  getDeepestIdentifierNode,
+  getPropertyIdentifierNode,
+  getReferenceNode,
   isObjectPattern,
   isProperty,
-  isCallExpression,
-  isLiteral,
-  isMemberExpression,
-  isImportSpecifier,
-  isRenderVariableDeclarator,
 } from '../node-utils';
+import { createTestingLibraryRule } from '../create-testing-library-rule';
+import { ASTUtils, TSESTree } from '@typescript-eslint/experimental-utils';
 
 export const RULE_NAME = 'no-debug';
 export type MessageIds = 'noDebug';
-type Options = [{ renderFunctions?: string[] }];
+type Options = [];
 
-export default ESLintUtils.RuleCreator(getDocsUrl)<Options, MessageIds>({
+export default createTestingLibraryRule<Options, MessageIds>({
   name: RULE_NAME,
   meta: {
     type: 'problem',
@@ -46,154 +36,67 @@ export default ESLintUtils.RuleCreator(getDocsUrl)<Options, MessageIds>({
       },
     ],
   },
-  defaultOptions: [
-    {
-      renderFunctions: [],
-    },
-  ],
-
-  create(context, [options]) {
-    let hasDestructuredDebugStatement = false;
-    const renderVariableDeclarators: TSESTree.VariableDeclarator[] = [];
-
-    const { renderFunctions } = options;
+  defaultOptions: [],
 
-    let hasImportedScreen = false;
-    let wildcardImportName: string = null;
+  create(context, [], helpers) {
+    const suspiciousDebugVariableNames: string[] = [];
+    const suspiciousReferenceNodes: TSESTree.Identifier[] = [];
 
     return {
       VariableDeclarator(node) {
-        if (isRenderVariableDeclarator(node, ['render', ...renderFunctions])) {
-          if (
-            isObjectPattern(node.id) &&
-            node.id.properties.some(
-              (property) =>
-                isProperty(property) &&
-                ASTUtils.isIdentifier(property.key) &&
-                property.key.name === 'debug'
-            )
-          ) {
-            hasDestructuredDebugStatement = true;
-          }
-
-          if (node.id.type === 'Identifier') {
-            renderVariableDeclarators.push(node);
-          }
-        }
-      },
-      [`VariableDeclarator > CallExpression > Identifier[name="require"]`](
-        node: TSESTree.Identifier
-      ) {
-        const { arguments: args } = node.parent as TSESTree.CallExpression;
+        const initIdentifierNode = getDeepestIdentifierNode(node.init);
 
-        const literalNodeScreenModuleName = args.find(
-          (args) =>
-            isLiteral(args) &&
-            typeof args.value === 'string' &&
-            LIBRARY_MODULES.includes(args.value)
-        );
-
-        if (!literalNodeScreenModuleName) {
+        if (!helpers.isRenderUtil(initIdentifierNode)) {
           return;
         }
 
-        const declaratorNode = node.parent
-          .parent as TSESTree.VariableDeclarator;
-
-        hasImportedScreen =
-          isObjectPattern(declaratorNode.id) &&
-          declaratorNode.id.properties.some(
-            (property) =>
+        // find debug obtained from render and save their name, like:
+        // const { debug } = render();
+        if (isObjectPattern(node.id)) {
+          for (const property of node.id.properties) {
+            if (
               isProperty(property) &&
               ASTUtils.isIdentifier(property.key) &&
-              property.key.name === 'screen'
-          );
-      },
-      // checks if import has shape:
-      // import { screen } from '@testing-library/dom';
-      ImportDeclaration(node: TSESTree.ImportDeclaration) {
-        if (!hasTestingLibraryImportModule(node)) {
-          return;
-        }
-
-        hasImportedScreen = node.specifiers.some(
-          (s) => isImportSpecifier(s) && s.imported.name === 'screen'
-        );
-      },
-      // checks if import has shape:
-      // import * as dtl from '@testing-library/dom';
-      'ImportDeclaration ImportNamespaceSpecifier'(
-        node: TSESTree.ImportNamespaceSpecifier
-      ) {
-        const importDeclarationNode = node.parent as TSESTree.ImportDeclaration;
-        if (!hasTestingLibraryImportModule(importDeclarationNode)) {
-          return;
+              property.key.name === 'debug'
+            ) {
+              suspiciousDebugVariableNames.push(
+                getDeepestIdentifierNode(property.value).name
+              );
+            }
+          }
         }
 
-        wildcardImportName = node.local && node.local.name;
-      },
-      [`CallExpression > Identifier[name="debug"]`](node: TSESTree.Identifier) {
-        if (hasDestructuredDebugStatement) {
-          context.report({
-            node,
-            messageId: 'noDebug',
-          });
+        // find utils kept from render and save their node, like:
+        // const utils = render();
+        if (ASTUtils.isIdentifier(node.id)) {
+          suspiciousReferenceNodes.push(node.id);
         }
       },
-      [`CallExpression > MemberExpression > Identifier[name="debug"]`](
-        node: TSESTree.Identifier
-      ) {
-        const memberExpression = node.parent as TSESTree.MemberExpression;
-        const identifier = memberExpression.object as TSESTree.Identifier;
-        const memberExpressionName = identifier.name;
-        /*
-         check if `debug` used following the pattern:
-
-            import { screen } from '@testing-library/dom';
-            ...
-            screen.debug();
-        */
-        const isScreenDebugUsed =
-          hasImportedScreen && memberExpressionName === 'screen';
-
-        /*
-         check if `debug` used following the pattern:
-
-            import * as dtl from '@testing-library/dom';
-            ...
-            dtl.debug();
-        */
-        const isNamespaceDebugUsed =
-          wildcardImportName && memberExpressionName === wildcardImportName;
+      CallExpression(node) {
+        const callExpressionIdentifier = getDeepestIdentifierNode(node);
+        const referenceNode = getReferenceNode(node);
+        const referenceIdentifier = getPropertyIdentifierNode(referenceNode);
+
+        const isDebugUtil = helpers.isDebugUtil(callExpressionIdentifier);
+        const isDeclaredDebugVariable = suspiciousDebugVariableNames.includes(
+          callExpressionIdentifier.name
+        );
+        const isChainedReferenceDebug = suspiciousReferenceNodes.some(
+          (suspiciousReferenceIdentifier) => {
+            return (
+              callExpressionIdentifier.name === 'debug' &&
+              suspiciousReferenceIdentifier.name === referenceIdentifier.name
+            );
+          }
+        );
 
-        if (isScreenDebugUsed || isNamespaceDebugUsed) {
+        if (isDebugUtil || isDeclaredDebugVariable || isChainedReferenceDebug) {
           context.report({
-            node,
+            node: callExpressionIdentifier,
             messageId: 'noDebug',
           });
         }
       },
-      'Program:exit'() {
-        renderVariableDeclarators.forEach((renderVar) => {
-          const renderVarReferences = context
-            .getDeclaredVariables(renderVar)[0]
-            .references.slice(1);
-          renderVarReferences.forEach((ref) => {
-            const parent = ref.identifier.parent;
-            if (
-              isMemberExpression(parent) &&
-              ASTUtils.isIdentifier(parent.property) &&
-              parent.property.name === 'debug' &&
-              isCallExpression(parent.parent)
-            ) {
-              context.report({
-                node: parent.property,
-                messageId: 'noDebug',
-              });
-            }
-          });
-        });
-      },
     };
   },
 });