Transform AWSError to ServiceException (#776)

Author: trivikr

.changeset/hungry-foxes-bow.md

@@ -0,0 +1,5 @@
+---
+"aws-sdk-js-codemod": minor
+---
+
+Transform AWSError to ServiceException

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

@@ -0,0 +1,8 @@
+import AWS = require("aws-sdk");
+
+export const isAwsError = (error: unknown): error is AWS.AWSError => {
+  if (error === undefined) {
+    return false
+  }
+  return error instanceof Error;
+}

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

@@ -0,0 +1,9 @@
+import AWS_smithy_client = require("@smithy/smithy-client");
+import ServiceException = AWS_smithy_client.ServiceException;
+
+export const isAwsError = (error: unknown): error is ServiceException => {
+  if (error === undefined) {
+    return false
+  }
+  return error instanceof Error;
+}

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

@@ -0,0 +1,8 @@
+import AWS from "aws-sdk";
+
+export const isAwsError = (error: unknown): error is AWS.AWSError => {
+  if (error === undefined) {
+    return false
+  }
+  return error instanceof Error;
+}

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

@@ -0,0 +1,8 @@
+import { ServiceException } from "@smithy/smithy-client";
+
+export const isAwsError = (error: unknown): error is ServiceException => {
+  if (error === undefined) {
+    return false
+  }
+  return error instanceof Error;
+}

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

@@ -0,0 +1,8 @@
+import { AWSError } from "aws-sdk";
+
+export const isAwsError = (error: unknown): error is AWSError => {
+  if (error === undefined) {
+    return false
+  }
+  return error instanceof Error;
+}

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

@@ -0,0 +1,8 @@
+import { ServiceException } from "@smithy/smithy-client";
+
+export const isAwsError = (error: unknown): error is ServiceException => {
+  if (error === undefined) {
+    return false
+  }
+  return error instanceof Error;
+}

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

@@ -7,6 +7,7 @@ export * from "./isS3GetSignedUrlApiUsed";
 export * from "./isS3UploadApiUsed";
 export * from "./removePromiseCalls";
 export * from "./replaceAwsIdentity";
+export * from "./replaceAwsError";
 export * from "./replaceS3GetSignedUrlApi";
 export * from "./replaceS3UploadApi";
 export * from "./replaceWaiterApi";

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

@@ -0,0 +1,48 @@
+import { Collection, JSCodeshift } from "jscodeshift";
+import { ImportType, addNamedModule } from "../modules";
+
+export interface ReplaceAwsErrorOptions {
+  v2GlobalName?: string;
+  importType: ImportType;
+}
+
+export const replaceAwsError = (
+  j: JSCodeshift,
+  source: Collection<unknown>,
+  { v2GlobalName, importType }: ReplaceAwsErrorOptions
+) => {
+  const v2AwsErrorName = "AWSError";
+  const v3AwsErrorName = "ServiceException";
+
+  const namedModuleParams = {
+    importType,
+    localName: v3AwsErrorName,
+    packageName: "@smithy/smithy-client",
+  };
+
+  if (v2GlobalName) {
+    source
+      .find(j.TSTypeReference, {
+        typeName: {
+          left: { type: "Identifier", name: v2GlobalName },
+          right: { type: "Identifier", name: v2AwsErrorName },
+        },
+      })
+      .replaceWith((v2ErrorType) => {
+        addNamedModule(j, source, namedModuleParams);
+        return j.tsTypeReference(j.identifier(v3AwsErrorName), v2ErrorType.node.typeParameters);
+      });
+  }
+
+  source
+    .find(j.TSTypeReference, {
+      typeName: {
+        type: "Identifier",
+        name: v2AwsErrorName,
+      },
+    })
+    .replaceWith((v2ErrorType) => {
+      addNamedModule(j, source, namedModuleParams);
+      return j.tsTypeReference(j.identifier(v3AwsErrorName), v2ErrorType.node.typeParameters);
+    });
+};

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

@@ -9,6 +9,7 @@ import {
   replaceS3GetSignedUrlApi,
   getClientIdentifiersRecord,
   replaceAwsIdentity,
+  replaceAwsError,
 } from "./apis";
 import { replaceAwsUtilFunctions } from "./aws-util";
 import {
@@ -110,6 +111,7 @@ const transformer = async (file: FileInfo, api: API) => {
   replaceAwsConfig(j, source, { v2GlobalName, awsGlobalConfig });
   replaceAwsIdentity(j, source, { v2GlobalName, importType });
   replaceAwsUtilFunctions(j, source, v2GlobalName);
+  replaceAwsError(j, source, { v2GlobalName, importType });
   removeModules(j, source, importType);
 
   const sourceString = getFormattedSourceString(source.toSource({ quote, useTabs, trailingComma }));