Remove promise() calls from clients created from service imports (#100)

Author: trivikr

.changeset/wet-timers-itch.md

@@ -0,0 +1,5 @@
+---
+"aws-sdk-js-codemod": patch
+---
+
+Remove promise() calls from clients created from service imports

src/transforms/v2-to-v3/__fixtures__/client-api-await.input.ts

@@ -0,0 +1,4 @@
+import DynamoDB from "aws-sdk/clients/dynamodb";
+
+const client = new DynamoDB();
+const data = await client.listTables().promise();

src/transforms/v2-to-v3/__fixtures__/client-api-await.output.ts

@@ -0,0 +1,4 @@
+import { DynamoDB } from "@aws-sdk/client-dynamodb";
+
+const client = new DynamoDB();
+const data = await client.listTables();

src/transforms/v2-to-v3/__fixtures__/client-api-promise-variable-declarator.input.ts

@@ -0,0 +1,4 @@
+import DynamoDB from "aws-sdk/clients/dynamodb";
+
+const client = new DynamoDB();
+const listTablesPromise = client.listTables().promise();

src/transforms/v2-to-v3/__fixtures__/client-api-promise-variable-declarator.output.ts

@@ -0,0 +1,4 @@
+import { DynamoDB } from "@aws-sdk/client-dynamodb";
+
+const client = new DynamoDB();
+const listTablesPromise = client.listTables();

src/transforms/v2-to-v3/__fixtures__/client-api-promise.input.ts

@@ -0,0 +1,9 @@
+import DynamoDB from "aws-sdk/clients/dynamodb";
+
+const client = new DynamoDB();
+
+client
+  .listTables()
+  .promise()
+  .then((data) => console.log(data))
+  .catch((err) => console.log(err, err.stack));

src/transforms/v2-to-v3/__fixtures__/client-api-promise.output.ts

@@ -0,0 +1,8 @@
+import { DynamoDB } from "@aws-sdk/client-dynamodb";
+
+const client = new DynamoDB();
+
+client
+  .listTables()
+  .then((data) => console.log(data))
+  .catch((err) => console.log(err, err.stack));

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

@@ -0,0 +1,44 @@
+import { Collection, Identifier, JSCodeshift } from "jscodeshift";
+
+import { getMergedArrayWithoutDuplicates } from "./getMergedArrayWithoutDuplicates";
+
+export interface GetClientIdentifierNamesOptions {
+  v2ClientName: string;
+  v2DefaultModuleName: string;
+}
+
+export const getClientIdentifierNames = (
+  j: JSCodeshift,
+  source: Collection<unknown>,
+  { v2DefaultModuleName, v2ClientName }: GetClientIdentifierNamesOptions
+): string[] => {
+  const clientIdentifierNamesFromDefaultImport = source
+    .find(j.VariableDeclarator, {
+      id: { type: "Identifier" },
+      init: {
+        type: "NewExpression",
+        callee: {
+          object: { type: "Identifier", name: v2DefaultModuleName },
+          property: { type: "Identifier", name: v2ClientName },
+        },
+      },
+    })
+    .nodes()
+    .map((variableDeclarator) => (variableDeclarator.id as Identifier).name);
+
+  const clientIdentifierNamesFromClientImport = source
+    .find(j.VariableDeclarator, {
+      id: { type: "Identifier" },
+      init: {
+        type: "NewExpression",
+        callee: { type: "Identifier", name: v2ClientName },
+      },
+    })
+    .nodes()
+    .map((variableDeclarator) => (variableDeclarator.id as Identifier).name);
+
+  return getMergedArrayWithoutDuplicates(
+    clientIdentifierNamesFromDefaultImport,
+    clientIdentifierNamesFromClientImport
+  );
+};

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

@@ -1,4 +1,6 @@
-import { Collection, Identifier, JSCodeshift, MemberExpression } from "jscodeshift";
+import { Collection, JSCodeshift, MemberExpression } from "jscodeshift";
+
+import { getClientIdentifierNames } from "./getClientIdentifierNames";
 
 export interface RemovePromiseCallsOptions {
   v2ClientName: string;
@@ -11,58 +13,51 @@ export const removePromiseCalls = (
   source: Collection<unknown>,
   { v2DefaultModuleName, v2ClientName }: RemovePromiseCallsOptions
 ): void => {
-  source
-    .find(j.VariableDeclarator, {
-      id: { type: "Identifier" },
-      init: {
-        type: "NewExpression",
+  const clientIdentifierNames = getClientIdentifierNames(j, source, {
+    v2DefaultModuleName,
+    v2ClientName,
+  });
+
+  for (const clientIdentifierName of clientIdentifierNames) {
+    source
+      .find(j.CallExpression, {
         callee: {
-          object: { type: "Identifier", name: v2DefaultModuleName },
-          property: { type: "Identifier", name: v2ClientName },
-        },
-      },
-    })
-    .forEach((nodePath) => {
-      const name = (nodePath.value.id as Identifier).name;
-      source
-        .find(j.CallExpression, {
-          callee: {
-            type: "MemberExpression",
-            object: {
-              type: "CallExpression",
-              callee: {
-                type: "MemberExpression",
-                object: {
-                  type: "Identifier",
-                  name,
-                },
+          type: "MemberExpression",
+          object: {
+            type: "CallExpression",
+            callee: {
+              type: "MemberExpression",
+              object: {
+                type: "Identifier",
+                name: clientIdentifierName,
               },
             },
-            property: { type: "Identifier", name: "promise" },
           },
-        })
-        .forEach((callExpressionPath) => {
-          switch (callExpressionPath.parentPath.value.type) {
-            case "AwaitExpression":
-              callExpressionPath.parentPath.value.argument = (
-                callExpressionPath.value.callee as MemberExpression
-              ).object;
-              break;
-            case "MemberExpression":
-              callExpressionPath.parentPath.value.object = (
-                callExpressionPath.value.callee as MemberExpression
-              ).object;
-              break;
-            case "VariableDeclarator":
-              callExpressionPath.parentPath.value.init = (
-                callExpressionPath.value.callee as MemberExpression
-              ).object;
-              break;
-            default:
-              throw new Error(
-                `Removal of .promise() not implemented for ${callExpressionPath.parentPath.value.type}`
-              );
-          }
-        });
-    });
+          property: { type: "Identifier", name: "promise" },
+        },
+      })
+      .forEach((callExpressionPath) => {
+        switch (callExpressionPath.parentPath.value.type) {
+          case "AwaitExpression":
+            callExpressionPath.parentPath.value.argument = (
+              callExpressionPath.value.callee as MemberExpression
+            ).object;
+            break;
+          case "MemberExpression":
+            callExpressionPath.parentPath.value.object = (
+              callExpressionPath.value.callee as MemberExpression
+            ).object;
+            break;
+          case "VariableDeclarator":
+            callExpressionPath.parentPath.value.init = (
+              callExpressionPath.value.callee as MemberExpression
+            ).object;
+            break;
+          default:
+            throw new Error(
+              `Removal of .promise() not implemented for ${callExpressionPath.parentPath.value.type}`
+            );
+        }
+      });
+  }
 };