@checkdigit/eslint-plugin 7.5.0 → 7.6.0-PR.75-5da1

package/src/agent/response-reference.ts

@@ -0,0 +1,129 @@
+// agent/response-reference.ts
+
+/*
+ * Copyright (c) 2021-2024 Check Digit, LLC
+ *
+ * This code is licensed under the MIT license (see LICENSE.txt for details).
+ */
+
+import { strict as assert } from 'node:assert';
+import type { MemberExpression, ObjectPattern, VariableDeclaration } from 'estree';
+import { type Scope } from 'eslint';
+import debug from 'debug';
+
+import { getParent } from '../library/tree';
+
+const log = debug('eslint-plugin:response-reference');
+
+/**
+ * analyze response related variables and their references
+ * the implementation is for fixture API, but it can be used for fetch API as well since the tree structure is similar
+ * @param variableDeclaration - variable declaration node
+ */
+export function analyzeResponseReferences(
+  variableDeclaration: VariableDeclaration | undefined,
+  scopeManager: Scope.ScopeManager,
+): {
+  variable?: Scope.Variable;
+  bodyReferences: MemberExpression[];
+  headersReferences: MemberExpression[];
+  statusReferences: MemberExpression[];
+  destructuringBodyVariable?: Scope.Variable | ObjectPattern;
+  destructuringHeadersVariable?: Scope.Variable | ObjectPattern;
+  destructuringHeadersReferences?: MemberExpression[] | undefined;
+} {
+  const results: {
+    variable?: Scope.Variable;
+    bodyReferences: MemberExpression[];
+    headersReferences: MemberExpression[];
+    statusReferences: MemberExpression[];
+    destructuringBodyVariable?: Scope.Variable | ObjectPattern;
+    destructuringHeadersVariable?: Scope.Variable | ObjectPattern;
+    destructuringHeadersReferences?: MemberExpression[] | undefined;
+  } = {
+    bodyReferences: [],
+    headersReferences: [],
+    statusReferences: [],
+  };
+  if (!variableDeclaration) {
+    return results;
+  }
+
+  const responseVariables = scopeManager.getDeclaredVariables(variableDeclaration);
+  for (const responseVariable of responseVariables) {
+    const identifier = responseVariable.identifiers[0];
+    assert.ok(identifier);
+    const identifierParent = getParent(identifier);
+    assert.ok(identifierParent);
+    if (identifierParent.type === 'VariableDeclarator') {
+      // e.g. const response = ...
+      results.variable = responseVariable;
+      const responseReferences = responseVariable.references.map((responseReference) =>
+        getParent(responseReference.identifier),
+      );
+      // e.g. response.body
+      results.bodyReferences = responseReferences.filter(
+        (node): node is MemberExpression =>
+          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?.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?.type === 'MemberExpression' &&
+          node.property.type === 'Identifier' &&
+          (node.property.name === 'status' || node.property.name === 'statusCode'),
+      );
+    } else if (
+      // body reference through destruction/renaming, e.g. "const { body } = ..."
+      identifierParent.type === 'Property' &&
+      identifierParent.key.type === 'Identifier' &&
+      identifierParent.key.name === 'body'
+    ) {
+      results.destructuringBodyVariable = responseVariable;
+    } else if (
+      // header reference through destruction/renaming, e.g. "const { headers } = ..."
+      identifierParent.type === 'Property' &&
+      identifierParent.key.type === 'Identifier' &&
+      identifierParent.key.name === 'headers'
+    ) {
+      results.destructuringHeadersVariable = responseVariable;
+      results.destructuringHeadersReferences = responseVariable.references
+        .map((reference) => reference.identifier)
+        .map(getParent)
+        .filter(
+          (parent): parent is MemberExpression =>
+            parent?.type === 'MemberExpression' &&
+            parent.property.type === 'Identifier' &&
+            parent.property.name !== 'get' &&
+            getParent(parent)?.type !== 'CallExpression',
+        );
+    } else if (identifierParent.type === 'Property') {
+      const parent = getParent(identifierParent);
+      if (parent?.type === 'ObjectPattern') {
+        // body reference through nested destruction, e.g. "const { body: {bodyPropertyName: renamedBodyPropertyName}, headers: {headerPropertyName: renamedHeaderPropertyName} } = ..."
+        const parent2 = getParent(parent);
+        if (parent2?.type === 'Property' && parent2.key.type === 'Identifier' && parent2.key.name === 'body') {
+          results.destructuringBodyVariable = parent;
+        }
+        if (
+          parent2?.type === 'Property' &&
+          parent2.key.type === 'Identifier' &&
+          (parent2.key.name === 'header' || parent2.key.name === 'headers')
+        ) {
+          results.destructuringHeadersVariable = parent;
+        }
+      }
+    } else {
+      log('+++++++ can not handle identifierParent', identifierParent);
+      throw new Error(`Unknown response variable reference: ${responseVariable.name}`);
+    }
+  }
+  return results;
+}

