Process clients from TS Type Reference (#77)

trivikr · web-flow · commit 334a8341cda6 · 2022-03-09T21:14:16.000-08:00
diff --git a/.changeset/tricky-flowers-talk.md b/.changeset/tricky-flowers-talk.md
@@ -0,0 +1,5 @@
+---
+"aws-sdk-js-codemod": minor
+---
+
+Process clients from TS Type Reference
diff --git a/src/transforms/v2-to-v3/__fixtures__/tsonly-api-promise-no-client.input.ts b/src/transforms/v2-to-v3/__fixtures__/tsonly-api-promise-no-client.input.ts
@@ -0,0 +1,3 @@
+import AWS from "aws-sdk";
+
+export const listTables = (client: AWS.DynamoDB) => client.listTables().promise();
diff --git a/src/transforms/v2-to-v3/__fixtures__/tsonly-api-promise-no-client.output.ts b/src/transforms/v2-to-v3/__fixtures__/tsonly-api-promise-no-client.output.ts
@@ -0,0 +1,3 @@
+import { DynamoDB } from "@aws-sdk/client-dynamodb";
+
+export const listTables = (client: DynamoDB) => client.listTables();
diff --git a/src/transforms/v2-to-v3/__fixtures__/tsonly-service-api-promise-no-client.input.ts b/src/transforms/v2-to-v3/__fixtures__/tsonly-service-api-promise-no-client.input.ts
@@ -0,0 +1,3 @@
+import DynamoDB from "aws-sdk/clients/dynamodb";
+
+export const listTables = (client: DynamoDB) => client.listTables().promise();
diff --git a/src/transforms/v2-to-v3/__fixtures__/tsonly-service-api-promise-no-client.output.ts b/src/transforms/v2-to-v3/__fixtures__/tsonly-service-api-promise-no-client.output.ts
@@ -0,0 +1,3 @@
+import { DynamoDB } from "@aws-sdk/client-dynamodb";
+
+export const listTables = (client: DynamoDB) => client.listTables();
diff --git a/src/transforms/v2-to-v3/transformer.spec.ts b/src/transforms/v2-to-v3/transformer.spec.ts
@@ -17,8 +17,13 @@ describe("v2-to-v3", () => {
     const outputCode = readFileSync(outputPath, "utf8");
     const input = { path: inputPath, source: inputCode };
 
-    it.each([{}, { parser: "ts" }])("with testOptions: %o", (testOptions) => {
-      runInlineTest(transformer, null, input, outputCode, testOptions);
-    });
+    // Some tests are tsonly as they fail with babel parser
+    // Refs: https://github.com/facebook/jscodeshift/issues/488
+    it.each([{ parser: "ts" }, ...(testFilePrefix.startsWith("tsonly-") ? [] : [{}])])(
+      "with testOptions: %o",
+      (testOptions) => {
+        runInlineTest(transformer, null, input, outputCode, testOptions);
+      }
+    );
   });
 });
