@checkdigit/eslint-plugin 6.6.0-PR.75-edd9 → 6.6.0-PR.77-5328

package/src/agent/no-service-wrapper.ts

@@ -1,238 +0,0 @@
-// fixture/no-service-wrapper.ts
-
-/*
- * Copyright (c) 2021-2024 Check Digit, LLC
- *
- * This code is licensed under the MIT license (see LICENSE.txt for details).
- */
-
-import { AST_NODE_TYPES, ESLintUtils, TSESTree } from '@typescript-eslint/utils';
-import { DefinitionType, type Scope } from '@typescript-eslint/scope-manager';
-import { PLAIN_URL_REGEXP, TOKENIZED_URL_REGEXP, replaceEndpointUrlPrefixWithDomain } from './url';
-import { strict as assert } from 'node:assert';
-import getDocumentationUrl from '../get-documentation-url';
-import { getEnclosingScopeNode } from '../library/ts-tree';
-import { getIndentation } from '../library/format';
-
-export const ruleId = 'no-service-wrapper';
-
-const createRule = ESLintUtils.RuleCreator((name) => getDocumentationUrl(name));
-
-const rule = createRule({
-  name: ruleId,
-  meta: {
-    type: 'suggestion',
-    docs: {
-      description: 'Prefer native fetch over customized service wrapper.',
-    },
-    messages: {
-      preferNativeFetch: 'Prefer native fetch over customized service wrapper.',
-      invalidOptions:
-        '"options" argument should be provided with "resolveWithFullResponse" property set as "true". Otherwise, it indicates that the response body will be obtained without status code assertion which could result in unexpected issue. Please manually convert the usage of customized service wrapper call to native fetch.',
-      unknownError:
-        'Unknown error occurred in file "{{fileName}}": {{ error }}. Please manually convert the usage of customized service wrapper call to native fetch.',
-    },
-    fixable: 'code',
-    schema: [],
-  },
-  defaultOptions: [],
-  create(context) {
-    const sourceCode = context.sourceCode;
-    const scopeManager = sourceCode.scopeManager;
-    const parserService = ESLintUtils.getParserServices(context);
-    const typeChecker = parserService.program.getTypeChecker();
-
-    function isUrlArgumentValid(urlArgument: TSESTree.Node | undefined, scope: Scope) {
-      if (
-        (urlArgument?.type === AST_NODE_TYPES.Literal && typeof urlArgument.value === 'string') ||
-        urlArgument?.type === AST_NODE_TYPES.TemplateLiteral
-      ) {
-        const urlText = sourceCode.getText(urlArgument);
-        return PLAIN_URL_REGEXP.test(urlText) || TOKENIZED_URL_REGEXP.test(urlText);
-      }
-
-      if (urlArgument?.type === AST_NODE_TYPES.Identifier) {
-        const foundVariable = scope.variables.find((variable) => variable.name === urlArgument.name);
-        if (foundVariable) {
-          const variableDefinition = foundVariable.defs.find((def) => def.type === DefinitionType.Variable);
-          assert.ok(variableDefinition, `Variable "${urlArgument.name}" not defined in scope`);
-          const variableDefinitionNode = variableDefinition.node;
-          assert.ok(variableDefinitionNode.type === AST_NODE_TYPES.VariableDeclarator);
-          assert.ok(variableDefinitionNode.init, 'Variable definition node has no init property');
-          return isUrlArgumentValid(variableDefinitionNode.init, scope);
-        }
-      }
-
-      return false;
-    }
-
-    function getType(identifier: TSESTree.Identifier) {
-      const variable = parserService.esTreeNodeToTSNodeMap.get(identifier);
-      const variableType = typeChecker.getTypeAtLocation(variable);
-      return typeChecker.typeToString(variableType);
-    }
-
-    function isServiceLikeName(name: string) {
-      return /.*[Ss]ervice$/u.test(name);
-    }
-
-    function isCalleeServiceWrapper(serviceCall: TSESTree.CallExpression) {
-      const callee = serviceCall.callee;
-      if (callee.type !== AST_NODE_TYPES.MemberExpression) {
-        return false;
-      }
-
-      const endpoint = callee.object;
-      if (endpoint.type === AST_NODE_TYPES.Identifier) {
-        return getType(endpoint) === 'Endpoint' || isServiceLikeName(endpoint.name);
-      }
-      if (endpoint.type !== AST_NODE_TYPES.CallExpression) {
-        return false;
-      }
-
-      const [contextArgument] = endpoint.arguments;
-      if (contextArgument?.type !== AST_NODE_TYPES.Identifier) {
-        return false;
-      }
-      if (contextArgument.name !== 'EMPTY_CONTEXT' && getType(contextArgument) !== 'InboundContext') {
-        return false;
-      }
-      const service = endpoint.callee;
-      if (service.type === AST_NODE_TYPES.Identifier) {
-        return getType(service) === 'ResolvedService';
-      }
-
-      if (service.type !== AST_NODE_TYPES.MemberExpression) {
-        return false;
-      }
-      const services = service.object;
-      if (services.type === AST_NODE_TYPES.Identifier) {
-        return getType(services) === 'ResolvedServices';
-      }
-
-      if (services.type !== AST_NODE_TYPES.MemberExpression) {
-        return false;
-      }
-      const configuration = services.object;
-      if (configuration.type === AST_NODE_TYPES.Identifier) {
-        return ['Configuration', 'Configuration<ResolvedServices>'].includes(getType(configuration));
-      }
-
-      // following applies only to test code (fixture)
-      if (configuration.type !== AST_NODE_TYPES.MemberExpression) {
-        return false;
-      }
-      const fixture = configuration.object;
-      if (fixture.type === AST_NODE_TYPES.Identifier) {
-        return fixture.name === 'fixture' || getType(fixture) === 'Fixture';
-      }
-
-      return false;
-    }
-
-    return {
-      'CallExpression[callee.property.name=/^(head|get|put|post|del|patch)$/]': (
-        serviceCall: TSESTree.CallExpression,
-      ) => {
-        try {
-          if (!isCalleeServiceWrapper(serviceCall)) {
-            return;
-          }
-
-          const enclosingScopeNode = getEnclosingScopeNode(serviceCall);
-          assert.ok(enclosingScopeNode, 'enclosingScopeNode is undefined');
-          const scope = scopeManager?.acquire(enclosingScopeNode);
-          assert.ok(scope, 'scope is undefined');
-          const urlArgument = serviceCall.arguments[0];
-          if (!isUrlArgumentValid(urlArgument, scope)) {
-            return;
-          }
-
-          assert.ok(serviceCall.callee.type === AST_NODE_TYPES.MemberExpression);
-          assert.ok(serviceCall.callee.property.type === AST_NODE_TYPES.Identifier);
-
-          // method
-          const method = serviceCall.callee.property.name;
-
-          // body
-          let requestBodyProperty = ['put', 'post', 'options'].includes(method) ? serviceCall.arguments[1] : undefined;
-          if (
-            requestBodyProperty !== undefined &&
-            requestBodyProperty.type === AST_NODE_TYPES.Identifier &&
-            requestBodyProperty.name === 'undefined'
-          ) {
-            requestBodyProperty = undefined;
-          }
-          // options
-          const optionsArgument = ['get', 'head', 'del'].includes(method)
-            ? serviceCall.arguments[1]
-            : serviceCall.arguments[2];
-          if (optionsArgument === undefined || optionsArgument.type !== AST_NODE_TYPES.ObjectExpression) {
-            context.report({
-              node: serviceCall,
-              messageId: 'invalidOptions',
-            });
-            return;
-          }
-          const resolveWithFullResponseProperty = optionsArgument.properties.find(
-            (property) =>
-              property.type === AST_NODE_TYPES.Property &&
-              property.key.type === AST_NODE_TYPES.Identifier &&
-              property.key.name === 'resolveWithFullResponse',
-          );
-          if (
-            resolveWithFullResponseProperty?.type !== AST_NODE_TYPES.Property ||
-            resolveWithFullResponseProperty.value.type !== AST_NODE_TYPES.Literal ||
-            resolveWithFullResponseProperty.value.value !== true
-          ) {
-            context.report({
-              node: optionsArgument,
-              messageId: 'invalidOptions',
-            });
-            return;
-          }
-
-          // headers
-          const requestHeadersProperty = optionsArgument.properties.find(
-            (property) =>
-              property.type === AST_NODE_TYPES.Property &&
-              property.key.type === AST_NODE_TYPES.Identifier &&
-              property.key.name === 'headers',
-          );
-
-          context.report({
-            messageId: 'preferNativeFetch',
-            node: serviceCall,
-            fix(fixer) {
-              const url = sourceCode.getText(urlArgument);
-              const replacedUrl = replaceEndpointUrlPrefixWithDomain(url);
-              const indentation = getIndentation(serviceCall, sourceCode);
-
-              const fetchText = [
-                `fetch(${replacedUrl}, {`,
-                `  method: '${method.toLowerCase() === 'del' ? 'DELETE' : method.toUpperCase()}',`,
-                ...(requestHeadersProperty ? [`  ${sourceCode.getText(requestHeadersProperty)},`] : []),
-                ...(requestBodyProperty ? [`  body: JSON.stringify(${sourceCode.getText(requestBodyProperty)}),`] : []),
-                '})',
-              ].join(`\n${indentation}`);
-              return fixer.replaceText(serviceCall, fetchText);
-            },
-          });
-        } catch (error) {
-          // eslint-disable-next-line no-console
-          console.error(`Failed to apply ${ruleId} rule for file "${context.filename}":`, error);
-          context.report({
-            node: serviceCall,
-            messageId: 'unknownError',
-            data: {
-              fileName: context.filename,
-              error: error instanceof Error ? error.toString() : JSON.stringify(error),
-            },
-          });
-        }
-      },
-    };
-  },
-});
-
-export default rule;

