lambda-essentials-ts 2.2.2 → 4.1.0

package/CHANGELOG.md

@@ -4,6 +4,41 @@ 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/)
 
+## [4.1.0] - 2021-11-22
+
+### Changed
+
+- `ApiResponse` default content-type header was changed from `application/links+json` to `application/hal+json`
+
+## [4.0.0] - 2021-11-12
+
+### Changed
+
+- `HttpClient` the [retryAdapterEnhancer axios adapter](https://github.com/kuitos/axios-extensions#cacheadapterenhancer)
+  was replaced by the more flexible [axios-cache-adapter](https://github.com/RasCarlito/axios-cache-adapter).
+- **[Breaking change]** `HttpClientOptions.cacheOptions` now accepts [extensive cache configuration](https://github.com/RasCarlito/axios-cache-adapter/blob/master/axios-cache-adapter.d.ts#L26).
+- The cache is now partitioned by `canonical_id` JWT claim.
+
+## [3.0.1] - 2021-09-13
+
+### Fixed
+
+- Downgraded Axios to 0.21.1 due to response interceptors not being applied correctly in 0.21.2. [There has been a fix to
+  axios but a version with the fix is not available yet.](https://github.com/axios/axios/commit/83ae3830e4070adbcdcdcdd6e8afbac568afd708)
+
+## [3.0.0] - 2021-09-10
+
+### Changed
+
+- `HttpClient` the [retryAdapterEnhancer axios adapter](https://github.com/kuitos/axios-extensions#retryadapterenhancer)
+  was replaced by the more flexible [retry-axios interceptor](https://github.com/JustinBeckwith/retry-axios).
+- **[Breaking change]** `HttpClientOptions.retryOptions` now accepts [extensive retry configuration](https://github.com/JustinBeckwith/retry-axios/blob/v2.6.0/src/index.ts#L11)
+  such as specifying HTTP status codes that should be retried.
+- **[Breaking change]** All HTTP status codes are no longer retried by default. The new default are these ranges:
+  - [100, 199] Informational, request still processing
+  - [429, 429] Too Many Requests
+  - [500, 599] Server errors
+
 ## [2.2.2] - 2021-07-08
 
 ### Fixed bugs

package/README.md

@@ -52,6 +52,23 @@ let httpClient = new HttpClient({
   logFunction: (msg) => logger.log(msg),
   logOptions: { enabledLogs: [HttpLogType.requests] },
   tokenResolver: () => Promise.resolve('exampleAccessToken'),
+  enableRetry: true,
+  retryOptions: {
+    retry: 3,
+    statusCodesToRetry: [
+      [100, 199],
+      [429, 429],
+      [500, 599],
+    ],
+  },
+  enableCache: true,
+  cacheOptions: {
+    maxAge: 5 * 60 * 1000,
+    readOnError: true,
+    exclude: {
+      query: false, // also cache requests with query parameters
+    },
+  },
 });
 
 let headers = {};

package/lib/httpClient/deduplicateRequestAdapter.d.ts

@@ -0,0 +1,2 @@
+import { AxiosAdapter } from 'axios';
+export declare function createDebounceRequestAdapter(requestAdapter: AxiosAdapter, requestKeyProvider: (AxiosRequestConfig: any) => string): AxiosAdapter;

package/lib/httpClient/deduplicateRequestAdapter.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createDebounceRequestAdapter = void 0;
+// adopted from https://github.com/RasCarlito/axios-cache-adapter/issues/231#issuecomment-880288436
+function createDebounceRequestAdapter(requestAdapter, requestKeyProvider) {
+    const runningRequests = {};
+    return (req) => {
+        const cacheKey = requestKeyProvider(req);
+        // Add the request to runningRequests. If it is already there, drop the duplicated request.
+        if (!runningRequests[cacheKey]) {
+            runningRequests[cacheKey] = requestAdapter(req);
+        }
+        // Return the response promise
+        return runningRequests[cacheKey].finally(() => {
+            // Finally, delete the request from the runningRequests whether there's error or not
+            delete runningRequests[cacheKey];
+        });
+    };
+}
+exports.createDebounceRequestAdapter = createDebounceRequestAdapter;

package/lib/httpClient/httpClient.d.ts

@@ -1,6 +1,6 @@
 import { AxiosInstance, AxiosRequestConfig, AxiosResponse } from 'axios';
-import { Options as CacheOptions } from 'axios-extensions/lib/cacheAdapterEnhancer';
-import { Options as RetryOptions } from 'axios-extensions/lib/retryAdapterEnhancer';
+import { IAxiosCacheAdapterOptions } from 'axios-cache-adapter';
+import { RetryConfig } from 'retry-axios';
 /**
  * Allows to specify which http data should be logged.
  */
@@ -21,6 +21,7 @@ export default class HttpClient {
      */
     constructor(options?: HttpClientOptions);
     private static extractRequestLogData;
+    static generateCacheKey(req: AxiosRequestConfig): string;
     /**
      * Resolves the token with the token provider and adds it to the headers
      */
@@ -81,18 +82,18 @@ export interface HttpClientOptions {
     enableCache?: boolean;
     /**
      * Cache options
-     * @link https://github.com/kuitos/axios-extensions#cacheadapterenhancer
+     * @link https://github.com/RasCarlito/axios-cache-adapter/blob/master/axios-cache-adapter.d.ts#L26
      */
-    cacheOptions?: CacheOptions;
+    cacheOptions?: IAxiosCacheAdapterOptions;
     /**
      * Enable automatic retries
      */
     enableRetry?: boolean;
     /**
      * Retry options
-     * @link https://github.com/kuitos/axios-extensions#cacheadapterenhancer
+     * @link https://github.com/JustinBeckwith/retry-axios/blob/v2.6.0/src/index.ts#L11
      */
-    retryOptions?: RetryOptions;
+    retryOptions?: RetryConfig;
 }
 /**
  * Log options object.

package/lib/httpClient/httpClient.js

@@ -1,17 +1,39 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.HttpLogType = void 0;
+const uuid = __importStar(require("uuid"));
 const url_1 = require("url");
 const axios_1 = __importDefault(require("axios"));
-const cacheAdapterEnhancer_1 = __importDefault(require("axios-extensions/lib/cacheAdapterEnhancer"));
-const retryAdapterEnhancer_1 = __importDefault(require("axios-extensions/lib/retryAdapterEnhancer"));
+const axios_cache_adapter_1 = require("axios-cache-adapter");
+const rax = __importStar(require("retry-axios"));
+const md5_1 = __importDefault(require("md5"));
 const util_1 = require("../util");
 const internalException_1 = require("../exceptions/internalException");
 const clientException_1 = require("../exceptions/clientException");
 const shared_1 = require("../shared");
+const deduplicateRequestAdapter_1 = require("./deduplicateRequestAdapter");
 const invalidToken = 'Invalid token';
 /**
  * Allows to specify which http data should be logged.
@@ -38,14 +60,41 @@ class HttpClient {
             adapter: (() => {
                 let adapters = axios_1.default.defaults.adapter;
                 if (this.enableCache) {
-                    adapters = cacheAdapterEnhancer_1.default(adapters, options === null || options === void 0 ? void 0 : options.cacheOptions);
-                }
-                if (this.enableRetry) {
-                    adapters = retryAdapterEnhancer_1.default(adapters, options === null || options === void 0 ? void 0 : options.retryOptions);
+                    const cache = axios_cache_adapter_1.setupCache({
+                        maxAge: 5 * 60 * 1000,
+                        readHeaders: false,
+                        readOnError: true,
+                        exclude: {
+                            query: false,
+                        },
+                        ...options === null || options === void 0 ? void 0 : options.cacheOptions,
+                        key: (req) => HttpClient.generateCacheKey(req),
+                    });
+                    // debounce concurrent calls with the same cacheKey so that only one HTTP request is made
+                    adapters = deduplicateRequestAdapter_1.createDebounceRequestAdapter(cache.adapter, HttpClient.generateCacheKey);
                 }
                 return adapters;
             })(),
         });
+        if (this.enableRetry) {
+            this.client.defaults.raxConfig = {
+                ...options === null || options === void 0 ? void 0 : options.retryOptions,
+                instance: this.client,
+                httpMethodsToRetry: ['GET', 'HEAD', 'OPTIONS', 'DELETE', 'PUT', 'POST'],
+                onRetryAttempt: (err) => {
+                    var _a, _b;
+                    this.logFunction({
+                        title: 'HTTP Response Error Retry',
+                        level: 'INFO',
+                        retryAttempt: (_b = (_a = err.config) === null || _a === void 0 ? void 0 : _a.raxConfig) === null || _b === void 0 ? void 0 : _b.currentRetryAttempt,
+                        ...HttpClient.extractRequestLogData(err.config),
+                        error: util_1.serializeAxiosError(err),
+                    });
+                },
+            };
+            // attach retry-axios
+            rax.attach(this.client);
+        }
         this.client.interceptors.request.use((config) => {
             if (this.logOptions.enabledLogs.includes(HttpLogType.requests)) {
                 this.logFunction({
@@ -82,6 +131,11 @@ class HttpClient {
             return response;
         }, (error) => {
             var _a;
+            // when retries are configured, this middleware gets triggered for each retry
+            // it changes the error object to ClientException and therefore the transformation can be run only once
+            if (error instanceof clientException_1.ClientException) {
+                throw error;
+            }
             const serializedAxiosError = util_1.serializeAxiosError(error);
             if (error.message === invalidToken) {
                 this.logFunction({
@@ -116,6 +170,15 @@ class HttpClient {
             correlationId: (_a = requestConfig.headers) === null || _a === void 0 ? void 0 : _a[shared_1.orionCorrelationIdRoot],
         };
     }
+    // implemented based on https://github.com/RasCarlito/axios-cache-adapter/blob/master/src/cache.js#L77
+    static generateCacheKey(req) {
+        var _a, _b;
+        const prefix = ((_a = req.headers) === null || _a === void 0 ? void 0 : _a.Authorization) ? (_b = util_1.safeJwtCanonicalIdParse(req.headers.Authorization.replace('Bearer ', ''))) !== null && _b !== void 0 ? _b : uuid.v4() : 'shared';
+        const url = `${req.baseURL ? req.baseURL : ''}${req.url}`;
+        const query = req.params ? JSON.stringify(req.params) : ''; // possible improvement: optimize cache-hit ratio by sorting the query params
+        const key = `${prefix}/${url}${query}`;
+        return `${key}${req.data ? md5_1.default(req.data) : ''}`;
+    }
     /**
      * Resolves the token with the token provider and adds it to the headers
      */

package/lib/openApi/apiResponseModel.js

@@ -6,7 +6,7 @@ class ApiResponse {
     constructor(statusCode, body, headers) {
         this.body = body;
         this.statusCode = statusCode;
-        this.headers = headers !== null && headers !== void 0 ? headers : {};
+        this.headers = { 'Content-type': 'application/hal+json', ...headers };
     }
     withCorrelationId(correlationId) {
         this.headers[shared_1.orionCorrelationIdRoot] = correlationId;

package/lib/openApi/openApiWrapper.js

@@ -23,7 +23,6 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const openapi_factory_1 = __importDefault(require("openapi-factory"));
-const jsonwebtoken_1 = __importDefault(require("jsonwebtoken"));
 const uuid = __importStar(require("uuid"));
 const apiResponseModel_1 = require("./apiResponseModel");
 const exception_1 = require("../exceptions/exception");
@@ -45,7 +44,7 @@ class OpenApiWrapper {
                 requestLogger.startInvocation(null, correlationId);
                 // TODO: restrict the alternative way of resolving token and principal only for localhost
                 this.userToken = (_b = (_a = request.requestContext.authorizer) === null || _a === void 0 ? void 0 : _a.jwt) !== null && _b !== void 0 ? _b : (_c = request.headers.Authorization) === null || _c === void 0 ? void 0 : _c.split(' ')[1];
-                this.userPrincipal = (_e = (_d = request.requestContext.authorizer) === null || _d === void 0 ? void 0 : _d.canonicalId) !== null && _e !== void 0 ? _e : (_f = jsonwebtoken_1.default.decode(this.userToken)) === null || _f === void 0 ? void 0 : _f[this.canonicalIdKey];
+                this.userPrincipal = (_f = (_e = (_d = request.requestContext.authorizer) === null || _d === void 0 ? void 0 : _d.canonicalId) !== null && _e !== void 0 ? _e : util_1.safeJwtCanonicalIdParse(this.userToken)) !== null && _f !== void 0 ? _f : 'unknown';
                 this.requestId = request.requestContext.requestId;
                 requestLogger.log({
                     title: 'RequestLogger',

package/lib/util.d.ts

@@ -1,4 +1,5 @@
 import { AxiosError } from 'axios';
+export declare function safeJwtCanonicalIdParse(jwtToken: string): string | undefined;
 export declare function safeJsonParse(input: any, defaultValue: unknown): unknown;
 export declare function serializeObject(obj: unknown): object;
 export declare function serializeAxiosError(error: AxiosError): SerializedAxiosError | undefined;

package/lib/util.js

@@ -1,6 +1,20 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.serializeAxiosError = exports.serializeObject = exports.safeJsonParse = void 0;
+exports.serializeAxiosError = exports.serializeObject = exports.safeJsonParse = exports.safeJwtCanonicalIdParse = void 0;
+const jsonwebtoken_1 = __importDefault(require("jsonwebtoken"));
+function safeJwtCanonicalIdParse(jwtToken) {
+    var _a;
+    try {
+        return (_a = jsonwebtoken_1.default.decode(jwtToken)) === null || _a === void 0 ? void 0 : _a['https://claims.cimpress.io/canonical_id'];
+    }
+    catch (_b) {
+        return undefined;
+    }
+}
+exports.safeJwtCanonicalIdParse = safeJwtCanonicalIdParse;
 function safeJsonParse(input, defaultValue) {
     try {
         return JSON.parse(input);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "lambda-essentials-ts",
-  "version": "2.2.2",
+  "version": "4.1.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,
@@ -28,11 +28,13 @@
   "dependencies": {
     "aws-sdk": "2.939.0",
     "axios": "0.21.1",
-    "axios-extensions": "3.1.3",
+    "axios-cache-adapter": "2.7.3",
     "fast-safe-stringify": "2.0.7",
     "is-error": "2.2.2",
     "jsonwebtoken": "8.5.1",
+    "md5": "2.3.0",
     "openapi-factory": "4.4.247",
+    "retry-axios": "2.6.0",
     "uuid": "8.3.2"
   },
   "devDependencies": {