Added private logging channel

Split the communication into two channels, one for "SDK" and one for the
3rd party user called "USER".
The channel name is written in front of the message (e.g: `[SDK]
Uploading users`).
The SDK needs to do additional steps to use the SDK channel, but 3rd
party users don't.

Author: gasperzgonec

src/attachments-streaming/attachments-streaming-pool.test.ts

@@ -217,7 +217,7 @@ describe(AttachmentsStreamingPool.name, () => {
       await pool.streamAll();
 
       expect(console.warn).toHaveBeenCalledWith(
-        "SDK: ", ["Skipping attachment with ID attachment-2 due to error: Error: Processing failed"]
+        "Skipping attachment with ID attachment-2 due to error: Error: Processing failed"
       );
       expect(mockAdapter.state.toDevRev!.attachmentsMetadata.lastProcessedAttachmentsIdsList).toEqual([
         'attachment-1',

src/attachments-streaming/attachments-streaming-pool.ts

@@ -5,7 +5,6 @@ import {
 } from '../types';
 import { AttachmentsStreamingPoolParams } from './attachments-streaming-pool.interfaces';
 import { WorkerAdapter } from '../workers/worker-adapter';
-import { SdkConsole as console } from '../sdkconsole';
 
 export class AttachmentsStreamingPool<ConnectorState> {
   private adapter: WorkerAdapter<ConnectorState>;

src/common/helpers.ts

@@ -13,7 +13,6 @@ import {
 import { readFileSync } from 'fs';
 import * as path from 'path';
 import { MAX_DEVREV_FILENAME_EXTENSION_LENGTH, MAX_DEVREV_FILENAME_LENGTH } from './constants';
-import { SdkConsole as console } from '../sdkconsole';
 
 export function getTimeoutErrorEventType(eventType: EventType): {
   eventType: ExtractorEventType | LoaderEventType;

src/common/install-initial-domain-mapping.ts

@@ -4,8 +4,6 @@ import { AirdropEvent } from '../types/extraction';
 import { InitialDomainMapping } from '../types/common';
 import { serializeError } from '../logger/logger';
 
-import { SdkConsole as console } from '../sdkconsole';
-
 export async function installInitialDomainMapping(
   event: AirdropEvent,
   initialDomainMappingJson: InitialDomainMapping

src/http/axios-client-internal.ts

@@ -1,6 +1,5 @@
 import axios, { AxiosError } from 'axios';
 import axiosRetry from 'axios-retry';
-import { SdkConsole as console } from '../sdkconsole';
 
 const axiosClient = axios.create();
 

src/http/axios-client.ts

@@ -25,8 +25,6 @@
 import axios, { AxiosError } from 'axios';
 import axiosRetry from 'axios-retry';
 
-import { SdkConsole as console } from '../sdkconsole';
-
 const axiosClient = axios.create();
 
 axiosRetry(axiosClient, {

src/logger/logger.test.ts

@@ -83,7 +83,7 @@ describe(Logger.name, () => {
 
       expect(mockConsoleInfo).toHaveBeenCalledWith(
         JSON.stringify({
-          message,
+          message: '[USER] ' + message,
           ...mockEvent.payload.event_context,
           dev_oid: mockEvent.payload.event_context.dev_oid,
         })
@@ -101,7 +101,7 @@ describe(Logger.name, () => {
       });
       expect(mockConsoleInfo).toHaveBeenCalledWith(
         JSON.stringify({
-          message: expectedMessage,
+          message: '[USER] ' + expectedMessage,
           ...mockEvent.payload.event_context,
           dev_oid: mockEvent.payload.event_context.dev_oid,
         })
@@ -120,7 +120,7 @@ describe(Logger.name, () => {
       });
       expect(mockConsoleInfo).toHaveBeenCalledWith(
         JSON.stringify({
-          message: `${text} ${expectedDataMessage}`,
+          message: `[USER] ${text} ${expectedDataMessage}`,
           ...mockEvent.payload.event_context,
           dev_oid: mockEvent.payload.event_context.dev_oid,
         })
@@ -140,7 +140,7 @@ describe(Logger.name, () => {
       });
       expect(mockConsoleInfo).toHaveBeenCalledWith(
         JSON.stringify({
-          message: `${text1} ${expectedDataMessage} ${text2}`,
+          message: `[USER] ${text1} ${expectedDataMessage} ${text2}`,
           ...mockEvent.payload.event_context,
           dev_oid: mockEvent.payload.event_context.dev_oid,
         })
@@ -162,7 +162,7 @@ describe(Logger.name, () => {
 
       logger.info(message, data);
 
-      expect(mockConsoleInfo).toHaveBeenCalledWith(message, data);
+      expect(mockConsoleInfo).toHaveBeenCalledWith('[USER]', message, data);
     });
   });
 
@@ -210,7 +210,7 @@ describe(Logger.name, () => {
       const callArgs = mockConsoleInfo.mock.calls[0][0];
       const logObject = JSON.parse(callArgs);
 
-      expect(logObject.message).toBe('');
+      expect(logObject.message).toBe('[USER] ');
       expect(logObject.dev_oid).toBe(mockEvent.payload.event_context.dev_oid);
       expect(logObject.request_id).toBe(
         mockEvent.payload.event_context.request_id
@@ -225,7 +225,7 @@ describe(Logger.name, () => {
       const logObject = JSON.parse(callArgs);
 
       // inspect shows 'null' and 'undefined' as strings
-      expect(logObject.message).toBe('test null undefined');
+      expect(logObject.message).toBe('[USER] test null undefined');
       expect(logObject.dev_oid).toBe(mockEvent.payload.event_context.dev_oid);
     });
 
@@ -250,7 +250,7 @@ describe(Logger.name, () => {
         compact: false,
         depth: Infinity,
       });
-      expect(logObject.message).toBe(expectedMessage);
+      expect(logObject.message).toBe('[USER] ' + expectedMessage);
       expect(logObject.dev_oid).toBe(mockEvent.payload.event_context.dev_oid);
       expect(typeof logObject.callback_url).toBe('string');
     });

src/logger/logger.ts

@@ -12,10 +12,12 @@ import { WorkerAdapterOptions, WorkerMessageSubject } from '../types/workers';
 import { AxiosError, RawAxiosResponseHeaders, isAxiosError } from 'axios';
 import { getCircularReplacer } from '../common/helpers';
 import { EventContext } from '../types/extraction';
+import { INTERNAL_CHANNEL, verificationToken } from './private_logger';
 
 export class Logger extends Console {
   private options?: WorkerAdapterOptions;
   private tags: EventContext & { dev_oid: string };
+  private isVerifiedChannel: boolean = false; // false = unverified (default), true = verified
 
   constructor({ event, options }: LoggerFactoryInterface) {
     super(process.stdout, process.stderr);
@@ -26,6 +28,33 @@ export class Logger extends Console {
     };
   }
 
+  // Internal method to create a verified logger
+  private [INTERNAL_CHANNEL](token: string): Logger {
+    if (token === verificationToken) {
+      const verifiedLogger = Object.create(this);
+      verifiedLogger.isVerifiedChannel = true;
+      // Ensure the verified logger retains the internal channel method
+      verifiedLogger[INTERNAL_CHANNEL] = this[INTERNAL_CHANNEL].bind(this);
+      // Override the logFn method to use the verified logger's context
+      verifiedLogger.logFn = this.logFn.bind(verifiedLogger);
+      // Override the logging methods to use the custom logFn
+      verifiedLogger.log = (...args: unknown[]): void => {
+        verifiedLogger.logFn(args, LogLevel.INFO);
+      };
+      verifiedLogger.info = (...args: unknown[]): void => {
+        verifiedLogger.logFn(args, LogLevel.INFO);
+      };
+      verifiedLogger.warn = (...args: unknown[]): void => {
+        verifiedLogger.logFn(args, LogLevel.WARN);
+      };
+      verifiedLogger.error = (...args: unknown[]): void => {
+        verifiedLogger.logFn(args, LogLevel.ERROR);
+      };
+      return verifiedLogger;
+    }
+    throw new Error('Unauthorized access to internal channel');
+  }
+  
   private valueToString(value: unknown): string {
     if (typeof value === 'string') {
       return value;
@@ -39,20 +68,25 @@ export class Logger extends Console {
   }
 
   logFn(args: unknown[], level: LogLevel): void {
+    // Always add prefix based on verification status
+    // false = unverified ([USER] prefix), true = verified ([SDK] prefix)
+    const prefix = this.isVerifiedChannel ? '[SDK]' : '[USER]';
+    const processedArgs = [prefix, ...args];
+
     if (isMainThread) {
       if (this.options?.isLocalDevelopment) {
-        console[level](...args);
+        console[level](...processedArgs);
       } else {
         let message: string;
-        if (args.length === 1 && typeof args[0] === 'string') {
+        if (processedArgs.length === 1 && typeof processedArgs[0] === 'string') {
           // Single string argument - use directly
-          message = args[0];
-        } else if (args.length === 1) {
+          message = processedArgs[0];
+        } else if (processedArgs.length === 1) {
           // Single non-string argument - convert to string properly
-          message = this.valueToString(args[0]);
+          message = this.valueToString(processedArgs[0]);
         } else {
           // Multiple arguments - create a readable format
-          message = args.map((arg) => this.valueToString(arg)).join(' ');
+          message = processedArgs.map((arg) => this.valueToString(arg)).join(' ');
         }
 
         const logObject = {
@@ -66,7 +100,7 @@ export class Logger extends Console {
       parentPort?.postMessage({
         subject: WorkerMessageSubject.WorkerMessageLog,
         payload: {
-          args: args.map((arg) => this.valueToString(arg)),
+          args: processedArgs.map((arg) => this.valueToString(arg)),
           level,
         },
       });