Use local names to minimize transformation (#237)

Author: trivikr

.changeset/shy-dancers-camp.md

@@ -0,0 +1,5 @@
+---
+"aws-sdk-js-codemod": minor
+---
+
+Use local names to minimize transformation

scripts/generateNewClientTests/getV3ClientsNewExpressionCode.ts

@@ -1,9 +1,9 @@
-import { CLIENT_NAMES, CLIENT_NAMES_MAP } from "../../src/transforms/v2-to-v3/utils/config";
+import { CLIENT_NAMES } from "../../src/transforms/v2-to-v3/utils/config";
 
 export const getV3ClientsNewExpressionCode = () => {
   let v3ClientsNewExpressionCode = ``;
   for (const v2ClientName of CLIENT_NAMES) {
-    v3ClientsNewExpressionCode += `new ${CLIENT_NAMES_MAP[v2ClientName]}();\n`;
+    v3ClientsNewExpressionCode += `new ${v2ClientName}();\n`;
   }
   return v3ClientsNewExpressionCode;
 };

scripts/generateNewClientTests/getV3PackageImportsCode.ts

@@ -9,7 +9,9 @@ export const getV3PackageImportsCode = (sortedV2ClientNames: typeof CLIENT_NAMES
   for (const v2ClientName of sortedV2ClientNames) {
     const v3ClientName = CLIENT_NAMES_MAP[v2ClientName];
     const v3ClientPackageName = `@aws-sdk/${CLIENT_PACKAGE_NAMES_MAP[v2ClientName]}`;
-    v3PackageImportsCode += `import { ${v3ClientName} } from "${v3ClientPackageName}";\n`;
+    const v3ImportSpecifier =
+      v3ClientName === v2ClientName ? v3ClientName : `${v3ClientName} as ${v2ClientName}`;
+    v3PackageImportsCode += `import { ${v3ImportSpecifier} } from "${v3ClientPackageName}";\n`;
   }
   return v3PackageImportsCode;
 };

scripts/generateNewClientTests/getV3PackageRequireCode.ts

@@ -12,7 +12,9 @@ export const getV3PackageRequireCode = (
   for (const v2ClientName of sortedV2ClientNames) {
     const v3ClientName = CLIENT_NAMES_MAP[v2ClientName];
     const v3ClientPackageName = `@aws-sdk/${CLIENT_PACKAGE_NAMES_MAP[v2ClientName]}`;
-    v3PackageRequireCode += `const {\n  ${v3ClientName}\n} = require("${v3ClientPackageName}");\n`;
+    const v3RequireKeyValuePair =
+      v3ClientName === v2ClientName ? v3ClientName : `${v3ClientName}: ${v2ClientName}`;
+    v3PackageRequireCode += `const {\n  ${v3RequireKeyValuePair}\n} = require("${v3ClientPackageName}");\n`;
     if (extraNewLine) v3PackageRequireCode += `\n`;
   }
   return v3PackageRequireCode;

src/transforms/v2-to-v3/__fixtures__/api-promise/service-import.input.js

@@ -1,6 +1,6 @@
-import DynamoDB from "aws-sdk/clients/dynamodb";
+import AWS_DynamoDB from "aws-sdk/clients/dynamodb";
 
-const client = new DynamoDB();
+const client = new AWS_DynamoDB();
 
 // Promise without params
 {
@@ -21,7 +21,7 @@ const client = new DynamoDB();
 
   // Client as class member
   class ClientClassMember {
-    constructor(clientInCtr = new DynamoDB()) {
+    constructor(clientInCtr = new AWS_DynamoDB()) {
       this.clientInClass = clientInCtr;
     }
 

src/transforms/v2-to-v3/__fixtures__/api-promise/service-import.output.js

@@ -1,6 +1,6 @@
-import { DynamoDB } from "@aws-sdk/client-dynamodb";
+import { DynamoDB as AWS_DynamoDB } from "@aws-sdk/client-dynamodb";
 
-const client = new DynamoDB();
+const client = new AWS_DynamoDB();
 
 // Promise without params
 {
@@ -20,7 +20,7 @@ const client = new DynamoDB();
 
   // Client as class member
   class ClientClassMember {
-    constructor(clientInCtr = new DynamoDB()) {
+    constructor(clientInCtr = new AWS_DynamoDB()) {
       this.clientInClass = clientInCtr;
     }
 

src/transforms/v2-to-v3/__fixtures__/api-promise/service-require.input.js

@@ -0,0 +1,60 @@
+const AWS_DynamoDB = require("aws-sdk/clients/dynamodb");
+
+const client = new AWS_DynamoDB();
+
+// Promise without params
+{
+  // async/await
+  try {
+    await client.listTables().promise();
+    console.log(data);
+  } catch (err) {
+    console.log(err, err.stack);
+  }
+
+  // .then() and .catch()
+  client
+    .listTables()
+    .promise()
+    .then((data) => console.log(data))
+    .catch((err) => console.log(err, err.stack));
+
+  // Client as class member
+  class ClientClassMember {
+    constructor(clientInCtr = new AWS_DynamoDB()) {
+      this.clientInClass = clientInCtr;
+    }
+  
+    async listTables() {
+      return await this.clientInClass.listTables().promise();
+    }
+  }
+
+  // Variable declarator
+  const listTablesPromise = client.listTables().promise();
+
+  // Promise call on request in variable declarator
+  const listTablesRequest = client.listTables();
+  listTablesRequest
+    .promise()
+    .then((data) => console.log(data))
+    .catch((err) => console.log(err, err.stack));
+}
+
+// Promise with params
+{
+  // async/await
+  try {
+    await client.listTagsOfResource({ ResourceArn: "STRING_VALUE" }).promise();
+    console.log(data);
+  } catch (err) {
+    console.log(err, err.stack);
+  }
+
+  // .then() and .catch()
+  client
+    .listTagsOfResource({ ResourceArn: "STRING_VALUE" })
+    .promise()
+    .then((data) => console.log(data))
+    .catch((err) => console.log(err, err.stack));
+}

src/transforms/v2-to-v3/__fixtures__/api-promise/service-require.output.js

@@ -0,0 +1,59 @@
+const {
+  DynamoDB: AWS_DynamoDB
+} = require("@aws-sdk/client-dynamodb");
+
+const client = new AWS_DynamoDB();
+
+// Promise without params
+{
+  // async/await
+  try {
+    await client.listTables();
+    console.log(data);
+  } catch (err) {
+    console.log(err, err.stack);
+  }
+
+  // .then() and .catch()
+  client
+    .listTables()
+    .then((data) => console.log(data))
+    .catch((err) => console.log(err, err.stack));
+
+  // Client as class member
+  class ClientClassMember {
+    constructor(clientInCtr = new AWS_DynamoDB()) {
+      this.clientInClass = clientInCtr;
+    }
+  
+    async listTables() {
+      return await this.clientInClass.listTables();
+    }
+  }
+
+  // Variable declarator
+  const listTablesPromise = client.listTables();
+
+  // Promise call on request in variable declarator
+  const listTablesRequest = client.listTables();
+  listTablesRequest
+    .then((data) => console.log(data))
+    .catch((err) => console.log(err, err.stack));
+}
+
+// Promise with params
+{
+  // async/await
+  try {
+    await client.listTagsOfResource({ ResourceArn: "STRING_VALUE" });
+    console.log(data);
+  } catch (err) {
+    console.log(err, err.stack);
+  }
+
+  // .then() and .catch()
+  client
+    .listTagsOfResource({ ResourceArn: "STRING_VALUE" })
+    .then((data) => console.log(data))
+    .catch((err) => console.log(err, err.stack));
+}