sm-utility 2.4.25 → 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.25",
+  "version": "2.4.26",
   "description": "reusable utility codes for sm projects",
   "main": "index.js",
   "types": "./index.d.ts",