@checkdigit/eslint-plugin 6.6.0-PR.75-bbf4 → 6.6.0-PR.75-4211

package/dist-mjs/require-resolve-full-response.mjs

@@ -0,0 +1,156 @@
+// src/require-resolve-full-response.ts
+import { AST_NODE_TYPES, ESLintUtils } from "@typescript-eslint/utils";
+import { DefinitionType } from "@typescript-eslint/scope-manager";
+import { PLAIN_URL_REGEXP, TOKENIZED_URL_REGEXP } from "./agent/url.mjs";
+import { strict as assert } from "node:assert";
+import getDocumentationUrl from "./get-documentation-url.mjs";
+import { getEnclosingScopeNode } from "./library/ts-tree.mjs";
+var ruleId = "require-resolve-full-response";
+var createRule = ESLintUtils.RuleCreator((name) => getDocumentationUrl(name));
+var rule = createRule({
+  name: ruleId,
+  meta: {
+    type: "suggestion",
+    docs: {
+      description: "Prefer native fetch over customized service wrapper."
+    },
+    messages: {
+      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.',
+      unknownError: 'Unknown error occurred in file "{{fileName}}": {{ error }}.'
+    },
+    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, 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) {
+      const variable = parserService.esTreeNodeToTSNodeMap.get(identifier);
+      const variableType = typeChecker.getTypeAtLocation(variable);
+      return typeChecker.typeToString(variableType);
+    }
+    function isServiceLikeName(name) {
+      return /.*[Ss]ervice$/u.test(name);
+    }
+    function isCalleeServiceWrapper(serviceCall) {
+      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));
+      }
+      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) => {
+        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);
+          const method = serviceCall.callee.property.name;
+          const optionsArgument = ["get", "head", "del"].includes(method) ? serviceCall.arguments[1] : serviceCall.arguments[2];
+          if (optionsArgument === void 0 || 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;
+          }
+        } catch (error) {
+          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)
+            }
+          });
+        }
+      }
+    };
+  }
+});
+var require_resolve_full_response_default = rule;
+export {
+  require_resolve_full_response_default as default,
+  ruleId
+};
+//# sourceMappingURL=data:application/json;base64,ewogICJ2ZXJzaW9uIjogMywKICAic291cmNlcyI6IFsiLi4vc3JjL3JlcXVpcmUtcmVzb2x2ZS1mdWxsLXJlc3BvbnNlLnRzIl0sCiAgIm1hcHBpbmdzIjogIjtBQVFBLFNBQVMsZ0JBQWdCLG1CQUE2QjtBQUN0RCxTQUFTLHNCQUFrQztBQUMzQyxTQUFTLGtCQUFrQiw0QkFBNEI7QUFDdkQsU0FBUyxVQUFVLGNBQWM7QUFDakMsT0FBTyx5QkFBeUI7QUFDaEMsU0FBUyw2QkFBNkI7QUFFL0IsSUFBTSxTQUFTO0FBRXRCLElBQU0sYUFBYSxZQUFZLFlBQVksQ0FBQyxTQUFTLG9CQUFvQixJQUFJLENBQUM7QUFFOUUsSUFBTSxPQUFPLFdBQVc7QUFBQSxFQUN0QixNQUFNO0FBQUEsRUFDTixNQUFNO0FBQUEsSUFDSixNQUFNO0FBQUEsSUFDTixNQUFNO0FBQUEsTUFDSixhQUFhO0FBQUEsSUFDZjtBQUFBLElBQ0EsVUFBVTtBQUFBLE1BQ1IsZ0JBQ0U7QUFBQSxNQUNGLGNBQWM7QUFBQSxJQUNoQjtBQUFBLElBQ0EsUUFBUSxDQUFDO0FBQUEsRUFDWDtBQUFBLEVBQ0EsZ0JBQWdCLENBQUM7QUFBQSxFQUNqQixPQUFPLFNBQVM7QUFDZCxVQUFNLGFBQWEsUUFBUTtBQUMzQixVQUFNLGVBQWUsV0FBVztBQUNoQyxVQUFNLGdCQUFnQixZQUFZLGtCQUFrQixPQUFPO0FBQzNELFVBQU0sY0FBYyxjQUFjLFFBQVEsZUFBZTtBQUV6RCxhQUFTLG1CQUFtQixhQUF3QyxPQUFjO0FBQ2hGLFVBQ0csYUFBYSxTQUFTLGVBQWUsV0FBVyxPQUFPLFlBQVksVUFBVSxZQUM5RSxhQUFhLFNBQVMsZUFBZSxpQkFDckM7QUFDQSxjQUFNLFVBQVUsV0FBVyxRQUFRLFdBQVc7QUFDOUMsZUFBTyxpQkFBaUIsS0FBSyxPQUFPLEtBQUsscUJBQXFCLEtBQUssT0FBTztBQUFBLE1BQzVFO0FBRUEsVUFBSSxhQUFhLFNBQVMsZUFBZSxZQUFZO0FBQ25ELGNBQU0sZ0JBQWdCLE1BQU0sVUFBVSxLQUFLLENBQUMsYUFBYSxTQUFTLFNBQVMsWUFBWSxJQUFJO0FBQzNGLFlBQUksZUFBZTtBQUNqQixnQkFBTSxxQkFBcUIsY0FBYyxLQUFLLEtBQUssQ0FBQyxRQUFRLElBQUksU0FBUyxlQUFlLFFBQVE7QUFDaEcsaUJBQU8sR0FBRyxvQkFBb0IsYUFBYSxZQUFZLElBQUksd0JBQXdCO0FBQ25GLGdCQUFNLHlCQUF5QixtQkFBbUI7QUFDbEQsaUJBQU8sR0FBRyx1QkFBdUIsU0FBUyxlQUFlLGtCQUFrQjtBQUMzRSxpQkFBTyxHQUFHLHVCQUF1QixNQUFNLCtDQUErQztBQUN0RixpQkFBTyxtQkFBbUIsdUJBQXVCLE1BQU0sS0FBSztBQUFBLFFBQzlEO0FBQUEsTUFDRjtBQUVBLGFBQU87QUFBQSxJQUNUO0FBRUEsYUFBUyxRQUFRLFlBQWlDO0FBQ2hELFlBQU0sV0FBVyxjQUFjLHNCQUFzQixJQUFJLFVBQVU7QUFDbkUsWUFBTSxlQUFlLFlBQVksa0JBQWtCLFFBQVE7QUFDM0QsYUFBTyxZQUFZLGFBQWEsWUFBWTtBQUFBLElBQzlDO0FBRUEsYUFBUyxrQkFBa0IsTUFBYztBQUN2QyxhQUFPLGlCQUFpQixLQUFLLElBQUk7QUFBQSxJQUNuQztBQUVBLGFBQVMsdUJBQXVCLGFBQXNDO0FBQ3BFLFlBQU0sU0FBUyxZQUFZO0FBQzNCLFVBQUksT0FBTyxTQUFTLGVBQWUsa0JBQWtCO0FBQ25ELGVBQU87QUFBQSxNQUNUO0FBRUEsWUFBTSxXQUFXLE9BQU87QUFDeEIsVUFBSSxTQUFTLFNBQVMsZUFBZSxZQUFZO0FBQy9DLGVBQU8sUUFBUSxRQUFRLE1BQU0sY0FBYyxrQkFBa0IsU0FBUyxJQUFJO0FBQUEsTUFDNUU7QUFDQSxVQUFJLFNBQVMsU0FBUyxlQUFlLGdCQUFnQjtBQUNuRCxlQUFPO0FBQUEsTUFDVDtBQUVBLFlBQU0sQ0FBQyxlQUFlLElBQUksU0FBUztBQUNuQyxVQUFJLGlCQUFpQixTQUFTLGVBQWUsWUFBWTtBQUN2RCxlQUFPO0FBQUEsTUFDVDtBQUNBLFVBQUksZ0JBQWdCLFNBQVMsbUJBQW1CLFFBQVEsZUFBZSxNQUFNLGtCQUFrQjtBQUM3RixlQUFPO0FBQUEsTUFDVDtBQUNBLFlBQU0sVUFBVSxTQUFTO0FBQ3pCLFVBQUksUUFBUSxTQUFTLGVBQWUsWUFBWTtBQUM5QyxlQUFPLFFBQVEsT0FBTyxNQUFNO0FBQUEsTUFDOUI7QUFFQSxVQUFJLFFBQVEsU0FBUyxlQUFlLGtCQUFrQjtBQUNwRCxlQUFPO0FBQUEsTUFDVDtBQUNBLFlBQU0sV0FBVyxRQUFRO0FBQ3pCLFVBQUksU0FBUyxTQUFTLGVBQWUsWUFBWTtBQUMvQyxlQUFPLFFBQVEsUUFBUSxNQUFNO0FBQUEsTUFDL0I7QUFFQSxVQUFJLFNBQVMsU0FBUyxlQUFlLGtCQUFrQjtBQUNyRCxlQUFPO0FBQUEsTUFDVDtBQUNBLFlBQU0sZ0JBQWdCLFNBQVM7QUFDL0IsVUFBSSxjQUFjLFNBQVMsZUFBZSxZQUFZO0FBQ3BELGVBQU8sQ0FBQyxpQkFBaUIsaUNBQWlDLEVBQUUsU0FBUyxRQUFRLGFBQWEsQ0FBQztBQUFBLE1BQzdGO0FBR0EsVUFBSSxjQUFjLFNBQVMsZUFBZSxrQkFBa0I7QUFDMUQsZUFBTztBQUFBLE1BQ1Q7QUFDQSxZQUFNLFVBQVUsY0FBYztBQUM5QixVQUFJLFFBQVEsU0FBUyxlQUFlLFlBQVk7QUFDOUMsZUFBTyxRQUFRLFNBQVMsYUFBYSxRQUFRLE9BQU8sTUFBTTtBQUFBLE1BQzVEO0FBRUEsYUFBTztBQUFBLElBQ1Q7QUFFQSxXQUFPO0FBQUEsTUFDTCwwRUFBMEUsQ0FDeEUsZ0JBQ0c7QUFDSCxZQUFJO0FBQ0YsY0FBSSxDQUFDLHVCQUF1QixXQUFXLEdBQUc7QUFDeEM7QUFBQSxVQUNGO0FBRUEsZ0JBQU0scUJBQXFCLHNCQUFzQixXQUFXO0FBQzVELGlCQUFPLEdBQUcsb0JBQW9CLGlDQUFpQztBQUMvRCxnQkFBTSxRQUFRLGNBQWMsUUFBUSxrQkFBa0I7QUFDdEQsaUJBQU8sR0FBRyxPQUFPLG9CQUFvQjtBQUNyQyxnQkFBTSxjQUFjLFlBQVksVUFBVSxDQUFDO0FBQzNDLGNBQUksQ0FBQyxtQkFBbUIsYUFBYSxLQUFLLEdBQUc7QUFDM0M7QUFBQSxVQUNGO0FBRUEsaUJBQU8sR0FBRyxZQUFZLE9BQU8sU0FBUyxlQUFlLGdCQUFnQjtBQUNyRSxpQkFBTyxHQUFHLFlBQVksT0FBTyxTQUFTLFNBQVMsZUFBZSxVQUFVO0FBR3hFLGdCQUFNLFNBQVMsWUFBWSxPQUFPLFNBQVM7QUFHM0MsZ0JBQU0sa0JBQWtCLENBQUMsT0FBTyxRQUFRLEtBQUssRUFBRSxTQUFTLE1BQU0sSUFDMUQsWUFBWSxVQUFVLENBQUMsSUFDdkIsWUFBWSxVQUFVLENBQUM7QUFDM0IsY0FBSSxvQkFBb0IsVUFBYSxnQkFBZ0IsU0FBUyxlQUFlLGtCQUFrQjtBQUM3RixvQkFBUSxPQUFPO0FBQUEsY0FDYixNQUFNO0FBQUEsY0FDTixXQUFXO0FBQUEsWUFDYixDQUFDO0FBQ0Q7QUFBQSxVQUNGO0FBRUEsZ0JBQU0sa0NBQWtDLGdCQUFnQixXQUFXO0FBQUEsWUFDakUsQ0FBQyxhQUNDLFNBQVMsU0FBUyxlQUFlLFlBQ2pDLFNBQVMsSUFBSSxTQUFTLGVBQWUsY0FDckMsU0FBUyxJQUFJLFNBQVM7QUFBQSxVQUMxQjtBQUNBLGNBQ0UsaUNBQWlDLFNBQVMsZUFBZSxZQUN6RCxnQ0FBZ0MsTUFBTSxTQUFTLGVBQWUsV0FDOUQsZ0NBQWdDLE1BQU0sVUFBVSxNQUNoRDtBQUNBLG9CQUFRLE9BQU87QUFBQSxjQUNiLE1BQU07QUFBQSxjQUNOLFdBQVc7QUFBQSxZQUNiLENBQUM7QUFDRDtBQUFBLFVBQ0Y7QUFBQSxRQUNGLFNBQVMsT0FBTztBQUVkLGtCQUFRLE1BQU0sbUJBQW1CLE1BQU0sbUJBQW1CLFFBQVEsUUFBUSxNQUFNLEtBQUs7QUFDckYsa0JBQVEsT0FBTztBQUFBLFlBQ2IsTUFBTTtBQUFBLFlBQ04sV0FBVztBQUFBLFlBQ1gsTUFBTTtBQUFBLGNBQ0osVUFBVSxRQUFRO0FBQUEsY0FDbEIsT0FBTyxpQkFBaUIsUUFBUSxNQUFNLFNBQVMsSUFBSSxLQUFLLFVBQVUsS0FBSztBQUFBLFlBQ3pFO0FBQUEsVUFDRixDQUFDO0FBQUEsUUFDSDtBQUFBLE1BQ0Y7QUFBQSxJQUNGO0FBQUEsRUFDRjtBQUNGLENBQUM7QUFFRCxJQUFPLHdDQUFROyIsCiAgIm5hbWVzIjogW10KfQo=

