sm-utility 2.4.22 → 2.4.24

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "sm-utility",
-  "version": "2.4.22",
+  "version": "2.4.24",
   "description": "reusable utility codes for sm projects",
   "main": "index.js",
   "types": "./index.d.ts",
@@ -21,6 +21,7 @@
   "devDependencies": {
     "@types/express": "^4.17.11",
     "@types/node": "^14.14.40",
+    "@types/request-ip": "0.0.41",
     "@types/uuid": "^8.3.1",
     "copyfiles": "^2.4.1",
     "typescript": "^4.2.4"
@@ -41,6 +42,7 @@
     "nanoid": "^3.3.6",
     "node-xlsx": "^0.24.0",
     "redis": "^4.1.0",
+    "request-ip": "3.3.0",
     "ts-node": "^10.9.1",
     "uuid": "^8.3.2",
     "winston": "^3.3.3"

package/request/axios-custom-client.js

@@ -5,13 +5,16 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.createApi = void 0;
 const axios_1 = __importDefault(require("axios"));
+const logger_1 = require("../logger");
 const request_interceptor_1 = require("./interceptors/request.interceptor");
 const response_interceptor_1 = require("./interceptors/response.interceptor");
 const error_interceptor_1 = require("./interceptors/error.interceptor");
 function createApi(axiosConfig) {
-    const axiosApi = axios_1.default.create(axiosConfig);
-    axiosApi.interceptors.request.use((0, request_interceptor_1.createRequestInterceptor)(), (0, error_interceptor_1.createErrorInterceptor)());
-    axiosApi.interceptors.response.use((0, response_interceptor_1.createResponseInterceptor)(), (0, error_interceptor_1.createErrorInterceptor)());
+    const { logContext, ...axiosCreateConfig } = axiosConfig || {};
+    const axiosApi = axios_1.default.create(axiosCreateConfig);
+    const scopedLogger = logContext ? logger_1.logger.child(logContext) : logger_1.logger;
+    axiosApi.interceptors.request.use((0, request_interceptor_1.createRequestInterceptor)(scopedLogger), (0, error_interceptor_1.createErrorInterceptor)(scopedLogger));
+    axiosApi.interceptors.response.use((0, response_interceptor_1.createResponseInterceptor)(scopedLogger), (0, error_interceptor_1.createErrorInterceptor)(scopedLogger));
     return axiosApi;
 }
 exports.createApi = createApi;

package/request/index.d.ts

@@ -1,3 +1,4 @@
 export * from './axios-custom-client';
 export * from './axios';
 export * from './types';
+export * from './requestExtractor';

package/request/index.js

@@ -17,3 +17,4 @@ Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./axios-custom-client"), exports);
 __exportStar(require("./axios"), exports);
 __exportStar(require("./types"), exports);
+__exportStar(require("./requestExtractor"), exports);

package/request/interceptors/error.interceptor.d.ts

@@ -1,2 +1,3 @@
 import { AxiosError } from "axios";
-export declare function createErrorInterceptor(): (error: AxiosError) => never;
+import type { Logger } from "winston";
+export declare function createErrorInterceptor(log?: Logger): (error: AxiosError) => never;

package/request/interceptors/error.interceptor.js

@@ -3,12 +3,12 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.createErrorInterceptor = void 0;
 const loggers_1 = require("../loggers");
 const utils_1 = require("../utils");
-function createErrorInterceptor() {
+function createErrorInterceptor(log) {
     return (error) => {
         const { config, message, response } = error;
         const { method, meta } = config || {};
         const fullUrl = (0, utils_1.getFullUrlFromConfig)(config);
-        (0, loggers_1.logError)(meta === null || meta === void 0 ? void 0 : meta.requestId, method, fullUrl, response === null || response === void 0 ? void 0 : response.data, response === null || response === void 0 ? void 0 : response.status, message);
+        (0, loggers_1.logError)(meta === null || meta === void 0 ? void 0 : meta.requestId, method, fullUrl, response === null || response === void 0 ? void 0 : response.data, response === null || response === void 0 ? void 0 : response.status, message, log);
         throw error;
     };
 }

package/request/interceptors/request.interceptor.d.ts

@@ -1,2 +1,3 @@
 import { InternalAxiosRequestConfig } from "axios";
-export declare function createRequestInterceptor(): (request: InternalAxiosRequestConfig) => InternalAxiosRequestConfig<any>;
+import type { Logger } from "winston";
+export declare function createRequestInterceptor(log?: Logger): (request: InternalAxiosRequestConfig) => InternalAxiosRequestConfig<any>;

package/request/interceptors/request.interceptor.js

@@ -4,7 +4,7 @@ exports.createRequestInterceptor = void 0;
 const uuid_1 = require("uuid");
 const utils_1 = require("../utils");
 const loggers_1 = require("../loggers");
-function createRequestInterceptor() {
+function createRequestInterceptor(log) {
     return (request) => {
         if (request === null || request === void 0 ? void 0 : request.logRequest) {
             const { data, params, method } = request;
@@ -12,7 +12,7 @@ function createRequestInterceptor() {
             request.meta = request.meta || {};
             request.meta.requestId = (0, uuid_1.v4)();
             request.meta.requestStartedAt = new Date().getTime();
-            (0, loggers_1.logRequest)(request.meta.requestId, method, fullUrl, data, params);
+            (0, loggers_1.logRequest)(request.meta.requestId, method, fullUrl, data, params, log);
         }
         return request;
     };

package/request/interceptors/response.interceptor.d.ts

@@ -1,2 +1,3 @@
 import { AxiosResponse } from "axios";
-export declare function createResponseInterceptor(): (response: AxiosResponse) => AxiosResponse<any, any>;
+import type { Logger } from "winston";
+export declare function createResponseInterceptor(log?: Logger): (response: AxiosResponse) => AxiosResponse<any, any>;

package/request/interceptors/response.interceptor.js

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.createResponseInterceptor = void 0;
 const loggers_1 = require("../loggers");
 const utils_1 = require("../utils");
-function createResponseInterceptor() {
+function createResponseInterceptor(log) {
     return (response) => {
         var _a;
         if ((_a = response.config) === null || _a === void 0 ? void 0 : _a.logResponse) {
@@ -11,7 +11,7 @@ function createResponseInterceptor() {
             const { method, meta } = config;
             const fullUrl = (0, utils_1.getFullUrlFromConfig)(config);
             const responseTime = (0, utils_1.getResponseTimeFromConfig)(config);
-            (0, loggers_1.logResponse)(meta === null || meta === void 0 ? void 0 : meta.requestId, method, fullUrl, data, status, responseTime);
+            (0, loggers_1.logResponse)(meta === null || meta === void 0 ? void 0 : meta.requestId, method, fullUrl, data, status, responseTime, log);
         }
         return response;
     };

package/request/loggers/error.logger.d.ts

@@ -1 +1,2 @@
-export declare function logError(id: string, method: string | undefined, url: string | undefined, data: unknown, status: any, message: any): void;
+import type { Logger } from "winston";
+export declare function logError(id: string, method: string | undefined, url: string | undefined, data: unknown, status: any, message: any, log?: Logger): void;

package/request/loggers/error.logger.js

@@ -2,7 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.logError = void 0;
 const logger_1 = require("../../logger");
-function logError(id, method, url, data, status, message) {
+function logError(id, method, url, data, status, message, log = logger_1.logger) {
     const err = {
         ["context-id"]: id,
         url,
@@ -11,6 +11,6 @@ function logError(id, method, url, data, status, message) {
         status,
         message,
     };
-    logger_1.logger.error("sm-utility/api-error", { err });
+    log.error("sm-utility/api-error", { err });
 }
 exports.logError = logError;

package/request/loggers/request.logger.d.ts

@@ -1 +1,2 @@
-export declare function logRequest(id: string, method: string | undefined, url: string | undefined, body: unknown, params: string): void;
+import type { Logger } from "winston";
+export declare function logRequest(id: string, method: string | undefined, url: string | undefined, body: unknown, params: string, log?: Logger): void;

package/request/loggers/request.logger.js

@@ -2,7 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.logRequest = void 0;
 const logger_1 = require("../../logger");
-function logRequest(id, method, url, body, params) {
+function logRequest(id, method, url, body, params, log = logger_1.logger) {
     const request = {
         ["context-id"]: id,
         url,
@@ -10,6 +10,6 @@ function logRequest(id, method, url, body, params) {
         params,
         body,
     };
-    logger_1.logger.info("sm-utility/api-request", { request });
+    log.info("sm-utility/api-request", { request });
 }
 exports.logRequest = logRequest;

package/request/loggers/response.logger.d.ts

@@ -1 +1,2 @@
-export declare function logResponse(id: string, method: string | undefined, url: string | undefined, body: unknown, status: any, responseTime: string): void;
+import type { Logger } from "winston";
+export declare function logResponse(id: string, method: string | undefined, url: string | undefined, body: unknown, status: any, responseTime: string, log?: Logger): void;

package/request/loggers/response.logger.js

@@ -2,7 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.logResponse = void 0;
 const logger_1 = require("../../logger");
-function logResponse(id, method, url, body, status, responseTime) {
+function logResponse(id, method, url, body, status, responseTime, log = logger_1.logger) {
     const response = {
         ["context-id"]: id,
         url,
@@ -11,6 +11,6 @@ function logResponse(id, method, url, body, status, responseTime) {
         status,
         responseTime,
     };
-    logger_1.logger.info("sm-utility/api-response", { response });
+    log.info("sm-utility/api-response", { response });
 }
 exports.logResponse = logResponse;

package/request/requestExtractor.d.ts

@@ -0,0 +1,25 @@
+import { Request } from 'express';
+export declare class IpAddress {
+    private readonly ip;
+    constructor(ip: string | null);
+    raw(): string;
+    sanitized(): string;
+}
+export declare class RequestExtractor {
+    private readonly req;
+    constructor(req: Request);
+    /**
+     * Extracts the ip address from the request headers.
+     *
+     * If the ip address is not in the cf-connecting-ip header (Cloudflare - HML and PROD), it will be extracted from the x-forwarded-for header (local development)
+     */
+    extractIp(): IpAddress;
+    /**
+     * Extracts the trace id (x-ray trace id) from the request headers
+     */
+    extractTraceId(): string | undefined;
+    /**
+     * Extracts the user agent from the request headers
+     */
+    extractUserAgent(): string | undefined;
+}

package/request/requestExtractor.js

@@ -0,0 +1,49 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RequestExtractor = exports.IpAddress = void 0;
+const request_ip_1 = __importDefault(require("request-ip"));
+class IpAddress {
+    constructor(ip) {
+        this.ip = ip;
+    }
+    raw() {
+        return this.ip || 'unknown';
+    }
+    sanitized() {
+        var _a;
+        return ((_a = this.ip) === null || _a === void 0 ? void 0 : _a.replace(/^::ffff:/, '')) || 'unknown';
+    }
+}
+exports.IpAddress = IpAddress;
+class RequestExtractor {
+    constructor(req) {
+        this.req = req;
+    }
+    /**
+     * Extracts the ip address from the request headers.
+     *
+     * If the ip address is not in the cf-connecting-ip header (Cloudflare - HML and PROD), it will be extracted from the x-forwarded-for header (local development)
+     */
+    extractIp() {
+        const cloudflareIp = this.req.headers['cf-connecting-ip'];
+        const ip = cloudflareIp || request_ip_1.default.getClientIp(this.req);
+        return new IpAddress(ip);
+    }
+    /**
+     * Extracts the trace id (x-ray trace id) from the request headers
+     */
+    extractTraceId() {
+        return this.req.headers['x-amzn-trace-id'];
+    }
+    /**
+     * Extracts the user agent from the request headers
+     */
+    extractUserAgent() {
+        var _a;
+        return (_a = this.req) === null || _a === void 0 ? void 0 : _a.headers['user-agent'];
+    }
+}
+exports.RequestExtractor = RequestExtractor;

package/request/types.d.ts

@@ -7,5 +7,10 @@ declare module 'axios' {
         logResponse?: boolean;
     }
 }
-export type CustomClientCreateApiParams = Omit<AxiosRequestConfig, 'meta'>;
+export type LoggerContext = {
+    trace_id: string;
+} & Record<string, any>;
+export type CustomClientCreateApiParams = Omit<AxiosRequestConfig, 'meta'> & {
+    logContext?: LoggerContext;
+};
 export type SmAxiosInstance = ReturnType<typeof createApi>;