Create session eagerly in registerTelemetry

Author: tonybaroneee

packages/telemetry/src/api.test.ts

@@ -113,6 +113,9 @@ describe('Top level API', () => {
       value: cryptoMock,
       writable: true
     });
+
+    // Simulate session creation that now happens in registerTelemetry
+    storage[TELEMETRY_SESSION_ID_KEY] = MOCK_SESSION_ID;
   });
 
   afterEach(async () => {
@@ -154,6 +157,32 @@ describe('Top level API', () => {
     });
   });
 
+  describe('registerTelemetry()', () => {
+    it('should create a session and emit a log entry if none exists', () => {
+      // Clear storage to simulate no session
+      storage = {};
+      emittedLogs.length = 0;
+
+      // We need a real-ish app to test registration, but we can mock the components
+      const app = getFakeApp();
+      getTelemetry(app);
+      // getFakeApp calls registerTelemetry, but we want to test it specifically.
+      // However, registerTelemetry is called during getFakeApp.
+
+      // Check if session ID was created in storage
+      expect(storage[TELEMETRY_SESSION_ID_KEY]).to.equal(MOCK_SESSION_ID);
+    });
+
+    it('should not create a new session if one exists', () => {
+      storage[TELEMETRY_SESSION_ID_KEY] = 'existing-session';
+      emittedLogs.length = 0;
+
+      getFakeApp();
+
+      expect(storage[TELEMETRY_SESSION_ID_KEY]).to.equal('existing-session');
+    });
+  });
+
   describe('captureError()', () => {
     it('should capture an Error object correctly', () => {
       const error = new Error('This is a test error');
@@ -312,17 +341,6 @@ describe('Top level API', () => {
     });
 
     describe('Session Metadata', () => {
-      it('should generate and store a new session ID if none exists', () => {
-        captureError(fakeTelemetry, 'error');
-
-        expect(emittedLogs.length).to.equal(1);
-        const log = emittedLogs[0];
-        expect(log.attributes![LOG_ENTRY_ATTRIBUTE_KEYS.SESSION_ID]).to.equal(
-          MOCK_SESSION_ID
-        );
-        expect(storage[TELEMETRY_SESSION_ID_KEY]).to.equal(MOCK_SESSION_ID);
-      });
-
       it('should retrieve existing session ID from sessionStorage', () => {
         storage[TELEMETRY_SESSION_ID_KEY] = 'existing-session-id';
 

packages/telemetry/src/helpers.ts

@@ -15,11 +15,18 @@
  * limitations under the License.
  */
 
+import { LoggerProvider, SeverityNumber } from '@opentelemetry/api-logs';
 import * as constants from './auto-constants';
-import { TELEMETRY_SESSION_ID_KEY } from './constants';
+import {
+  LOG_ENTRY_ATTRIBUTE_KEYS,
+  TELEMETRY_SESSION_ID_KEY
+} from './constants';
 import { Telemetry } from './public-types';
 import { TelemetryService } from './service';
 
+/**
+ * Returns the app version from the provided Telemetry instance, if available.
+ */
 export function getAppVersion(telemetry: Telemetry): string {
   if ((telemetry as TelemetryService).options?.appVersion) {
     return (telemetry as TelemetryService).options!.appVersion!;
@@ -29,18 +36,39 @@ export function getAppVersion(telemetry: Telemetry): string {
   return 'unset';
 }
 
+/**
+ * Returns the session ID stored in sessionStorage, if available.
+ */
 export function getSessionId(): string | undefined {
-  if (
-    typeof sessionStorage !== 'undefined' &&
-    typeof crypto?.randomUUID === 'function'
-  ) {
+  if (typeof sessionStorage !== 'undefined') {
+    try {
+      return sessionStorage.getItem(TELEMETRY_SESSION_ID_KEY) || undefined;
+    } catch (e) {
+      // Ignore errors accessing sessionStorage (e.g. security restrictions)
+    }
+  }
+}
+
+/**
+ * Generate a new session UUID. We record it in two places:
+ * 1. The client browser's sessionStorage (if available)
+ * 2. In Cloud Logging as its own log entry
+ */
+export function startNewSession(loggerProvider: LoggerProvider): void {
+  if (typeof sessionStorage !== 'undefined') {
     try {
-      let sessionId = sessionStorage.getItem(TELEMETRY_SESSION_ID_KEY);
-      if (!sessionId) {
-        sessionId = crypto.randomUUID();
-        sessionStorage.setItem(TELEMETRY_SESSION_ID_KEY, sessionId);
-      }
-      return sessionId;
+      const sessionId = crypto.randomUUID();
+      sessionStorage.setItem(TELEMETRY_SESSION_ID_KEY, sessionId);
+
+      // Emit session creation log
+      const logger = loggerProvider.getLogger('session-logger');
+      logger.emit({
+        severityNumber: SeverityNumber.DEBUG,
+        body: 'Session created',
+        attributes: {
+          [LOG_ENTRY_ATTRIBUTE_KEYS.SESSION_ID]: sessionId
+        }
+      });
     } catch (e) {
       // Ignore errors accessing sessionStorage (e.g. security restrictions)
     }

packages/telemetry/src/react/index.ts

@@ -53,24 +53,18 @@ export function FirebaseTelemetry({
   telemetryOptions?: TelemetryOptions;
 }): null {
   useEffect(() => {
+    const telemetry = getTelemetry(firebaseApp, telemetryOptions);
+
     if (typeof window === 'undefined') {
       return;
     }
 
     const errorListener = (event: ErrorEvent): void => {
-      captureError(
-        getTelemetry(firebaseApp, telemetryOptions),
-        event.error,
-        {}
-      );
+      captureError(telemetry, event.error, {});
     };
 
     const unhandledRejectionListener = (event: PromiseRejectionEvent): void => {
-      captureError(
-        getTelemetry(firebaseApp, telemetryOptions),
-        event.reason,
-        {}
-      );
+      captureError(telemetry, event.reason, {});
     };
 
     try {

packages/telemetry/src/register.ts

@@ -17,16 +17,17 @@
 
 import { _registerComponent, registerVersion } from '@firebase/app';
 import { Component, ComponentType } from '@firebase/component';
-import { TELEMETRY_TYPE } from './constants';
 import { name, version } from '../package.json';
 import { TelemetryService } from './service';
 import { createLoggerProvider } from './logging/logger-provider';
 import { AppCheckProvider } from './logging/appcheck-provider';
 import { InstallationIdProvider } from './logging/installation-id-provider';
+import { TELEMETRY_TYPE } from './constants';
 
 // We only import types from this package elsewhere in the `telemetry` package, so this
 // explicit import is needed here to prevent this module from being tree-shaken out.
 import '@firebase/installations';
+import { getSessionId, startNewSession } from './helpers';
 
 export function registerTelemetry(): void {
   _registerComponent(
@@ -57,6 +58,11 @@ export function registerTelemetry(): void {
           dynamicLogAttributeProviders
         );
 
+        // Immediately track this as a new client session (if one doesn't exist yet)
+        if (!getSessionId()) {
+          startNewSession(loggerProvider);
+        }
+
         return new TelemetryService(app, loggerProvider);
       },
       ComponentType.PUBLIC