package/src/agent/url.ts

@@ -0,0 +1,32 @@
+// agent/url.ts
+
+// eslint-disable-next-line @typescript-eslint/no-inferrable-types
+const PLAIN_URL_REGEXP: RegExp = /^[`']\/\w+(?<serviceNamePart>-\w+)*\/v\d+\/(?<any>.|\r|\n)+[`']$/u;
+// eslint-disable-next-line @typescript-eslint/no-inferrable-types
+const TOKENIZED_URL_REGEXP: RegExp = /^`\$\{(?<serviceNamePart>[A-Z]+_)*BASE_PATH\}\/(?<any>.|\r|\n)+`$/u;
+
+export function isServiceApiCallUrl(url: string): boolean {
+  return PLAIN_URL_REGEXP.test(url) || TOKENIZED_URL_REGEXP.test(url);
+}
+
+export function replaceEndpointUrlPrefixWithBasePath(url: string): string {
+  return url.replace(
+    /^(?<quotStart>[`'])\/(?<servicename>\w+(?<parts>-\w+)*)(?<path>\/v\d+\/)(?<endpoint>(?<any>.|\r|\n)+)(?<quotEnd>[`'])$/u,
+    // eslint-disable-next-line no-template-curly-in-string
+    '`${BASE_PATH}/$5`',
+  );
+}
+
+export function replaceEndpointUrlPrefixWithDomain(url: string): string {
+  return url.replace(
+    /^(?<quotStart>[`'])\/(?<servicename>\w+(?<parts>-\w+)*)(?<path>\/v\d+\/(?<any>.|\r|\n)+(?<quotEnd>[`'])$)/u,
+    '$1https://$2.checkdigit/$2$4',
+  );
+}
+
+export function addBasePathUrlDomain(url: string): string {
+  return url.replace(
+    /^(?<quotStart>[`'])\/(?<servicename>\w+(?<parts>-\w+)*)(?<path>\/v\d+(?<quotEnd>[`'])$)/u,
+    '$1https://$2.checkdigit/$2$4',
+  );
+}

package/src/index.ts

@@ -8,10 +8,30 @@
 
 import type { TSESLint } from '@typescript-eslint/utils';
 
+import addUrlDomain, { ruleId as addUrlDomainRuleId } from './agent/add-url-domain';
+import agentTestWiring, { ruleId as agentTestWiringRuleId } from './agent/agent-test-wiring';
+import fetchResponseBodyJson, { ruleId as fetchResponseBodyJsonRuleId } from './agent/fetch-response-body-json';
+import fetchResponseHeaderGetter, {
+  ruleId as fetchResponseHeaderGetterRuleId,
+} from './agent/fetch-response-header-getter';
+import fetchResponseStatus, { ruleId as fetchResponseStatusRuleId } from './agent/fetch-response-status';
+import fetchThen, { ruleId as fetchThenRuleId } from './agent/fetch-then';
+import fixFunctionCallArguments, {
+  ruleId as fixFunctionCallArgumentsRuleId,
+} from './agent/fix-function-call-arguments';
 import invalidJsonStringify, { ruleId as invalidJsonStringifyRuleId } from './invalid-json-stringify';
 import noDuplicatedImports, { ruleId as noDuplicatedImportsRuleId } from './no-duplicated-imports';
+import noFixture, { ruleId as noFixtureRuleId } from './agent/no-fixture';
 import noLegacyServiceTyping, { ruleId as noLegacyServiceTypingRuleId } from './no-legacy-service-typing';
+import noMappedResponse, { ruleId as noMappedResponseRuleId } from './agent/no-mapped-response';
 import noPromiseInstanceMethod, { ruleId as noPromiseInstanceMethodRuleId } from './no-promise-instance-method';
+import noServiceWrapper, { ruleId as noServiceWrapperRuleId } from './agent/no-service-wrapper';
+import noStatusCode, { ruleId as noStatusCodeRuleId } from './agent/no-status-code';
+import noUnusedFunctionArguments, {
+  ruleId as noUnusedFunctionArgumentsRuleId,
+} from './agent/no-unused-function-argument';
+import noUnusedImports, { ruleId as noUnusedImportsRuleId } from './agent/no-unused-imports';
+import noUnusedServiceVariables, { ruleId as noUnusedServiceVariablesRuleId } from './agent/no-unused-service-variable';
 import requireFixedServicesImport, {
   ruleId as requireFixedServicesImportRuleId,
 } from './require-fixed-services-import';
@@ -22,6 +42,9 @@ import requireTypeOutOfTypeOnlyImports, {
   ruleId as requireTypeOutOfTypeOnlyImportsRuleId,
 } from './require-type-out-of-type-only-imports';
 import noServeRuntime, { ruleId as noServeRuntimeRuleId } from './no-serve-runtime';
+import addBasePathConst, { ruleId as addBasePathConstRuleId } from './agent/add-base-path-const';
+import addBasePathImport, { ruleId as addBasePathImportRuleId } from './agent/add-base-path-import';
+import addAssertImport, { ruleId as addAssertImportRuleId } from './agent/add-assert-import';
 import filePathComment from './file-path-comment';
 import noCardNumbers from './no-card-numbers';
 import noSideEffects from './no-side-effects';
@@ -48,12 +71,29 @@ const rules: Record<string, TSESLint.LooseRuleDefinition> = {
   'object-literal-response': objectLiteralResponse,
   [invalidJsonStringifyRuleId]: invalidJsonStringify,
   [noPromiseInstanceMethodRuleId]: noPromiseInstanceMethod,
+  [noFixtureRuleId]: noFixture,
+  [fetchThenRuleId]: fetchThen,
+  [noServiceWrapperRuleId]: noServiceWrapper,
+  [noStatusCodeRuleId]: noStatusCode,
+  [fetchResponseBodyJsonRuleId]: fetchResponseBodyJson,
+  [fetchResponseHeaderGetterRuleId]: fetchResponseHeaderGetter,
+  [fetchResponseStatusRuleId]: fetchResponseStatus,
+  [addUrlDomainRuleId]: addUrlDomain,
   [noLegacyServiceTypingRuleId]: noLegacyServiceTyping,
+  [noMappedResponseRuleId]: noMappedResponse,
   [requireResolveFullResponseRuleId]: requireResolveFullResponse,
   [noDuplicatedImportsRuleId]: noDuplicatedImports,
   [noServeRuntimeRuleId]: noServeRuntime,
+  [addBasePathConstRuleId]: addBasePathConst,
+  [addBasePathImportRuleId]: addBasePathImport,
+  [addAssertImportRuleId]: addAssertImport,
   [requireFixedServicesImportRuleId]: requireFixedServicesImport,
   [requireTypeOutOfTypeOnlyImportsRuleId]: requireTypeOutOfTypeOnlyImports,
+  [noUnusedFunctionArgumentsRuleId]: noUnusedFunctionArguments,
+  [noUnusedServiceVariablesRuleId]: noUnusedServiceVariables,
+  [noUnusedImportsRuleId]: noUnusedImports,
+  [fixFunctionCallArgumentsRuleId]: fixFunctionCallArguments,
+  [agentTestWiringRuleId]: agentTestWiring,
 };
 
 const plugin: TSESLint.FlatConfig.Plugin = {
@@ -87,6 +127,25 @@ const configs: Record<string, TSESLint.FlatConfig.Config[]> = {
         [`@checkdigit/${requireFixedServicesImportRuleId}`]: 'error',
         [`@checkdigit/${requireTypeOutOfTypeOnlyImportsRuleId}`]: 'error',
         [`@checkdigit/${noServeRuntimeRuleId}`]: 'error',
+        // --- agent rules BEGIN ---
+        [`@checkdigit/${noMappedResponseRuleId}`]: 'off',
+        [`@checkdigit/${addUrlDomainRuleId}`]: 'off',
+        [`@checkdigit/${noFixtureRuleId}`]: 'off',
+        [`@checkdigit/${noServiceWrapperRuleId}`]: 'off',
+        [`@checkdigit/${noStatusCodeRuleId}`]: 'off',
+        [`@checkdigit/${fetchResponseBodyJsonRuleId}`]: 'off',
+        [`@checkdigit/${fetchResponseHeaderGetterRuleId}`]: 'off',
+        [`@checkdigit/${fetchResponseStatusRuleId}`]: 'off',
+        [`@checkdigit/${fetchThenRuleId}`]: 'off',
+        [`@checkdigit/${noUnusedFunctionArgumentsRuleId}`]: 'off',
+        [`@checkdigit/${noUnusedServiceVariablesRuleId}`]: 'off',
+        [`@checkdigit/${noUnusedImportsRuleId}`]: 'off',
+        [`@checkdigit/${fixFunctionCallArgumentsRuleId}`]: 'off',
+        [`@checkdigit/${agentTestWiringRuleId}`]: 'off',
+        [`@checkdigit/${addBasePathConstRuleId}`]: 'off',
+        [`@checkdigit/${addBasePathImportRuleId}`]: 'off',
+        [`@checkdigit/${addAssertImportRuleId}`]: 'off',
+        // --- agent rules END ---
       },
     },
   ],
@@ -116,6 +175,89 @@ const configs: Record<string, TSESLint.FlatConfig.Config[]> = {
         [`@checkdigit/${requireFixedServicesImportRuleId}`]: 'off',
         [`@checkdigit/${requireTypeOutOfTypeOnlyImportsRuleId}`]: 'error',
         [`@checkdigit/${noServeRuntimeRuleId}`]: 'off',
+        // --- agent rules BEGIN ---
+        [`@checkdigit/${noMappedResponseRuleId}`]: 'off',
+        [`@checkdigit/${addUrlDomainRuleId}`]: 'off',
+        [`@checkdigit/${noFixtureRuleId}`]: 'off',
+        [`@checkdigit/${noServiceWrapperRuleId}`]: 'off',
+        [`@checkdigit/${noStatusCodeRuleId}`]: 'off',
+        [`@checkdigit/${fetchResponseBodyJsonRuleId}`]: 'off',
+        [`@checkdigit/${fetchResponseHeaderGetterRuleId}`]: 'off',
+        [`@checkdigit/${fetchResponseStatusRuleId}`]: 'off',
+        [`@checkdigit/${fetchThenRuleId}`]: 'off',
+        [`@checkdigit/${noUnusedFunctionArgumentsRuleId}`]: 'off',
+        [`@checkdigit/${noUnusedServiceVariablesRuleId}`]: 'off',
+        [`@checkdigit/${noUnusedImportsRuleId}`]: 'off',
+        [`@checkdigit/${fixFunctionCallArgumentsRuleId}`]: 'off',
+        [`@checkdigit/${agentTestWiringRuleId}`]: 'off',
+        [`@checkdigit/${addBasePathConstRuleId}`]: 'off',
+        [`@checkdigit/${addBasePathImportRuleId}`]: 'off',
+        [`@checkdigit/${addAssertImportRuleId}`]: 'off',
+        // --- agent rules END ---
+      },
+    },
+  ],
+  'agent-phase-1-test': [
+    {
+      files: ['**/*.spec.ts', '**/*.test.ts', 'src/api/v*/index.ts'],
+      // eslint-disable-next-line sonarjs/no-duplicate-string
+      ignores: ['src/plugin/**'],
+      plugins: {
+        '@checkdigit': plugin,
+      },
+      rules: {
+        [`@checkdigit/${noMappedResponseRuleId}`]: 'error',
+        [`@checkdigit/${addUrlDomainRuleId}`]: 'error',
+        [`@checkdigit/${noServiceWrapperRuleId}`]: 'error',
+        [`@checkdigit/${noStatusCodeRuleId}`]: 'error',
+        [`@checkdigit/${fetchResponseBodyJsonRuleId}`]: 'error',
+        [`@checkdigit/${fetchResponseHeaderGetterRuleId}`]: 'error',
+        [`@checkdigit/${fetchResponseStatusRuleId}`]: 'error',
+        [`@checkdigit/${fetchThenRuleId}`]: 'error',
+        [`@checkdigit/${noUnusedFunctionArgumentsRuleId}`]: 'error',
+        [`@checkdigit/${noUnusedServiceVariablesRuleId}`]: 'error',
+        [`@checkdigit/${noUnusedImportsRuleId}`]: 'error',
+        [`@checkdigit/${fixFunctionCallArgumentsRuleId}`]: 'error',
+        [`@checkdigit/${addBasePathConstRuleId}`]: 'error',
+        [`@checkdigit/${addBasePathImportRuleId}`]: 'error',
+        [`@checkdigit/${addAssertImportRuleId}`]: 'error',
+        [`@checkdigit/${noFixtureRuleId}`]: 'error',
+      },
+    },
+    {
+      files: ['**/*.spec.ts'],
+      ignores: ['src/plugin/**'],
+      plugins: {
+        '@checkdigit': plugin,
+      },
+      rules: {
+        [`@checkdigit/${agentTestWiringRuleId}`]: 'error',
+      },
+    },
+  ],
+  'agent-phase-2-production': [
+    {
+      files: ['**/*.ts'],
+      ignores: ['src/plugin/**'],
+      plugins: {
+        '@checkdigit': plugin,
+      },
+      rules: {
+        [`@checkdigit/${noMappedResponseRuleId}`]: 'error',
+        [`@checkdigit/${addUrlDomainRuleId}`]: 'error',
+        [`@checkdigit/${noServiceWrapperRuleId}`]: 'error',
+        [`@checkdigit/${noStatusCodeRuleId}`]: 'error',
+        [`@checkdigit/${fetchResponseBodyJsonRuleId}`]: 'error',
+        [`@checkdigit/${fetchResponseHeaderGetterRuleId}`]: 'error',
+        [`@checkdigit/${fetchResponseStatusRuleId}`]: 'error',
+        [`@checkdigit/${fetchThenRuleId}`]: 'error',
+        [`@checkdigit/${noUnusedFunctionArgumentsRuleId}`]: 'error',
+        [`@checkdigit/${noUnusedServiceVariablesRuleId}`]: 'error',
+        [`@checkdigit/${noUnusedImportsRuleId}`]: 'error',
+        [`@checkdigit/${fixFunctionCallArgumentsRuleId}`]: 'error',
+        [`@checkdigit/${addBasePathConstRuleId}`]: 'error',
+        [`@checkdigit/${addBasePathImportRuleId}`]: 'error',
+        [`@checkdigit/${addAssertImportRuleId}`]: 'error',
       },
     },
   ],