Add comment to investigate removal of .promise() (#859)

Author: trivikr

.changeset/popular-ties-arrive.md

@@ -0,0 +1,5 @@
+---
+"aws-sdk-js-codemod": patch
+---
+
+Add comment to investigate removal of .promise()

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

@@ -0,0 +1,4 @@
+// client is AWS SDK JS v2 client here, but jscodeshift can't detect it because of lack of types/import.
+export const listTables = (client) => {
+  return client.listTables().promise();
+}

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

@@ -0,0 +1,8 @@
+// client is AWS SDK JS v2 client here, but jscodeshift can't detect it because of lack of types/import.
+export const listTables = (client) => {
+  return (
+    // The `.promise()` call might be on an JS SDK v2 client API.
+    // If yes, please remove .promise(). If not, remove this comment.
+    client.listTables().promise()
+  );
+}

src/transforms/v2-to-v3/__fixtures__/misc/no-formatting.input.js

@@ -1 +1 @@
-const env = {...process.env, ...this.config.env || {}}
+const env = {...process.env, ...(this.config.env || {})}

src/transforms/v2-to-v3/__fixtures__/misc/no-formatting.output.js

@@ -1 +1 @@
-const env = {...process.env, ...this.config.env || {}}
+const env = {...process.env, ...(this.config.env || {})}

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

@@ -0,0 +1,20 @@
+import { Collection, JSCodeshift } from "jscodeshift";
+
+export const addPromiseRemovalComments = (j: JSCodeshift, source: Collection<unknown>): void => {
+  // Add comment for .promise() calls which weren't removed.
+  source
+    .find(j.CallExpression, {
+      callee: {
+        type: "MemberExpression",
+        property: { type: "Identifier", name: "promise" },
+      },
+    })
+    .forEach(({ node }) => {
+      const comments = node.comments || [];
+      comments.push(j.commentLine(" The `.promise()` call might be on an JS SDK v2 client API."));
+      comments.push(
+        j.commentLine(" If yes, please remove .promise(). If not, remove this comment.")
+      );
+      node.comments = comments;
+    });
+};

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

@@ -5,6 +5,7 @@ export * from "./getClientWaiterStates";
 export * from "./getCommandName";
 export * from "./getS3SignedUrlApiNames";
 export * from "./getV3ClientWaiterApiName";
+export * from "./addPromiseRemovalComments";
 export * from "./isS3GetSignedUrlApiUsed";
 export * from "./isS3UploadApiUsed";
 export * from "./removePromiseCalls";

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

@@ -12,6 +12,7 @@ import {
   replaceAwsError,
   addEmptyObjectForUndefined,
   renameErrorCodeWithName,
+  addPromiseRemovalComments,
 } from "./apis";
 import { replaceAwsUtilFunctions } from "./aws-util";
 import {
@@ -50,8 +51,9 @@ const transformer = async (file: FileInfo, api: API) => {
   const importType = getImportType(j, source);
 
   if (importType === null) {
+    addPromiseRemovalComments(j, source);
     // Skip transformation, since no import/require statements found for "aws-sdk" package.
-    return file.source;
+    return source.toSource();
   }
 
   replaceDeepImport(j, source, { fromPath: "aws-sdk/global", toPath: PACKAGE_NAME });
@@ -126,6 +128,7 @@ const transformer = async (file: FileInfo, api: API) => {
   replaceAwsError(j, source, { v2GlobalName, importType });
   replaceAwsEndpoint(j, source, v2GlobalName);
   removeModules(j, source, importType);
+  addPromiseRemovalComments(j, source);
 
   const sourceString = getFormattedSourceString(source.toSource({ quote, useTabs, trailingComma }));