Support requires with MemberExpression property (#340)

.changeset/twelve-clouds-mix.md

@@ -0,0 +1,5 @@
+---
+"aws-sdk-js-codemod": patch
+---
+
+Support requires with MemberExpression property

scripts/generateNewClientTests/getGlobalRequirePropertyInput.ts

@@ -0,0 +1,14 @@
+import { CLIENTS_TO_TEST } from "./config";
+import { getV2ClientsNewExpressionCode } from "./getV2ClientsNewExpressionCode";
+
+export const getGlobalRequirePropertyInput = (codegenComment: string) => {
+  let globalRequireInputContent = `${codegenComment}\n`;
+
+  for (const clientName of CLIENTS_TO_TEST) {
+    globalRequireInputContent += `const ${clientName} = require("aws-sdk").${clientName};\n`;
+  }
+  globalRequireInputContent += `\n`;
+  globalRequireInputContent += getV2ClientsNewExpressionCode(CLIENTS_TO_TEST);
+
+  return globalRequireInputContent;
+};

scripts/generateNewClientTests/getGlobalRequirePropertyOutput.ts

@@ -0,0 +1,3 @@
+import { getServiceRequireDeepOutput } from "./getServiceRequireDeepOutput";
+
+export const getGlobalRequirePropertyOutput = getServiceRequireDeepOutput;

scripts/generateNewClientTests/index.ts

@@ -9,6 +9,8 @@ import { getGlobalImportInput } from "./getGlobalImportInput";
 import { getGlobalImportOutput } from "./getGlobalImportOutput";
 import { getGlobalRequireInput } from "./getGlobalRequireInput";
 import { getGlobalRequireOutput } from "./getGlobalRequireOutput";
+import { getGlobalRequirePropertyInput } from "./getGlobalRequirePropertyInput";
+import { getGlobalRequirePropertyOutput } from "./getGlobalRequirePropertyOutput";
 import { getServiceImportDeepInput } from "./getServiceImportDeepInput";
 import { getServiceImportDeepOutput } from "./getServiceImportDeepOutput";
 import { getServiceImportEqualsInput } from "./getServiceImportEqualsInput";
@@ -42,6 +44,8 @@ const newClientTestsPath = join(__dirname, "..", "..", newClientsTestsFolder);
     ["global-import-equals.output.ts", getGlobalImportEqualsOutput],
     ["global-require.input.js", getGlobalRequireInput],
     ["global-require.output.js", getGlobalRequireOutput],
+    ["global-require-property.input.js", getGlobalRequirePropertyInput],
+    ["global-require-property.output.js", getGlobalRequirePropertyOutput],
     ["service-import.input.js", getServiceImportInput],
     ["service-import.output.js", getServiceImportOutput],
     ["service-import-equals.input.ts", getServiceImportEqualsInput],

src/transforms/v2-to-v3/__fixtures__/new-client/global-require-property.input.js

@@ -0,0 +1,10 @@
+// This file is generated by scripts/generateNewClientTests/index.ts
+// Do not edit this file directly. Instead, edit the script and run it to regenerate this file.
+"use strict";
+const ACM = require("aws-sdk").ACM;
+const AccessAnalyzer = require("aws-sdk").AccessAnalyzer;
+const Discovery = require("aws-sdk").Discovery;
+
+new ACM();
+new AccessAnalyzer();
+new Discovery();

src/transforms/v2-to-v3/__fixtures__/new-client/global-require-property.output.js

@@ -0,0 +1,16 @@
+// This file is generated by scripts/generateNewClientTests/index.ts
+// Do not edit this file directly. Instead, edit the script and run it to regenerate this file.
+"use strict";
+const {
+  ACM
+} = require("@aws-sdk/client-acm");
+const {
+  AccessAnalyzer
+} = require("@aws-sdk/client-accessanalyzer");
+const {
+  ApplicationDiscoveryService: Discovery
+} = require("@aws-sdk/client-application-discovery-service");
+
+new ACM();
+new AccessAnalyzer();
+new Discovery();

src/transforms/v2-to-v3/client-names/getV2ClientNamesRecordFromRequire.ts

@@ -1,6 +1,7 @@
 import { Collection, Identifier, JSCodeshift, ObjectPattern, Property } from "jscodeshift";
 
 import { CLIENT_NAMES, PACKAGE_NAME } from "../config";
+import { getRequireDeclaratorsWithProperty } from "../modules";
 import { getV2ServiceModulePath } from "../utils";
 import { getRequireIds } from "./getRequireIds";
 
@@ -33,6 +34,25 @@ export const getV2ClientNamesRecordFromRequire = (
     }
   }
 
