Attach fid to captureError in telemetry

Author: tonybaroneee

packages/telemetry/package.json

@@ -71,6 +71,7 @@
   "peerDependencies": {
     "@firebase/app": "0.x",
     "@firebase/app-types": "0.x",
+    "@firebase/installations": "0.x",
     "@types/react": "17.x || 18.x || 19.x",
     "react": "17.x || 18.x || 19.x"
   },

packages/telemetry/src/api.test.ts

@@ -67,7 +67,8 @@ const fakeTelemetry: Telemetry = {
       appId: APP_ID
     }
   },
-  loggerProvider: fakeLoggerProvider
+  loggerProvider: fakeLoggerProvider,
+  fid: 'fid-1234'
 };
 
 describe('Top level API', () => {
@@ -123,6 +124,7 @@ describe('Top level API', () => {
       expect(log.severityNumber).to.equal(SeverityNumber.ERROR);
       expect(log.body).to.equal('This is a test error');
       expect(log.attributes).to.deep.equal({
+        'user.id': 'fid-1234',
         'error.type': 'TestError',
         'error.stack': '...stack trace...'
       });
@@ -139,6 +141,7 @@ describe('Top level API', () => {
       expect(log.severityNumber).to.equal(SeverityNumber.ERROR);
       expect(log.body).to.equal('error with no stack');
       expect(log.attributes).to.deep.equal({
+        'user.id': 'fid-1234',
         'error.type': 'Error',
         'error.stack': 'No stack trace available'
       });
@@ -151,7 +154,9 @@ describe('Top level API', () => {
       const log = emittedLogs[0];
       expect(log.severityNumber).to.equal(SeverityNumber.ERROR);
       expect(log.body).to.equal('a string error');
-      expect(log.attributes).to.deep.equal({});
+      expect(log.attributes).to.deep.equal({
+        "user.id": "fid-1234"
+      });
     });
 
     it('should capture an unknown error type correctly', () => {
@@ -161,7 +166,9 @@ describe('Top level API', () => {
       const log = emittedLogs[0];
       expect(log.severityNumber).to.equal(SeverityNumber.ERROR);
       expect(log.body).to.equal('Unknown error type: number');
-      expect(log.attributes).to.deep.equal({});
+      expect(log.attributes).to.deep.equal({
+        "user.id": "fid-1234"
+      });
     });
 
     it('should propagate trace context', async () => {
@@ -185,6 +192,7 @@ describe('Top level API', () => {
       await provider.shutdown();
 
       expect(emittedLogs[0].attributes).to.deep.equal({
+        'user.id': 'fid-1234',
         'error.type': 'TestError',
         'error.stack': '...stack trace...',
         'logging.googleapis.com/trace': `projects/${PROJECT_ID}/traces/my-trace`,
@@ -209,6 +217,7 @@ describe('Top level API', () => {
       expect(emittedLogs.length).to.equal(1);
       const log = emittedLogs[0];
       expect(log.attributes).to.deep.equal({
+        'user.id': 'fid-1234',
         'error.type': 'TestError',
         'error.stack': '...stack trace...',
         strAttr: 'string attribute',
@@ -237,6 +246,16 @@ describe('Top level API', () => {
 
 function getFakeApp(): FirebaseApp {
   registerTelemetry();
+  _registerComponent(
+    new Component(
+      'installations-internal',
+      () => ({
+        getId: () => Promise.resolve('fid-1234'),
+        getToken: () => Promise.resolve('token-5678')
+      }),
+      ComponentType.PRIVATE
+    )
+  );
   _registerComponent(
     new Component(
       'app-check-internal',

packages/telemetry/src/api.ts

@@ -87,6 +87,12 @@ export function captureError(
 
   const customAttributes = attributes || {};
 
+  // Set firebase installation ID ("FID") if available, which
+  // represents the "user" who experienced the error.
+  if (telemetry.fid) {
+    customAttributes['user.id'] = telemetry.fid;
+  }
+
   if (error instanceof Error) {
     logger.emit({
       severityNumber: SeverityNumber.ERROR,

packages/telemetry/src/public-types.ts

@@ -33,6 +33,13 @@ export interface Telemetry {
 
   /** The {@link LoggerProvider} this {@link Telemetry} instance uses. */
   loggerProvider: LoggerProvider;
+
+  /**
+   * The Firebase Installation ID.
+   *
+   * @internal
+   */
+  fid?: string;
 }
 
 /**

packages/telemetry/src/service.ts

@@ -18,9 +18,19 @@
 import { _FirebaseService, FirebaseApp } from '@firebase/app';
 import { Telemetry } from './public-types';
 import { LoggerProvider } from '@opentelemetry/sdk-logs';
+import { getInstallations, getId } from '@firebase/installations';
 
 export class TelemetryService implements Telemetry, _FirebaseService {
-  constructor(public app: FirebaseApp, public loggerProvider: LoggerProvider) {}
+  fid?: string;
+
+  constructor(public app: FirebaseApp, public loggerProvider: LoggerProvider) {
+    this._getFid().catch(console.error);
+  }
+
+  private async _getFid(): Promise<void> {
+    const installations = getInstallations(this.app);
+    this.fid = await getId(installations);
+  }
 
   _delete(): Promise<void> {
     return Promise.resolve();

yarn.lock

@@ -1360,6 +1360,17 @@
   resolved "https://registry.npmjs.org/@eslint/js/-/js-8.57.1.tgz#de633db3ec2ef6a3c89e2f19038063e8a122e2c2"
   integrity sha512-d9zaMRSTIKDLhctzH12MtXvJKSSUhaHcjV+2Z+GK+EEY7XKpP5yR4x+N3TAcHTcu963nIr+TMcCb4DBCYX1z6Q==
 
+"@firebase/app@0.14.4":
+  version "0.14.4"
+  resolved "https://registry.npmjs.org/@firebase/app/-/app-0.14.4.tgz#1d2ce74c09752dec9664e2f981b20335c4efbec1"
+  integrity sha512-pUxEGmR+uu21OG/icAovjlu1fcYJzyVhhT0rsCrn+zi+nHtrS43Bp9KPn9KGa4NMspCUE++nkyiqziuIvJdwzw==
+  dependencies:
+    "@firebase/component" "0.7.0"
+    "@firebase/logger" "0.5.0"
+    "@firebase/util" "1.13.0"
+    idb "7.1.1"
+    tslib "^2.1.0"
+
 "@gar/promisify@^1.0.1":
   version "1.1.3"
   resolved "https://registry.npmjs.org/@gar/promisify/-/promisify-1.1.3.tgz#555193ab2e3bb3b6adc3d551c9c030d9e860daf6"