package/src/agent/no-status-code.ts

@@ -1,71 +0,0 @@
-// fixture/no-status-code.ts
-
-/*
- * Copyright (c) 2021-2024 Check Digit, LLC
- *
- * This code is licensed under the MIT license (see LICENSE.txt for details).
- */
-
-import { ESLintUtils, TSESTree } from '@typescript-eslint/utils';
-import getDocumentationUrl from '../get-documentation-url';
-
-export const ruleId = 'no-status-code';
-
-const createRule = ESLintUtils.RuleCreator((name) => getDocumentationUrl(name));
-
-const rule = createRule({
-  name: ruleId,
-  meta: {
-    type: 'suggestion',
-    docs: {
-      description: 'Access the status code property of the fetch Response using "status" instead of "statusCode".',
-    },
-    messages: {
-      replaceStatusCode: 'Replace "statusCode" with "status".',
-      unknownError: 'Unknown error occurred in file "{{fileName}}": {{ error }}.',
-    },
-    fixable: 'code',
-    schema: [],
-  },
-  defaultOptions: [],
-  create(context) {
-    const parserServices = ESLintUtils.getParserServices(context);
-    const typeChecker = parserServices.program.getTypeChecker();
-
-    return {
-      'MemberExpression[property.name="statusCode"]': (responseStatusCode: TSESTree.MemberExpression) => {
-        try {
-          const responseNode = parserServices.esTreeNodeToTSNodeMap.get(responseStatusCode.object);
-          const responseType = typeChecker.getTypeAtLocation(responseNode);
-
-          const shouldReplace =
-            responseType.getProperties().some((symbol) => symbol.name === 'status') &&
-            !responseType.getProperties().some((symbol) => symbol.name === 'statusCode');
-
-          if (shouldReplace) {
-            context.report({
-              messageId: 'replaceStatusCode',
-              node: responseStatusCode.property,
-              fix(fixer) {
-                return fixer.replaceText(responseStatusCode.property, 'status');
-              },
-            });
-          }
-        } catch (error) {
-          // eslint-disable-next-line no-console
-          console.error(`Failed to apply ${ruleId} rule for file "${context.filename}":`, error);
-          context.report({
-            node: responseStatusCode,
-            messageId: 'unknownError',
-            data: {
-              fileName: context.filename,
-              error: error instanceof Error ? error.toString() : JSON.stringify(error),
-            },
-          });
-        }
-      },
-    };
-  },
-});
-
-export default rule;