+  const declaratorsWithProperty = getRequireDeclaratorsWithProperty(j, source, {
+    sourceValue: PACKAGE_NAME,
+  }).nodes();
+
+  for (const declaratorWithProperty of declaratorsWithProperty) {
+    const { id, init } = declaratorWithProperty;
+    if (
+      id.type === "Identifier" &&
+      init != undefined &&
+      init.type === "MemberExpression" &&
+      init.property.type === "Identifier"
+    ) {
+      const v2ClientName = (init.property as Identifier).name;
+      if (CLIENT_NAMES.includes(v2ClientName)) {
+        v2ClientNamesRecord[v2ClientName] = (id as Identifier).name;
+      }
+    }
+  }
+
   for (const clientName of v2ClientNamesWithServiceModule) {
     const deepRequirePath = getV2ServiceModulePath(clientName);
     const idsFromDefaultImport = getRequireIds(j, source, deepRequirePath).filter(

src/transforms/v2-to-v3/modules/getRequireDeclaratorsWithProperty.ts

@@ -0,0 +1,25 @@
+import { Collection, JSCodeshift } from "jscodeshift";
+
+export interface GetRequireDeclaratorsWithPropertyOptions {
+  localName?: string;
+  identifierName?: string;
+  sourceValue: string;
+}
+
+export const getRequireDeclaratorsWithProperty = (
+  j: JSCodeshift,
+  source: Collection<unknown>,
+  { localName, identifierName, sourceValue }: GetRequireDeclaratorsWithPropertyOptions
+) =>
+  source.find(j.VariableDeclarator, {
+    id: { type: "Identifier", ...(localName && { name: localName }) },
+    init: {
+      type: "MemberExpression",
+      object: {
+        type: "CallExpression",
+        callee: { type: "Identifier", name: "require" },
+        arguments: [{ value: sourceValue }],
+      },
+      property: { type: "Identifier", ...(identifierName && { name: identifierName }) },
+    },
+  });

src/transforms/v2-to-v3/modules/getV2RequireDeclarator.ts

@@ -4,6 +4,7 @@ import { PACKAGE_NAME } from "../config";
 import { getV2ServiceModulePath } from "../utils";
 import { getRequireDeclaratorsWithIdentifier } from "./getRequireDeclaratorsWithIdentifier";
 import { getRequireDeclaratorsWithObjectPattern } from "./getRequireDeclaratorsWithObjectPattern";
+import { getRequireDeclaratorsWithProperty } from "./getRequireDeclaratorsWithProperty";
 
 export interface GetV2BaseDeclaratorOptions {
   v2ClientName: string;
@@ -36,6 +37,15 @@ export const getV2RequireDeclarator = (
     return requireDeclaratorsWithObjectPattern;
   }
 
+  const requireDeclaratorsWithProperty = getRequireDeclaratorsWithProperty(j, source, {
+    identifierName: v2ClientName,
+    sourceValue: PACKAGE_NAME,
+  });
+
+  if (requireDeclaratorsWithProperty.size() > 0) {
+    return requireDeclaratorsWithProperty;
+  }
+
   const v2ServiceModulePath = getV2ServiceModulePath(v2ClientName);
   const requireDeclaratorsWithIdentifier = getRequireDeclaratorsWithIdentifier(j, source, {
     identifierName: v2ClientLocalName,

src/transforms/v2-to-v3/modules/index.ts

@@ -1,6 +1,7 @@
 export * from "./addV3ClientModules";
 export * from "./getImportEqualsDeclaration";
 export * from "./getImportSpecifiers";
+export * from "./getRequireDeclaratorsWithProperty";
 export * from "./getV2GlobalNameFromModule";
 export * from "./hasRequire";
 export * from "./removeV2ClientModule";

src/transforms/v2-to-v3/modules/removeRequireProperty.ts

@@ -0,0 +1,34 @@
+import { Collection, JSCodeshift } from "jscodeshift";
+
+import { getRequireDeclaratorsWithProperty } from "./getRequireDeclaratorsWithProperty";
+
+export interface RemoveRequireObjectPropertyOptions {
+  localName: string;
+  propertyName: string;
+  sourceValue: string;
+}
+
+export const removeRequireProperty = (
+  j: JSCodeshift,
+  source: Collection<unknown>,
+  { localName, propertyName, sourceValue }: RemoveRequireObjectPropertyOptions
+) => {
+  const requireDeclarators = getRequireDeclaratorsWithProperty(j, source, {
+    identifierName: propertyName,
+    localName,
+    sourceValue,
+  });
+
+  requireDeclarators.forEach((varDeclarator) => {
+    const varDeclarationCollection = j(varDeclarator).closest(j.VariableDeclaration);
+
+    // Remove VariableDeclarator as it contains the only identifier.
+    j(varDeclarator).remove();
+
+    // Remove VariableDeclaration if there are no declarations.
+    const varDeclaration = varDeclarationCollection.nodes()[0];
+    if (varDeclaration && varDeclaration.declarations?.length === 0) {
+      varDeclarationCollection.remove();
+    }
+  });
+};

src/transforms/v2-to-v3/modules/removeV2ClientModule.ts

@@ -10,6 +10,7 @@ import { removeImportEquals } from "./removeImportEquals";
 import { removeImportNamed } from "./removeImportNamed";
 import { removeRequireIdentifier } from "./removeRequireIdentifier";
 import { removeRequireObjectProperty } from "./removeRequireObjectProperty";
+import { removeRequireProperty } from "./removeRequireProperty";
 
 export interface RemoveV2ClientModuleOptions {
   v2ClientName: string;
@@ -31,6 +32,7 @@ export const removeV2ClientModule = (
   if (hasRequire(j, source)) {
     removeRequireIdentifier(j, source, defaultOptions);
     removeRequireObjectProperty(j, source, namedOptions);
+    removeRequireProperty(j, source, { ...namedOptions, propertyName: v2ClientName });
   } else if (hasImportEquals(j, source)) {
     removeImportEquals(j, source, defaultOptions);
   } else {