Added log tagging.

Author: gasperzgonec

src/logger/logger.interfaces.ts

@@ -1,6 +1,6 @@
-import { RawAxiosResponseHeaders } from 'axios';
-import { AirdropEvent, EventContext } from '../types/extraction';
-import { WorkerAdapterOptions } from '../types/workers';
+import type { RawAxiosResponseHeaders } from 'axios';
+import type { AirdropEvent, EventContext } from '../types/extraction';
+import type { WorkerAdapterOptions } from '../types/workers';
 
 export interface LoggerFactoryInterface {
   event: AirdropEvent;
@@ -48,4 +48,5 @@ export interface AxiosErrorResponse {
 
 export interface LoggerTags extends EventContext {
   sdk_version: string;
+  sdk_log: boolean;
 }

src/logger/logger.test.ts

@@ -5,6 +5,7 @@ import { createEvent } from '../tests/test-helpers';
 import { AirdropEvent, EventType } from '../types/extraction';
 import { WorkerAdapterOptions } from '../types/workers';
 import { getPrintableState, Logger, serializeAxiosError } from './logger';
+import { LogLevel } from './logger.interfaces';
 import {
   INSPECT_OPTIONS as EXPECTED_INSPECT_OPTIONS,
   MAX_LOG_STRING_LENGTH,
@@ -67,6 +68,7 @@ describe(Logger.name, () => {
     expect(tags).toEqual({
       ...mockEvent.payload.event_context,
       sdk_version: LIBRARY_VERSION,
+      sdk_log: true,
     });
   });
 
@@ -84,6 +86,7 @@ describe(Logger.name, () => {
         message,
         ...mockEvent.payload.event_context,
         sdk_version: LIBRARY_VERSION,
+        sdk_log: true,
       })
     );
   });
@@ -103,6 +106,7 @@ describe(Logger.name, () => {
         message: expectedMessage,
         ...mockEvent.payload.event_context,
         sdk_version: LIBRARY_VERSION,
+        sdk_log: true,
       })
     );
   });
@@ -123,6 +127,7 @@ describe(Logger.name, () => {
         message: `${text} ${expectedDataMessage}`,
         ...mockEvent.payload.event_context,
         sdk_version: LIBRARY_VERSION,
+        sdk_log: true,
       })
     );
   });
@@ -144,6 +149,22 @@ describe(Logger.name, () => {
         message: `${text1} ${expectedDataMessage} ${text2}`,
         ...mockEvent.payload.event_context,
         sdk_version: LIBRARY_VERSION,
+        sdk_log: true,
+      })
+    );
+  });
+
+  it('should set sdk_log to false for worker thread logs', () => {
+    const logger = new Logger({ event: mockEvent, options: mockOptions });
+
+    logger.logFn('Worker log', LogLevel.INFO, false);
+
+    expect(mockConsoleInfo).toHaveBeenCalledWith(
+      JSON.stringify({
+        message: 'Worker log',
+        ...mockEvent.payload.event_context,
+        sdk_version: LIBRARY_VERSION,
+        sdk_log: false,
       })
     );
   });
@@ -347,6 +368,7 @@ describe(Logger.name, () => {
     const logObject = JSON.parse(callArgs);
     expect(logObject.message).toBe('');
     expect(logObject.sdk_version).toBe(LIBRARY_VERSION);
+    expect(logObject.sdk_log).toBe(true);
   });
 
   it('[edge] should handle null and undefined values in log arguments', () => {

src/logger/logger.ts

@@ -33,6 +33,7 @@ export class Logger extends Console {
     this.tags = {
       ...event.payload.event_context,
       sdk_version: LIBRARY_VERSION,
+      sdk_log: true,
     };
   }
 
@@ -73,8 +74,9 @@ export class Logger extends Console {
    *
    * @param message - The pre-formatted message string to log
    * @param level - Log level (info, warn, error)
+   * @param sdkLog - Flag indicating if the log originated from the SDK
    */
-  logFn(message: string, level: LogLevel): void {
+  logFn(message: string, level: LogLevel, sdkLog: boolean = this.tags.sdk_log): void {
     if (this.options?.isLocalDevelopment) {
       this.originalConsole[level](message);
       return;
@@ -83,6 +85,7 @@ export class Logger extends Console {
     const logObject = {
       message,
       ...this.tags,
+      sdk_log: sdkLog,
     };
     this.originalConsole[level](JSON.stringify(logObject));
   }
@@ -105,7 +108,7 @@ export class Logger extends Console {
     } else {
       parentPort?.postMessage({
         subject: WorkerMessageSubject.WorkerMessageLog,
-        payload: { stringifiedArgs, level },
+        payload: { stringifiedArgs, level, sdk_log: false },
       });
     }
   }

src/types/workers.ts

@@ -1,5 +1,6 @@
 import { Worker } from 'worker_threads';
 
+import type { LogLevel } from '../logger/logger.interfaces';
 import { State } from '../state/state';
 import { WorkerAdapter } from '../workers/worker-adapter';
 
@@ -131,10 +132,25 @@ export interface WorkerMessageExit {
   subject: WorkerMessageSubject.WorkerMessageExit;
 }
 
+/**
+ * WorkerMessageLog interface represents the structure of the worker log message.
+ */
+export interface WorkerMessageLog {
+  subject: WorkerMessageSubject.WorkerMessageLog;
+  payload: {
+    stringifiedArgs: string;
+    level: LogLevel;
+    sdk_log?: boolean;
+  };
+}
+
 /**
  * WorkerMessage represents the structure of the worker message.
  */
-export type WorkerMessage = WorkerMessageEmitted | WorkerMessageExit;
+export type WorkerMessage =
+  | WorkerMessageEmitted
+  | WorkerMessageExit
+  | WorkerMessageLog;
 
 /**
  * WorkerData represents the structure of the worker data object.

src/workers/spawn.ts

@@ -246,8 +246,9 @@ export class Spawn {
       if (message?.subject === WorkerMessageSubject.WorkerMessageLog) {
         const stringifiedArgs = message.payload?.stringifiedArgs;
         const level = message.payload?.level as LogLevel;
+        const sdkLog = message.payload?.sdk_log ?? false;
         // Args are already sanitized in the worker thread, skip double sanitization
-        (console as Logger).logFn(stringifiedArgs, level);
+        (console as Logger).logFn(stringifiedArgs, level, sdkLog);
       }
 
       // If worker sends a message that it has emitted an event, then set alreadyEmitted to true.