sm-utility 2.4.24 → 2.4.26

package/general/command.abstract.d.ts

@@ -1,5 +1,5 @@
 import { MetadataModel } from './metadata.model';
-import { LeveledLogMethod } from 'winston';
+import { LeveledLogMethod, Logger } from 'winston';
 type LogData<T> = {
     context?: T;
 };
@@ -10,9 +10,10 @@ type EnhancedLogParams<T, E> = {
     error?: E;
 };
 export declare abstract class Command {
-    protected readonly className: string;
-    protected readonly metadata: MetadataModel;
-    protected readonly logger: import("winston").Logger;
+    protected className?: string | undefined;
+    protected metadata?: MetadataModel | undefined;
+    private loggerInstance;
+    private lastTime;
     private startTime;
     /**
      * Creates a new instance of the Command class.
@@ -21,7 +22,7 @@ export declare abstract class Command {
      * @param metadata - (Optional) A metadata model containing additional information for the command.
      * If not provided, a new `MetadataModel` will be created with a randomly generated `auditUuid`.
      */
-    constructor(className: string, metadata?: MetadataModel);
+    constructor(className?: string | undefined, metadata?: MetadataModel | undefined);
     /**
      * Executes the command logic. This method must be implemented by any class extending the Command base class.
      *
@@ -48,6 +49,19 @@ export declare abstract class Command {
      * }
      */
     abstract execute(params?: any): Promise<any>;
+    /**
+     * Sets the logger of the command.
+     * @param logger - The logger to be used for the command.
+     * @returns The command instance.
+     */
+    withLogger(customLogger: Logger): this;
+    protected get logger(): Logger;
+    /**
+     * Sets the metadata of the command that will be included in log messages.
+     * @param metadata - The metadata of the command.
+     * @returns The command instance.
+     */
+    withMetadata(metadata: MetadataModel): this;
     /**
      * Logs that the command has been initiated.
      * @param logData Optional contextual data for the log.
@@ -64,6 +78,14 @@ export declare abstract class Command {
      * @param logData Optional contextual data for the log.
      */
     protected logUnexpectedFailed<T>(error: Error, logData?: LogData<T>): void;
+    protected logExpectedFailed<T>(error: Error, logData?: LogData<T>): void;
+    /**
+     * Logs that the command has been interrupted.
+     * @param error The error that was thrown.
+     * @param logData Optional contextual data for the log.
+     */
+    protected logInterruptionError<T>(error: Error, logData?: LogData<T>): void;
+    protected logEarlyFinish<T>(logData?: LogData<T>): void;
     /**
      * Logs detailed information about the current operation, optionally including execution time and error details.
      *
@@ -84,7 +106,7 @@ export declare abstract class Command {
      * @example
      * // Log a successful operation
      * this.enhancedLog({
-     *   logMethod: this.logger.info,
+     *   logMethod: this.logger.info.bind(this.logger),
      *   message: 'Operation finished successfully',
      *   logData: { userId: '12345' },
      * });
@@ -92,7 +114,7 @@ export declare abstract class Command {
      * @example
      * // Log a failed operation with an error
      * this.enhancedLog({
-     *   logMethod: this.logger.error,
+     *   logMethod: this.logger.error.bind(this.logger),
      *   message: 'Operation failed',
      *   logData: { userId: '12345' },
      *   error: new Error('Unexpected error'),
@@ -101,12 +123,13 @@ export declare abstract class Command {
      * @example
      * // Log an initiated operation
      * this.enhancedLog({
-     *   logMethod: this.logger.info,
+     *   logMethod: this.logger.info.bind(this.logger),
      *   message: 'Operation initiated',
      * });
      */
     protected enhancedLog<T, E>({ logMethod, message, logData, error, }: EnhancedLogParams<T, E>): void;
-    getExecutionTime(): string;
+    getAccumulatedExecutionTime(): string;
+    getExecutionTimeSinceLastTimestamp(): string;
     private buildLogData;
 }
 export {};

package/general/command.abstract.js

@@ -4,6 +4,7 @@ exports.Command = void 0;
 const logger_1 = require("../logger");
 const metadata_model_1 = require("./metadata.model");
 const uuid_1 = require("uuid");
