feat: auto retry certain errors

Author: Mkassabov

scripts/generate-clients.ts

@@ -4,6 +4,7 @@ import { Effect } from "effect";
 import { commonAwsErrorNames, isCommonAwsErrorName } from "../src/error.ts";
 import type { Manifest, Shape } from "./manifest.ts";
 import { loadAllLocalManifests } from "./manifest.ts";
+import { retryableErrorTags } from "../src/client.ts";
 
 // Configuration flags
 const INCLUDE_DOCUMENTATION = false; // Set to false to disable JSDoc comments
@@ -580,6 +581,10 @@ const generateErrorInterface = (
   const shapeName = extractShapeName(shapeId);
   let code = "";
 
+  if (retryableErrorTags.includes(shapeName)) {
+    return code;
+  }
+
   if (doc) {
     code += `${doc}\n`;
   }
@@ -1201,11 +1206,16 @@ const generateServiceTypes = (serviceName: string, manifest: Manifest) =>
       code += `import type { Buffer } from "node:buffer";\n`;
     }
     const { inherited, overrides } = getServiceErrorOverrides(manifest);
+    const filteredInherited = inherited.filter(
+      (type) => !retryableErrorTags.includes(type),
+    );
     if (overrides.length === 0) {
       code += `import type { CommonAwsError } from "../../error.ts";\n`;
     } else {
-      code += `import type { ${inherited.join(", ")} } from "../../error.ts";\n`;
-      code += `type CommonAwsError = ${inherited.concat(overrides).join(" | ")};\n`;
+      code += `import type { ${filteredInherited.join(", ")} } from "../../error.ts";\n`;
+      code += `type CommonAwsError = ${filteredInherited
+        .concat(overrides)
+        .join(" | ")};\n`;
     }
 
     code += `import { AWSServiceClient } from "../../client.ts";\n\n`;
@@ -1325,7 +1335,11 @@ const generateServiceTypes = (serviceName: string, manifest: Manifest) =>
       errorTypes.push("CommonAwsError");
 
       const errorUnion =
-        errorTypes.length > 1 ? errorTypes.join(" | ") : errorTypes[0];
+        errorTypes.length > 1
+          ? errorTypes
+              .filter((type) => !retryableErrorTags.includes(type))
+              .join(" | ")
+          : errorTypes[0];
       const effectOutputType =
         !operation.shape.output ||
         operation.shape.output.target === "smithy.api#Unit"
@@ -1500,7 +1514,10 @@ const generateServiceTypes = (serviceName: string, manifest: Manifest) =>
       );
       errorTypes.push("CommonAwsError");
 
-      const errorUnion = errorTypes.map((type) => `    | ${type}`).join("\n");
+      const errorUnion = errorTypes
+        .filter((type) => !retryableErrorTags.includes(type))
+        .map((type) => `    | ${type}`)
+        .join("\n");
       const effectOutputType =
         !operation.shape.output ||
         operation.shape.output.target === "smithy.api#Unit"
@@ -1585,7 +1602,9 @@ const generateServiceTypes = (serviceName: string, manifest: Manifest) =>
       .filter(([_, shape]) => shape.traits?.["smithy.api#error"])
       .map(([shapeId, _]) => extractShapeName(shapeId));
     allServiceErrors.push("CommonAwsError");
-    code += `export type ${consistentInterfaceName}Errors = ${allServiceErrors.join(" | ")};\n\n`;
+    code += `export type ${consistentInterfaceName}Errors = ${allServiceErrors
+      .filter((type) => !retryableErrorTags.includes(type))
+      .join(" | ")};\n\n`;
 
     // Store metadata for the service
     // FIXME: shouldn't this be typed to ServiceMetdata?

scripts/manifest.ts

@@ -1,6 +1,6 @@
 import { FileSystem } from "@effect/platform";
 import { Effect, Schema } from "effect";
-import { join } from "node:path";
+import { join } from "pathe";
 
 // Base trait schema for common Smithy traits
 const TraitValue = Schema.Union(

src/client.ts

@@ -6,6 +6,16 @@ import { Credentials, fromStaticCredentials } from "./credentials.ts";
 import type { AwsErrorMeta } from "./error.ts";
 import { DefaultFetch, Fetch } from "./fetch.service.ts";
 import type { ProtocolHandler } from "./protocols/interface.ts";
+import * as Schedule from "effect/Schedule";
+
+export const retryableErrorTags = [
+  "InternalFailure",
+  "RequestExpired",
+  "ServiceException",
+  "ServiceUnavailable",
+  "ThrottlingException",
+  "TooManyRequestsException",
+];
 
 const errorTags: {
   [serviceName: string]: {
@@ -247,7 +257,13 @@ export function createServiceProxy<T>(
               );
             }
           });
-          return program;
+
+          return program.pipe(
+            Effect.retry({
+              schedule: Schedule.exponential(100),
+              while: (e) => retryableErrorTags.includes(e._tag),
+            }),
+          );
         };
       },
     },

src/error.ts

@@ -59,19 +59,20 @@ export class ValidationException extends Data.TaggedError(
 )<AwsErrorMeta> {}
 
 export type CommonAwsError =
+  //* handled in src/client.ts
+  // | InternalFailure
+  // | RequestExpired
+  // | ServiceUnavailable
+  // | ThrottlingException
   | AccessDeniedException
   | ExpiredTokenException
   | IncompleteSignature
-  | InternalFailure
   | MalformedHttpRequestException
   | NotAuthorized
   | OptInRequired
   | RequestAbortedException
   | RequestEntityTooLargeException
-  | RequestExpired
   | RequestTimeoutException
-  | ServiceUnavailable
-  | ThrottlingException
   | UnrecognizedClientException
   | UnknownOperationException
   | ValidationError