@checkdigit/eslint-plugin 6.6.0-PR.75-20dc → 6.6.0-PR.75-66d8

package/src/fixture/fetch-header-getter.ts

@@ -1,4 +1,4 @@
-// no-fixture.ts
+// fixture/no-fixture.ts
 
 /*
  * Copyright (c) 2021-2024 Check Digit, LLC
@@ -6,12 +6,13 @@
  * This code is licensed under the MIT license (see LICENSE.txt for details).
  */
 
-import type { Identifier, MemberExpression, VariableDeclarator } from 'estree';
+import type { Identifier, VariableDeclarator } from 'estree';
 import type { Rule } from 'eslint';
 import { analyzeResponseReferences } from './response-reference';
 import { strict as assert } from 'node:assert';
 import getDocumentationUrl from '../get-documentation-url';
 import { getParent } from '../ast/tree';
+import { isInvalidResponseHeadersAccess } from './fetch';
 
 export const ruleId = 'fetch-header-getter';
 
@@ -42,12 +43,13 @@ const rule: Rule.RuleModule = {
         );
         assert.ok(responseVariable);
 
-        const directHeaderReferences = responseHeadersReferences
-          .map(getParent)
-          .filter((parent): parent is MemberExpression => parent?.type === 'MemberExpression');
+        const directHeadersReferences = responseHeadersReferences.filter((headersReference) => {
+          const headersAccess = getParent(headersReference);
+          return headersAccess?.type !== 'VariableDeclarator';
+        });
 
-        const indirectHeaderReferences = responseHeadersReferences
-          .map((reference) => getParent(reference))
+        const indirectHeadersReferences = responseHeadersReferences
+          .map(getParent)
           .filter((parent): parent is VariableDeclarator => parent?.type === 'VariableDeclarator')
           .map((declarator) => (declarator.id as Identifier).name)
           .map((redefinedHeadersVariableName) => {
@@ -55,32 +57,31 @@ const rule: Rule.RuleModule = {
               const identifier = variable.identifiers[0];
               return identifier?.type === 'Identifier' && identifier.name === redefinedHeadersVariableName;
             });
-            return (
-              headersVariable?.references
-                .map((reference) => getParent(reference.identifier))
-                .filter((parent): parent is MemberExpression => parent?.type === 'MemberExpression') ?? []
-            );
+            return headersVariable?.references.map((reference) => reference.identifier) ?? [];
           })
           .flat();
 
