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

package/package.json

@@ -1 +1 @@
-{"name":"@checkdigit/eslint-plugin","version":"6.6.0-PR.75-20dc","description":"Check Digit eslint plugins","keywords":["eslint","eslintplugin"],"homepage":"https://github.com/checkdigit/eslint-plugin#readme","bugs":{"url":"https://github.com/checkdigit/eslint-plugin/issues"},"repository":{"type":"git","url":"https://github.com/checkdigit/eslint-plugin"},"license":"MIT","author":"Check Digit, LLC","sideEffects":false,"type":"module","exports":{".":{"types":"./dist-types/index.d.ts","require":"./dist-cjs/index.cjs","import":"./dist-mjs/index.mjs","default":"./dist-mjs/index.mjs"}},"files":["src","dist-types","dist-cjs","dist-mjs","!src/**/*.test.ts","!src/**/*.spec.ts","!dist-types/**/*.test.d.ts","!dist-types/**/*.spec.d.ts","!dist-cjs/**/*.test.cjs","!dist-cjs/**/*.spec.cjs","!dist-mjs/**/*.test.mjs","!dist-mjs/**/*.spec.mjs","SECURITY.md"],"scripts":{"build:dist-cjs":"rimraf dist-cjs && npx builder --type=commonjs --sourceMap --entryPoint=index.ts --outDir=dist-cjs --outFile=index.cjs --external=espree && echo \"module.exports = module.exports.default;\" >> dist-cjs/index.cjs","build:dist-mjs":"rimraf dist-mjs && npx builder --type=module --sourceMap --outDir=dist-mjs && node dist-mjs/index.mjs","build:dist-types":"rimraf dist-types && npx builder --type=types --outDir=dist-types","ci:compile":"tsc --noEmit","ci:coverage":"NODE_OPTIONS=\"--disable-warning ExperimentalWarning --experimental-vm-modules\" jest --coverage=true","ci:lint":"npm run lint","ci:style":"npm run prettier","ci:test":"NODE_OPTIONS=\"--disable-warning ExperimentalWarning --experimental-vm-modules\" jest --coverage=false","lint":"eslint --max-warnings 0 --ignore-path .gitignore .","lint:fix":"eslint --ignore-path .gitignore . --fix","prepublishOnly":"npm run build:dist-types && npm run build:dist-cjs && npm run build:dist-mjs","prettier":"prettier --ignore-path .gitignore --list-different .","prettier:fix":"prettier --ignore-path .gitignore --write .","test":"npm run ci:compile && npm run ci:test && npm run ci:lint && npm run ci:style"},"prettier":"@checkdigit/prettier-config","jest":{"preset":"@checkdigit/jest-config"},"devDependencies":{"@checkdigit/jest-config":"^6.0.2","@checkdigit/prettier-config":"^5.5.0","@checkdigit/typescript-config":"6.0.0","@types/eslint":"^8.56.10","@typescript-eslint/eslint-plugin":"^7.16.1","@typescript-eslint/parser":"^7.16.1","eslint-config-prettier":"^9.1.0","eslint-plugin-eslint-plugin":"^6.2.0","eslint-plugin-import":"^2.29.1","eslint-plugin-no-only-tests":"^3.1.0","eslint-plugin-no-secrets":"^1.0.2","eslint-plugin-node":"^11.1.0","eslint-plugin-sonarjs":"0.24.0"},"peerDependencies":{"eslint":">=8 <9"},"engines":{"node":">=20.14"}}
+{"name":"@checkdigit/eslint-plugin","version":"6.6.0-PR.75-9891","description":"Check Digit eslint plugins","keywords":["eslint","eslintplugin"],"homepage":"https://github.com/checkdigit/eslint-plugin#readme","bugs":{"url":"https://github.com/checkdigit/eslint-plugin/issues"},"repository":{"type":"git","url":"https://github.com/checkdigit/eslint-plugin"},"license":"MIT","author":"Check Digit, LLC","sideEffects":false,"type":"module","exports":{".":{"types":"./dist-types/index.d.ts","require":"./dist-cjs/index.cjs","import":"./dist-mjs/index.mjs","default":"./dist-mjs/index.mjs"}},"files":["src","dist-types","dist-cjs","dist-mjs","!src/**/*.test.ts","!src/**/*.spec.ts","!dist-types/**/*.test.d.ts","!dist-types/**/*.spec.d.ts","!dist-cjs/**/*.test.cjs","!dist-cjs/**/*.spec.cjs","!dist-mjs/**/*.test.mjs","!dist-mjs/**/*.spec.mjs","SECURITY.md"],"scripts":{"build:dist-cjs":"rimraf dist-cjs && npx builder --type=commonjs --sourceMap --entryPoint=index.ts --outDir=dist-cjs --outFile=index.cjs --external=espree && echo \"module.exports = module.exports.default;\" >> dist-cjs/index.cjs","build:dist-mjs":"rimraf dist-mjs && npx builder --type=module --sourceMap --outDir=dist-mjs && node dist-mjs/index.mjs","build:dist-types":"rimraf dist-types && npx builder --type=types --outDir=dist-types","ci:compile":"tsc --noEmit","ci:coverage":"NODE_OPTIONS=\"--disable-warning ExperimentalWarning --experimental-vm-modules\" jest --coverage=true","ci:lint":"npm run lint","ci:style":"npm run prettier","ci:test":"NODE_OPTIONS=\"--disable-warning ExperimentalWarning --experimental-vm-modules\" jest --coverage=false","lint":"eslint --max-warnings 0 --ignore-path .gitignore .","lint:fix":"eslint --ignore-path .gitignore . --fix","prepublishOnly":"npm run build:dist-types && npm run build:dist-cjs && npm run build:dist-mjs","prettier":"prettier --ignore-path .gitignore --list-different .","prettier:fix":"prettier --ignore-path .gitignore --write .","test":"npm run ci:compile && npm run ci:test && npm run ci:lint && npm run ci:style"},"prettier":"@checkdigit/prettier-config","jest":{"preset":"@checkdigit/jest-config"},"devDependencies":{"@checkdigit/jest-config":"^6.0.2","@checkdigit/prettier-config":"^5.5.0","@checkdigit/typescript-config":"6.0.0","@types/eslint":"^8.56.10","@typescript-eslint/eslint-plugin":"^7.16.1","@typescript-eslint/parser":"^7.16.1","eslint-config-prettier":"^9.1.0","eslint-plugin-eslint-plugin":"^6.2.0","eslint-plugin-import":"^2.29.1","eslint-plugin-no-only-tests":"^3.1.0","eslint-plugin-no-secrets":"^1.0.2","eslint-plugin-node":"^11.1.0","eslint-plugin-sonarjs":"0.24.0"},"peerDependencies":{"eslint":">=8 <9"},"engines":{"node":">=20.14"}}