package/dist-types/index.d.ts

@@ -19,6 +19,7 @@ declare const _default: {
         "fetch-response-header-getter-ts": import("@typescript-eslint/utils/ts-eslint").RuleModule<"unknownError" | "useGetter", never[], import("@typescript-eslint/utils/ts-eslint").RuleListener>;
         "add-url-domain": import("@typescript-eslint/utils/ts-eslint").RuleModule<"addDomain" | "unknownError", never[], import("@typescript-eslint/utils/ts-eslint").RuleListener>;
         "no-full-response": import("@typescript-eslint/utils/ts-eslint").RuleModule<"unknownError" | "removeFullResponse", never[], import("@typescript-eslint/utils/ts-eslint").RuleListener>;
+        "require-resolve-full-response": import("@typescript-eslint/utils/ts-eslint").RuleModule<"unknownError" | "invalidOptions", never[], import("@typescript-eslint/utils/ts-eslint").RuleListener>;
     };
     configs: {
         all: {
@@ -34,6 +35,15 @@ declare const _default: {
                 '@checkdigit/no-test-import': string;
                 "@checkdigit/invalid-json-stringify": string;
                 "@checkdigit/no-promise-instance-method": string;
+                "@checkdigit/no-full-response": string;
+                "@checkdigit/require-resolve-full-response": string;
+                "@checkdigit/add-url-domain": string;
+                "@checkdigit/no-fixture": string;
+                "@checkdigit/no-service-wrapper": string;
+                "@checkdigit/no-status-code": string;
+                "@checkdigit/fetch-response-body-json": string;
+                "@checkdigit/fetch-response-header-getter-ts": string;
+                "@checkdigit/fetch-then": string;
             };
         };
         recommended: {
@@ -51,16 +61,31 @@ declare const _default: {
                 "@checkdigit/no-promise-instance-method": string;
             };
         };
-        agent: {
+        'agent-serve-runtime': {
+            ignorePatterns: string[];
             rules: {
+                "@checkdigit/no-full-response": string;
+                "@checkdigit/require-resolve-full-response": string;
+                "@checkdigit/add-url-domain": string;
                 "@checkdigit/no-fixture": string;
-                "@checkdigit/fetch-then": string;
                 "@checkdigit/no-service-wrapper": string;
                 "@checkdigit/no-status-code": string;
                 "@checkdigit/fetch-response-body-json": string;
                 "@checkdigit/fetch-response-header-getter-ts": string;
-                "@checkdigit/add-url-domain": string;
+                "@checkdigit/fetch-then": string;
+            };
+        };
+        'agent-fixture': {
+            rules: {
                 "@checkdigit/no-full-response": string;
+                "@checkdigit/require-resolve-full-response": string;
+                "@checkdigit/add-url-domain": string;
+                "@checkdigit/no-fixture": string;
+                "@checkdigit/no-service-wrapper": string;
+                "@checkdigit/no-status-code": string;
+                "@checkdigit/fetch-response-body-json": string;
+                "@checkdigit/fetch-response-header-getter-ts": string;
+                "@checkdigit/fetch-then": string;
             };
         };
     };

package/dist-types/require-resolve-full-response.d.ts

@@ -0,0 +1,4 @@
+import { ESLintUtils } from '@typescript-eslint/utils';
+export declare const ruleId = "require-resolve-full-response";
+declare const rule: ESLintUtils.RuleModule<"unknownError" | "invalidOptions", never[], ESLintUtils.RuleListener>;
+export default rule;

package/package.json

@@ -1 +1 @@
-{"name":"@checkdigit/eslint-plugin","version":"6.6.0-PR.75-bbf4","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"},"dependencies":{"@typescript-eslint/type-utils":"7.18.0","@typescript-eslint/utils":"7.18.0","ts-api-utils":"^1.3.0"},"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.18.0","@typescript-eslint/parser":"^7.18.0","@typescript-eslint/rule-tester":"7.18.0","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","http-status-codes":"^2.3.0"},"peerDependencies":{"eslint":">=8 <9"},"engines":{"node":">=20.14"}}
+{"name":"@checkdigit/eslint-plugin","version":"6.6.0-PR.75-4211","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"},"dependencies":{"@typescript-eslint/type-utils":"7.18.0","@typescript-eslint/utils":"7.18.0","ts-api-utils":"^1.3.0"},"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.18.0","@typescript-eslint/parser":"^7.18.0","@typescript-eslint/rule-tester":"7.18.0","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","http-status-codes":"^2.3.0"},"peerDependencies":{"eslint":">=8 <9"},"engines":{"node":">=20.14"}}

