Installations heartbeat implementation (#5966)

Author: hsubox76

.changeset/proud-otters-tap.md

@@ -0,0 +1,5 @@
+---
+'@firebase/installations': patch
+---
+
+Update platform logging code to send to new endpoint.

packages/installations/src/api/get-id.test.ts

@@ -26,17 +26,14 @@ import {
 import { getFakeInstallations } from '../testing/fake-generators';
 import '../testing/setup';
 import { getId } from './get-id';
-import {
-  FirebaseInstallationsImpl,
-  AppConfig
-} from '../interfaces/installation-impl';
+import { FirebaseInstallationsImpl } from '../interfaces/installation-impl';
 
 const FID = 'disciples-of-the-watch';
 
 describe('getId', () => {
   let installations: FirebaseInstallationsImpl;
   let getInstallationEntrySpy: SinonStub<
-    [AppConfig],
+    [FirebaseInstallationsImpl],
     Promise<getInstallationEntryModule.InstallationEntryWithRegistrationPromise>
   >;
 

packages/installations/src/api/get-id.ts

@@ -30,7 +30,7 @@ import { Installations } from '../interfaces/public-types';
 export async function getId(installations: Installations): Promise<string> {
   const installationsImpl = installations as FirebaseInstallationsImpl;
   const { installationEntry, registrationPromise } = await getInstallationEntry(
-    installationsImpl.appConfig
+    installationsImpl
   );
 
   if (registrationPromise) {

packages/installations/src/api/get-token.test.ts

@@ -175,7 +175,7 @@ const setupInstallationEntryMap: Map<
 describe('getToken', () => {
   let installations: FirebaseInstallationsImpl;
   let createInstallationRequestSpy: SinonStub<
-    [AppConfig, InProgressInstallationEntry],
+    [FirebaseInstallationsImpl, InProgressInstallationEntry],
     Promise<RegisteredInstallationEntry>
   >;
   let generateAuthTokenRequestSpy: SinonStub<

packages/installations/src/api/get-token.ts

@@ -17,10 +17,7 @@
 
 import { getInstallationEntry } from '../helpers/get-installation-entry';
 import { refreshAuthToken } from '../helpers/refresh-auth-token';
-import {
-  FirebaseInstallationsImpl,
-  AppConfig
-} from '../interfaces/installation-impl';
+import { FirebaseInstallationsImpl } from '../interfaces/installation-impl';
 import { Installations } from '../interfaces/public-types';
 
 /**
@@ -36,7 +33,7 @@ export async function getToken(
   forceRefresh = false
 ): Promise<string> {
   const installationsImpl = installations as FirebaseInstallationsImpl;
-  await completeInstallationRegistration(installationsImpl.appConfig);
+  await completeInstallationRegistration(installationsImpl);
 
   // At this point we either have a Registered Installation in the DB, or we've
   // already thrown an error.
@@ -45,9 +42,9 @@ export async function getToken(
 }
 
 async function completeInstallationRegistration(
-  appConfig: AppConfig
+  installations: FirebaseInstallationsImpl
 ): Promise<void> {
-  const { registrationPromise } = await getInstallationEntry(appConfig);
+  const { registrationPromise } = await getInstallationEntry(installations);
 
   if (registrationPromise) {
     // A createInstallation request is in progress. Wait until it finishes.

packages/installations/src/api/on-id-change.ts

@@ -26,7 +26,7 @@ import { Installations } from '../interfaces/public-types';
  */
 export type IdChangeCallbackFn = (installationId: string) => void;
 /**
- * Unsubscribe a callback function previously added via {@link #IdChangeCallbackFn}.
+ * Unsubscribe a callback function previously added via {@link IdChangeCallbackFn}.
  *
  * @public
  */

packages/installations/src/functions/config.ts

@@ -36,12 +36,12 @@ const publicFactory: InstanceFactory<'installations'> = (
   const app = container.getProvider('app').getImmediate();
   // Throws if app isn't configured properly.
   const appConfig = extractAppConfig(app);
-  const platformLoggerProvider = _getProvider(app, 'platform-logger');
+  const heartbeatServiceProvider = _getProvider(app, 'heartbeat');
 
   const installationsImpl: FirebaseInstallationsImpl = {
     app,
     appConfig,
-    platformLoggerProvider,
+    heartbeatServiceProvider,
     _delete: () => Promise.resolve()
   };
   return installationsImpl;

packages/installations/src/functions/create-installation-request.test.ts

@@ -19,13 +19,13 @@ import { FirebaseError } from '@firebase/util';
 import { expect } from 'chai';
 import { SinonStub, stub } from 'sinon';
 import { CreateInstallationResponse } from '../interfaces/api-response';
-import { AppConfig } from '../interfaces/installation-impl';
+import { FirebaseInstallationsImpl } from '../interfaces/installation-impl';
 import {
   InProgressInstallationEntry,
   RequestStatus
 } from '../interfaces/installation-entry';
 import { compareHeaders } from '../testing/compare-headers';
-import { getFakeAppConfig } from '../testing/fake-generators';
+import { getFakeInstallations } from '../testing/fake-generators';
 import '../testing/setup';
 import {
   INSTALLATIONS_API_URL,
@@ -38,13 +38,13 @@ import { createInstallationRequest } from './create-installation-request';
 const FID = 'defenders-of-the-faith';
 
 describe('createInstallationRequest', () => {
-  let appConfig: AppConfig;
+  let fakeInstallations: FirebaseInstallationsImpl;
   let fetchSpy: SinonStub<[RequestInfo, RequestInit?], Promise<Response>>;
   let inProgressInstallationEntry: InProgressInstallationEntry;
   let response: CreateInstallationResponse;
 
   beforeEach(() => {
-    appConfig = getFakeAppConfig();
+    fakeInstallations = getFakeInstallations();
 
     inProgressInstallationEntry = {
       fid: FID,
@@ -71,7 +71,7 @@ describe('createInstallationRequest', () => {
 
     it('registers a pending InstallationEntry', async () => {
       const registeredInstallationEntry = await createInstallationRequest(
-        appConfig,
+        fakeInstallations,
         inProgressInstallationEntry
       );
       expect(registeredInstallationEntry.registrationStatus).to.equal(
@@ -83,12 +83,13 @@ describe('createInstallationRequest', () => {
       const expectedHeaders = new Headers({
         'Content-Type': 'application/json',
         Accept: 'application/json',
-        'x-goog-api-key': 'apiKey'
+        'x-goog-api-key': 'apiKey',
+        'x-firebase-client': 'a/1.2.3 b/2.3.4'
       });
       const expectedBody = {
         fid: FID,
         authVersion: INTERNAL_AUTH_VERSION,
-        appId: appConfig.appId,
+        appId: fakeInstallations.appConfig.appId,
         sdkVersion: PACKAGE_VERSION
       };
       const expectedRequest: RequestInit = {
@@ -98,7 +99,10 @@ describe('createInstallationRequest', () => {
       };
       const expectedEndpoint = `${INSTALLATIONS_API_URL}/projects/projectId/installations`;
 
-      await createInstallationRequest(appConfig, inProgressInstallationEntry);
+      await createInstallationRequest(
+        fakeInstallations,
+        inProgressInstallationEntry
+      );
       expect(fetchSpy).to.be.calledOnceWith(expectedEndpoint, expectedRequest);
       const actualHeaders = fetchSpy.lastCall.lastArg.headers;
       compareHeaders(expectedHeaders, actualHeaders);
@@ -117,7 +121,7 @@ describe('createInstallationRequest', () => {
     fetchSpy.resolves(new Response(JSON.stringify(response)));
 
     const registeredInstallationEntry = await createInstallationRequest(
-      appConfig,
+      fakeInstallations,
       inProgressInstallationEntry
     );
     expect(registeredInstallationEntry.fid).to.equal(FID);
@@ -138,7 +142,10 @@ describe('createInstallationRequest', () => {
       );
 
       await expect(
-        createInstallationRequest(appConfig, inProgressInstallationEntry)
+        createInstallationRequest(
+          fakeInstallations,
+          inProgressInstallationEntry
+        )
       ).to.be.rejectedWith(FirebaseError);
     });
 
@@ -157,7 +164,10 @@ describe('createInstallationRequest', () => {
       fetchSpy.onCall(1).resolves(new Response(JSON.stringify(response)));
 
       await expect(
-        createInstallationRequest(appConfig, inProgressInstallationEntry)
+        createInstallationRequest(
+          fakeInstallations,
+          inProgressInstallationEntry
+        )
       ).to.be.fulfilled;
       expect(fetchSpy).to.be.calledTwice;
     });

packages/installations/src/functions/create-installation-request.ts

@@ -29,15 +29,27 @@ import {
   getInstallationsEndpoint,
   retryIfServerError
 } from './common';
-import { AppConfig } from '../interfaces/installation-impl';
+import { FirebaseInstallationsImpl } from '../interfaces/installation-impl';
 
 export async function createInstallationRequest(
-  appConfig: AppConfig,
+  { appConfig, heartbeatServiceProvider }: FirebaseInstallationsImpl,
   { fid }: InProgressInstallationEntry
 ): Promise<RegisteredInstallationEntry> {
   const endpoint = getInstallationsEndpoint(appConfig);
 
   const headers = getHeaders(appConfig);
+
+  // If heartbeat service exists, add the heartbeat string to the header.
+  const heartbeatService = heartbeatServiceProvider.getImmediate({
+    optional: true
+  });
+  if (heartbeatService) {
+    const heartbeatsHeader = await heartbeatService.getHeartbeatsHeader();
+    if (heartbeatsHeader) {
+      headers.append('x-firebase-client', heartbeatsHeader);
+    }
+  }
+
   const body = {
     fid,
     authVersion: INTERNAL_AUTH_VERSION,

packages/installations/src/functions/generate-auth-token-request.test.ts

@@ -91,7 +91,8 @@ describe('generateAuthTokenRequest', () => {
       });
       const expectedBody = {
         installation: {
-          sdkVersion: PACKAGE_VERSION
+          sdkVersion: PACKAGE_VERSION,
+          appId: installations.appConfig.appId
         }
       };
       const expectedRequest: RequestInit = {