Support transformation of v2 client imports (#48)

Author: trivikr

.changeset/hot-maps-walk.md

@@ -0,0 +1,5 @@
+---
+"aws-sdk-js-codemod": minor
+---
+
+Support transformation of v2 client imports

src/transforms/v2-to-v3/__fixtures__/clients-individual-all.input.ts

@@ -3,10 +3,12 @@ import { API, FileInfo } from "jscodeshift";
 import {
   addV3ClientImport,
   getClientMetadata,
+  getV2ClientImportNames,
   getV2ClientNames,
   getV2DefaultImportName,
   removeDefaultImportIfNotUsed,
   removePromiseCalls,
+  removeV2ClientImport,
   replaceClientCreation,
 } from "./utils";
 
@@ -15,16 +17,18 @@ export default function transformer(file: FileInfo, api: API) {
   const source = j(file.source);
 
   const v2DefaultImportName = getV2DefaultImportName(j, source);
-  if (!v2DefaultImportName) {
+  const v2ClientImportNames = getV2ClientImportNames(j, source);
+  if (!v2DefaultImportName && v2ClientImportNames.length === 0) {
     return source.toSource();
   }
 
-  const v2ClientNames = getV2ClientNames(j, source, v2DefaultImportName);
+  const v2ClientNames = getV2ClientNames(j, source, { v2DefaultImportName, v2ClientImportNames });
   const clientMetadata = getClientMetadata(v2ClientNames);
 
   for (const [v2ClientName, v3ClientMetadata] of Object.entries(clientMetadata).reverse()) {
     const { v3ClientName, v3ClientPackageName } = v3ClientMetadata;
-    addV3ClientImport(j, source, { v3ClientName, v3ClientPackageName });
+    addV3ClientImport(j, source, { v2ClientName, v3ClientName, v3ClientPackageName });
+    removeV2ClientImport(j, source, v2ClientName);
     removePromiseCalls(j, source, { v2DefaultImportName, v2ClientName });
     replaceClientCreation(j, source, { v2DefaultImportName, v2ClientName, v3ClientName });
   }

src/transforms/v2-to-v3/__fixtures__/clients-individual-all.output.ts

@@ -1,14 +1,15 @@
 import { Collection, JSCodeshift } from "jscodeshift";
 
 export interface AddV3ClientImportOptions {
+  v2ClientName: string;
   v3ClientName: string;
   v3ClientPackageName: string;
 }
 
 export const addV3ClientImport = (
   j: JSCodeshift,
   source: Collection<any>,
-  { v3ClientName, v3ClientPackageName }: AddV3ClientImportOptions
+  { v2ClientName, v3ClientName, v3ClientPackageName }: AddV3ClientImportOptions
 ): void => {
   const existingImports = source.find(j.ImportDeclaration, {
     source: { value: v3ClientPackageName },
@@ -25,9 +26,14 @@ export const addV3ClientImport = (
     return;
   }
 
+  // Insert after default import if present. If not, insert after client import.
   source
     .find(j.ImportDeclaration)
-    .filter((path) => path.value.source.value === "aws-sdk")
+    .filter(
+      (path) =>
+        path.value.source.value === "aws-sdk" ||
+        path.value.source.value === `aws-sdk/clients/${v2ClientName.toLowerCase()}`
+    )
     .insertAfter(
       j.importDeclaration(
         [j.importSpecifier(j.identifier(v3ClientName))],

src/transforms/v2-to-v3/transformer.ts

@@ -1,2 +1,3 @@
+export * from "./CLIENT_NAMES";
 export * from "./CLIENT_NAMES_MAP";
 export * from "./CLIENT_PACKAGE_NAMES_MAP";

src/transforms/v2-to-v3/utils/addV3ClientImport.ts

@@ -0,0 +1,20 @@
+import { Collection, JSCodeshift } from "jscodeshift";
+import findImports from "jscodeshift-find-imports";
+
+import { CLIENT_NAMES } from "./config";
+
+export const getV2ClientImportNames = (j: JSCodeshift, source: Collection<any>): string[] => {
+  const v2ClientImportNames = [];
+  const { statement } = j.template;
+
+  for (const clientName of CLIENT_NAMES) {
+    const importStatement = `import ${clientName} from 'aws-sdk/clients/${clientName.toLowerCase()}'`;
+    const imports = findImports(source, statement([importStatement]));
+
+    for (const importObj of Object.values(imports)) {
+      if (importObj.type === "Identifier") v2ClientImportNames.push(importObj.name);
+    }
+  }
+
+  return v2ClientImportNames;
+};

src/transforms/v2-to-v3/utils/config/index.ts

@@ -1,11 +1,16 @@
 import { Collection, Identifier, JSCodeshift, MemberExpression } from "jscodeshift";
 
+export interface GetV2ClientNamesOptions {
+  v2DefaultImportName: string;
+  v2ClientImportNames: string[];
+}
+
 export const getV2ClientNames = (
   j: JSCodeshift,
   source: Collection<any>,
-  v2DefaultImportName: string
-): Array<string> =>
-  source
+  { v2DefaultImportName, v2ClientImportNames }: GetV2ClientNamesOptions
+): Array<string> => {
+  const v2ClientNamesFromDefaultImport = source
     .find(j.NewExpression, {
       callee: {
         type: "MemberExpression",
@@ -17,3 +22,11 @@ export const getV2ClientNames = (
     .map(
       (newExpression) => ((newExpression.callee as MemberExpression).property as Identifier).name
     );
+
+  // Merge v2ClientNamesFromDefaultImport with v2ClientImportNames with duplicates removed.
+  return v2ClientNamesFromDefaultImport.concat(
+    v2ClientImportNames.filter(
+      (v2ClientImportName) => v2ClientNamesFromDefaultImport.indexOf(v2ClientImportName) < 0
+    )
+  );
+};

src/transforms/v2-to-v3/utils/getV2ClientImportNames.ts

@@ -1,8 +1,10 @@
 export * from "./addV3ClientImport";
 export * from "./getClientMetadata";
+export * from "./getV2ClientImportNames";
 export * from "./getV2ClientNames";
 export * from "./getV2DefaultImportName";
 export * from "./removeDefaultImportIfNotUsed";
 export * from "./removePromiseCalls";
+export * from "./removeV2ClientImport";
 export * from "./replaceClientCreation";
 export * from "./types";

src/transforms/v2-to-v3/utils/getV2ClientNames.ts

@@ -17,7 +17,7 @@ export const removeDefaultImportIfNotUsed = (
         source: { value: "aws-sdk" },
       })
       .forEach((declerationPath) => {
-        // Remove default import from ImportDecleration.
+        // Remove default import from ImportDeclaration.
         declerationPath.value.specifiers = declerationPath.value.specifiers.filter(
           (specifier) =>
             specifier.type !== "ImportDefaultSpecifier" &&