feat: add support for waitForElementToBeRemoved

Author: thomaslombart

lib/rules/no-get-by-for-absent-elements.js

@@ -23,9 +23,10 @@ module.exports = {
   },
 
   create: context => ({
-    [`CallExpression > Identifier[name=/getBy|getAllBy/]`](node) {
-      const expectCallNode = findClosestExpectStatement(node);
+    [`Identifier[name=/getBy|getAllBy/]`](node) {
+      const expectCallNode = findClosestCallNode(node, 'expect');
 
+      // expect(getByText("foo"))...
       if (expectCallNode) {
         const expectStatement = expectCallNode.parent;
         const matcher = expectStatement.property.name;
@@ -48,18 +49,30 @@ module.exports = {
           });
         }
       }
+
+      const waitCallNode = findClosestCallNode(
+        node,
+        'waitForElementToBeRemoved'
+      );
+
+      if (waitCallNode) {
+        return context.report({
+          node,
+          messageId: 'expectQueryBy',
+        });
+      }
     },
   }),
 };
 
-function findClosestExpectStatement(node) {
+function findClosestCallNode(node, name) {
   if (!node.parent) {
     return false;
   }
 
-  if (node.type === 'CallExpression' && node.callee.name === 'expect') {
+  if (node.type === 'CallExpression' && node.callee.name === name) {
     return node;
   } else {
-    return findClosestExpectStatement(node.parent);
+    return findClosestCallNode(node.parent, name);
   }
 }

tests/lib/rules/no-get-by-for-absent-elements.js

@@ -5,28 +5,23 @@ const rule = require('../../../lib/rules/no-get-by-for-absent-elements');
 const { ALL_QUERIES_METHODS } = require('../../../lib/utils');
 
 const ruleTester = new RuleTester({
-  parserOptions: { ecmaVersion: 2015, sourceType: 'module' },
+  parserOptions: { ecmaVersion: 2017, sourceType: 'module' },
 });
 
-const queryByVariants = ALL_QUERIES_METHODS.reduce(
-  (variants, method) => [
-    ...variants,
-    ...[`query${method}`, `queryAll${method}`],
-  ],
-  []
-);
 const getByVariants = ALL_QUERIES_METHODS.reduce(
   (variants, method) => [...variants, ...[`get${method}`, `getAll${method}`]],
   []
 );
 
 ruleTester.run('prefer-expect-query-by', rule, {
-  valid: queryByVariants.reduce(
+  valid: getByVariants.reduce(
     (validRules, queryName) => [
       ...validRules,
       { code: `expect(${queryName}('Hello')).toBeInTheDocument()` },
       { code: `expect(${queryName}('Hello')).toBe("foo")` },
       { code: `expect(${queryName}('Hello')).toBeTruthy()` },
+      { code: `expect(rendered.${queryName}('Hello')).toEqual("World")` },
+      { code: `expect(rendered.${queryName}('Hello')).not.toBeFalsy()` },
     ],
     []
   ),
@@ -53,6 +48,22 @@ ruleTester.run('prefer-expect-query-by', rule, {
         code: `expect(${queryName}('Hello')).toBeFalsy()`,
         errors: [{ messageId: 'expectQueryBy' }],
       },
+      {
+        code: `expect(rendered.${queryName}('Hello')).toBeFalsy()`,
+        errors: [{ messageId: 'expectQueryBy' }],
+      },
+      {
+        code: `expect(rendered.${queryName}('Hello')).not.toBeTruthy()`,
+        errors: [{ messageId: 'expectQueryBy' }],
+      },
+      {
+        code: `(async () => {
+          await waitForElementToBeRemoved(() => {
+            return getByText("hello")
+          })
+        })()`,
+        errors: [{ messageId: 'expectQueryBy' }],
+      },
     ],
     []
   ),