Integrate VertexAI with Auth (#8216)

Author: dlarocque

packages/vertexai/src/index.ts

@@ -40,8 +40,9 @@ function registerVertex(): void {
       (container, { instanceIdentifier: location }) => {
         // getImmediate for FirebaseApp will always succeed
         const app = container.getProvider('app').getImmediate();
+        const auth = container.getProvider('auth-internal');
         const appCheckProvider = container.getProvider('app-check-internal');
-        return new VertexAIService(app, appCheckProvider, { location });
+        return new VertexAIService(app, auth, appCheckProvider, { location });
       },
       ComponentType.PUBLIC
     ).setMultipleInstances(true)

packages/vertexai/src/models/generative-model.ts

@@ -79,6 +79,11 @@ export class GenerativeModel {
         this._apiSettings.getAppCheckToken = () =>
           (vertexAI as VertexAIService).appCheck!.getToken();
       }
+
+      if ((vertexAI as VertexAIService).auth) {
+        this._apiSettings.getAuthToken = () =>
+          (vertexAI as VertexAIService).auth!.getToken();
+      }
     }
     if (modelParams.model.includes('/')) {
       if (modelParams.model.startsWith('models/')) {

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

@@ -101,6 +101,7 @@ describe('request methods', () => {
       apiKey: 'key',
       project: 'myproject',
       location: 'moon',
+      getAuthToken: () => Promise.resolve({ accessToken: 'authtoken' }),
       getAppCheckToken: () => Promise.resolve({ token: 'appchecktoken' })
     };
     const fakeUrl = new RequestUrl(
@@ -173,6 +174,42 @@ describe('request methods', () => {
       const headers = await getHeaders(fakeUrl);
       expect(headers.has('X-Firebase-AppCheck')).to.be.false;
     });
+    it('adds auth token if it exists', async () => {
+      const headers = await getHeaders(fakeUrl);
+      expect(headers.get('Authorization')).to.equal('Firebase authtoken');
+    });
+    it('ignores auth token header if no auth service', async () => {
+      const fakeUrl = new RequestUrl(
+        'models/model-name',
+        Task.GENERATE_CONTENT,
+        {
+          apiKey: 'key',
+          project: 'myproject',
+          location: 'moon'
+        },
+        true,
+        {}
+      );
+      const headers = await getHeaders(fakeUrl);
+      expect(headers.has('Authorization')).to.be.false;
+    });
+    it('ignores auth token header if returned token was undefined', async () => {
+      const fakeUrl = new RequestUrl(
+        'models/model-name',
+        Task.GENERATE_CONTENT,
+        {
+          apiKey: 'key',
+          project: 'myproject',
+          location: 'moon',
+          //@ts-ignore
+          getAppCheckToken: () => Promise.resolve()
+        },
+        true,
+        {}
+      );
+      const headers = await getHeaders(fakeUrl);
+      expect(headers.has('Authorization')).to.be.false;
+    });
   });
   describe('makeRequest', () => {
     it('no error', async () => {

packages/vertexai/src/requests/request.ts

@@ -87,6 +87,14 @@ export async function getHeaders(url: RequestUrl): Promise<Headers> {
       headers.append('X-Firebase-AppCheck', appCheckToken.token);
     }
   }
+
+  if (url.apiSettings.getAuthToken) {
+    const authToken = await url.apiSettings.getAuthToken();
+    if (authToken) {
+      headers.append('Authorization', `Firebase ${authToken.accessToken}`);
+    }
+  }
+
   return headers;
 }
 

packages/vertexai/src/service.test.ts

@@ -35,6 +35,7 @@ describe('VertexAIService', () => {
   it('uses custom location if specified', () => {
     const vertexAI = new VertexAIService(
       fakeApp,
+      /* authProvider */ undefined,
       /* appCheckProvider */ undefined,
       { location: 'somewhere' }
     );

packages/vertexai/src/service.ts

@@ -22,18 +22,26 @@ import {
   FirebaseAppCheckInternal
 } from '@firebase/app-check-interop-types';
 import { Provider } from '@firebase/component';
+import {
+  FirebaseAuthInternal,
+  FirebaseAuthInternalName
+} from '@firebase/auth-interop-types';
 import { DEFAULT_LOCATION } from './constants';
 
 export class VertexAIService implements VertexAI, _FirebaseService {
+  auth: FirebaseAuthInternal | null;
   appCheck: FirebaseAppCheckInternal | null;
   location: string;
 
   constructor(
     public app: FirebaseApp,
+    authProvider?: Provider<FirebaseAuthInternalName>,
     appCheckProvider?: Provider<AppCheckInternalComponentName>,
     public options?: VertexAIOptions
   ) {
     const appCheck = appCheckProvider?.getImmediate({ optional: true });
+    const auth = authProvider?.getImmediate({ optional: true });
+    this.auth = auth || null;
     this.appCheck = appCheck || null;
     this.location = this.options?.location || DEFAULT_LOCATION;
   }

packages/vertexai/src/types/internal.ts

@@ -16,10 +16,12 @@
  */
 
 import { AppCheckTokenResult } from '@firebase/app-check-interop-types';
+import { FirebaseAuthTokenData } from '@firebase/auth-interop-types';
 
 export interface ApiSettings {
   apiKey: string;
   project: string;
   location: string;
+  getAuthToken?: () => Promise<FirebaseAuthTokenData | null>;
   getAppCheckToken?: () => Promise<AppCheckTokenResult>;
 }