Refactor logger appId usage and stack-trace package usage

RocketChat · Dec 16, 2023 · 526412e · 526412e
1 parent 6f9da6f
commit 526412e
Show file tree

Hide file tree

Showing 5 changed files with 31 additions and 22 deletions.
diff --git a/deno-runtime/deno.jsonc b/deno-runtime/deno.jsonc
@@ -7,5 +7,6 @@
         "astring": "npm:[email protected]",
         "jsonrpc-lite": "npm:[email protected]",
         "uuid": "npm:[email protected]",
+        "stack-trace": "npm:[email protected]",
     }
 }
diff --git a/deno-runtime/deno.lock b/deno-runtime/deno.lock
diff --git a/deno-runtime/lib/logger.ts b/deno-runtime/lib/logger.ts
@@ -1,5 +1,16 @@
-import * as stackTrace from 'npm:stack-trace'
-import { StackFrame } from 'npm:stack-trace'
+import stackTrace from 'stack-trace';
+import { AppObjectRegistry } from '../AppObjectRegistry.ts';
+
+export interface StackFrame {
+    getTypeName(): string;
+    getFunctionName(): string;
+    getMethodName(): string;
+    getFileName(): string;
+    getLineNumber(): number;
+    getColumnNumber(): number;
+    isNative(): boolean;
+    isConstructor(): boolean;
+}
 
 enum LogMessageSeverity {
     DEBUG = 'debug',
@@ -16,7 +27,7 @@ type Entry = {
     method: string;
     timestamp: Date;
     args: Array<unknown>;
-}
+};
 
 interface ILoggerStorageEntry {
     appId: string;
@@ -29,40 +40,38 @@ interface ILoggerStorageEntry {
 }
 
 export class Logger {
-    private appId: string;
     private entries: Array<Entry>;
     private start: Date;
     private method: string;
 
-    constructor(method: string, appId: string) {
-        this.appId = appId;
+    constructor(method: string) {
         this.method = method;
         this.entries = [];
         this.start = new Date();
     }
 
     public debug(...args: Array<unknown>): void {
-        this.addEntry(LogMessageSeverity.DEBUG, this.getStack(stackTrace.get()), ...args)
+        this.addEntry(LogMessageSeverity.DEBUG, this.getStack(stackTrace.get()), ...args);
     }
 
     public info(...args: Array<unknown>): void {
-        this.addEntry(LogMessageSeverity.INFORMATION, this.getStack(stackTrace.get()), ...args)
+        this.addEntry(LogMessageSeverity.INFORMATION, this.getStack(stackTrace.get()), ...args);
     }
 
     public log(...args: Array<unknown>): void {
-        this.addEntry(LogMessageSeverity.LOG, this.getStack(stackTrace.get()), ...args)
+        this.addEntry(LogMessageSeverity.LOG, this.getStack(stackTrace.get()), ...args);
     }
 
     public warning(...args: Array<unknown>): void {
-        this.addEntry(LogMessageSeverity.WARNING, this.getStack(stackTrace.get()), ...args)
+        this.addEntry(LogMessageSeverity.WARNING, this.getStack(stackTrace.get()), ...args);
     }
 
     public error(...args: Array<unknown>): void {
-        this.addEntry(LogMessageSeverity.ERROR, this.getStack(stackTrace.get()), ...args)
+        this.addEntry(LogMessageSeverity.ERROR, this.getStack(stackTrace.get()), ...args);
     }
 
     public success(...args: Array<unknown>): void {
-        this.addEntry(LogMessageSeverity.SUCCESS, this.getStack(stackTrace.get()), ...args)
+        this.addEntry(LogMessageSeverity.SUCCESS, this.getStack(stackTrace.get()), ...args);
     }
 
     private addEntry(severity: LogMessageSeverity, caller: string, ...items: Array<unknown>): void {
@@ -78,7 +87,6 @@ export class Logger {
             }
             const str = JSON.stringify(args, null, 2);
             return str ? JSON.parse(str) : str; // force call toJSON to prevent circular references
-
         });
 
         this.entries.push({
@@ -122,7 +130,7 @@ export class Logger {
 
     public getLogs(): ILoggerStorageEntry {
         return {
-            appId: this.appId,
+            appId: AppObjectRegistry.get('id')!,
             method: this.method,
             entries: this.entries,
             startTime: this.start,

diff --git a/deno-runtime/lib/tests/messenger.test.ts b/deno-runtime/lib/tests/messenger.test.ts
@@ -9,7 +9,8 @@ import { Logger } from '../logger.ts';
 describe('Messenger', () => {
     beforeEach(() => {
         AppObjectRegistry.clear();
-        AppObjectRegistry.set('logger', new Logger('test', 'test'));
+        AppObjectRegistry.set('logger', new Logger('test'));
+        AppObjectRegistry.set('id', 'test');
         Messenger.Transport.selectTransport('noop');
     });
 

diff --git a/deno-runtime/main.ts b/deno-runtime/main.ts
@@ -55,6 +55,7 @@ function wrapAppCode(code: string): (require: (module: string) => unknown) => Pr
 }
 
 async function handlInitializeApp(appPackage: IParseAppPackageResult): Promise<void> {
+    AppObjectRegistry.set('id', appPackage.info.id);
     const source = sanitizeDeprecatedUsage(appPackage.files[appPackage.info.classFile]);
 
     const require = buildRequire();
@@ -93,7 +94,6 @@ async function handlInitializeApp(appPackage: IParseAppPackageResult): Promise<v
     }
 
     AppObjectRegistry.set('app', app);
-    AppObjectRegistry.set('id', appPackage.info.id);
 }
 
 async function handleRequest({ type, payload }: Messenger.JsonRpcRequest): Promise<void> {
@@ -104,13 +104,11 @@ async function handleRequest({ type, payload }: Messenger.JsonRpcRequest): Promi
 
     const { id, method, params } = payload;
 
-    const appId: string = method === 'construct' ? (params as Array<string>)[0] : AppObjectRegistry.get('id') as string;
-
-    const logger = new Logger(method, appId);
+    const logger = new Logger(method);
     AppObjectRegistry.set('logger', logger);
 
-    switch (method) {
-        case 'app:construct': {
+    switch (true) {
+        case method.includes('app:construct'): {
             const [appPackage] = params as [IParseAppPackageResult];
 
             if (!appPackage?.info?.id || !appPackage?.info?.classFile || !appPackage?.files) {
@@ -162,7 +160,7 @@ async function main() {
             JSONRPCMessage = Messenger.parseMessage(message);
         } catch (error) {
             if (Messenger.isErrorResponse(error)) {
-                await Messenger.send(error);
+                await Messenger.Transport.send(error);
             } else {
                 await Messenger.sendParseError();
             }