@checkdigit/eslint-plugin 6.6.0-PR.75-c68b → 6.6.0-PR.75-0869

package/src/fixture/fetch-response-body-json.ts

@@ -0,0 +1,76 @@
+// fixture/fetch-response-body-json.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 getDocumentationUrl from '../get-documentation-url';
+
+export const ruleId = 'fetch-response-body-json';
+
+const createRule = ESLintUtils.RuleCreator((name) => getDocumentationUrl(name));
+
+const rule = createRule({
+  name: ruleId,
+  meta: {
+    type: 'suggestion',
+    docs: {
+      description: 'Replace "response.body" with "await response.json()".',
+    },
+    messages: {
+      replaceBodyWithJson: 'Replace "response.body" with "await response.json()".',
+      unknownError: 'Unknown error occurred in file "{{fileName}}": {{ error }}.',
+    },
+    fixable: 'code',
+    schema: [],
+  },
+  defaultOptions: [],
+  create(context) {
+    const parserServices = ESLintUtils.getParserServices(context);
+    const typeChecker = parserServices.program.getTypeChecker();
+    const sourceCode = context.sourceCode;
+
+    return {
+      'MemberExpression[property.name="body"]': (responseBody: TSESTree.MemberExpression) => {
+        try {
+          const responseNode = parserServices.esTreeNodeToTSNodeMap.get(responseBody.object);
+          const responseType = typeChecker.getTypeAtLocation(responseNode);
+
+          const shouldReplace =
+            responseType.getProperties().some((symbol) => symbol.name === 'body') &&
+            responseType.getProperties().some((symbol) => symbol.name === 'json');
+
+          if (shouldReplace) {
+            const responseText = sourceCode.getText(responseBody.object);
+            const needAwait = responseBody.parent.type !== AST_NODE_TYPES.ReturnStatement;
+            const replacementText = needAwait ? `(await ${responseText}.json())` : `${responseText}.json()`;
+
+            context.report({
+              messageId: 'replaceBodyWithJson',
+              node: responseBody,
+              fix(fixer) {
+                return fixer.replaceText(responseBody, replacementText);
+              },
+            });
+          }
+        } catch (error) {
+          // eslint-disable-next-line no-console
+          console.error(`Failed to apply ${ruleId} rule for file "${context.filename}":`, error);
+          context.report({
+            node: responseBody,
+            messageId: 'unknownError',
+            data: {
+              fileName: context.filename,
+              error: error instanceof Error ? error.toString() : JSON.stringify(error),
+            },
+          });
+        }
+      },
+    };
+  },
+});
+
+export default rule;

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

@@ -0,0 +1,96 @@
+// fixture/fetch-response-header-getter-ts.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 getDocumentationUrl from '../get-documentation-url';
+
+export const ruleId = 'fetch-response-header-getter-ts';
+
+const createRule = ESLintUtils.RuleCreator((name) => getDocumentationUrl(name));
+
+const rule = createRule({
+  name: ruleId,
+  meta: {
+    type: 'suggestion',
+    docs: {
+      description: 'Use "get()" method to get header value from the headers object of the fetch response.',
+    },
+    messages: {
+      useGetter: 'Use "get()" method to get header value from the headers object of the fetch response.',
+      unknownError: 'Unknown error occurred in file "{{fileName}}": {{ error }}.',
+    },
+    fixable: 'code',
+    schema: [],
+  },
+  defaultOptions: [],
+  create(context) {
+    const parserServices = ESLintUtils.getParserServices(context);
+    const typeChecker = parserServices.program.getTypeChecker();
+    const sourceCode = context.sourceCode;
+
+    return {
+      'MemberExpression[object.property.name="headers"]': (responseHeadersAccess: TSESTree.MemberExpression) => {
+        try {
+          if (
+            responseHeadersAccess.property.type === AST_NODE_TYPES.Identifier &&
+            responseHeadersAccess.property.name === 'get'
+          ) {
+            // getter is already being used
+            return;
+          }
+
+          const responseHeadersTsNode = parserServices.esTreeNodeToTSNodeMap.get(responseHeadersAccess.object);
+          const responseType = typeChecker.getTypeAtLocation(responseHeadersTsNode);
+
+          const shouldReplace = responseType.getProperties().some((symbol) => symbol.name === 'get');
+          if (!shouldReplace) {
+            return;
+          }
+
+          // let replacementText = 'xxx';
+          // if (responseHeadersAccess.property.type === AST_NODE_TYPES.Identifier) {
+          //   replacementText = `${sourceCode.getText(responseHeadersAccess.object)}.get(${sourceCode.getText(responseHeadersAccess.property)})`;
+          // }
+          let replacementText: string;
+          if (responseHeadersAccess.property.type === AST_NODE_TYPES.Identifier) {
+            replacementText = `${sourceCode.getText(responseHeadersAccess.object)}.get(${sourceCode.getText(responseHeadersAccess.property)})`;
+          } else if (responseHeadersAccess.property.type === AST_NODE_TYPES.TemplateLiteral) {
+            replacementText = `${sourceCode.getText(responseHeadersAccess.object)}.get(${sourceCode.getText(responseHeadersAccess.property)})`;
+          } else if (responseHeadersAccess.property.type === AST_NODE_TYPES.Literal) {
+            replacementText = responseHeadersAccess.computed
+              ? `${sourceCode.getText(responseHeadersAccess.object)}.get(${sourceCode.getText(responseHeadersAccess.property)})`
+              : `${sourceCode.getText(responseHeadersAccess.object)}.get('${sourceCode.getText(responseHeadersAccess.property)}')`;
+          } else {
+            throw new Error(`Unexpected property type: ${responseHeadersAccess.property.type}`);
+          }
+
+          context.report({
+            messageId: 'useGetter',
+            node: responseHeadersAccess.property,
+            fix(fixer) {
+              return fixer.replaceText(responseHeadersAccess, replacementText);
+            },
+          });
+        } catch (error) {
+          // eslint-disable-next-line no-console
+          console.error(`Failed to apply ${ruleId} rule for file "${context.filename}":`, error);
+          context.report({
+            node: responseHeadersAccess,
+            messageId: 'unknownError',
+            data: {
+              fileName: context.filename,
+              error: error instanceof Error ? error.toString() : JSON.stringify(error),
+            },
+          });
+        }
+      },
+    };
+  },
+});
+
+export default rule;

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

