enable log buffer

Author: dconeybe

packages/firestore/src/api.ts

@@ -238,7 +238,11 @@ export { debugAssert as _debugAssert } from './util/assert';
 export { FieldPath as _FieldPath } from './model/path';
 export type { ResourcePath as _ResourcePath } from './model/path';
 export { ByteString as _ByteString } from './util/byte_string';
-export { logWarn as _logWarn } from './util/log';
+export {
+  logWarn as _logWarn,
+  enableLogBuffer as _enableLogBuffer,
+  dumpLogBuffer as _dumpLogBuffer
+} from './util/log';
 export { AutoId as _AutoId } from './util/misc';
 export type {
   AuthTokenFactory,

packages/firestore/src/local/simple_db.ts

@@ -20,7 +20,7 @@ import { getGlobal, getUA, isIndexedDBAvailable } from '@firebase/util';
 import { debugAssert, hardAssert } from '../util/assert';
 import { generateUniqueDebugId } from '../util/debug_uid';
 import { Code, FirestoreError } from '../util/error';
-import { logDebug, logError, logWarn } from '../util/log';
+import { logDebug, logError, logWarn, dumpLogBuffer } from '../util/log';
 import { Deferred } from '../util/promise';
 
 import { DatabaseDeletedListener } from './persistence';
@@ -514,6 +514,8 @@ export class SimpleDb {
             `One possible cause is clicking the "Clear Site Data" button ` +
             `in a web browser.`
         );
+        // TODO(dconeybe) REVERT THE NEXT LINE
+        dumpLogBuffer();
       },
       { passive: true }
     );

packages/firestore/src/util/log.ts

@@ -47,13 +47,15 @@ export function setLogLevel(logLevel: LogLevelString): void {
 }
 
 export function logDebug(msg: string, ...obj: unknown[]): void {
+  logBuffer?.add(LogLevel.DEBUG, msg, obj);
   if (logClient.logLevel <= LogLevel.DEBUG) {
     const args = obj.map(argToString);
     logClient.debug(`Firestore (${SDK_VERSION}): ${msg}`, ...args);
   }
 }
 
 export function logError(msg: string, ...obj: unknown[]): void {
+  logBuffer?.add(LogLevel.ERROR, msg, obj);
   if (logClient.logLevel <= LogLevel.ERROR) {
     const args = obj.map(argToString);
     logClient.error(`Firestore (${SDK_VERSION}): ${msg}`, ...args);
@@ -64,6 +66,7 @@ export function logError(msg: string, ...obj: unknown[]): void {
  * @internal
  */
 export function logWarn(msg: string, ...obj: unknown[]): void {
+  logBuffer?.add(LogLevel.WARN, msg, obj);
   if (logClient.logLevel <= LogLevel.WARN) {
     const args = obj.map(argToString);
     logClient.warn(`Firestore (${SDK_VERSION}): ${msg}`, ...args);
@@ -85,3 +88,61 @@ function argToString(obj: unknown): string | unknown {
     }
   }
 }
+
+interface LogBufferMessage {
+  level: LogLevel;
+  msg: string;
+  objs: unknown[];
+  timestamp: number;
+}
+
+class LogBuffer {
+  private messages: Array<LogBufferMessage> = [];
+
+  constructor(private readonly maxLength: number) {}
+
+  add(level: LogLevel, msg: string, objs: unknown[]): void {
+    const message: LogBufferMessage = {
+      level,
+      msg,
+      objs: objs.map(value => structuredClone(value)),
+      timestamp: performance.now()
+    };
+    if (this.messages.length == this.maxLength) {
+      this.messages.shift();
+    }
+    this.messages.push(message);
+  }
+
+  dump(): void {
+    const now = performance.now();
+
+    while (this.messages.length > 0) {
+      const { level, msg, objs, timestamp } = this.messages.shift();
+      const args = obj.map(argToString);
+      const messageString = `Firestore BUFFERED (${
+        now - timestamp
+      }ms ago): ${msg}`;
+      if (level === LogLevel.WARN) {
+        logClient.warn(messageString, ...objs);
+      } else if (level === LogLevel.ERROR) {
+        logClient.error(messageString, ...objs);
+      } else {
+        logClient.debug(messageString, ...objs);
+      }
+    }
+  }
+}
+
+let logBuffer: LogBuffer | null = null;
+
+export function enableLogBuffer(maxLength: number): void {
+  if (logBuffer) {
+    throw new Error('log buffer has already been enabled');
+  }
+  logBuffer = new LogBuffer(maxLength);
+}
+
+export function dumpLogBuffer(): void {
+  logBuffer?.dump();
+}

packages/firestore/test/integration/util/firebase_export.ts

@@ -20,16 +20,16 @@
 // reference to the minified sources. If you change any exports in this file,
 // you need to also adjust "integration/firestore/firebase_export.ts".
 
-import { FirebaseApp, initializeApp, setLogLevel } from '@firebase/app';
+import { FirebaseApp, initializeApp } from '@firebase/app';
 
-import { Firestore, initializeFirestore } from '../../../src';
+import { Firestore, initializeFirestore, _enableLogBuffer } from '../../../src';
 import { PrivateSettings } from '../../../src/lite-api/settings';
 
 // TODO(dimond): Right now we create a new app and Firestore instance for
 // every test and never clean them up. We may need to revisit.
 let appCount = 0;
 
-setLogLevel('debug');
+_enableLogBuffer(1000);
 
 export function newTestApp(projectId: string, appName?: string): FirebaseApp {
   if (appName === undefined) {