lambda-essentials-ts 5.3.1 → 5.4.0

package/CHANGELOG.md

@@ -4,6 +4,18 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 
+## [5.4.0] - 2024-02-08
+
+### Added
+
+HttpClient options now accept `clientExceptionStatusCodeMapOverride` which can be used to override the default HTTP error status code mapping. This is useful e.g. when a dependent service is not following REST-ful best practices and e.g. returns a 403 when there's an intermittent network error communicating with the authorization service
+
+## [5.3.2] - 2024-02-08
+
+### Fixed
+
+Error details of external HTTP error responses are propagated correctly
+
 ## [5.3.1] - 2023-10-25
 
 ### Fixed

package/lib/exceptions/clientException.d.ts

@@ -3,6 +3,6 @@ export declare class ClientException extends Exception {
     readonly serviceName: string;
     readonly originalStatusCode?: number;
     private static readonly statusCodeMap;
-    constructor(serviceName: string, originalStatusCode?: number, details?: any);
+    constructor(serviceName: string, originalStatusCode?: number, details?: any, statusCodeMapOverride?: Record<number, number>);
     private static convertStatusCode;
 }

package/lib/exceptions/clientException.js

@@ -3,15 +3,19 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.ClientException = void 0;
 const exception_1 = require("./exception");
 class ClientException extends exception_1.Exception {
-    constructor(serviceName, originalStatusCode, details) {
-        super(`Dependent service "${serviceName}" returned error`, ClientException.convertStatusCode(originalStatusCode), details);
+    constructor(serviceName, originalStatusCode, details, statusCodeMapOverride) {
+        super(`Dependent service "${serviceName}" returned error`, ClientException.convertStatusCode(originalStatusCode, statusCodeMapOverride), details);
         this.serviceName = serviceName;
         this.originalStatusCode = originalStatusCode;
     }
-    static convertStatusCode(originalStatusCode) {
+    static convertStatusCode(originalStatusCode, statusCodeMapOverride) {
         let statusCode = 503;
-        if (originalStatusCode && this.statusCodeMap[originalStatusCode]) {
-            statusCode = this.statusCodeMap[originalStatusCode];
+        const statusCodeMap = {
+            ...ClientException.statusCodeMap,
+            ...(statusCodeMapOverride || {}),
+        };
+        if (originalStatusCode && statusCodeMap[originalStatusCode]) {
+            statusCode = statusCodeMap[originalStatusCode];
         }
         return statusCode;
     }

package/lib/httpClient/httpClient.d.ts

@@ -17,6 +17,7 @@ export default class HttpClient {
     private readonly enableRetry;
     private readonly enableCache;
     private readonly timeout?;
+    private readonly clientExceptionStatusCodeMapOverride?;
     /**
      * Create a new Instance of the HttpClient
      */
@@ -100,6 +101,11 @@ export interface HttpClientOptions {
      * @link https://github.com/axios/axios/blob/main/README.md#request-config
      */
     timeout?: number;
+    /**
+     * Override the default mapping of status code when wrapping error responses returned by dependencies into ClientException.
+     * This is useful, when dependent services return incorrect status codes than then drive incorrect behavior upstream (e.g. 403 instead of 503)
+     */
+    clientExceptionStatusCodeMapOverride?: Record<number, number>;
 }
 /**
  * Log options object.

package/lib/httpClient/httpClient.js

@@ -62,6 +62,7 @@ class HttpClient {
         this.enableCache = (_c = options === null || options === void 0 ? void 0 : options.enableCache) !== null && _c !== void 0 ? _c : false;
         this.enableRetry = (_d = options === null || options === void 0 ? void 0 : options.enableRetry) !== null && _d !== void 0 ? _d : false;
         this.timeout = options === null || options === void 0 ? void 0 : options.timeout;
+        this.clientExceptionStatusCodeMapOverride = options === null || options === void 0 ? void 0 : options.clientExceptionStatusCodeMapOverride;
         this.client =
             (_e = options === null || options === void 0 ? void 0 : options.client) !== null && _e !== void 0 ? _e : axios_1.default.create({
                 adapter: (() => {
@@ -129,7 +130,7 @@ class HttpClient {
             const hostname = ((_a = error.config) === null || _a === void 0 ? void 0 : _a.url)
                 ? new url_1.URL(error.config.url, error.config.baseURL).hostname
                 : 'N/A';
-            throw new clientException_1.ClientException(hostname, serializedAxiosError === null || serializedAxiosError === void 0 ? void 0 : serializedAxiosError.status, serializedAxiosError === null || serializedAxiosError === void 0 ? void 0 : serializedAxiosError.details);
+            throw new clientException_1.ClientException(hostname, serializedAxiosError === null || serializedAxiosError === void 0 ? void 0 : serializedAxiosError.status, serializedAxiosError === null || serializedAxiosError === void 0 ? void 0 : serializedAxiosError.details, this.clientExceptionStatusCodeMapOverride);
         });
         this.client.interceptors.response.use((response) => {
             if (this.logOptions.enabledLogs.includes(HttpLogType.responses)) {
@@ -168,7 +169,7 @@ class HttpClient {
             const hostname = ((_a = error.config) === null || _a === void 0 ? void 0 : _a.url)
                 ? new url_1.URL(error.config.url, error.config.baseURL).hostname
                 : 'N/A';
-            throw new clientException_1.ClientException(hostname, serializedAxiosError === null || serializedAxiosError === void 0 ? void 0 : serializedAxiosError.status, serializedAxiosError === null || serializedAxiosError === void 0 ? void 0 : serializedAxiosError.details);
+            throw new clientException_1.ClientException(hostname, serializedAxiosError === null || serializedAxiosError === void 0 ? void 0 : serializedAxiosError.status, serializedAxiosError === null || serializedAxiosError === void 0 ? void 0 : serializedAxiosError.details, this.clientExceptionStatusCodeMapOverride);
         });
     }
     static extractRequestLogData(requestConfig) {

package/lib/util.js

@@ -53,7 +53,7 @@ function serializeAxiosError(error) {
     const { status, data } = error.response;
     return {
         status: (_a = data.originalStatusCode) !== null && _a !== void 0 ? _a : status,
-        details: data.details ? data.details : data, // Prevent wrapping of Exception
+        details: data.details && Object.keys(data.details).length > 0 ? data.details : data, // Prevent wrapping of Exception
     };
 }
 exports.serializeAxiosError = serializeAxiosError;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "lambda-essentials-ts",
-  "version": "5.3.1",
+  "version": "5.4.0",
   "description": "A selection of the finest modules supporting authorization, API routing, error handling, logging and sending HTTP requests.",
   "main": "lib/index.js",
   "private": false,