Provide installations package via getProvider

Author: tonybaroneee

packages/telemetry/package.json

@@ -71,7 +71,6 @@
   "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"
   },
@@ -91,6 +90,7 @@
   },
   "dependencies": {
     "@firebase/component": "0.7.0",
+    "@firebase/installations": "0.6.19",
     "@opentelemetry/api": "1.9.0",
     "@opentelemetry/api-logs": "0.203.0",
     "@opentelemetry/exporter-logs-otlp-http": "0.203.0",

packages/telemetry/src/api.test.ts

@@ -37,9 +37,12 @@ import { FirebaseAppCheckInternal } from '@firebase/app-check-interop-types';
 import { captureError, flush, getTelemetry } from './api';
 import { TelemetryService } from './service';
 import { registerTelemetry } from './register';
+import { _FirebaseInstallationsInternal } from '@firebase/installations';
 
 const PROJECT_ID = 'my-project';
 const APP_ID = 'my-appid';
+const API_KEY = 'my-api-key';
+const FID = 'fid-1234';
 
 const emittedLogs: LogRecord[] = [];
 
@@ -68,7 +71,7 @@ const fakeTelemetry: Telemetry = {
     }
   },
   loggerProvider: fakeLoggerProvider,
-  fid: 'fid-1234'
+  fid: FID
 };
 
 describe('Top level API', () => {
@@ -124,7 +127,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',
+        'user.id': FID,
         'error.type': 'TestError',
         'error.stack': '...stack trace...'
       });
@@ -141,7 +144,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',
+        'user.id': FID,
         'error.type': 'Error',
         'error.stack': 'No stack trace available'
       });
@@ -192,7 +195,7 @@ describe('Top level API', () => {
       await provider.shutdown();
 
       expect(emittedLogs[0].attributes).to.deep.equal({
-        'user.id': 'fid-1234',
+        'user.id': FID,
         'error.type': 'TestError',
         'error.stack': '...stack trace...',
         'logging.googleapis.com/trace': `projects/${PROJECT_ID}/traces/my-trace`,
@@ -217,7 +220,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',
+        'user.id': FID,
         'error.type': 'TestError',
         'error.stack': '...stack trace...',
         strAttr: 'string attribute',
@@ -250,10 +253,10 @@ function getFakeApp(): FirebaseApp {
     new Component(
       'installations-internal',
       () => ({
-        getId: () => Promise.resolve('fid-1234'),
-        getToken: () => Promise.resolve('token-5678')
-      }),
-      ComponentType.PRIVATE
+        getId: async () => 'FID',
+        getToken: async () => 'authToken'
+      }) as _FirebaseInstallationsInternal,
+      ComponentType.PUBLIC
     )
   );
   _registerComponent(
@@ -265,7 +268,11 @@ function getFakeApp(): FirebaseApp {
       ComponentType.PUBLIC
     )
   );
-  const app = initializeApp({});
+  const app = initializeApp({
+    projectId: PROJECT_ID,
+    appId: APP_ID,
+    apiKey: API_KEY
+  });
   _addOrOverwriteComponent(
     app,
     //@ts-ignore

packages/telemetry/src/register.node.ts

@@ -21,6 +21,9 @@ import { TELEMETRY_TYPE } from './constants';
 import { name, version } from '../package.json';
 import { TelemetryService } from './service';
 import { createLoggerProvider } from './logging/logger-provider';
+// This needs to be in the same file that calls `getProvider()` on the component
+// or it will get tree-shaken out.
+import '@firebase/installations';
 
 export function registerTelemetry(): void {
   _registerComponent(
@@ -36,9 +39,10 @@ export function registerTelemetry(): void {
 
         // getImmediate for FirebaseApp will always succeed
         const app = container.getProvider('app').getImmediate();
+        const installationsProvider = container.getProvider('installations-internal').getImmediate();
         const loggerProvider = createLoggerProvider(app, endpointUrl);
 
-        return new TelemetryService(app, loggerProvider);
+        return new TelemetryService(app, installationsProvider, loggerProvider);
       },
       ComponentType.PUBLIC
     ).setMultipleInstances(true)

packages/telemetry/src/register.ts

@@ -22,6 +22,9 @@ import { name, version } from '../package.json';
 import { TelemetryService } from './service';
 import { createLoggerProvider } from './logging/logger-provider';
 import { AppCheckProvider } from './logging/appcheck-provider';
+// This needs to be in the same file that calls `getProvider()` on the component
+// or it will get tree-shaken out.
+import '@firebase/installations';
 
 export function registerTelemetry(): void {
   _registerComponent(
@@ -38,14 +41,15 @@ export function registerTelemetry(): void {
         // getImmediate for FirebaseApp will always succeed
         const app = container.getProvider('app').getImmediate();
         const appCheckProvider = container.getProvider('app-check-internal');
+        const installationsProvider = container.getProvider('installations-internal').getImmediate();
         const dynamicHeaderProviders = [new AppCheckProvider(appCheckProvider)];
         const loggerProvider = createLoggerProvider(
           app,
           endpointUrl,
           dynamicHeaderProviders
         );
 
-        return new TelemetryService(app, loggerProvider);
+        return new TelemetryService(app, installationsProvider, loggerProvider);
       },
       ComponentType.PUBLIC
     ).setMultipleInstances(true)

packages/telemetry/src/service.ts

@@ -18,18 +18,22 @@
 import { _FirebaseService, FirebaseApp } from '@firebase/app';
 import { Telemetry } from './public-types';
 import { LoggerProvider } from '@opentelemetry/sdk-logs';
-import { getInstallations, getId } from '@firebase/installations';
+import { _FirebaseInstallationsInternal } from '@firebase/installations';
 
 export class TelemetryService implements Telemetry, _FirebaseService {
   fid?: string;
 
-  constructor(public app: FirebaseApp, public loggerProvider: LoggerProvider) {
-    this._getFid().catch(err => console.error('Failed to get FID for telemetry:', err));
+  constructor(public app: FirebaseApp, public installationsProvider: _FirebaseInstallationsInternal, public loggerProvider: LoggerProvider) {
+    void this._getFid();
   }
 
   private async _getFid(): Promise<void> {
-    const installations = getInstallations(this.app);
-    this.fid = await getId(installations);
+    try {
+      const fid = await this.installationsProvider.getId();
+      this.fid = fid;
+    } catch (err) {
+      console.error('Failed to get FID for telemetry:', err);
+    }
   }
 
   _delete(): Promise<void> {