Transform promise() on APIs called on client created inside constructor (#843)

Author: trivikr

.changeset/tasty-pugs-smile.md

@@ -0,0 +1,5 @@
+---
+"aws-sdk-js-codemod": patch
+---
+
+Transform promise() on APIs called on client created inside constructor

src/transforms/v2-to-v3/__fixtures__/api-promise/client-class-member.input.js

@@ -13,4 +13,19 @@ class ClientClassMember {
   async listTagsOfResource() {
     return await this.clientInClass.listTagsOfResource({ ResourceArn: "STRING_VALUE" }).promise();
   }
+}
+
+// Client as class member with creation inside constructor
+class ClientClassMemberConstructor {
+  constructor() {
+    this.clientInClassCtr = new AWS.DynamoDB();
+  }
+
+  async listTables() {
+    return this.clientInClassCtr.listTables().promise();
+  }
+
+  async listTagsOfResource() {
+    return this.clientInClassCtr.listTagsOfResource({ ResourceArn: "STRING_VALUE" }).promise();
+  }
 }

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

@@ -15,4 +15,21 @@ class ClientClassMember {
   async listTagsOfResource() {
     return this.clientInClass.listTagsOfResource({ ResourceArn: "STRING_VALUE" }).promise();
   }
+}
+
+// Client as class member with creation inside constructor
+class ClientClassMemberConstructor {
+  private clientInClassCtr: AWS.DynamoDB;
+  
+  constructor() {
+    this.clientInClassCtr = new AWS.DynamoDB();
+  }
+
+  async listTables() {
+    return this.clientInClassCtr.listTables().promise();
+  }
+
+  async listTagsOfResource() {
+    return this.clientInClassCtr.listTagsOfResource({ ResourceArn: "STRING_VALUE" }).promise();
+  }
 }

src/transforms/v2-to-v3/__fixtures__/api-promise/client-class-member.output.js

@@ -13,4 +13,19 @@ class ClientClassMember {
   async listTagsOfResource() {
     return await this.clientInClass.listTagsOfResource({ ResourceArn: "STRING_VALUE" });
   }
+}
+
+// Client as class member with creation inside constructor
+class ClientClassMemberConstructor {
+  constructor() {
+    this.clientInClassCtr = new DynamoDB();
+  }
+
+  async listTables() {
+    return this.clientInClassCtr.listTables();
+  }
+
+  async listTagsOfResource() {
+    return this.clientInClassCtr.listTagsOfResource({ ResourceArn: "STRING_VALUE" });
+  }
 }

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

@@ -15,4 +15,21 @@ class ClientClassMember {
   async listTagsOfResource() {
     return this.clientInClass.listTagsOfResource({ ResourceArn: "STRING_VALUE" });
   }
+}
+
+// Client as class member with creation inside constructor
+class ClientClassMemberConstructor {
+  private clientInClassCtr: DynamoDB;
+  
+  constructor() {
+    this.clientInClassCtr = new DynamoDB();
+  }
+
+  async listTables() {
+    return this.clientInClassCtr.listTables();
+  }
+
+  async listTagsOfResource() {
+    return this.clientInClassCtr.listTagsOfResource({ ResourceArn: "STRING_VALUE" });
+  }
 }

src/transforms/v2-to-v3/apis/getClientIdNamesFromNewExpr.ts

@@ -1,4 +1,4 @@
-import { Collection, Identifier, JSCodeshift, NewExpression } from "jscodeshift";
+import { Collection, Identifier, JSCodeshift, MemberExpression, NewExpression } from "jscodeshift";
 
 import { DOCUMENT_CLIENT, DYNAMODB, DYNAMODB_DOCUMENT_CLIENT } from "../config";
 import { getClientNewExpression } from "../utils";
@@ -15,10 +15,7 @@ const getNamesFromVariableDeclarator = (
   newExpression: NewExpression
 ) =>
   source
-    .find(j.VariableDeclarator, {
-      id: { type: "Identifier" },
-      init: newExpression,
-    })
+    .find(j.VariableDeclarator, { id: { type: "Identifier" }, init: newExpression })
     .nodes()
     .map((variableDeclarator) => (variableDeclarator.id as Identifier).name);
 
@@ -28,12 +25,29 @@ const getNamesFromAssignmentPattern = (
   newExpression: NewExpression
 ) =>
   source
-    .find(j.AssignmentPattern, {
-      left: { type: "Identifier" },
+    .find(j.AssignmentPattern, { left: { type: "Identifier" }, right: newExpression })
+    .nodes()
+    .map((assignmentPattern) => (assignmentPattern.left as Identifier).name);
+
+const getNamesFromThisMemberExpression = (
+  j: JSCodeshift,
+  source: Collection<unknown>,
+  newExpression: NewExpression
+) =>
+  source
+    .find(j.AssignmentExpression, {
+      left: {
+        type: "MemberExpression",
+        object: { type: "ThisExpression" },
+        property: { type: "Identifier" },
+      },
       right: newExpression,
     })
     .nodes()
-    .map((assignmentPattern) => (assignmentPattern.left as Identifier).name);
+    .map(
+      (assignmentExpression) =>
+        ((assignmentExpression.left as MemberExpression).property as Identifier).name
+    );
 
 export const getClientIdNamesFromNewExpr = (
   j: JSCodeshift,
@@ -43,7 +57,11 @@ export const getClientIdNamesFromNewExpr = (
   const namesFromGlobalModule = [];
   const namesFromServiceModule = [];
 
-  for (const getNames of [getNamesFromVariableDeclarator, getNamesFromAssignmentPattern]) {
+  for (const getNames of [
+    getNamesFromVariableDeclarator,
+    getNamesFromAssignmentPattern,
+    getNamesFromThisMemberExpression,
+  ]) {
     if (v2GlobalName) {
       namesFromGlobalModule.push(
         ...getNames(j, source, getClientNewExpression({ v2GlobalName, v2ClientName }))

src/transforms/v2-to-v3/apis/getClientIdThisExpressions.ts

@@ -8,8 +8,8 @@ export const getClientIdThisExpressions = (
   source: Collection<unknown>,
   clientIdentifiers: Identifier[]
 ): ThisMemberExpression[] =>
-  clientIdentifiers.flatMap((clientIdentifier) =>
-    source
+  clientIdentifiers.flatMap((clientIdentifier) => {
+    const clientIdsFromThisExpressionAssignment = source
       .find(j.AssignmentExpression, {
         left: thisMemberExpression as MemberExpression,
         right: clientIdentifier,
@@ -24,5 +24,25 @@ export const getClientIdThisExpressions = (
               name: ((assignmentExpression.left as MemberExpression).property as Identifier).name,
             },
           }) as ThisMemberExpression
-      )
-  );
+      );
+
+    const clientIdsFromThisExpression = source
+      .find(j.MemberExpression, {
+        type: "MemberExpression",
+        object: { type: "ThisExpression" },
+        property: clientIdentifier,
+      })
+      .nodes()
+      .map(
+        (memberExpression) =>
+          ({
+            ...thisMemberExpression,
+            property: {
+              type: "Identifier",
+              name: (memberExpression.property as Identifier).name,
+            },
+          }) as ThisMemberExpression
+      )[0];
+
+    return [...clientIdsFromThisExpressionAssignment, clientIdsFromThisExpression];
+  });