Updates log client initialization

This update includes a timeout to handle clients initializing indefinitely, assuming some initial logs might be lost on application startup while the log client still loading. Now we can better handle this scenario since we have more control over the startup process of the log client.
We've also updated error handling for this step, avoiding throwing errors on log client startup so the app is still available and able to use console.log fallback - ensuring the app is able to run even if the logger is not working properly.

Author: daniyelnnr

src/constants.ts

@@ -72,3 +72,5 @@ export const PRODUCTION = process.env.VTEX_PRODUCTION === 'true'
 export const INSPECT_DEBUGGER_PORT = 5858
 
 export const cancellableMethods = new Set(['GET', 'OPTIONS', 'HEAD'])
+
+export const LOG_CLIENT_INIT_TIMEOUT = 5000

src/service/logger/logger.ts

@@ -1,4 +1,4 @@
-import { APP } from '../../constants'
+import { APP, LOG_CLIENT_INIT_TIMEOUT } from '../../constants'
 import { cleanError } from '../../utils/error'
 import { cleanLog } from '../../utils/log'
 import { LogClient } from '@vtex/diagnostics-nodejs/dist/types';
@@ -16,8 +16,7 @@ export class Logger {
   private production: boolean
   private tracingState?: TracingState
   private logClient: LogClient | undefined = undefined
-  private clientInitialized: boolean = false
-  private clientInitializing: boolean = false
+  private clientInitPromise: Promise<LogClient | undefined> | undefined = undefined
 
   constructor(ctx: LoggerContext) {
     this.account = ctx.account
@@ -36,21 +35,30 @@ export class Logger {
     this.initLogClient();
   }
 
-  private async initLogClient() {
-    if (this.clientInitialized || this.clientInitializing) {
-      return;
+  private initLogClient(): Promise<LogClient | undefined> {
+    if (this.clientInitPromise) {
+      return this.clientInitPromise;
     }
 
-    this.clientInitializing = true;
-    try {
-      this.logClient = await getLogClient(this.account, this.workspace, APP.NAME);
-      this.clientInitialized = true;
-    } catch (error) {
-      console.error('Failed to initialize log client:', error);
-      throw error;
-    } finally {
-      this.clientInitializing = false;
-    }
+    this.clientInitPromise = (async () => {
+      try {
+        const timeoutPromise = new Promise<never>((_, reject) => {
+          setTimeout(() => reject(new Error('Log client initialization timeout')), LOG_CLIENT_INIT_TIMEOUT);
+        });
+
+        this.logClient = await Promise.race([
+          getLogClient(this.account, this.workspace, APP.NAME),
+          timeoutPromise
+        ]);
+
+        return this.logClient;
+      } catch (error) {
+        console.error('Failed to initialize log client:', error);
+        return undefined;
+      }
+    })();
+
+    return this.clientInitPromise;
   }
 
   public debug = (message: any) =>
@@ -115,6 +123,7 @@ export class Logger {
         console.error('Error using diagnostics client for logging:', e);
       }
     }
+
     console.log(typeof inflatedLog === 'string' ? JSON.stringify(inflatedLog) : inflatedLog)
   }
 }