lambda-essentials-ts 5.1.6 → 5.1.8

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.1.8] - 2022-12-15
+
+### Changed
+
+Removed client_secret from API response
+
+## [5.1.7] - 2022-12-13
+
+### Changed
+
+Add timeout option in HttpClient. If no value is provided the default is no timeout.
+
 ## [5.1.6] - 2022-11-30
 
 ### Changed

package/README.md

@@ -69,6 +69,7 @@ let httpClient = new HttpClient({
       query: false, // also cache requests with query parameters
     },
   },
+  timeout: 1000
 });
 
 let headers = {};

package/lib/httpClient/httpClient.d.ts

@@ -16,6 +16,7 @@ export default class HttpClient {
     private readonly client;
     private readonly enableRetry;
     private readonly enableCache;
+    private readonly timeout?;
     /**
      * Create a new Instance of the HttpClient
      */
@@ -94,6 +95,11 @@ export interface HttpClientOptions {
      * @link https://github.com/JustinBeckwith/retry-axios/blob/v2.6.0/src/index.ts#L11
      */
     retryOptions?: RetryConfig;
+    /**
+     * Number of milliseconds before the request times out. Default or `0` is no time out.
+     * @link https://github.com/axios/axios/blob/main/README.md#request-config
+     */
+    timeout?: number;
 }
 /**
  * Log options object.

package/lib/httpClient/httpClient.js

@@ -61,6 +61,7 @@ class HttpClient {
         this.correlationIdResolverFunction = options === null || options === void 0 ? void 0 : options.correlationIdResolver;
         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.client =
             (_e = options === null || options === void 0 ? void 0 : options.client) !== null && _e !== void 0 ? _e : axios_1.default.create({
                 adapter: (() => {
@@ -101,6 +102,9 @@ class HttpClient {
             // attach retry-axios
             rax.attach(this.client);
         }
+        if (this.timeout) {
+            this.client.defaults.timeout = this.timeout;
+        }
         this.client.interceptors.request.use((config) => {
             if (this.logOptions.enabledLogs.includes(HttpLogType.requests)) {
                 this.logFunction({

package/lib/logger/logger.js

@@ -30,6 +30,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const uuid = __importStar(require("uuid"));
 const fast_safe_stringify_1 = __importDefault(require("fast-safe-stringify"));
 const is_error_1 = __importDefault(require("is-error"));
+const util_1 = require("../util");
 class Logger {
     constructor(configuration) {
         var _a, _b;
@@ -74,12 +75,9 @@ class Logger {
         const truncateToken = (innerPayload) => {
             return innerPayload.replace(/(eyJ[a-zA-Z0-9_-]{5,}\.eyJ[a-zA-Z0-9_-]{5,})\.[a-zA-Z0-9_-]*/gi, (m, p1) => `${p1}.<sig>`);
         };
-        const truncateSecret = (data) => {
-            return data.replace(/(\\*"client_secret\\*":\\*")([a-zA-Z0-9_+=.@/-]{60,})(\\*")/gi, (m, p1, p2, p3) => `${p1}<REDACTED>${p3}`);
-        };
         const replacer = (key, value) => ((0, is_error_1.default)(value) ? Logger.errorToObject(value) : value);
         let stringifiedPayload = truncateToken((0, fast_safe_stringify_1.default)(payload, replacer, this.jsonSpace));
-        stringifiedPayload = truncateSecret(stringifiedPayload);
+        stringifiedPayload = (0, util_1.redactSecret)(stringifiedPayload);
         // https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/cloudwatch_limits_cwl.html 256KB => 32768 characters
         if (stringifiedPayload.length >= 32768) {
             const replacementPayload = {

package/lib/openApi/openApiWrapper.js

@@ -83,7 +83,7 @@ class OpenApiWrapper {
             errorMiddleware: (request, error) => {
                 const { correlationId } = this;
                 this.clearContext();
-                const serializedError = (0, util_1.serializeObject)(error);
+                const serializedError = (0, util_1.serializeObject)(error, true);
                 if (error instanceof exception_1.Exception) {
                     if (error.statusCode === 500) {
                         requestLogger.log({ title: 'ErrorLogger', level: 'ERROR', ...serializedError });

package/lib/util.d.ts

@@ -1,7 +1,8 @@
 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 const redactSecret: (data: string) => string;
+export declare function serializeObject(obj: unknown, redact?: boolean): object;
 export declare function serializeAxiosError(error: AxiosError): SerializedAxiosError | undefined;
 export interface SerializedAxiosError {
     status: number;

package/lib/util.js

@@ -3,7 +3,7 @@ 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 = exports.safeJwtCanonicalIdParse = void 0;
+exports.serializeAxiosError = exports.serializeObject = exports.redactSecret = exports.safeJsonParse = exports.safeJwtCanonicalIdParse = void 0;
 const jsonwebtoken_1 = __importDefault(require("jsonwebtoken"));
 function safeJwtCanonicalIdParse(jwtToken) {
     var _a;
@@ -24,15 +24,22 @@ function safeJsonParse(input, defaultValue) {
     }
 }
 exports.safeJsonParse = safeJsonParse;
-function serializeObject(obj) {
+const redactSecret = (data) => {
+    return data.replace(/(\\*"*'*client_secret\\*"*'*:\s*\\*"*'*)([^"'\\]+)(\\*"*'*)/gi, (m, p1, p2, p3) => `${p1}<REDACTED>${p3}`);
+};
+exports.redactSecret = redactSecret;
+function serializeObject(obj, redact) {
+    let modObj = obj;
     if (obj && typeof obj === 'object') {
-        return Object.getOwnPropertyNames(obj).reduce((map, key) => {
+        modObj = Object.getOwnPropertyNames(obj).reduce((map, key) => {
             // eslint-disable-next-line no-param-reassign
             map[key] = obj[key];
             return map;
         }, {});
     }
-    return JSON.parse(JSON.stringify(obj));
+    return redact
+        ? JSON.parse((0, exports.redactSecret)(JSON.stringify(modObj)))
+        : JSON.parse(JSON.stringify(modObj));
 }
 exports.serializeObject = serializeObject;
 function serializeAxiosError(error) {

package/package.json

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