package/src/agent/fetch-then.ts

@@ -193,8 +193,7 @@ const rule: Rule.RuleModule = {
     messages: {
       preferNativeFetch: 'Prefer native fetch API over customized fixture API.',
       shouldUseHeaderGetter: 'Getter should be used to access response headers.',
-      unknownError:
-        'Unknown error occurred in file "{{fileName}}": {{ error }}. Please manually convert the fixture API call to fetch API call.',
+      unknownError: 'Unknown error occurred in file "{{fileName}}": {{ error }}.',
     },
     fixable: 'code',
     schema: [],

package/src/agent/no-fixture.ts

@@ -228,8 +228,7 @@ const rule: Rule.RuleModule = {
     },
     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.',
+      unknownError: 'Unknown error occurred in file "{{fileName}}": {{ error }}.',
     },
     fixable: 'code',
     schema: [],
@@ -281,9 +280,11 @@ const rule: Rule.RuleModule = {
           // fetch request argument
           const methodNode = fixtureFunction.property; // get/put/etc.
           assert.ok(methodNode.type === 'Identifier');
+          const methodName = methodNode.name.toUpperCase();
+
           const fetchRequestArgumentLines = [
             '{',
-            `  method: '${methodNode.name.toUpperCase()}',`,
+            `  method: '${methodName === 'DEL' ? 'DELETE' : methodName}',`,
             ...(fixtureCallInformation.requestBody
               ? [`  body: JSON.stringify(${sourceCode.getText(fixtureCallInformation.requestBody)}),`]
               : []),

package/src/agent/no-full-response.ts

@@ -23,7 +23,7 @@ const rule = createRule({
       description: 'Remove the usage of FullResponse type.',
     },
     messages: {
-      removeFullResponse: 'Remove the usage of FullResponse type.',
+      removeFullResponse: 'Removing the usage of FullResponse type.',
       unknownError: 'Unknown error occurred in file "{{fileName}}": {{ error }}.',
     },
     fixable: 'code',

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

@@ -210,7 +210,7 @@ const rule = createRule({
 
               const fetchText = [
                 `fetch(${replacedUrl}, {`,
-                `  method: '${method.toUpperCase()}',`,
+                `  method: '${method.toLowerCase() === 'del' ? 'DELETE' : method.toUpperCase()}',`,
                 ...(requestHeadersProperty ? [`  ${sourceCode.getText(requestHeadersProperty)},`] : []),
                 ...(requestBodyProperty ? [`  body: JSON.stringify(${sourceCode.getText(requestBodyProperty)}),`] : []),
                 '})',

package/src/index.ts

@@ -18,6 +18,9 @@ import noFullResponse, { ruleId as noFullResponseRuleId } from './agent/no-full-
 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 requireResolveFullResponse, {
+  ruleId as requireResolveFullResponseRuleId,
+} from './require-resolve-full-response';
 import filePathComment from './file-path-comment';
 import noCardNumbers from './no-card-numbers';
 import noTestImport from './no-test-import';
@@ -49,6 +52,7 @@ export default {
     [fetchResponseHeaderGetterRuleId]: fetchResponseHeaderGetter,
     [addUrlDomainRuleId]: addUrlDomain,
     [noFullResponseRuleId]: noFullResponse,
+    [requireResolveFullResponseRuleId]: requireResolveFullResponse,
   },
   configs: {
     all: {
@@ -64,6 +68,15 @@ export default {
         '@checkdigit/no-test-import': 'error',
         [`@checkdigit/${invalidJsonStringifyRuleId}`]: 'error',
         [`@checkdigit/${noPromiseInstanceMethodRuleId}`]: 'error',
+        [`@checkdigit/${noFullResponseRuleId}`]: 'error',
+        [`@checkdigit/${requireResolveFullResponseRuleId}`]: 'error',
+        [`@checkdigit/${addUrlDomainRuleId}`]: 'off',
+        [`@checkdigit/${noFixtureRuleId}`]: 'off',
+        [`@checkdigit/${noServiceWrapperRuleId}`]: 'off',
+        [`@checkdigit/${noStatusCodeRuleId}`]: 'off',
+        [`@checkdigit/${fetchResponseBodyJsonRuleId}`]: 'off',
+        [`@checkdigit/${fetchResponseHeaderGetterRuleId}`]: 'off',
+        [`@checkdigit/${fetchThenRuleId}`]: 'off',
       },
     },
     recommended: {
@@ -81,16 +94,31 @@ export default {
         [`@checkdigit/${noPromiseInstanceMethodRuleId}`]: 'error',
       },
     },
-    agent: {
+    'agent-serve-runtime': {
+      ignorePatterns: ['*.spec.ts', '*.test.ts'],
       rules: {
-        [`@checkdigit/${noFixtureRuleId}`]: 'error',
-        [`@checkdigit/${fetchThenRuleId}`]: 'error',
+        [`@checkdigit/${noFullResponseRuleId}`]: 'error',
+        [`@checkdigit/${requireResolveFullResponseRuleId}`]: 'error',
+        [`@checkdigit/${addUrlDomainRuleId}`]: 'error',
+        [`@checkdigit/${noFixtureRuleId}`]: 'off',
         [`@checkdigit/${noServiceWrapperRuleId}`]: 'error',
         [`@checkdigit/${noStatusCodeRuleId}`]: 'error',
         [`@checkdigit/${fetchResponseBodyJsonRuleId}`]: 'error',
         [`@checkdigit/${fetchResponseHeaderGetterRuleId}`]: 'error',
-        [`@checkdigit/${addUrlDomainRuleId}`]: 'error',
+        [`@checkdigit/${fetchThenRuleId}`]: 'error',
+      },
+    },
+    'agent-fixture': {
+      rules: {
         [`@checkdigit/${noFullResponseRuleId}`]: 'error',
+        [`@checkdigit/${requireResolveFullResponseRuleId}`]: 'error',
+        [`@checkdigit/${addUrlDomainRuleId}`]: 'error',
+        [`@checkdigit/${noFixtureRuleId}`]: 'error',
+        [`@checkdigit/${noServiceWrapperRuleId}`]: 'error',
+        [`@checkdigit/${noStatusCodeRuleId}`]: 'error',
+        [`@checkdigit/${fetchResponseBodyJsonRuleId}`]: 'error',
+        [`@checkdigit/${fetchResponseHeaderGetterRuleId}`]: 'error',
+        [`@checkdigit/${fetchThenRuleId}`]: 'error',
       },
     },
   },

package/src/require-resolve-full-response.ts

@@ -0,0 +1,199 @@
+// require-resolve-full-response.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 } from './agent/url';
+import { strict as assert } from 'node:assert';
+import getDocumentationUrl from './get-documentation-url';
+import { getEnclosingScopeNode } from './library/ts-tree';
+
+export const ruleId = 'require-resolve-full-response';
+
+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: {
+      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.',
+      unknownError: 'Unknown error occurred in file "{{fileName}}": {{ error }}.',
+    },
+    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;
+
+          // 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;
+          }
+        } 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;