Transform checks for error.code to error.name in try-catch (#808)

.changeset/poor-poems-flash.md

@@ -0,0 +1,5 @@
+---
+"aws-sdk-js-codemod": patch
+---
+
+Transform checks for error.code to error.name in try-catch

src/transforms/v2-to-v3/__fixtures__/aws-error-name/global-import.input.js

@@ -0,0 +1,15 @@
+import AWS from "aws-sdk";
+
+const client = new AWS.S3();
+
+try {
+  await client.createBucket({
+    Bucket: "bucket"
+  }).promise();
+} catch (error) {
+  if (error.code === "BucketAlreadyExists") {
+    // Handle BucketAlreadyExists error
+  } else {
+    throw error;
+  }
+}

src/transforms/v2-to-v3/__fixtures__/aws-error-name/global-import.input.ts

@@ -0,0 +1,15 @@
+import AWS from "aws-sdk";
+
+export const func = async (client: AWS.S3) => {
+  try {
+    await client.createBucket({
+      Bucket: "bucket"
+    }).promise();
+  } catch (error) {
+    if (error.code === "BucketAlreadyExists") {
+      // Handle BucketAlreadyExists error
+    } else {
+      throw error;
+    }
+  }
+}

src/transforms/v2-to-v3/__fixtures__/aws-error-name/global-import.output.js

@@ -0,0 +1,15 @@
+import { S3 } from "@aws-sdk/client-s3";
+
+const client = new S3();
+
+try {
+  await client.createBucket({
+    Bucket: "bucket"
+  });
+} catch (error) {
+  if (error.name === "BucketAlreadyExists") {
+    // Handle BucketAlreadyExists error
+  } else {
+    throw error;
+  }
+}

src/transforms/v2-to-v3/__fixtures__/aws-error-name/global-import.output.ts

@@ -0,0 +1,15 @@
+import { S3 } from "@aws-sdk/client-s3";
+
+export const func = async (client: S3) => {
+  try {
+    await client.createBucket({
+      Bucket: "bucket"
+    });
+  } catch (error) {
+    if (error.name === "BucketAlreadyExists") {
+      // Handle BucketAlreadyExists error
+    } else {
+      throw error;
+    }
+  }
+}

src/transforms/v2-to-v3/__fixtures__/aws-error-name/service-import.input.js

@@ -0,0 +1,15 @@
+import { S3 } from "aws-sdk";
+
+const client = new S3();
+
+try {
+  await client.createBucket({
+    Bucket: "bucket"
+  }).promise();
+} catch (error) {
+  if (error.code === "BucketAlreadyExists") {
+    // Handle BucketAlreadyExists error
+  } else {
+    throw error;
+  }
+}

src/transforms/v2-to-v3/__fixtures__/aws-error-name/service-import.input.ts

@@ -0,0 +1,15 @@
+import { S3 } from "aws-sdk";
+
+export const func = async (client: S3) => {
+  try {
+    await client.createBucket({
+      Bucket: "bucket"
+    }).promise();
+  } catch (error) {
+    if (error.code === "BucketAlreadyExists") {
+      // Handle BucketAlreadyExists error
+    } else {
+      throw error;
+    }
+  }
+}

src/transforms/v2-to-v3/__fixtures__/aws-error-name/service-import.output.js

@@ -0,0 +1,15 @@
+import { S3 } from "@aws-sdk/client-s3";
+
+const client = new S3();
+
+try {
+  await client.createBucket({
+    Bucket: "bucket"
+  });
+} catch (error) {
+  if (error.name === "BucketAlreadyExists") {
+    // Handle BucketAlreadyExists error
+  } else {
+    throw error;
+  }
+}

src/transforms/v2-to-v3/__fixtures__/aws-error-name/service-import.output.ts

@@ -0,0 +1,15 @@
+import { S3 } from "@aws-sdk/client-s3";
+
+export const func = async (client: S3) => {
+  try {
+    await client.createBucket({
+      Bucket: "bucket"
+    });
+  } catch (error) {
+    if (error.name === "BucketAlreadyExists") {
+      // Handle BucketAlreadyExists error
+    } else {
+      throw error;
+    }
+  }
+}

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

@@ -9,7 +9,6 @@ export const addEmptyObjectForUndefined = (
   clientIdentifiers: ClientIdentifier[]
 ): void => {
   for (const clientId of clientIdentifiers) {
-    // Remove .promise() from client API calls.
     source
       .find(j.CallExpression, {
         callee: {

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

@@ -14,3 +14,4 @@ export * from "./replaceS3UploadApi";
 export * from "./replaceWaiterApi";
 export * from "./getCommandName";
 export * from "./getClientIdentifiersRecord";
+export * from "./renameErrorCodeWithName";

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

@@ -0,0 +1,48 @@
+import { Collection, JSCodeshift, TryStatement } from "jscodeshift";
+
+import { ClientIdentifier } from "../types";
+
+// Renames error.code with error.name.
+export const renameErrorCodeWithName = (
+  j: JSCodeshift,
+  source: Collection<unknown>,
+  clientIdentifiers: ClientIdentifier[]
+): void => {
+  for (const clientId of clientIdentifiers) {
+    // Replace error.code with error.name in catch clauses.
+    source
+      .find(j.CallExpression, {
+        callee: {
+          type: "MemberExpression",
+          object: clientId,
+        },
+      })
+      .forEach((callExpression) => {
+        const tryStatement = j(callExpression).closest(j.TryStatement).nodes()[0] as TryStatement;
+
+        if (!tryStatement || !tryStatement.handler) {
+          return;
+        }
+
+        const catchClause = tryStatement.handler;
+        const errorParam = catchClause.param;
+
+        if (errorParam?.type !== "Identifier") {
+          return;
+        }
+
+        j(catchClause.body)
+          .find(j.MemberExpression, {
+            object: {
+              type: "Identifier",
+              name: errorParam.name,
+            },
+            property: {
+              type: "Identifier",
+              name: "code",
+            },
+          })
+          .replaceWith(() => j.memberExpression(errorParam, j.identifier("name")));
+      });
+  }
+};

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

@@ -11,6 +11,7 @@ import {
   replaceAwsIdentity,
   replaceAwsError,
   addEmptyObjectForUndefined,
+  renameErrorCodeWithName,
 } from "./apis";
 import { replaceAwsUtilFunctions } from "./aws-util";
 import {
@@ -99,6 +100,7 @@ const transformer = async (file: FileInfo, api: API) => {
     }
 
     removePromiseCalls(j, source, clientIdentifiers);
+    renameErrorCodeWithName(j, source, clientIdentifiers);
     addEmptyObjectForUndefined(j, source, clientIdentifiers);
 
     if (v2ClientName === S3) {