fix: flush events when exiting cli-repl

Author: gagik

packages/cli-repl/src/cli-repl.ts

@@ -1172,6 +1172,8 @@ export class CliRepl implements MongoshIOProvider {
       const analytics = this.toggleableAnalytics;
       let flushError: string | null = null;
       let flushDuration: number | null = null;
+      this.loggingAndTelemetry?.flush();
+
       if (analytics) {
         const flushStart = Date.now();
         try {
@@ -1194,6 +1196,7 @@ export class CliRepl implements MongoshIOProvider {
         }
       );
       await this.logWriter?.flush();
+
       markTime(TimingCategories.Logging, 'flushed log writer');
       this.bus.emit('mongosh:closed');
     })());
@@ -1211,6 +1214,7 @@ export class CliRepl implements MongoshIOProvider {
     // onExit never returns. If it does, that's a bug.
     const error = new MongoshInternalError('onExit() unexpectedly returned');
     this.bus.emit('mongosh:error', error, 'fatal');
+
     throw error;
   }
 

packages/logging/src/logging-and-telemetry.spec.ts

@@ -378,7 +378,6 @@ describe('MongoshLoggingAndTelemetry', function () {
 
     expect(logOutput).to.have.lengthOf(1);
 
-    await (loggingAndTelemetry as LoggingAndTelemetry).setupTelemetryPromise;
     expect(analyticsOutput).to.have.lengthOf(2);
   });
 
@@ -402,7 +401,6 @@ describe('MongoshLoggingAndTelemetry', function () {
 
     expect(logOutput).to.have.lengthOf(1);
 
-    await (loggingAndTelemetry as LoggingAndTelemetry).setupTelemetryPromise;
     expect(analyticsOutput).to.have.lengthOf(2);
 
     loggingAndTelemetry.attachLogger(logger);
@@ -411,7 +409,6 @@ describe('MongoshLoggingAndTelemetry', function () {
 
     expect(logOutput).to.have.lengthOf(2);
 
-    await (loggingAndTelemetry as LoggingAndTelemetry).setupTelemetryPromise;
     expect(analyticsOutput).to.have.lengthOf(3);
   });
 

packages/logging/src/logging-and-telemetry.ts

@@ -113,6 +113,9 @@ export class LoggingAndTelemetry implements MongoshLoggingAndTelemetry {
   /** @internal */
   public setupTelemetryPromise: Promise<void> = Promise.resolve();
 
+  // eslint-disable-next-line @typescript-eslint/no-empty-function
+  private resolveDeviceId: (value: string) => void = () => {};
+
   constructor({
     bus,
     analytics,
@@ -132,19 +135,34 @@ export class LoggingAndTelemetry implements MongoshLoggingAndTelemetry {
     if (this.isSetup) {
       throw new Error('Setup can only be called once.');
     }
-    this.isBufferingBusEvents = true;
     this.isBufferingTelemetryEvents = true;
+    this.isBufferingBusEvents = true;
 
     this.setupTelemetryPromise = this.setupTelemetry();
     this.setupBusEventListeners();
 
     this.isSetup = true;
   }
 
+  public flush(): void {
+    // Run any telemetry events even if device ID hasn't been resolved yet
+    this.runAndClearPendingTelemetryEvents();
+
+    // Run any other pending events with the set or dummy log for telemetry purposes.
+    this.runAndClearPendingBusEvents();
+
+    this.resolveDeviceId('unknown');
+  }
+
   private async setupTelemetry(): Promise<void> {
     if (!this.deviceId) {
       try {
-        this.deviceId ??= await getDeviceId();
+        this.deviceId ??= await Promise.race([
+          getDeviceId(),
+          new Promise<string>((resolve) => {
+            this.resolveDeviceId = resolve;
+          }),
+        ]);
       } catch (error) {
         this.bus.emit('mongosh:error', error as Error, 'telemetry');
         this.deviceId = 'unknown';
@@ -173,8 +191,8 @@ export class LoggingAndTelemetry implements MongoshLoggingAndTelemetry {
 
   public detachLogger() {
     this.log = LoggingAndTelemetry.dummyLogger;
-    // Still run any remaining pending events with the dummy log for telemetry purposes.
-    this.runAndClearPendingBusEvents();
+
+    this.flush();
   }
 
   private runAndClearPendingBusEvents() {

packages/logging/src/types.ts

@@ -6,6 +6,8 @@ import type { MultiSet } from './helpers';
 export interface MongoshLoggingAndTelemetry {
   attachLogger(logger: MongoLogWriter): void;
   detachLogger(): void;
+  /** Flush any remaining log or telemetry events. */
+  flush(): void;
 }
 
 export type MongoshLoggingAndTelemetryArguments = {