fix(service-error-classification): treat Node.js network errors as transient (smithy-lang#1619)

Author: trivikr

.changeset/kind-crabs-jam.md

@@ -0,0 +1,5 @@
+---
+"@smithy/service-error-classification": patch
+---
+
+Treat Node.js network errors as transient

packages/service-error-classification/src/constants.ts

@@ -50,3 +50,8 @@ export const TRANSIENT_ERROR_STATUS_CODES = [500, 502, 503, 504];
  * Node.js system error codes that indicate timeout.
  */
 export const NODEJS_TIMEOUT_ERROR_CODES = ["ECONNRESET", "ECONNREFUSED", "EPIPE", "ETIMEDOUT"];
+
+/**
+ * Node.js system error codes that indicate network error.
+ */
+export const NODEJS_NETWORK_ERROR_CODES = ["EHOSTUNREACH", "ENETUNREACH", "ENOTFOUND"];

packages/service-error-classification/src/index.spec.ts

@@ -3,6 +3,8 @@ import { describe, expect, test as it } from "vitest";
 
 import {
   CLOCK_SKEW_ERROR_CODES,
+  NODEJS_NETWORK_ERROR_CODES,
+  NODEJS_TIMEOUT_ERROR_CODES,
   THROTTLING_ERROR_CODES,
   TRANSIENT_ERROR_CODES,
   TRANSIENT_ERROR_STATUS_CODES,
@@ -16,15 +18,17 @@ const checkForErrorType = (
     httpStatusCode?: number;
     $retryable?: RetryableTrait;
     cause?: Partial<Error>;
+    code?: string;
   },
   errorTypeResult: boolean
 ) => {
-  const { name, httpStatusCode, $retryable, cause } = options;
+  const { name, httpStatusCode, $retryable, cause, code } = options;
   const error = Object.assign(new Error(), {
     name,
     $metadata: { httpStatusCode },
     $retryable,
     cause,
+    code,
   });
   expect(isErrorTypeFunc(error as SdkError)).toBe(errorTypeResult);
 };
@@ -141,6 +145,18 @@ describe("isTransientError", () => {
     error.cause = error;
     checkForErrorType(isTransientError, { cause: error }, false);
   });
+
+  NODEJS_TIMEOUT_ERROR_CODES.forEach((code) => {
+    it(`should declare error with cause with the code "${code}" to be a Transient error`, () => {
+      checkForErrorType(isTransientError, { code }, true);
+    });
+  });
+
+  NODEJS_NETWORK_ERROR_CODES.forEach((code) => {
+    it(`should declare error with cause with the code "${code}" to be a Transient error`, () => {
+      checkForErrorType(isTransientError, { code }, true);
+    });
+  });
 });
 
 describe("isServerError", () => {

packages/service-error-classification/src/index.ts

@@ -2,6 +2,7 @@ import { SdkError } from "@smithy/types";
 
 import {
   CLOCK_SKEW_ERROR_CODES,
+  NODEJS_NETWORK_ERROR_CODES,
   NODEJS_TIMEOUT_ERROR_CODES,
   THROTTLING_ERROR_CODES,
   TRANSIENT_ERROR_CODES,
@@ -57,6 +58,7 @@ export const isTransientError = (error: SdkError, depth = 0): boolean =>
   isClockSkewCorrectedError(error) ||
   TRANSIENT_ERROR_CODES.includes(error.name) ||
   NODEJS_TIMEOUT_ERROR_CODES.includes((error as { code?: string })?.code || "") ||
+  NODEJS_NETWORK_ERROR_CODES.includes((error as { code?: string })?.code || "") ||
   TRANSIENT_ERROR_STATUS_CODES.includes(error.$metadata?.httpStatusCode || 0) ||
   isBrowserNetworkError(error) ||
   (error.cause !== undefined && depth <= 10 && isTransientError(error.cause, depth + 1));