package/src/agent/response-reference.ts

@@ -1,100 +0,0 @@
-// fixture/response-reference.ts
-
-/*
- * Copyright (c) 2021-2024 Check Digit, LLC
- *
- * This code is licensed under the MIT license (see LICENSE.txt for details).
- */
-
-import type { MemberExpression, VariableDeclaration } from 'estree';
-import { type Scope } from 'eslint';
-import { strict as assert } from 'node:assert';
-import { getParent } from '../library/tree';
-
-/**
- * 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,
-) {
-  const results: {
-    variable?: Scope.Variable;
-    bodyReferences: MemberExpression[];
-    headersReferences: MemberExpression[];
-    statusReferences: MemberExpression[];
-    destructuringBodyVariable?: Scope.Variable;
-    destructuringHeadersVariable?: Scope.Variable;
-    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 {
-      throw new Error(`Unknown response variable reference: ${responseVariable.name}`);
-    }
-  }
-  return results;
-}

package/src/agent/url.ts

@@ -1,23 +0,0 @@
-// fixture/url.ts
-
-export const PLAIN_URL_REGEXP = /^[`']\/\w+(?<serviceNamePart>-\w+)*\/v\d+\/(?<any>.|\r|\n)+[`']$/u;
-export const TOKENIZED_URL_REGEXP = /^`\$\{(?<serviceNamePart>[A-Z]+_)*BASE_PATH\}\/(?<any>.|\r|\n)+`$/u;
-
-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}/');
-}
-
-export function replaceEndpointUrlPrefixWithDomain(url: 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) {
-  return url.replace(
-    /^(?<quotStart>[`'])\/(?<servicename>\w+(?<parts>-\w+)*)(?<path>\/v\d+(?<quotEnd>[`'])$)/u,
-    '$1https://$2.checkdigit/$2$4',
-  );
-}