Add comment with warning when removing .promise() from untested cases (#397)

Author: trivikr

.changeset/mean-actors-give.md

@@ -0,0 +1,5 @@
+---
+"aws-sdk-js-codemod": minor
+---
+
+Add comment with warning when removing .promise() from untested cases

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

@@ -36,7 +36,7 @@ export const removePromiseCalls = (
         },
       })
       .forEach((callExpression) => {
-        removePromiseForCallExpression(callExpression);
+        removePromiseForCallExpression(j, callExpression);
       });
 
     // Remove .promise() from client API request stored in a variable.
@@ -64,7 +64,7 @@ export const removePromiseCalls = (
             },
           })
           .forEach((callExpression) => {
-            removePromiseForCallExpression(callExpression);
+            removePromiseForCallExpression(j, callExpression);
           });
       });
   }

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

@@ -1,14 +1,37 @@
-import { ASTPath, CallExpression, MemberExpression } from "jscodeshift";
-import { print } from "recast";
+import { ASTPath, CallExpression, JSCodeshift, MemberExpression } from "jscodeshift";
+import { emitWarning } from "process";
 
-export const removePromiseForCallExpression = (callExpression: ASTPath<CallExpression>) => {
+export const removePromiseForCallExpression = (
+  j: JSCodeshift,
+  callExpression: ASTPath<CallExpression>
+) => {
   switch (callExpression.parentPath.value.type) {
     case "MemberExpression": {
       callExpression.parentPath.value.object = (
         callExpression.value.callee as MemberExpression
       ).object;
       break;
     }
+    default: {
+      emitWarning(
+        `Removal of .promise() not implemented for parentPath: ${callExpression.parentPath.value.type}\n` +
+          `Code processed: ${j(callExpression.parentPath).toSource()}\n\n` +
+          "Please report your use case on https://github.com/awslabs/aws-sdk-js-codemod\n"
+      );
+      const comments = callExpression.parentPath.node.comments || [];
+      comments.push(
+        j.commentLine(
+          " The promise() call was removed by aws-sdk-js-codemod v2-to-v3 transform using best guess."
+        )
+      );
+      comments.push(
+        j.commentLine(
+          " Please check that it is correct, and create an issue on GitHub to report this use case."
+        )
+      );
+      callExpression.parentPath.node.comments = comments;
+    }
+    // eslint-disable-next-line no-fallthrough
     case "ArrowFunctionExpression":
     case "AwaitExpression":
     case "ExpressionStatement":
@@ -23,11 +46,5 @@ export const removePromiseForCallExpression = (callExpression: ASTPath<CallExpre
       callExpression.value.callee = currentCalleeObject.callee;
       break;
     }
-    default:
-      throw new Error(
-        `Removal of .promise() not implemented for parentPath: ${callExpression.parentPath.value.type}\n` +
-          `Code processed: ${print(callExpression.parentPath.node).code}\n\n` +
-          "Please report your use case on https://github.com/awslabs/aws-sdk-js-codemod\n"
-      );
   }
 };