package/src/fixture/concurrent-promises.ts

@@ -0,0 +1,242 @@
+// fixture/concurrent-promises.ts
+
+/*
+ * Copyright (c) 2021-2024 Check Digit, LLC
+ *
+ * This code is licensed under the MIT license (see LICENSE.txt for details).
+ */
+
+import type { CallExpression, Expression, SimpleCallExpression } from 'estree';
+import { type Rule, SourceCode } from 'eslint';
+import { strict as assert } from 'node:assert';
+import getDocumentationUrl from '../get-documentation-url';
+import { getIndentation } from '../ast/format';
+import { getParent } from '../ast/tree';
+import { isValidPropertyName } from './variable';
+import { replaceEndpointUrlPrefixWithBasePath } from './url';
+
+export const ruleId = 'concurrent-promises';
+
+interface FixtureCallInformation {
+  fixtureNode: SimpleCallExpression;
+  requestBody?: Expression;
+  requestHeaders?: { name: Expression; value: Expression }[];
+  assertions?: Expression[][];
+}
+
+// recursively analyze the fixture/supertest call chain to collect information of request/response
+function analyzeFixtureCall(call: SimpleCallExpression, results: FixtureCallInformation, sourceCode: SourceCode) {
+  const parent = getParent(call);
+  if (!parent) {
+    return;
+  }
+
+  let nextCall;
+  if (parent.type === 'ArrayExpression') {
+    results.fixtureNode = call;
+  } else if (parent.type === 'MemberExpression' && parent.property.type === 'Identifier') {
+    if (parent.property.name === 'expect') {
+      // supertest assertions
+      const assertionCall = getParent(parent);
+      assert.ok(assertionCall && assertionCall.type === 'CallExpression');
+      results.assertions = [...(results.assertions ?? []), assertionCall.arguments as Expression[]];
+      nextCall = assertionCall;
+    } else if (parent.property.name === 'send') {
+      // request body
+      const sendRequestBodyCall = getParent(parent);
+      assert.ok(sendRequestBodyCall && sendRequestBodyCall.type === 'CallExpression');
+      results.requestBody = sendRequestBodyCall.arguments[0] as Expression;
+      nextCall = sendRequestBodyCall;
+    } else if (parent.property.name === 'set') {
+      // request headers
+      const setRequestHeaderCall = getParent(parent);
+      assert.ok(setRequestHeaderCall && setRequestHeaderCall.type === 'CallExpression');
+      const [name, value] = setRequestHeaderCall.arguments as [Expression, Expression];
+      results.requestHeaders = [...(results.requestHeaders ?? []), { name, value }];
+      nextCall = setRequestHeaderCall;
+    }
+  } else {
+    throw new Error(`Unexpected expression in fixture/supertest call ${sourceCode.getText(parent)}.`);
+  }
+  if (nextCall) {
+    analyzeFixtureCall(nextCall, results, sourceCode);
+  }
+}
+
+// eslint-disable-next-line sonarjs/cognitive-complexity
+function createResponseAssertions(
+  fixtureCallInformation: FixtureCallInformation,
+  sourceCode: SourceCode,
+  responseVariableName: string,
+) {
+  let statusAssertion: string | undefined;
+  const nonStatusAssertions: string[] = [];
+  for (const expectArguments of fixtureCallInformation.assertions ?? []) {
+    if (expectArguments.length === 1) {
+      const [assertionArgument] = expectArguments;
+      assert.ok(assertionArgument);
+      if (
+        (assertionArgument.type === 'MemberExpression' &&
+          assertionArgument.object.type === 'Identifier' &&
+          assertionArgument.object.name === 'StatusCodes') ||
+        assertionArgument.type === 'Literal' ||
+        sourceCode.getText(assertionArgument).includes('StatusCodes.')
+      ) {
+        // status code assertion
+        statusAssertion = `assert.equal(${responseVariableName}.status, ${sourceCode.getText(assertionArgument)})`;
+      } else if (assertionArgument.type === 'ArrowFunctionExpression') {
+        // callback assertion using arrow function
+        let functionBody = sourceCode.getText(assertionArgument.body);
+
+        const [originalResponseArgument] = assertionArgument.params;
+        assert.ok(originalResponseArgument?.type === 'Identifier');
+        const originalResponseArgumentName = originalResponseArgument.name;
+        if (originalResponseArgumentName !== responseVariableName) {
+          functionBody = functionBody.replace(
+            new RegExp(`\\b${originalResponseArgumentName}\\b`, 'ug'),
+            responseVariableName,
+          );
+        }
+        nonStatusAssertions.push(`assert.ok(${functionBody})`);
+      } else if (assertionArgument.type === 'Identifier') {
+        // callback assertion using function reference
+        nonStatusAssertions.push(`assert.ok(${sourceCode.getText(assertionArgument)}(${responseVariableName}))`);
+      } else if (assertionArgument.type === 'ObjectExpression' || assertionArgument.type === 'CallExpression') {
+        // body deep equal assertion
+        nonStatusAssertions.push(
+          `assert.deepEqual(await ${responseVariableName}.json(), ${sourceCode.getText(assertionArgument)})`,
+        );
+      } else {
+        throw new Error(`Unexpected Supertest assertion argument: ".expect(${sourceCode.getText(assertionArgument)})`);
+      }
+    } else if (expectArguments.length === 2) {
+      // header assertion
+      const [headerName, headerValue] = expectArguments;
+      assert.ok(headerName && headerValue);
+      const headersReference = `${responseVariableName}.headers`;
+      if (headerValue.type === 'Literal' && headerValue.value instanceof RegExp) {
+        nonStatusAssertions.push(
+          `assert.ok(${headersReference}.get(${sourceCode.getText(headerName)}).match(${sourceCode.getText(headerValue)}))`,
+        );
+      } else {
+        nonStatusAssertions.push(
+          `assert.equal(${headersReference}.get(${sourceCode.getText(headerName)}), ${sourceCode.getText(headerValue)})`,
+        );
+      }
+    }
+  }
+  return {
+    statusAssertion,
+    nonStatusAssertions,
+  };
+}
+
+const rule: Rule.RuleModule = {
+  meta: {
+    type: 'suggestion',
+    docs: {
+      description: 'Prefer native fetch API over customized fixture API.',
+      url: getDocumentationUrl(ruleId),
+    },
+    messages: {
+      preferNativeFetch: 'Prefer native fetch API over customized fixture API.',
+      unknownError:
+        'Unknown error occurred in file "{{fileName}}": {{ error }}. Please manually convert the fixture API call to fetch API call.',
+    },
+    fixable: 'code',
+    schema: [],
+  },
+  // eslint-disable-next-line max-lines-per-function
+  create(context) {
+    const sourceCode = context.sourceCode;
+
+    return {
+      // eslint-disable-next-line max-lines-per-function
+      'CallExpression[callee.object.name="Promise"] > ArrayExpression CallExpression[callee.object.object.name="fixture"][callee.object.property.name="api"]':
+        (fixtureCall: CallExpression) => {
+          try {
+            assert.ok(fixtureCall.type === 'CallExpression');
+            const fixtureFunction = fixtureCall.callee; // e.g. fixture.api.get
+            assert.ok(fixtureFunction.type === 'MemberExpression');
+            const indentation = getIndentation(fixtureCall, sourceCode);
+
+            const [urlArgumentNode] = fixtureCall.arguments; // e.g. `/sample-service/v1/ping`
+            assert.ok(urlArgumentNode !== undefined);
+
+            const fixtureCallInformation = {} as FixtureCallInformation;
+            analyzeFixtureCall(fixtureCall, fixtureCallInformation, sourceCode);
+
+            // convert url from `/sample-service/v1/ping` to `${BASE_PATH}/ping`
+            const originalUrlArgumentText = sourceCode.getText(urlArgumentNode);
+            const fetchUrlArgumentText = replaceEndpointUrlPrefixWithBasePath(originalUrlArgumentText);
+
+            // fetch request argument
+            const methodNode = fixtureFunction.property; // get/put/etc.
+            assert.ok(methodNode.type === 'Identifier');
+            const fetchRequestArgumentLines = [
+              '{',
+              `  method: '${methodNode.name.toUpperCase()}',`,
+              ...(fixtureCallInformation.requestBody
+                ? [`  body: JSON.stringify(${sourceCode.getText(fixtureCallInformation.requestBody)}),`]
+                : []),
+              ...(fixtureCallInformation.requestHeaders
+                ? [
+                    `  headers: {`,
+                    ...fixtureCallInformation.requestHeaders.map(
+                      ({ name, value }) =>
+                        // eslint-disable-next-line @typescript-eslint/restrict-template-expressions, no-nested-ternary, sonarjs/no-nested-template-literals
+                        `    ${name.type === 'Literal' ? (isValidPropertyName(name.value) ? name.value : `'${name.value}'`) : `[${sourceCode.getText(name)}]`}: ${sourceCode.getText(value)},`,
+                    ),
+                    `  },`,
+                  ]
+                : []),
+              '}',
+            ].join(`\n${indentation}`);
+
+            const responseVariableNameToUse = 'res';
+            const { statusAssertion, nonStatusAssertions } = createResponseAssertions(
+              fixtureCallInformation,
+              sourceCode,
+              responseVariableNameToUse,
+            );
+
+            // add variable declaration if needed
+            const disableLintComment = '// eslint-disable-next-line @checkdigit/no-promise-instance-method';
+            const fetchCallText = `fetch(${fetchUrlArgumentText}, ${fetchRequestArgumentLines})`;
+            const appendingAssignmentAndAssertionText = [
+              ...(statusAssertion !== undefined ? [statusAssertion] : []),
+              ...nonStatusAssertions,
+            ].join(`;\n${indentation}`);
+            const replacementText = [
+              disableLintComment,
+              `${fetchCallText}.then((${responseVariableNameToUse}) => {`,
+              appendingAssignmentAndAssertionText === '' ? '' : `  ${appendingAssignmentAndAssertionText};`,
+              `  return ${responseVariableNameToUse};`,
+              `})`,
+            ].join(`\n${indentation}`);
+
+            context.report({
+              node: fixtureCall,
+              messageId: 'preferNativeFetch',
+              fix(fixer) {
+                return fixer.replaceText(fixtureCallInformation.fixtureNode, replacementText);
+              },
+            });
+          } catch (error) {
+            // eslint-disable-next-line no-console
+            console.error(`Failed to apply ${ruleId} rule for file "${context.filename}":`, error);
+            context.report({
+              node: fixtureCall,
+              messageId: 'unknownError',
+              data: {
+                fileName: context.filename,
+                error: error instanceof Error ? error.toString() : JSON.stringify(error),
+              },
+            });
+          }
+        },
+    };
+  },
+};
+
+export default rule;

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

package/src/fixture/fetch.ts

@@ -0,0 +1,5 @@
+// fixture/fetch.ts
+
+export function getResponseBodyRetrievalText(responseVariableName: string) {
+  return `await ${responseVariableName}.json()`;
+}

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';
 
@@ -92,16 +95,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 +208,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',

package/src/fixture/response-reference.ts

@@ -1,4 +1,4 @@
-// no-fixture.ts
+// fixture/response-reference.ts
 
 /*
  * Copyright (c) 2021-2024 Check Digit, LLC

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: {