fix(util-waiter): return stringified result object in case of failure (#1314)

Author: trivikr

.changeset/giant-swans-trade.md

@@ -0,0 +1,5 @@
+---
+"@smithy/util-waiter": patch
+---
+
+Return stringified result object in case of failure

packages/util-waiter/src/waiter.spec.ts

@@ -0,0 +1,42 @@
+import { checkExceptions, WaiterState } from "./waiter";
+
+describe(checkExceptions.name, () => {
+  const reason = "generic reason";
+
+  it(`throw AbortError if state is ${WaiterState.ABORTED}`, () => {
+    const result = { state: WaiterState.ABORTED, reason };
+    expect(() => checkExceptions(result)).toThrow({
+      name: "AbortError",
+      message: JSON.stringify({ ...result, reason: "Request was aborted" }),
+    });
+  });
+
+  it(`throw TimeoutError if state is ${WaiterState.TIMEOUT}`, () => {
+    const result = { state: WaiterState.TIMEOUT, reason };
+    expect(() => checkExceptions(result)).toThrow({
+      name: "TimeoutError",
+      message: JSON.stringify({ ...result, reason: "Waiter has timed out" }),
+    });
+  });
+
+  it(`throw generic Error if state is ${WaiterState.RETRY}`, () => {
+    const result = { state: WaiterState.RETRY, reason };
+    expect(() => checkExceptions(result)).toThrow({
+      name: "Error",
+      message: JSON.stringify(result),
+    });
+  });
+
+  it(`throw generic Error if state is ${WaiterState.FAILURE}`, () => {
+    const result = { state: WaiterState.FAILURE, reason };
+    expect(() => checkExceptions(result)).toThrow({
+      name: "Error",
+      message: JSON.stringify(result),
+    });
+  });
+
+  it(`return result if state is ${WaiterState.SUCCESS}`, () => {
+    const result = { state: WaiterState.SUCCESS };
+    expect(checkExceptions(result)).toEqual(result);
+  });
+});

packages/util-waiter/src/waiter.ts

@@ -68,7 +68,7 @@ export const checkExceptions = (result: WaiterResult): WaiterResult => {
     timeoutError.name = "TimeoutError";
     throw timeoutError;
   } else if (result.state !== WaiterState.SUCCESS) {
-    throw new Error(`${JSON.stringify({ result })}`);
+    throw new Error(`${JSON.stringify(result)}`);
   }
   return result;
 };