Merge pull request #128 from ulixee/named-logger

feat(client): add sessionid/name to logs + errors

Author: calebjclark

client/connections/CoreClientConnection.ts

@@ -101,7 +101,7 @@ export default abstract class CoreClientConnection {
 
   public async createSession(options: ICreateSessionOptions): Promise<CoreSession> {
     const sessionMeta = await this.commandQueue.run<ISessionMeta>('createSession', options);
-    const session = new CoreSession(sessionMeta, this);
+    const session = new CoreSession({ ...sessionMeta, sessionName: options.sessionName }, this);
     this.coreSessions.track(session);
     return session;
   }

client/lib/CoreCommandQueue.ts

@@ -11,14 +11,25 @@ export default class CoreCommandQueue {
   public lastCommandId = 0;
   private isProcessing = false;
 
+  private readonly sessionMarker: string = '';
+
   constructor(
-    private readonly meta: ISessionMeta | null,
+    private readonly meta: (ISessionMeta & { sessionName: string }) | null,
     private readonly connection: CoreClientConnection,
     parentCommandQueue?: CoreCommandQueue,
   ) {
     if (parentCommandQueue) {
       this.type = parentCommandQueue.type;
     }
+    if (meta) {
+      const markers = [
+        ''.padEnd(50, '-'),
+        `------${meta.sessionName ?? ''}`.padEnd(50, '-'),
+        `------${meta.sessionId ?? ''}`.padEnd(50, '-'),
+        ''.padEnd(50, '-'),
+      ].join('\n');
+      this.sessionMarker = `\n\n${markers}`;
+    }
   }
 
   public run<T>(command: string, ...args: any[]): Promise<T> {
@@ -62,7 +73,9 @@ export default class CoreCommandQueue {
           }
           item.resolve(data);
         } catch (error) {
-          error.stack += `\n${'------CORE COMMANDS'.padEnd(50, '-')}${item.stack}`;
+          error.stack += `\n${'------CORE COMMANDS'.padEnd(50, '-')}${item.stack}${
+            this.sessionMarker
+          }`;
           item.reject(error);
         }
         // force next loop so promises don't simulate synchronous-ity when local core

client/lib/CoreSession.ts

@@ -1,6 +1,7 @@
 import ISessionMeta from '@secret-agent/core-interfaces/ISessionMeta';
 import IConfigureSessionOptions from '@secret-agent/core-interfaces/IConfigureSessionOptions';
 import { IJsPath } from 'awaited-dom/base/AwaitedPath';
+import { loggerSessionIdNames } from '@secret-agent/commons/Logger';
 import CoreCommandQueue from './CoreCommandQueue';
 import CoreEventHeap from './CoreEventHeap';
 import CoreTab from './CoreTab';
@@ -10,6 +11,7 @@ import CoreClientConnection from '../connections/CoreClientConnection';
 export default class CoreSession implements IJsPathEventTarget {
   public tabsById = new Map<string, CoreTab>();
   public sessionId: string;
+  public sessionName: string;
   public sessionsDataLocation: string;
   public replayApiServer: string;
   public commandQueue: CoreCommandQueue;
@@ -22,17 +24,23 @@ export default class CoreSession implements IJsPathEventTarget {
   protected readonly meta: ISessionMeta;
   private readonly connection: CoreClientConnection;
 
-  constructor(sessionMeta: ISessionMeta, connection: CoreClientConnection) {
-    const { sessionId, sessionsDataLocation, replayApiServer } = sessionMeta;
+  constructor(
+    sessionMeta: ISessionMeta & { sessionName: string },
+    connection: CoreClientConnection,
+  ) {
+    const { sessionId, sessionsDataLocation, replayApiServer, sessionName } = sessionMeta;
     this.sessionId = sessionId;
+    this.sessionName = sessionName;
     this.sessionsDataLocation = sessionsDataLocation;
     this.replayApiServer = replayApiServer;
     this.meta = {
       sessionId,
     };
     this.connection = connection;
-    this.commandQueue = new CoreCommandQueue(this.meta, connection);
+    loggerSessionIdNames.set(sessionId, sessionName);
+    this.commandQueue = new CoreCommandQueue({ sessionId, sessionName }, connection);
     this.eventHeap = new CoreEventHeap(this.meta, connection);
+
     this.addTab(sessionMeta);
   }
 
@@ -59,7 +67,10 @@ export default class CoreSession implements IJsPathEventTarget {
 
   public addTab(tabMeta: ISessionMeta): void {
     if (!this.tabsById.has(tabMeta.tabId)) {
-      this.tabsById.set(tabMeta.tabId, new CoreTab(tabMeta, this.connection));
+      this.tabsById.set(
+        tabMeta.tabId,
+        new CoreTab({ ...tabMeta, sessionName: this.sessionName }, this.connection),
+      );
     }
   }
 
@@ -70,6 +81,7 @@ export default class CoreSession implements IJsPathEventTarget {
   public async close(): Promise<void> {
     await this.commandQueue.run('closeSession');
     process.nextTick(() => this.connection.closeSession(this));
+    loggerSessionIdNames.delete(this.sessionId);
   }
 
   public async addEventListener(

client/lib/CoreTab.ts

@@ -26,18 +26,20 @@ export default class CoreTab implements IJsPathEventTarget {
   public commandQueue: CoreCommandQueue;
   public eventHeap: CoreEventHeap;
 
-  protected readonly meta: ISessionMeta;
+  protected readonly meta: ISessionMeta & { sessionName: string };
   private readonly connection: CoreClientConnection;
 
-  constructor({ tabId, sessionId }: ISessionMeta, connection: CoreClientConnection) {
+  constructor(meta: ISessionMeta & { sessionName: string }, connection: CoreClientConnection) {
+    const { tabId, sessionId, sessionName } = meta;
     this.tabId = tabId;
     this.sessionId = sessionId;
     this.meta = {
       sessionId,
       tabId,
+      sessionName,
     };
     this.connection = connection;
-    this.commandQueue = new CoreCommandQueue(this.meta, connection, connection.commandQueue);
+    this.commandQueue = new CoreCommandQueue(meta, connection, connection.commandQueue);
     this.eventHeap = new CoreEventHeap(this.meta, connection);
 
     if (!this.eventHeap.hasEventInterceptors('resource')) {
@@ -146,7 +148,7 @@ export default class CoreTab implements IJsPathEventTarget {
     const sessionMeta = await this.commandQueue.run<ISessionMeta>('waitForNewTab', opts);
     const session = this.connection.getSession(sessionMeta.sessionId);
     session.addTab(sessionMeta);
-    return new CoreTab(sessionMeta, this.connection);
+    return new CoreTab({ ...this.meta, tabId: sessionMeta.tabId }, this.connection);
   }
 
   public async focusTab(): Promise<void> {

client/lib/ScriptInstance.ts

@@ -1,10 +1,7 @@
 import { v1 as uuidv1 } from 'uuid';
 import IScriptInstanceMeta from '@secret-agent/core-interfaces/IScriptInstanceMeta';
-import Log from '@secret-agent/commons/Logger';
 import CoreSession from './CoreSession';
 
-const { log } = Log(module);
-
 export default class ScriptInstance {
   public readonly id: string = uuidv1();
   public readonly entrypoint: string = process.argv[1];

commons/Logger.ts

@@ -75,7 +75,7 @@ class Log implements ILog {
         .replace('.js', '')
         .replace('.ts', '')
         .replace('build/', '');
-      const printData = {};
+      const printData: any = {};
       for (const [key, value] of Object.entries(entry.data)) {
         if (value === undefined || value === null) continue;
         if (value instanceof Error) {
@@ -86,6 +86,12 @@ class Log implements ILog {
           printData[key] = value;
         }
       }
+
+      if (level === 'warn' || level === 'error') {
+        printData.sessionId = sessionId;
+        printData.sessionName = loggerSessionIdNames.get(sessionId) ?? undefined;
+      }
+
       const params = Object.keys(printData).length ? [printData] : [];
       // eslint-disable-next-line no-console
       console.log(
@@ -116,6 +122,8 @@ export default function logger(module: NodeModule): ILogBuilder {
 
 let idCounter = 0;
 
+const loggerSessionIdNames = new Map<string, string>();
+
 class LogEvents {
   private static subscriptions: { [id: number]: (log: ILogEntry) => any } = {};
 
@@ -135,7 +143,7 @@ class LogEvents {
   }
 }
 
-export { LogEvents };
+export { LogEvents, loggerSessionIdNames };
 
 export function injectLogger(builder: (module: NodeModule) => ILogBuilder): void {
   logCreator = builder;

session-state/index.ts

@@ -8,7 +8,7 @@ import IWebsocketMessage from '@secret-agent/core-interfaces/IWebsocketMessage';
 import IResourceMeta from '@secret-agent/core-interfaces/IResourceMeta';
 import ICommandMeta from '@secret-agent/core-interfaces/ICommandMeta';
 import { IBoundLog } from '@secret-agent/core-interfaces/ILog';
-import Log, { ILogEntry, LogEvents } from '@secret-agent/commons/Logger';
+import Log, { ILogEntry, LogEvents, loggerSessionIdNames } from '@secret-agent/commons/Logger';
 import { IDomChangeEvent } from '@secret-agent/injected-scripts/interfaces/IDomChangeEvent';
 import { LocationStatus } from '@secret-agent/core-interfaces/Location';
 import IViewport from '@secret-agent/core-interfaces/IViewport';
@@ -114,6 +114,8 @@ export default class SessionState {
       viewport,
     );
 
+    loggerSessionIdNames.set(sessionId, sessionName);
+
     this.logSubscriptionId = LogEvents.subscribe(this.onLogEvent.bind(this));
   }
 
@@ -373,6 +375,7 @@ export default class SessionState {
     this.closeDate = new Date();
     this.db.session.close(this.sessionId, this.closeDate);
     LogEvents.unsubscribe(this.logSubscriptionId);
+    loggerSessionIdNames.delete(this.sessionId);
     this.db.flush();
     this.db.close();
     SessionState.registry.delete(this.sessionId);