@smithy/util-waiter 3.1.10 → 4.0.0

package/dist-cjs/index.js

@@ -79,30 +79,55 @@ var exponentialBackoffWithJitter = /* @__PURE__ */ __name((minDelay, maxDelay, a
 }, "exponentialBackoffWithJitter");
 var randomInRange = /* @__PURE__ */ __name((min, max) => min + Math.random() * (max - min), "randomInRange");
 var runPolling = /* @__PURE__ */ __name(async ({ minDelay, maxDelay, maxWaitTime, abortController, client, abortSignal }, input, acceptorChecks) => {
-  var _a;
+  const observedResponses = {};
   const { state, reason } = await acceptorChecks(client, input);
+  if (reason) {
+    const message = createMessageFromResponse(reason);
+    observedResponses[message] |= 0;
+    observedResponses[message] += 1;
+  }
   if (state !== "RETRY" /* RETRY */) {
-    return { state, reason };
+    return { state, reason, observedResponses };
   }
   let currentAttempt = 1;
   const waitUntil = Date.now() + maxWaitTime * 1e3;
   const attemptCeiling = Math.log(maxDelay / minDelay) / Math.log(2) + 1;
   while (true) {
-    if (((_a = abortController == null ? void 0 : abortController.signal) == null ? void 0 : _a.aborted) || (abortSignal == null ? void 0 : abortSignal.aborted)) {
-      return { state: "ABORTED" /* ABORTED */ };
+    if (abortController?.signal?.aborted || abortSignal?.aborted) {
+      const message = "AbortController signal aborted.";
+      observedResponses[message] |= 0;
+      observedResponses[message] += 1;
+      return { state: "ABORTED" /* ABORTED */, observedResponses };
     }
     const delay = exponentialBackoffWithJitter(minDelay, maxDelay, attemptCeiling, currentAttempt);
     if (Date.now() + delay * 1e3 > waitUntil) {
-      return { state: "TIMEOUT" /* TIMEOUT */ };
+      return { state: "TIMEOUT" /* TIMEOUT */, observedResponses };
     }
     await sleep(delay);
     const { state: state2, reason: reason2 } = await acceptorChecks(client, input);
+    if (reason2) {
+      const message = createMessageFromResponse(reason2);
+      observedResponses[message] |= 0;
+      observedResponses[message] += 1;
+    }
     if (state2 !== "RETRY" /* RETRY */) {
-      return { state: state2, reason: reason2 };
+      return { state: state2, reason: reason2, observedResponses };
     }
     currentAttempt += 1;
   }
 }, "runPolling");
+var createMessageFromResponse = /* @__PURE__ */ __name((reason) => {
+  if (reason?.$responseBodyText) {
+    return `Deserialization error for body: ${reason.$responseBodyText}`;
+  }
+  if (reason?.$metadata?.httpStatusCode) {
+    if (reason.$response || reason.message) {
+      return `${reason.$response.statusCode ?? reason.$metadata.httpStatusCode ?? "Unknown"}: ${reason.message}`;
+    }
+    return `${reason.$metadata.httpStatusCode}: OK`;
+  }
+  return String(reason?.message ?? JSON.stringify(reason) ?? "Unknown");
+}, "createMessageFromResponse");
 
 // src/utils/validate.ts
 var validateWaiterOptions = /* @__PURE__ */ __name((options) => {

package/dist-es/poller.js

@@ -8,26 +8,52 @@ const exponentialBackoffWithJitter = (minDelay, maxDelay, attemptCeiling, attemp
 };
 const randomInRange = (min, max) => min + Math.random() * (max - min);
 export const runPolling = async ({ minDelay, maxDelay, maxWaitTime, abortController, client, abortSignal }, input, acceptorChecks) => {
+    const observedResponses = {};
     const { state, reason } = await acceptorChecks(client, input);
+    if (reason) {
+        const message = createMessageFromResponse(reason);
+        observedResponses[message] |= 0;
+        observedResponses[message] += 1;
+    }
     if (state !== WaiterState.RETRY) {
-        return { state, reason };
+        return { state, reason, observedResponses };
     }
     let currentAttempt = 1;
     const waitUntil = Date.now() + maxWaitTime * 1000;
     const attemptCeiling = Math.log(maxDelay / minDelay) / Math.log(2) + 1;
     while (true) {
         if (abortController?.signal?.aborted || abortSignal?.aborted) {
-            return { state: WaiterState.ABORTED };
+            const message = "AbortController signal aborted.";
+            observedResponses[message] |= 0;
+            observedResponses[message] += 1;
+            return { state: WaiterState.ABORTED, observedResponses };
         }
         const delay = exponentialBackoffWithJitter(minDelay, maxDelay, attemptCeiling, currentAttempt);
         if (Date.now() + delay * 1000 > waitUntil) {
-            return { state: WaiterState.TIMEOUT };
+            return { state: WaiterState.TIMEOUT, observedResponses };
         }
         await sleep(delay);
         const { state, reason } = await acceptorChecks(client, input);
+        if (reason) {
+            const message = createMessageFromResponse(reason);
+            observedResponses[message] |= 0;
+            observedResponses[message] += 1;
+        }
         if (state !== WaiterState.RETRY) {
-            return { state, reason };
+            return { state, reason, observedResponses };
         }
         currentAttempt += 1;
     }
 };
+const createMessageFromResponse = (reason) => {
+    if (reason?.$responseBodyText) {
+        return `Deserialization error for body: ${reason.$responseBodyText}`;
+    }
+    if (reason?.$metadata?.httpStatusCode) {
+        if (reason.$response || reason.message) {
+            return `${reason.$response.statusCode ?? reason.$metadata.httpStatusCode ?? "Unknown"}: ${reason.message}`;
+        }
+        return `${reason.$metadata.httpStatusCode}: OK`;
+    }
+    return String(reason?.message ?? JSON.stringify(reason) ?? "Unknown");
+};

package/dist-types/ts3.4/waiter.d.ts

@@ -34,6 +34,11 @@ export type WaiterResult = {
      * (optional) Indicates a reason for why a waiter has reached its state.
      */
     reason?: any;
+    /**
+     * Responses observed by the waiter during its polling, where the value
+     * is the count.
+     */
+    observedResponses?: Record<string, number>;
 };
 /**
  * @internal

package/dist-types/waiter.d.ts

@@ -34,6 +34,11 @@ export type WaiterResult = {
      * (optional) Indicates a reason for why a waiter has reached its state.
      */
     reason?: any;
+    /**
+     * Responses observed by the waiter during its polling, where the value
+     * is the count.
+     */
+    observedResponses?: Record<string, number>;
 };
 /**
  * @internal

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "@smithy/util-waiter",
-  "version": "3.1.10",
+  "version": "4.0.0",
   "description": "Shared utilities for client waiters for the AWS SDK",
   "dependencies": {
-    "@smithy/abort-controller": "^3.1.9",
-    "@smithy/types": "^3.7.2",
+    "@smithy/abort-controller": "^4.0.0",
+    "@smithy/types": "^4.0.0",
     "tslib": "^2.6.2"
   },
   "scripts": {
@@ -29,7 +29,7 @@
   "module": "./dist-es/index.js",
   "types": "./dist-types/index.d.ts",
   "engines": {
-    "node": ">=16.0.0"
+    "node": ">=18.0.0"
   },
   "typesVersions": {
     "<4.0": {