fix: improve promise tracking in debug logging

ibm-telemetry · Dec 4, 2023 · cc14bc2 · cc14bc2
1 parent 2c8d326
commit cc14bc2
Showing 1 changed file with 12 additions and 3 deletions.
diff --git a/src/main/core/log/logger.ts b/src/main/core/log/logger.ts
@@ -12,6 +12,8 @@ type Level = 'debug' | 'error'
 
 const DRAIN_INTERVAL = 250 // ms
 
+let curPromiseId = 1
+
 /**
  * Logger class to log debug and error statements to a given file.
  */
@@ -89,7 +91,7 @@ export class Logger {
   public traceEnter(targetName: string, methodName: string, args: unknown[]) {
     const stringArgs = String(args.map(safeStringify))
 
-    this.debug(`-> ${targetName}::${methodName}(${stringArgs})`)
+    this.debug(`--> ${targetName}::${methodName}(${stringArgs})`)
   }
 
   /**
@@ -101,9 +103,16 @@ export class Logger {
    */
   public traceExit(targetName: string, methodName: string, result: unknown) {
     if (result instanceof Promise) {
+      const promiseIndex = curPromiseId++
+      this.debug(`-?- ${targetName}::${methodName}(...): awaiting [Promise${promiseIndex}]`)
+
       result.then(
         (value: unknown) => {
-          this.debug(`<- ${targetName}::${methodName}(...): ${safeStringify(value)}`)
+          this.debug(
+            `<-- ${targetName}::${methodName}(...): resolved [Promise${promiseIndex}]: ${safeStringify(
+              value
+            )}`
+          )
         },
         (err: unknown) => {
           this.error(`-x- ${targetName}::${methodName}(...): ${safeStringify(err)}`)
@@ -116,7 +125,7 @@ export class Logger {
       this.error(`-x- ${targetName}::${methodName}(...): ${safeStringify(result)}`)
       this.error(result)
     } else {
-      this.debug(`<- ${targetName}::${methodName}(...): ${safeStringify(result)}`)
+      this.debug(`<-- ${targetName}::${methodName}(...): ${safeStringify(result)}`)
     }
   }