@@ -157,10 +157,14 @@ const rule = createRule({
           const method = serviceCall.callee.property.name;
 
           // body
-          const requestBodyProperty = ['put', 'post', 'options'].includes(method)
-            ? serviceCall.arguments[1]
-            : undefined;
-
+          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]

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

@@ -21,7 +21,7 @@ const rule = createRule({
       description: 'Access the status code property of the fetch Response using "status" instead of "statusCode".',
     },
     messages: {
-      replaceStatusCode: 'Replacing "statusCode" with "status".',
+      replaceStatusCode: 'Replace "statusCode" with "status".',
       unknownError: 'Unknown error occurred in file "{{fileName}}": {{ error }}.',
     },
     fixable: 'code',

package/src/fixture/url.ts

@@ -1,7 +1,7 @@
 // fixture/url.ts
 
-export const PLAIN_URL_REGEXP = /^[`']\/\w+(?<serviceNamePart>-\w+)*\/v\d+\/.+[`']$/u;
-export const TOKENIZED_URL_REGEXP = /^`\$\{(?<serviceNamePart>[A-Z]+_)*BASE_PATH\}\/.+`$/u;
+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

package/src/index.ts

@@ -7,6 +7,10 @@
  */
 
 import fetchHeaderGetter, { ruleId as fetchHeaderGetterRuleId } from './fixture/fetch-header-getter';
+import fetchResponseBodyJson, { ruleId as fetchResponseBodyJsonRuleId } from './fixture/fetch-response-body-json';
+import fetchResponseHeaderGetterTs, {
+  ruleId as fetchResponseHeaderGetterTsRuleId,
+} from './fixture/fetch-response-header-getter-ts';
 import fetchThen, { ruleId as fetchThenRuleId } from './fixture/fetch-then';
 import invalidJsonStringify, { ruleId as invalidJsonStringifyRuleId } from './invalid-json-stringify';
 import noFixture, { ruleId as noFixtureRuleId } from './fixture/no-fixture';
@@ -41,6 +45,8 @@ export default {
     [fetchThenRuleId]: fetchThen,
     [noServiceWrapperRuleId]: noServiceWrapper,
     [noStatusCodeRuleId]: noStatusCode,
+    [fetchResponseBodyJsonRuleId]: fetchResponseBodyJson,
+    [fetchResponseHeaderGetterTsRuleId]: fetchResponseHeaderGetterTs,
   },
   configs: {
     all: {
@@ -61,6 +67,8 @@ export default {
         [`@checkdigit/${fetchThenRuleId}`]: 'error',
         [`@checkdigit/${noServiceWrapperRuleId}`]: 'error',
         [`@checkdigit/${noStatusCodeRuleId}`]: 'error',
+        [`@checkdigit/${fetchResponseBodyJsonRuleId}`]: 'error',
+        [`@checkdigit/${fetchResponseHeaderGetterTsRuleId}`]: 'error',
       },
     },
     recommended: {