@doist/comms-sdk 3.0.0 → 3.0.1

package/dist/esm/transport/fetch-with-retry.js

@@ -4,7 +4,8 @@ import { transformTimestamps } from '../utils/timestamp-conversion.js';
 import { getDefaultTransport } from './http-dispatcher.js';
 export async function fetchWithRetry(url, options, maxRetries = 3, customFetch) {
     let lastError;
-    for (let attempt = 0; attempt <= maxRetries; attempt++) {
+    let attempt = 0;
+    for (; attempt <= maxRetries; attempt++) {
         let clearTimeoutFn;
         try {
             let requestSignal = options.signal || undefined;
@@ -56,7 +57,48 @@ export async function fetchWithRetry(url, options, maxRetries = 3, customFetch)
     if (lastError instanceof CommsRequestError) {
         throw lastError;
     }
-    throw new CommsRequestError(lastError?.message ?? 'Request failed');
+    throw new CommsRequestError(describeTransportFailure(lastError, attempt + 1), undefined, undefined, {
+        cause: lastError,
+    });
+}
+/** Causes reported before the rest of the chain is dropped. */
+const CAUSE_CHAIN_LIMIT = 3;
+/**
+ * Builds the message for a request that never produced a response.
+ *
+ * `fetch` reports every transport problem as the same `fetch failed`, and puts
+ * the reason a caller actually needs — `ENOTFOUND`, `ECONNRESET`, a TLS failure
+ * — in `cause`. Dropping that leaves an unattributable error in the logs, so
+ * unwrap the chain into the message and keep the original as `cause`.
+ */
+function describeTransportFailure(error, attempts) {
+    const base = error?.message ?? 'Request failed';
+    const cause = describeCauseChain(error);
+    const tries = attempts > 1 ? ` after ${attempts} attempts` : '';
+    return cause ? `${base} (${cause})${tries}` : `${base}${tries}`;
+}
+function describeCauseChain(error) {
+    const descriptions = [];
+    const seen = new Set();
+    let current = error?.cause;
+    while (current instanceof Error &&
+        !seen.has(current) &&
+        descriptions.length < CAUSE_CHAIN_LIMIT) {
+        seen.add(current);
+        const description = describeCause(current);
+        if (description) {
+            descriptions.push(description);
+        }
+        // A failed connect can carry one error per address it tried; the first
+        // one is representative and the rest are the same failure repeated.
+        const aggregated = current instanceof AggregateError ? current.errors[0] : undefined;
+        current = aggregated ?? current.cause;
+    }
+    return descriptions.length > 0 ? descriptions.join(' <- ') : undefined;
+}
+function describeCause(error) {
+    const code = error.code;
+    return typeof code === 'string' && code.length > 0 ? `${code}: ${error.message}` : error.message;
 }
 async function fetchWithDefaultTransport(url, options, signal) {
     // Read the dispatcher and its paired `fetch` as one value so they can never

package/dist/esm/types/errors.js

@@ -1,7 +1,7 @@
 import { CustomError } from 'ts-custom-error';
 export class CommsRequestError extends CustomError {
-    constructor(message, httpStatusCode, responseData) {
-        super(message);
+    constructor(message, httpStatusCode, responseData, options) {
+        super(message, options);
         this.httpStatusCode = httpStatusCode;
         this.responseData = responseData;
     }

package/dist/types/types/errors.d.ts

@@ -2,5 +2,5 @@ import { CustomError } from 'ts-custom-error';
 export declare class CommsRequestError extends CustomError {
     httpStatusCode?: number;
     responseData?: unknown;
-    constructor(message: string, httpStatusCode?: number, responseData?: unknown);
+    constructor(message: string, httpStatusCode?: number, responseData?: unknown, options?: ErrorOptions);
 }

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@doist/comms-sdk",
-    "version": "3.0.0",
+    "version": "3.0.1",
     "description": "A TypeScript wrapper for the Comms REST API.",
     "author": "Doist developers",
     "homepage": "https://doist.github.io/comms-sdk-typescript/",