@beyonk/http 12.4.2 → 12.6.0

package/README.MD

@@ -192,10 +192,14 @@ Handlers have a signature with two items:
 })
 ```
 
+Every error carries the request that failed as `e.request` (`{ method, url }`), and HTTP failures also carry `e.status` and the parsed response as `e.body`. Errors thrown by `fetch` itself, such as network failures or aborts, have `e.request` but no `e.status`.
+
 ctx can be whatever you want really - it is whatever you pass in as `context(...)`.
 
 However, if the `context` object you pass in has a `fetch` function, this is used as the `fetch` for XHR requests.
 
+If it has a `logger` with an `error(details, message)` method, such as a pino logger, every failure that reaches a `default` handler (request-level or global) is logged through it before the handler runs, with `err`, `status`, `method`, `url` and `body`. Without one the console is used. Failures caught by a status-specific handler such as `.notFound()` are not logged.
+
 ```js
 export async function preload () {
   await Api

package/dist/index.cjs

@@ -29,10 +29,13 @@ var HttpError = class extends Error {
    * Create a new HTTP error
    * @param {string} message - Error message
    * @param {any} body - Error response body
+   * @param {number} [status] - HTTP status code, absent when the request never got a response
    */
-  constructor(message, body) {
+  constructor(message, body, status) {
     super(message);
     this.body = body;
+    this.status = status;
+    this.request = void 0;
   }
 };
 var AccessDeniedError = class extends HttpError {
@@ -141,11 +144,26 @@ var Api = class {
   handle(e, ctx) {
     const constructorName = Object.getPrototypeOf(e).constructor.name;
     const globalHandlerName = `${constructorName[0].toLowerCase()}${constructorName.slice(1, -5)}`;
-    const handler = this.handlers[constructorName] || this.options.handlers && this.options.handlers[globalHandlerName] || this.defaultHandler || this.options.handlers && this.options.handlers.default || ((e2) => {
+    const specificHandler = this.handlers[constructorName] || this.options.handlers && this.options.handlers[globalHandlerName];
+    const handler = specificHandler || this.defaultHandler || this.options.handlers && this.options.handlers.default || ((e2) => {
       console.error(constructorName, e2.message, e2);
     });
+    if (!specificHandler) {
+      this.log(e, ctx);
+    }
     return handler(e, ctx);
   }
+  /**
+   * Log a failed request through the context logger, or the console
+   * @param {HttpError} e - Error instance
+   * @param {ApiContext} [ctx] - API context
+   */
+  log(e, ctx) {
+    const logger = ctx && ctx.logger || console;
+    const { method, url } = e.request || {};
+    const reason = e.status ? `with ${e.status}` : `(${e.message})`;
+    logger.error({ err: e, status: e.status, method, url, body: e.body }, `${method} ${url} failed ${reason}`);
+  }
   /**
    * Send the HTTP request
    * @template T
@@ -175,7 +193,7 @@ var Api = class {
     try {
       result = await this.#doQuery(1, client, ep, options);
     } catch (e) {
-      console.log(e);
+      e.request = { method: options.method, url: ep };
       return this.handle(e, this.ctx);
     } finally {
       this.resetRequest();
@@ -228,7 +246,7 @@ var Api = class {
         console.log("Failed to parse error body when asked.");
       }
       const ClientError = getErrorByCode(r.status);
-      throw new ClientError(r.statusText, content);
+      throw new ClientError(r.statusText, content, r.status);
     } catch (e) {
       if (retry.attempts && retry.errors && attempt < retry.attempts && retry.errors.includes(e.code)) {
         console.warn(`Got ${e.code} when calling ${endpoint}. Retrying request (${attempt}/${retry.attempts})`);

package/dist/index.d.cts

@@ -30,6 +30,10 @@ type RetryOptions = {
 type ApiContext = {
     /** Fetch client */
     fetch?: FetchClient;
+    /** Logger for failed requests, defaults to console */
+    logger?: {
+        error: (details: Record<string, any>, message: string) => void;
+    };
     /** Additional context properties */
     [key: string]: any;
 };
@@ -98,9 +102,16 @@ declare class HttpError extends Error {
      * Create a new HTTP error
      * @param {string} message - Error message
      * @param {any} body - Error response body
+     * @param {number} [status] - HTTP status code, absent when the request never got a response
      */
-    constructor(message: string, body: any);
+    constructor(message: string, body: any, status?: number);
     body: any;
+    status: number;
+    /** @type {{ method: string, url: string } | undefined} The request that failed */
+    request: {
+        method: string;
+        url: string;
+    } | undefined;
 }
 declare namespace _default {
     export { create };
@@ -145,6 +156,12 @@ declare class Api {
      * @returns {any} Result of error handler
      */
     handle(e: HttpError, ctx?: ApiContext): any;
+    /**
+     * Log a failed request through the context logger, or the console
+     * @param {HttpError} e - Error instance
+     * @param {ApiContext} [ctx] - API context
+     */
+    log(e: HttpError, ctx?: ApiContext): void;
     /**
      * Send the HTTP request
      * @template T

package/dist/index.d.ts

@@ -30,6 +30,10 @@ type RetryOptions = {
 type ApiContext = {
     /** Fetch client */
     fetch?: FetchClient;
+    /** Logger for failed requests, defaults to console */
+    logger?: {
+        error: (details: Record<string, any>, message: string) => void;
+    };
     /** Additional context properties */
     [key: string]: any;
 };
@@ -98,9 +102,16 @@ declare class HttpError extends Error {
      * Create a new HTTP error
      * @param {string} message - Error message
      * @param {any} body - Error response body
+     * @param {number} [status] - HTTP status code, absent when the request never got a response
      */
-    constructor(message: string, body: any);
+    constructor(message: string, body: any, status?: number);
     body: any;
+    status: number;
+    /** @type {{ method: string, url: string } | undefined} The request that failed */
+    request: {
+        method: string;
+        url: string;
+    } | undefined;
 }
 declare namespace _default {
     export { create };
@@ -145,6 +156,12 @@ declare class Api {
      * @returns {any} Result of error handler
      */
     handle(e: HttpError, ctx?: ApiContext): any;
+    /**
+     * Log a failed request through the context logger, or the console
+     * @param {HttpError} e - Error instance
+     * @param {ApiContext} [ctx] - API context
+     */
+    log(e: HttpError, ctx?: ApiContext): void;
     /**
      * Send the HTTP request
      * @template T

package/dist/index.js

@@ -4,10 +4,13 @@ var HttpError = class extends Error {
    * Create a new HTTP error
    * @param {string} message - Error message
    * @param {any} body - Error response body
+   * @param {number} [status] - HTTP status code, absent when the request never got a response
    */
-  constructor(message, body) {
+  constructor(message, body, status) {
     super(message);
     this.body = body;
+    this.status = status;
+    this.request = void 0;
   }
 };
 var AccessDeniedError = class extends HttpError {
@@ -116,11 +119,26 @@ var Api = class {
   handle(e, ctx) {
     const constructorName = Object.getPrototypeOf(e).constructor.name;
     const globalHandlerName = `${constructorName[0].toLowerCase()}${constructorName.slice(1, -5)}`;
-    const handler = this.handlers[constructorName] || this.options.handlers && this.options.handlers[globalHandlerName] || this.defaultHandler || this.options.handlers && this.options.handlers.default || ((e2) => {
+    const specificHandler = this.handlers[constructorName] || this.options.handlers && this.options.handlers[globalHandlerName];
+    const handler = specificHandler || this.defaultHandler || this.options.handlers && this.options.handlers.default || ((e2) => {
       console.error(constructorName, e2.message, e2);
     });
+    if (!specificHandler) {
+      this.log(e, ctx);
+    }
     return handler(e, ctx);
   }
+  /**
+   * Log a failed request through the context logger, or the console
+   * @param {HttpError} e - Error instance
+   * @param {ApiContext} [ctx] - API context
+   */
+  log(e, ctx) {
+    const logger = ctx && ctx.logger || console;
+    const { method, url } = e.request || {};
+    const reason = e.status ? `with ${e.status}` : `(${e.message})`;
+    logger.error({ err: e, status: e.status, method, url, body: e.body }, `${method} ${url} failed ${reason}`);
+  }
   /**
    * Send the HTTP request
    * @template T
@@ -150,7 +168,7 @@ var Api = class {
     try {
       result = await this.#doQuery(1, client, ep, options);
     } catch (e) {
-      console.log(e);
+      e.request = { method: options.method, url: ep };
       return this.handle(e, this.ctx);
     } finally {
       this.resetRequest();
@@ -203,7 +221,7 @@ var Api = class {
         console.log("Failed to parse error body when asked.");
       }
       const ClientError = getErrorByCode(r.status);
-      throw new ClientError(r.statusText, content);
+      throw new ClientError(r.statusText, content, r.status);
     } catch (e) {
       if (retry.attempts && retry.errors && attempt < retry.attempts && retry.errors.includes(e.code)) {
         console.warn(`Got ${e.code} when calling ${endpoint}. Retrying request (${attempt}/${retry.attempts})`);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@beyonk/http",
-  "version": "12.4.2",
+  "version": "12.6.0",
   "description": "An isomorphic http client for Svelte apps",
   "type": "module",
   "repository": "https://github.com/beyonk/http.git",