+const tracing_1 = require("../tracing");
 class Command {
     /**
      * Creates a new instance of the Command class.
@@ -12,13 +13,48 @@ class Command {
      * @param metadata - (Optional) A metadata model containing additional information for the command.
      * If not provided, a new `MetadataModel` will be created with a randomly generated `auditUuid`.
      */
-    constructor(className, metadata = new metadata_model_1.MetadataModel({
-        auditUuid: (0, uuid_1.v4)(),
-    })) {
+    constructor(className, metadata) {
         this.className = className;
         this.metadata = metadata;
-        this.logger = logger_1.logger;
-        this.startTime = performance.now();
+        this.className = this.constructor.name;
+        if (!this.metadata) {
+            this.metadata = new metadata_model_1.MetadataModel({
+                auditUuid: (0, uuid_1.v4)(),
+            });
+        }
+        const startTime = performance.now();
+        this.startTime = startTime;
+        this.lastTime = startTime;
+    }
+    /**
+     * Sets the logger of the command.
+     * @param logger - The logger to be used for the command.
+     * @returns The command instance.
+     */
+    withLogger(customLogger) {
+        this.loggerInstance = customLogger.child({
+            'command.name': this.className,
+        });
+        return this;
+    }
+    get logger() {
+        if (!this.loggerInstance) {
+            this.loggerInstance = logger_1.logger.child({
+                'command.name': this.className,
+                'trace.id': tracing_1.TracingContextProvider.getTraceId(),
+                'span.id': tracing_1.TracingContextProvider.getSpanId(),
+            });
+        }
+        return this.loggerInstance;
+    }
+    /**
+     * Sets the metadata of the command that will be included in log messages.
+     * @param metadata - The metadata of the command.
+     * @returns The command instance.
+     */
+    withMetadata(metadata) {
+        this.metadata = metadata;
+        return this;
     }
     /**
      * Logs that the command has been initiated.
@@ -26,7 +62,7 @@ class Command {
      */
     logInitiated(logData) {
         this.enhancedLog({
-            logMethod: this.logger.info,
+            logMethod: this.logger.info.bind(this.logger),
             message: `${this.className} initiated`,
             logData,
         });
@@ -37,7 +73,7 @@ class Command {
      */
     logFinished(logData) {
         this.enhancedLog({
-            logMethod: this.logger.info,
+            logMethod: this.logger.info.bind(this.logger),
             message: `${this.className} finished`,
             logData,
         });
@@ -49,12 +85,40 @@ class Command {
      */
     logUnexpectedFailed(error, logData) {
         this.enhancedLog({
-            logMethod: this.logger.error,
-            message: `${this.className} failed`,
+            logMethod: this.logger.error.bind(this.logger),
+            message: `${this.className} unexpected failed`,
+            logData,
+            error,
+        });
+    }
+    logExpectedFailed(error, logData) {
+        this.enhancedLog({
+            logMethod: this.logger.error.bind(this.logger),
+            message: `${this.className} expected failed`,
             logData,
             error,
         });
     }
+    /**
+     * Logs that the command has been interrupted.
+     * @param error The error that was thrown.
+     * @param logData Optional contextual data for the log.
+     */
+    logInterruptionError(error, logData) {
+        this.enhancedLog({
+            logMethod: this.logger.error.bind(this.logger),
+            message: `${this.className} interrupted`,
+            logData,
+            error,
+        });
+    }
+    logEarlyFinish(logData) {
+        this.enhancedLog({
+            logMethod: this.logger.info.bind(this.logger),
+            message: `${this.className} finished early`,
+            logData,
+        });
+    }
     /**
      * Logs detailed information about the current operation, optionally including execution time and error details.
      *
@@ -75,7 +139,7 @@ class Command {
      * @example
      * // Log a successful operation
      * this.enhancedLog({
-     *   logMethod: this.logger.info,
+     *   logMethod: this.logger.info.bind(this.logger),
      *   message: 'Operation finished successfully',
      *   logData: { userId: '12345' },
      * });
@@ -83,7 +147,7 @@ class Command {
      * @example
      * // Log a failed operation with an error
      * this.enhancedLog({
-     *   logMethod: this.logger.error,
+     *   logMethod: this.logger.error.bind(this.logger),
      *   message: 'Operation failed',
      *   logData: { userId: '12345' },
      *   error: new Error('Unexpected error'),
@@ -92,7 +156,7 @@ class Command {
      * @example
      * // Log an initiated operation
      * this.enhancedLog({
-     *   logMethod: this.logger.info,
+     *   logMethod: this.logger.info.bind(this.logger),
      *   message: 'Operation initiated',
      * });
      */
@@ -102,7 +166,7 @@ class Command {
         };
         //* Add `executionTime` if the message is not about initiation
         if (!message.includes('initiated')) {
-            logPayload.executionTime = this.getExecutionTime();
+            logPayload.executionTime = this.getAccumulatedExecutionTime();
         }
         //* Add error details if present
         if (error) {
@@ -111,7 +175,7 @@ class Command {
         //* Log the message with the appropriate level
         logMethod(message, logPayload);
     }
-    getExecutionTime() {
+    getAccumulatedExecutionTime() {
         const executionTime = performance.now() - this.startTime;
         if (executionTime >= 1000) {
             //* Converting to seconds if the execution time is greater than 1000ms
@@ -119,6 +183,15 @@ class Command {
         }
         return `${executionTime.toFixed(2)}ms`;
     }
+    getExecutionTimeSinceLastTimestamp() {
+        const now = performance.now();
+        const executionTime = now - this.lastTime;
+        this.lastTime = now;
+        if (executionTime >= 1000) {
+            return `${(executionTime / 1000).toFixed(2)}s`;
+        }
+        return `${executionTime.toFixed(2)}ms`;
+    }
     buildLogData(logData) {
         var _a;
         return {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "sm-utility",
-  "version": "2.4.24",
+  "version": "2.4.26",
   "description": "reusable utility codes for sm projects",
   "main": "index.js",
   "types": "./index.d.ts",

package/request/axios-custom-client.js

@@ -5,16 +5,13 @@ 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 { 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));
+    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)());
     return axiosApi;
 }
 exports.createApi = createApi;

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

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

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

@@ -1,3 +1,2 @@
 import { InternalAxiosRequestConfig } from "axios";
-import type { Logger } from "winston";
-export declare function createRequestInterceptor(log?: Logger): (request: InternalAxiosRequestConfig) => InternalAxiosRequestConfig<any>;
+export declare function createRequestInterceptor(): (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(log) {
+function createRequestInterceptor() {
     return (request) => {
         if (request === null || request === void 0 ? void 0 : request.logRequest) {
             const { data, params, method } = request;
@@ -12,7 +12,7 @@ function createRequestInterceptor(log) {
             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, log);
+            (0, loggers_1.logRequest)(request.meta.requestId, method, fullUrl, data, params);
         }
         return request;
     };

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

@@ -1,3 +1,2 @@
 import { AxiosResponse } from "axios";
-import type { Logger } from "winston";
-export declare function createResponseInterceptor(log?: Logger): (response: AxiosResponse) => AxiosResponse<any, any>;
+export declare function createResponseInterceptor(): (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(log) {
+function createResponseInterceptor() {
     return (response) => {
         var _a;
         if ((_a = response.config) === null || _a === void 0 ? void 0 : _a.logResponse) {
@@ -11,7 +11,7 @@ function createResponseInterceptor(log) {
             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, log);
+            (0, loggers_1.logResponse)(meta === null || meta === void 0 ? void 0 : meta.requestId, method, fullUrl, data, status, responseTime);
         }
         return response;
     };

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

@@ -1,2 +1 @@
-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;
+export declare function logError(id: string, method: string | undefined, url: string | undefined, data: unknown, status: any, message: any): void;

package/request/loggers/error.logger.js

@@ -2,7 +2,8 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.logError = void 0;
 const logger_1 = require("../../logger");
-function logError(id, method, url, data, status, message, log = logger_1.logger) {
+const tracing_1 = require("../../tracing");
+function logError(id, method, url, data, status, message) {
     const err = {
         ["context-id"]: id,
         url,
@@ -11,6 +12,14 @@ function logError(id, method, url, data, status, message, log = logger_1.logger)
         status,
         message,
     };
-    log.error("sm-utility/api-error", { err });
+    const traceId = tracing_1.TracingContextProvider.getTraceId();
+    if (traceId) {
+        err['trace.id'] = traceId;
+    }
+    const spanId = tracing_1.TracingContextProvider.getSpanId();
+    if (spanId) {
+        err['span.id'] = spanId;
+    }
+    logger_1.logger.error("sm-utility/api-error", { err });
 }
 exports.logError = logError;

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

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

package/request/loggers/request.logger.js

@@ -2,7 +2,8 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.logRequest = void 0;
 const logger_1 = require("../../logger");
-function logRequest(id, method, url, body, params, log = logger_1.logger) {
+const tracing_1 = require("../../tracing");
+function logRequest(id, method, url, body, params) {
     const request = {
         ["context-id"]: id,
         url,
@@ -10,6 +11,14 @@ function logRequest(id, method, url, body, params, log = logger_1.logger) {
         params,
         body,
     };
-    log.info("sm-utility/api-request", { request });
+    const traceId = tracing_1.TracingContextProvider.getTraceId();
+    if (traceId) {
+        request['trace.id'] = traceId;
+    }
+    const spanId = tracing_1.TracingContextProvider.getSpanId();
+    if (spanId) {
+        request['span.id'] = spanId;
+    }
+    logger_1.logger.info("sm-utility/api-request", { request });
 }
 exports.logRequest = logRequest;

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

@@ -1,2 +1 @@
-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;
+export declare function logResponse(id: string, method: string | undefined, url: string | undefined, body: unknown, status: any, responseTime: string): void;

package/request/loggers/response.logger.js

@@ -2,7 +2,8 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.logResponse = void 0;
 const logger_1 = require("../../logger");
-function logResponse(id, method, url, body, status, responseTime, log = logger_1.logger) {
+const tracing_1 = require("../../tracing");
+function logResponse(id, method, url, body, status, responseTime) {
     const response = {
         ["context-id"]: id,
         url,
@@ -11,6 +12,14 @@ function logResponse(id, method, url, body, status, responseTime, log = logger_1
         status,
         responseTime,
     };
-    log.info("sm-utility/api-response", { response });
+    const traceId = tracing_1.TracingContextProvider.getTraceId();
+    if (traceId) {
+        response['trace.id'] = traceId;
+    }
+    const spanId = tracing_1.TracingContextProvider.getSpanId();
+    if (spanId) {
+        response['span.id'] = spanId;
+    }
+    logger_1.logger.info("sm-utility/api-response", { response });
 }
 exports.logResponse = logResponse;

package/request/types.d.ts

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

package/tracing/index.d.ts

@@ -1,2 +1,3 @@
 export { OpenTelemetryTracer } from "./opentelemetry-tracer";
 export type { TracingConfig } from "./opentelemetry-tracer";
+export { TracingContextProvider } from "./tracingContextProvider";

package/tracing/index.js

@@ -1,5 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.OpenTelemetryTracer = void 0;
+exports.TracingContextProvider = exports.OpenTelemetryTracer = void 0;
 var opentelemetry_tracer_1 = require("./opentelemetry-tracer");
 Object.defineProperty(exports, "OpenTelemetryTracer", { enumerable: true, get: function () { return opentelemetry_tracer_1.OpenTelemetryTracer; } });
+var tracingContextProvider_1 = require("./tracingContextProvider");
+Object.defineProperty(exports, "TracingContextProvider", { enumerable: true, get: function () { return tracingContextProvider_1.TracingContextProvider; } });

package/tracing/tracingContextProvider.d.ts

@@ -0,0 +1,10 @@
+export declare class TracingContextProvider {
+    /**
+     * Returns the canonical OpenTelemetry trace id (32 hex chars)
+     */
+    static getTraceId(): string | undefined;
+    /**
+     * Returns the current span id (16 hex chars)
+     */
+    static getSpanId(): string | undefined;
+}

package/tracing/tracingContextProvider.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TracingContextProvider = void 0;
+const api_1 = require("@opentelemetry/api");
+class TracingContextProvider {
+    /**
+     * Returns the canonical OpenTelemetry trace id (32 hex chars)
+     */
+    static getTraceId() {
+        var _a;
+        const span = api_1.trace.getSpan(api_1.context.active());
+        return (_a = span === null || span === void 0 ? void 0 : span.spanContext()) === null || _a === void 0 ? void 0 : _a.traceId;
+    }
+    /**
+     * Returns the current span id (16 hex chars)
+     */
+    static getSpanId() {
+        var _a;
+        const span = api_1.trace.getSpan(api_1.context.active());
+        return (_a = span === null || span === void 0 ? void 0 : span.spanContext()) === null || _a === void 0 ? void 0 : _a.spanId;
+    }
+}
+exports.TracingContextProvider = TracingContextProvider;