-        const invalidHeaderReferences = [...directHeaderReferences, ...indirectHeaderReferences].filter(
-          (reference) => !(reference.property.type === 'Identifier' && reference.property.name === 'get'),
+        const invalidHeadersReferences = [...directHeadersReferences, ...indirectHeadersReferences].filter(
+          isInvalidResponseHeadersAccess,
         );
 
-        invalidHeaderReferences.forEach((reference) => {
-          const headerNameNode = reference.property;
-          const headerName = reference.computed
-            ? sourceCode.getText(headerNameNode)
-            : `'${sourceCode.getText(headerNameNode)}'`;
-          const replacementText = `${sourceCode.getText(reference.object)}.get(${headerName})`;
+        invalidHeadersReferences.forEach((headersReference) => {
+          const headerAccess = getParent(headersReference);
+          if (headerAccess?.type === 'MemberExpression') {
+            const headerNameNode = headerAccess.property;
+            const headerName = headerAccess.computed
+              ? sourceCode.getText(headerNameNode)
+              : `'${sourceCode.getText(headerNameNode)}'`;
+            const replacementText = `${sourceCode.getText(headerAccess.object)}.get(${headerName})`;
 
-          context.report({
-            node: reference,
-            messageId: 'shouldUseHeaderGetter',
-            fix(fixer) {
-              return fixer.replaceText(reference, replacementText);
-            },
-          });
+            context.report({
+              node: headerAccess,
+              messageId: 'shouldUseHeaderGetter',
+              fix(fixer) {
+                return fixer.replaceText(headerAccess, replacementText);
+              },
+            });
+          }
         });
       },
     };

package/src/fixture/fetch.ts

@@ -0,0 +1,30 @@
+// fixture/fetch.ts
+
+import type { Node } from 'estree';
+import { getParent } from '../ast/tree';
+
+export function getResponseBodyRetrievalText(responseVariableName: string) {
+  return `await ${responseVariableName}.json()`;
+}
+
+export function isInvalidResponseHeadersAccess(responseHeadersAccess: Node) {
+  const responseHeaderAccessParent = getParent(responseHeadersAccess);
+  if (responseHeaderAccessParent?.type === 'VariableDeclarator') {
+    return false;
+  }
+
+  if (
+    responseHeaderAccessParent?.type === 'CallExpression' &&
+    responseHeaderAccessParent.callee.type === 'MemberExpression' &&
+    responseHeaderAccessParent.callee.property.type === 'Identifier' &&
+    responseHeaderAccessParent.callee.property.name === 'get'
+  ) {
+    return true;
+  }
+
+  return !(
+    responseHeaderAccessParent?.type === 'MemberExpression' &&
+    responseHeaderAccessParent.property.type === 'Identifier' &&
+    responseHeaderAccessParent.property.name === 'get'
+  );
+}

package/src/fixture/no-fixture.ts

@@ -1,4 +1,4 @@
-// no-fixture.ts
+// fixture/no-fixture.ts
 
 /*
  * Copyright (c) 2021-2024 Check Digit, LLC
@@ -22,6 +22,9 @@ import { analyzeResponseReferences } from './response-reference';
 import { strict as assert } from 'node:assert';
 import getDocumentationUrl from '../get-documentation-url';
 import { getIndentation } from '../ast/format';
+import { getResponseBodyRetrievalText } from './fetch';
+import { isValidPropertyName } from './variable';
+import { replaceEndpointUrlPrefixWithBasePath } from './url';
 
 export const ruleId = 'no-fixture';
 
@@ -34,6 +37,7 @@ interface FixtureCallInformation {
   assertions?: Expression[][];
   inlineStatementNode?: Node;
   inlineBodyReference?: MemberExpression;
+  isConcurrent?: boolean;
 }
 
 // recursively analyze the fixture/supertest call chain to collect information of request/response
@@ -46,6 +50,8 @@ function analyzeFixtureCall(call: SimpleCallExpression, results: FixtureCallInfo
     // direct return, no variable declaration or await
     results.fixtureNode = call;
     results.rootNode = parent;
+  } else if (parent.type === 'ArrayExpression') {
+    results.isConcurrent = true;
   } else if (parent.type === 'AwaitExpression') {
     results.fixtureNode = call;
     const enclosingStatement = getEnclosingStatement(parent);
@@ -92,16 +98,6 @@ function analyzeFixtureCall(call: SimpleCallExpression, results: FixtureCallInfo
   }
 }
 
-// `/sample-service/v1/ping` -> `${BASE_PATH}/ping`
-function replaceEndpointUrlPrefixWithBasePath(url: string) {
-  // eslint-disable-next-line no-template-curly-in-string
-  return url.replace(/`\/\w+(?<parts>-\w+)*\/v\d+\//u, '`${BASE_PATH}/');
-}
-
-function isValidPropertyName(name: unknown) {
-  return typeof name === 'string' && /^[a-zA-Z_$][a-zA-Z_$0-9]*$/u.test(name);
-}
-
 // eslint-disable-next-line sonarjs/cognitive-complexity
 function createResponseAssertions(
   fixtureCallInformation: FixtureCallInformation,
@@ -215,10 +211,6 @@ function isResponseBodyRedefinition(responseBodyReference: MemberExpression): bo
   return parent?.type === 'VariableDeclarator' && parent.id.type === 'Identifier';
 }
 
-function getResponseBodyRetrievalText(responseVariableName: string) {
-  return `await ${responseVariableName}.json()`;
-}
-
 const rule: Rule.RuleModule = {
   meta: {
     type: 'suggestion',
@@ -256,6 +248,9 @@ const rule: Rule.RuleModule = {
 
           const fixtureCallInformation = {} as FixtureCallInformation;
           analyzeFixtureCall(fixtureCall, fixtureCallInformation, sourceCode);
+          if (fixtureCallInformation.isConcurrent === true) {
+            return;
+          }
 
           const {
             variable: responseVariable,

package/src/fixture/response-reference.ts

@@ -1,4 +1,4 @@
-// no-fixture.ts
+// fixture/response-reference.ts
 
 /*
  * Copyright (c) 2021-2024 Check Digit, LLC
@@ -52,27 +52,19 @@ export function analyzeResponseReferences(
       // e.g. response.body
       results.bodyReferences = responseReferences.filter(
         (node): node is MemberExpression =>
-          node !== null &&
-          node !== undefined &&
-          node.type === 'MemberExpression' &&
-          node.property.type === 'Identifier' &&
-          node.property.name === 'body',
+          node?.type === 'MemberExpression' && node.property.type === 'Identifier' && node.property.name === 'body',
       );
       // e.g. response.headers / response.header / response.get()
       results.headersReferences = responseReferences.filter(
         (node): node is MemberExpression =>
-          node !== null &&
-          node !== undefined &&
-          node.type === 'MemberExpression' &&
+          node?.type === 'MemberExpression' &&
           node.property.type === 'Identifier' &&
           (node.property.name === 'header' || node.property.name === 'headers' || node.property.name === 'get'),
       );
       // e.g. response.status / response.statusCode
       results.statusReferences = responseReferences.filter(
         (node): node is MemberExpression =>
-          node !== null &&
-          node !== undefined &&
-          node.type === 'MemberExpression' &&
+          node?.type === 'MemberExpression' &&
           node.property.type === 'Identifier' &&
           (node.property.name === 'status' || node.property.name === 'statusCode'),
       );

package/src/fixture/url.ts

@@ -0,0 +1,6 @@
+// fixture/url.ts
+
+export function replaceEndpointUrlPrefixWithBasePath(url: string) {
+  // eslint-disable-next-line no-template-curly-in-string
+  return url.replace(/`\/\w+(?<parts>-\w+)*\/v\d+\//u, '`${BASE_PATH}/');
+}

package/src/fixture/variable.ts

@@ -0,0 +1,5 @@
+// fixture/variable.ts
+
+export function isValidPropertyName(name: unknown) {
+  return typeof name === 'string' && /^[a-zA-Z_$][a-zA-Z_$0-9]*$/u.test(name);
+}

package/src/index.ts

@@ -6,6 +6,7 @@
  * This code is licensed under the MIT license (see LICENSE.txt for details).
  */
 
+import concurrentPromises, { ruleId as concurrentPromisesRuleId } from './fixture/concurrent-promises';
 import fetchHeaderGetter, { ruleId as fetchHeaderGetterRuleId } from './fixture/fetch-header-getter';
 import invalidJsonStringify, { ruleId as invalidJsonStringifyRuleId } from './invalid-json-stringify';
 import noFixture, { ruleId as noFixtureRuleId } from './fixture/no-fixture';
@@ -35,6 +36,7 @@ export default {
     [noPromiseInstanceMethodRuleId]: noPromiseInstanceMethod,
     [noFixtureRuleId]: noFixture,
     [fetchHeaderGetterRuleId]: fetchHeaderGetter,
+    [concurrentPromisesRuleId]: concurrentPromises,
   },
   configs: {
     all: {
@@ -52,6 +54,7 @@ export default {
         [`@checkdigit/${noPromiseInstanceMethodRuleId}`]: 'error',
         [`@checkdigit/${noFixtureRuleId}`]: 'error',
         [`@checkdigit/${fetchHeaderGetterRuleId}`]: 'error',
+        [`@checkdigit/${concurrentPromisesRuleId}`]: 'error',
       },
     },
     recommended: {