Remove enforcement of v2GlobalName to string (#234)

Author: trivikr

.changeset/thirty-cycles-know.md

@@ -0,0 +1,5 @@
+---
+"aws-sdk-js-codemod": patch
+---
+
+Remove enforcement of v2GlobalName to string

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

@@ -18,8 +18,7 @@ export default function transformer(file: FileInfo, api: API) {
   const j = isTypeScriptFile(file.path) ? api.jscodeshift.withParser("ts") : api.jscodeshift;
   const source = j(file.source);
 
-  // ToDo: Make v2GlobalName optional downstream as it can be undefined.
-  const v2GlobalName = getV2GlobalName(j, source) as string;
+  const v2GlobalName = getV2GlobalName(j, source);
   const v2ClientNames = getV2ClientNames(j, source);
 
   if (!v2GlobalName && v2ClientNames.length === 0) {
@@ -45,7 +44,9 @@ export default function transformer(file: FileInfo, api: API) {
     replaceClientCreation(j, source, { ...v2Options, v3ClientName });
   }
 
-  removeV2GlobalModule(j, source, v2GlobalName);
+  if (v2GlobalName) {
+    removeV2GlobalModule(j, source, v2GlobalName);
+  }
 
   return source.toSource();
 }

src/transforms/v2-to-v3/utils/add/addV3ClientModules.ts

@@ -6,9 +6,9 @@ import { addV3ClientRequires } from "./addV3ClientRequires";
 
 export interface AddV3ClientModulesOptions {
   v2ClientName: string;
+  v2GlobalName?: string;
   v3ClientName: string;
   v3ClientPackageName: string;
-  v2GlobalName: string;
 }
 
 export const addV3ClientModules = (

src/transforms/v2-to-v3/utils/get/getV2ClientIdNamesFromNewExpr.ts

@@ -5,7 +5,7 @@ import { getV2ClientNewExpression } from "./getV2ClientNewExpression";
 
 export interface GetV2ClientIdNamesFromNewExprOptions {
   v2ClientName: string;
-  v2GlobalName: string;
+  v2GlobalName?: string;
 }
 
 const getNamesFromVariableDeclarator = (

src/transforms/v2-to-v3/utils/get/getV2ClientIdNamesFromTSTypeRef.ts

@@ -4,29 +4,31 @@ import { getMergedArrayWithoutDuplicates } from "./getMergedArrayWithoutDuplicat
 
 export interface GetV2ClientIdNamesFromTSTypeRefOptions {
   v2ClientName: string;
-  v2GlobalName: string;
+  v2GlobalName?: string;
 }
 
 export const getV2ClientIdNamesFromTSTypeRef = (
   j: JSCodeshift,
   source: Collection<unknown>,
   { v2GlobalName, v2ClientName }: GetV2ClientIdNamesFromTSTypeRefOptions
 ): string[] => {
-  const clientIdNamesFromGlobalModule = source
-    .find(j.Identifier, {
-      typeAnnotation: {
-        typeAnnotation: {
-          typeName: {
-            left: { name: v2GlobalName },
-            right: { name: v2ClientName },
+  const namesFromGlobalName = v2GlobalName
+    ? source
+        .find(j.Identifier, {
+          typeAnnotation: {
+            typeAnnotation: {
+              typeName: {
+                left: { name: v2GlobalName },
+                right: { name: v2ClientName },
+              },
+            },
           },
-        },
-      },
-    })
-    .nodes()
-    .map((identifier) => identifier.name);
+        })
+        .nodes()
+        .map((identifier) => identifier.name)
+    : [];
 
-  const clientIdNamesFromServiceModule = source
+  const namesFromClientName = source
     .find(j.Identifier, {
       typeAnnotation: {
         typeAnnotation: {
@@ -37,8 +39,5 @@ export const getV2ClientIdNamesFromTSTypeRef = (
     .nodes()
     .map((identifier) => identifier.name);
 
-  return getMergedArrayWithoutDuplicates(
-    clientIdNamesFromGlobalModule,
-    clientIdNamesFromServiceModule
-  );
+  return getMergedArrayWithoutDuplicates(namesFromGlobalName, namesFromClientName);
 };

src/transforms/v2-to-v3/utils/get/getV2ClientIdentifiers.ts

@@ -4,30 +4,18 @@ import { getMergedArrayWithoutDuplicates } from "./getMergedArrayWithoutDuplicat
 import { getV2ClientIdNamesFromNewExpr } from "./getV2ClientIdNamesFromNewExpr";
 import { getV2ClientIdNamesFromTSTypeRef } from "./getV2ClientIdNamesFromTSTypeRef";
 
-export interface GetV2ClientIdNamesOptions {
+export interface GetV2ClientIdentifiersOptions {
   v2ClientName: string;
-  v2GlobalName: string;
+  v2GlobalName?: string;
 }
 
 export const getV2ClientIdentifiers = (
   j: JSCodeshift,
   source: Collection<unknown>,
-  { v2GlobalName, v2ClientName }: GetV2ClientIdNamesOptions
+  options: GetV2ClientIdentifiersOptions
 ): Identifier[] => {
-  const v2ClientIdNamesFromNewExpr = getV2ClientIdNamesFromNewExpr(j, source, {
-    v2GlobalName,
-    v2ClientName,
-  });
-
-  const v2ClientIdNamesFromTSTypeRef = getV2ClientIdNamesFromTSTypeRef(j, source, {
-    v2GlobalName,
-    v2ClientName,
-  });
-
-  const clientIdNames = getMergedArrayWithoutDuplicates(
-    v2ClientIdNamesFromNewExpr,
-    v2ClientIdNamesFromTSTypeRef
-  );
-
+  const namesFromNewExpr = getV2ClientIdNamesFromNewExpr(j, source, options);
+  const namesFromTSTypeRef = getV2ClientIdNamesFromTSTypeRef(j, source, options);
+  const clientIdNames = getMergedArrayWithoutDuplicates(namesFromNewExpr, namesFromTSTypeRef);
   return clientIdNames.map((clientidName) => ({ type: "Identifier", name: clientidName }));
 };

src/transforms/v2-to-v3/utils/get/getV2ClientTypeNames.ts

@@ -13,7 +13,7 @@ import { getV2ServiceModulePath } from "./getV2ServiceModulePath";
 
 export interface GetV2ClientTypeNamesOptions {
   v2ClientName: string;
-  v2GlobalName: string;
+  v2GlobalName?: string;
 }
 
 const getRightIdentifierName = (

src/transforms/v2-to-v3/utils/remove/removePromiseCalls.ts

@@ -5,19 +5,16 @@ import { removePromiseForCallExpression } from "./removePromiseForCallExpression
 
 export interface RemovePromiseCallsOptions {
   v2ClientName: string;
-  v2GlobalName: string;
+  v2GlobalName?: string;
 }
 
 // Removes .promise() from client API calls.
 export const removePromiseCalls = (
   j: JSCodeshift,
   source: Collection<unknown>,
-  { v2GlobalName, v2ClientName }: RemovePromiseCallsOptions
+  options: RemovePromiseCallsOptions
 ): void => {
-  const v2ClientIdentifiers = getV2ClientIdentifiers(j, source, {
-    v2GlobalName,
-    v2ClientName,
-  });
+  const v2ClientIdentifiers = getV2ClientIdentifiers(j, source, options);
   const v2ClientIdThisExpressions = getV2ClientIdThisExpressions(j, source, v2ClientIdentifiers);
 
   for (const v2ClientId of [...v2ClientIdentifiers, ...v2ClientIdThisExpressions]) {

src/transforms/v2-to-v3/utils/remove/removeV2ClientModule.ts

@@ -8,14 +8,15 @@ import { removeRequireIdentifierName } from "./removeRequireIdentifierName";
 
 export interface RemoveV2ClientModuleOptions {
   v2ClientName: string;
-  v2GlobalName: string;
+  v2GlobalName?: string;
 }
 
 export const removeV2ClientModule = (
   j: JSCodeshift,
   source: Collection<unknown>,
-  { v2ClientName, v2GlobalName }: RemoveV2ClientModuleOptions
+  options: RemoveV2ClientModuleOptions
 ) => {
+  const { v2ClientName } = options;
   const literalValue = getV2ServiceModulePath(v2ClientName);
   const removeIdentifierNameOptions = {
     identifierName: v2ClientName,
@@ -27,10 +28,7 @@ export const removeV2ClientModule = (
   } else {
     removeImportIdentifierName(j, source, removeIdentifierNameOptions);
 
-    const v2ClientTypeNames = getV2ClientTypeNames(j, source, {
-      v2ClientName,
-      v2GlobalName,
-    });
+    const v2ClientTypeNames = getV2ClientTypeNames(j, source, options);
     for (const v2ClientTypeName of v2ClientTypeNames) {
       if (isV2ClientInputOutputType(v2ClientTypeName)) {
         removeImportIdentifierName(j, source, {

src/transforms/v2-to-v3/utils/replace/replaceClientCreation.ts

@@ -4,22 +4,24 @@ import { getV2ClientNewExpression } from "../get";
 
 export interface ReplaceClientCreationOptions {
   v2ClientName: string;
+  v2GlobalName?: string;
   v3ClientName: string;
-  v2GlobalName: string;
 }
 
 // Replace v2 client creation with v3 client creation.
 export const replaceClientCreation = (
   j: JSCodeshift,
   source: Collection<unknown>,
-  { v2GlobalName, v2ClientName, v3ClientName }: ReplaceClientCreationOptions
+  { v2ClientName, v2GlobalName, v3ClientName }: ReplaceClientCreationOptions
 ): void => {
-  // Replace clients created with default module.
-  source
-    .find(j.NewExpression, getV2ClientNewExpression({ v2GlobalName, v2ClientName }))
-    .replaceWith((v2ClientNewExpression) =>
-      j.newExpression(j.identifier(v3ClientName), v2ClientNewExpression.node.arguments)
-    );
+  if (v2GlobalName) {
+    // Replace clients created with default module.
+    source
+      .find(j.NewExpression, getV2ClientNewExpression({ v2GlobalName, v2ClientName }))
+      .replaceWith((v2ClientNewExpression) =>
+        j.newExpression(j.identifier(v3ClientName), v2ClientNewExpression.node.arguments)
+      );
+  }
 
   // Replace clients created with client module.
   source