diff --git a/src/transforms/v2-to-v3/transformer.ts b/src/transforms/v2-to-v3/transformer.ts
@@ -10,6 +10,7 @@ import {
   removePromiseCalls,
   removeV2ClientModule,
   replaceClientCreation,
+  replaceTSTypeReference,
 } from "./utils";
 
 export default function transformer(file: FileInfo, api: API) {
@@ -31,6 +32,7 @@ export default function transformer(file: FileInfo, api: API) {
     removeV2ClientModule(j, source, v2ClientName);
     removePromiseCalls(j, source, { v2DefaultModuleName, v2ClientName });
     replaceClientCreation(j, source, { v2DefaultModuleName, v2ClientName, v3ClientName });
+    replaceTSTypeReference(j, source, { v2DefaultModuleName, v2ClientName, v3ClientName });
   }
 
   removeDefaultModuleIfNotUsed(j, source, v2DefaultModuleName);
diff --git a/src/transforms/v2-to-v3/utils/getV2ClientIdNames.ts b/src/transforms/v2-to-v3/utils/getV2ClientIdNames.ts
@@ -0,0 +1,28 @@
+import { Collection, JSCodeshift } from "jscodeshift";
+
+import { getMergedArrayWithoutDuplicates } from "./getMergedArrayWithoutDuplicates";
+import { getV2ClientIdNamesFromNewExpr } from "./getV2ClientIdNamesFromNewExpr";
+import { getV2ClientIdNamesFromTSTypeRef } from "./getV2ClientIdNamesFromTSTypeRef";
+
+export interface GetV2ClientIdNamesOptions {
+  v2ClientName: string;
+  v2DefaultModuleName: string;
+}
+
+export const getV2ClientIdNames = (
+  j: JSCodeshift,
+  source: Collection<unknown>,
+  { v2DefaultModuleName, v2ClientName }: GetV2ClientIdNamesOptions
+): string[] => {
+  const v2ClientIdNamesFromNewExpr = getV2ClientIdNamesFromNewExpr(j, source, {
+    v2DefaultModuleName,
+    v2ClientName,
+  });
+
+  const v2ClientIdNamesFromTSTypeRef = getV2ClientIdNamesFromTSTypeRef(j, source, {
+    v2DefaultModuleName,
+    v2ClientName,
+  });
+
+  return getMergedArrayWithoutDuplicates(v2ClientIdNamesFromNewExpr, v2ClientIdNamesFromTSTypeRef);
+};
diff --git a/src/transforms/v2-to-v3/utils/getV2ClientIdNamesFromNewExpr.ts b/src/transforms/v2-to-v3/utils/getV2ClientIdNamesFromNewExpr.ts
@@ -2,17 +2,17 @@ import { Collection, Identifier, JSCodeshift } from "jscodeshift";
 
 import { getMergedArrayWithoutDuplicates } from "./getMergedArrayWithoutDuplicates";
 
-export interface GetClientIdentifierNamesOptions {
+export interface GetV2ClientIdNamesFromNewExprOptions {
   v2ClientName: string;
   v2DefaultModuleName: string;
 }
 
-export const getClientIdentifierNames = (
+export const getV2ClientIdNamesFromNewExpr = (
   j: JSCodeshift,
   source: Collection<unknown>,
-  { v2DefaultModuleName, v2ClientName }: GetClientIdentifierNamesOptions
+  { v2DefaultModuleName, v2ClientName }: GetV2ClientIdNamesFromNewExprOptions
 ): string[] => {
-  const clientIdentifierNamesFromDefaultImport = source
+  const clientIdNamesFromDefaultModule = source
     .find(j.VariableDeclarator, {
       id: { type: "Identifier" },
       init: {
@@ -26,7 +26,7 @@ export const getClientIdentifierNames = (
     .nodes()
     .map((variableDeclarator) => (variableDeclarator.id as Identifier).name);
 
-  const clientIdentifierNamesFromClientImport = source
+  const clientIdNamesFromServiceModule = source
     .find(j.VariableDeclarator, {
       id: { type: "Identifier" },
       init: {
@@ -38,7 +38,7 @@ export const getClientIdentifierNames = (
     .map((variableDeclarator) => (variableDeclarator.id as Identifier).name);
 
   return getMergedArrayWithoutDuplicates(
-    clientIdentifierNamesFromDefaultImport,
-    clientIdentifierNamesFromClientImport
+    clientIdNamesFromDefaultModule,
+    clientIdNamesFromServiceModule
   );
 };
diff --git a/src/transforms/v2-to-v3/utils/getV2ClientIdNamesFromTSTypeRef.ts b/src/transforms/v2-to-v3/utils/getV2ClientIdNamesFromTSTypeRef.ts
@@ -0,0 +1,44 @@
+import { Collection, Identifier, JSCodeshift } from "jscodeshift";
+
+import { getMergedArrayWithoutDuplicates } from "./getMergedArrayWithoutDuplicates";
+
+export interface GetV2ClientIdNamesFromTSTypeRefOptions {
+  v2ClientName: string;
+  v2DefaultModuleName: string;
+}
+
+export const getV2ClientIdNamesFromTSTypeRef = (
+  j: JSCodeshift,
+  source: Collection<unknown>,
+  { v2DefaultModuleName, v2ClientName }: GetV2ClientIdNamesFromTSTypeRefOptions
+): string[] => {
+  const clientIdNamesFromDefaultModule = source
+    .find(j.Identifier, {
+      typeAnnotation: {
+        typeAnnotation: {
+          typeName: {
+            left: { name: v2DefaultModuleName },
+            right: { name: v2ClientName },
+          },
+        },
+      },
+    })
+    .nodes()
+    .map((identifier) => identifier.name);
+
+  const clientIdNamesFromServiceModule = source
+    .find(j.Identifier, {
+      typeAnnotation: {
+        typeAnnotation: {
+          typeName: { type: "Identifier", name: v2ClientName },
+        },
+      },
+    })
+    .nodes()
+    .map((identifier) => identifier.name);
+
+  return getMergedArrayWithoutDuplicates(
+    clientIdNamesFromDefaultModule,
+    clientIdNamesFromServiceModule
+  );
+};
diff --git a/src/transforms/v2-to-v3/utils/getV2ClientNames.ts b/src/transforms/v2-to-v3/utils/getV2ClientNames.ts
@@ -1,6 +1,8 @@
-import { Collection, Identifier, JSCodeshift, MemberExpression } from "jscodeshift";
+import { Collection, JSCodeshift } from "jscodeshift";
 
 import { getMergedArrayWithoutDuplicates } from "./getMergedArrayWithoutDuplicates";
+import { getV2ClientNamesFromNewExpr } from "./getV2ClientNamesFromNewExpr";
+import { getV2ClientNamesFromTSTypeRef } from "./getV2ClientNamesFromTSTypeRef";
 
 export interface GetV2ClientNamesOptions {
   v2DefaultModuleName: string;
@@ -12,18 +14,11 @@ export const getV2ClientNames = (
   source: Collection<unknown>,
   { v2DefaultModuleName, v2ServiceModuleNames }: GetV2ClientNamesOptions
 ): string[] => {
-  const v2ClientNamesFromDefaultModule = source
-    .find(j.NewExpression, {
-      callee: {
-        type: "MemberExpression",
-        object: { type: "Identifier", name: v2DefaultModuleName },
-        property: { type: "Identifier" },
-      },
-    })
-    .nodes()
-    .map(
-      (newExpression) => ((newExpression.callee as MemberExpression).property as Identifier).name
-    );
+  const v2ClientNamesFromNewExpr = getV2ClientNamesFromNewExpr(j, source, v2DefaultModuleName);
+  const v2ClientNamesFromTSTypeRef = getV2ClientNamesFromTSTypeRef(j, source, v2DefaultModuleName);
 
-  return getMergedArrayWithoutDuplicates(v2ClientNamesFromDefaultModule, v2ServiceModuleNames);
+  return getMergedArrayWithoutDuplicates(
+    getMergedArrayWithoutDuplicates(v2ClientNamesFromNewExpr, v2ClientNamesFromTSTypeRef),
+    v2ServiceModuleNames
+  );
 };
diff --git a/src/transforms/v2-to-v3/utils/getV2ClientNamesFromNewExpr.ts b/src/transforms/v2-to-v3/utils/getV2ClientNamesFromNewExpr.ts
@@ -0,0 +1,19 @@
+import { Collection, Identifier, JSCodeshift, MemberExpression } from "jscodeshift";
+
+export const getV2ClientNamesFromNewExpr = (
+  j: JSCodeshift,
+  source: Collection<unknown>,
+  v2DefaultModuleName: string
+): string[] =>
+  source
+    .find(j.NewExpression, {
+      callee: {
+        type: "MemberExpression",
+        object: { type: "Identifier", name: v2DefaultModuleName },
+        property: { type: "Identifier" },
+      },
+    })
+    .nodes()
+    .map(
+      (newExpression) => ((newExpression.callee as MemberExpression).property as Identifier).name
+    );
diff --git a/src/transforms/v2-to-v3/utils/getV2ClientNamesFromTSTypeRef.ts b/src/transforms/v2-to-v3/utils/getV2ClientNamesFromTSTypeRef.ts
@@ -0,0 +1,15 @@
+import { Collection, Identifier, JSCodeshift, TSQualifiedName } from "jscodeshift";
+
+export const getV2ClientNamesFromTSTypeRef = (
+  j: JSCodeshift,
+  source: Collection<unknown>,
+  v2DefaultModuleName: string
+): string[] =>
+  source
+    .find(j.TSTypeReference, {
+      typeName: { left: { name: v2DefaultModuleName } },
+    })
+    .nodes()
+    .map(
+      (tsTypeReference) => ((tsTypeReference.typeName as TSQualifiedName).right as Identifier).name
+    );
diff --git a/src/transforms/v2-to-v3/utils/index.ts b/src/transforms/v2-to-v3/utils/index.ts
@@ -8,4 +8,5 @@ export * from "./removeDefaultModuleIfNotUsed";
 export * from "./removePromiseCalls";
 export * from "./removeV2ClientModule";
 export * from "./replaceClientCreation";
+export * from "./replaceTSTypeReference";
 export * from "./types";
diff --git a/src/transforms/v2-to-v3/utils/removePromiseCalls.ts b/src/transforms/v2-to-v3/utils/removePromiseCalls.ts
@@ -1,6 +1,6 @@
-import { Collection, JSCodeshift, MemberExpression } from "jscodeshift";
+import { CallExpression, Collection, JSCodeshift, MemberExpression } from "jscodeshift";
 
-import { getClientIdentifierNames } from "./getClientIdentifierNames";
+import { getV2ClientIdNames } from "./getV2ClientIdNames";
 
 export interface RemovePromiseCallsOptions {
   v2ClientName: string;
@@ -13,12 +13,12 @@ export const removePromiseCalls = (
   source: Collection<unknown>,
   { v2DefaultModuleName, v2ClientName }: RemovePromiseCallsOptions
 ): void => {
-  const clientIdentifierNames = getClientIdentifierNames(j, source, {
+  const v2ClientIdNames = getV2ClientIdNames(j, source, {
     v2DefaultModuleName,
     v2ClientName,
   });
 
-  for (const clientIdentifierName of clientIdentifierNames) {
+  for (const v2ClientIdName of v2ClientIdNames) {
     source
       .find(j.CallExpression, {
         callee: {
@@ -29,7 +29,7 @@ export const removePromiseCalls = (
               type: "MemberExpression",
               object: {
                 type: "Identifier",
-                name: clientIdentifierName,
+                name: v2ClientIdName,
               },
             },
           },
@@ -53,6 +53,12 @@ export const removePromiseCalls = (
               callExpressionPath.value.callee as MemberExpression
             ).object;
             break;
+          case "ArrowFunctionExpression":
+          case "ReturnStatement":
+            callExpressionPath.value.callee = (
+              (callExpressionPath.value.callee as MemberExpression).object as CallExpression
+            ).callee;
+            break;
           default:
             throw new Error(
               `Removal of .promise() not implemented for ${callExpressionPath.parentPath.value.type}`
diff --git a/src/transforms/v2-to-v3/utils/replaceTSTypeReference.ts b/src/transforms/v2-to-v3/utils/replaceTSTypeReference.ts
@@ -0,0 +1,36 @@
+import { Collection, JSCodeshift } from "jscodeshift";
+
+export interface ReplaceTypeReferenceOptions {
+  v2ClientName: string;
+  v3ClientName: string;
+  v2DefaultModuleName: string;
+}
+
+// Replace v2 client type reference with v3 client type reference.
+export const replaceTSTypeReference = (
+  j: JSCodeshift,
+  source: Collection<unknown>,
+  { v2DefaultModuleName, v2ClientName, v3ClientName }: ReplaceTypeReferenceOptions
+): void => {
+  // Replace type reference created with default module.
+  source
+    .find(j.TSTypeReference, {
+      typeName: { left: { name: v2DefaultModuleName } },
+    })
+    .replaceWith((nodePath) => {
+      const { node } = nodePath;
+      node.typeName = j.identifier(v3ClientName);
+      return node;
+    });
+
+  // Replace type reference created with client module.
+  source
+    .find(j.TSTypeReference, {
+      typeName: { type: "Identifier", name: v2ClientName },
+    })
+    .replaceWith((nodePath) => {
+      const { node } = nodePath;
+      node.typeName = j.identifier(v3ClientName);
+      return node;
+    });
+};

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +---
 +"aws-sdk-js-codemod": minor
 +---
++
 +Process clients from TS Type Reference
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+import AWS from "aws-sdk";`
	`2`	`+`
	`3`	`+export const listTables = (client: AWS.DynamoDB) => client.listTables().promise();`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+import { DynamoDB } from "@aws-sdk/client-dynamodb";`
	`2`	`+`
	`3`	`+export const listTables = (client: DynamoDB) => client.listTables();`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+import DynamoDB from "aws-sdk/clients/dynamodb";`
	`2`	`+`
	`3`	`+export const listTables = (client: DynamoDB) => client.listTables().promise();`