Add Firebase-Appversion header

Author: dlarocque

packages/vertexai/src/requests/request.test.ts

@@ -25,6 +25,7 @@ import { DEFAULT_API_VERSION } from '../constants';
 import { VertexAIErrorCode } from '../types';
 import { VertexAIError } from '../errors';
 import { getMockResponse } from '../../test-utils/mock-response';
+import { SDK_VERSION } from '@firebase/app';
 
 use(sinonChai);
 use(chaiAsPromised);
@@ -126,10 +127,6 @@ describe('request methods', () => {
       const headers = await getHeaders(fakeUrl);
       expect(headers.get('x-goog-api-key')).to.equal('key');
     });
-    it('adds app id if automatedDataCollectionEnabled is undefined', async () => {
-      const headers = await getHeaders(fakeUrl);
-      expect(headers.get('X-Firebase-AppId')).to.equal('my-appid');
-    });
     it('adds app id if automatedDataCollectionEnabled is true', async () => {
       const fakeApiSettings: ApiSettings = {
         apiKey: 'key',
@@ -148,7 +145,11 @@ describe('request methods', () => {
         {}
       );
       const headers = await getHeaders(fakeUrl);
-      expect(headers.get('X-Firebase-AppId')).to.equal('my-appid');
+      expect(headers.get('X-Firebase-Appid')).to.equal('my-appid');
+    });
+    it('does not add app id if automatedDataCollectionEnabled is undefined', async () => {
+      const headers = await getHeaders(fakeUrl);
+      expect(headers.get('X-Firebase-Appid')).to.be.null;
     });
     it('does not add app id if automatedDataCollectionEnabled is false', async () => {
       const fakeApiSettings: ApiSettings = {
@@ -168,7 +169,51 @@ describe('request methods', () => {
         {}
       );
       const headers = await getHeaders(fakeUrl);
-      expect(headers.get('X-Firebase-AppId')).to.be.null;
+      expect(headers.get('X-Firebase-Appid')).to.be.null;
+    });
+    it('adds app version if automatedDataCollectionEnabled is true', async () => {
+      const fakeApiSettings: ApiSettings = {
+        apiKey: 'key',
+        project: 'myproject',
+        appId: 'my-appid',
+        location: 'moon',
+        automaticDataCollectionEnabled: true,
+        getAuthToken: () => Promise.resolve({ accessToken: 'authtoken' }),
+        getAppCheckToken: () => Promise.resolve({ token: 'appchecktoken' })
+      };
+      const fakeUrl = new RequestUrl(
+        'models/model-name',
+        Task.GENERATE_CONTENT,
+        fakeApiSettings,
+        true,
+        {}
+      );
+      const headers = await getHeaders(fakeUrl);
+      expect(headers.get('X-Firebase-Appversion')).to.equal(SDK_VERSION);
+    });
+    it('does not add app version if automatedDataCollectionEnabled is undefined', async () => {
+      const headers = await getHeaders(fakeUrl);
+      expect(headers.get('X-Firebase-Appversion')).to.be.null;
+    });
+    it('does not add app version if automatedDataCollectionEnabled is false', async () => {
+      const fakeApiSettings: ApiSettings = {
+        apiKey: 'key',
+        project: 'myproject',
+        appId: 'my-appid',
+        location: 'moon',
+        automaticDataCollectionEnabled: false,
+        getAuthToken: () => Promise.resolve({ accessToken: 'authtoken' }),
+        getAppCheckToken: () => Promise.resolve({ token: 'appchecktoken' })
+      };
+      const fakeUrl = new RequestUrl(
+        'models/model-name',
+        Task.GENERATE_CONTENT,
+        fakeApiSettings,
+        true,
+        {}
+      );
+      const headers = await getHeaders(fakeUrl);
+      expect(headers.get('X-Firebase-Appversion')).to.be.null;
     });
     it('adds app check token if it exists', async () => {
       const headers = await getHeaders(fakeUrl);

packages/vertexai/src/requests/request.ts

@@ -26,6 +26,7 @@ import {
   PACKAGE_VERSION
 } from '../constants';
 import { logger } from '../logger';
+import { SDK_VERSION } from '@firebase/app';
 
 export enum Task {
   GENERATE_CONTENT = 'generateContent',
@@ -84,8 +85,9 @@ export async function getHeaders(url: RequestUrl): Promise<Headers> {
   headers.append('Content-Type', 'application/json');
   headers.append('x-goog-api-client', getClientHeaders());
   headers.append('x-goog-api-key', url.apiSettings.apiKey);
-  if (url.apiSettings.automaticDataCollectionEnabled !== false) {
-    headers.append('X-Firebase-AppId', url.apiSettings.appId);
+  if (url.apiSettings.automaticDataCollectionEnabled) {
+    headers.append('X-Firebase-Appid', url.apiSettings.appId);
+    headers.append('X-Firebase-Appversion', SDK_VERSION);
   }
   if (url.apiSettings.getAppCheckToken) {
     const appCheckToken = await url.apiSettings.getAppCheckToken();