Initial implementation across all SDKs.

DellaBitta · DellaBitta · commit 25f264fb2247 · 2024-11-22T11:32:47.000-05:00
diff --git a/common/api-review/app.api.md b/common/api-review/app.api.md
@@ -79,6 +79,7 @@ export interface FirebaseServerApp extends FirebaseApp {
 
 // @public
 export interface FirebaseServerAppSettings extends Omit<FirebaseAppSettings, 'name'> {
+    appCheckToken?: string;
     authIdToken?: string;
     releaseOnDeref?: object;
 }
diff --git a/packages/app/src/public-types.ts b/packages/app/src/public-types.ts
@@ -196,6 +196,12 @@ export interface FirebaseServerAppSettings
    */
   authIdToken?: string;
 
+  /**
+   * An optional App Check token. If provided, the Firebase SDKs that use App Check will utilizze
+   * this App Check token in lieu of requiring an instance of App Check to be initialized.
+   */
+  appCheckToken?: string;
+
   /**
    * An optional object. If provided, the Firebase SDK uses a `FinalizationRegistry`
    * object to monitor the garbage collection status of the provided object. The
diff --git a/packages/auth/src/core/auth/auth_impl.ts b/packages/auth/src/core/auth/auth_impl.ts
@@ -845,6 +845,9 @@ export class AuthImpl implements AuthInternal, _FirebaseService {
   }
 
   async _getAppCheckToken(): Promise<string | undefined> {
+    if (_isFirebaseServerApp(this.app) && this.app.settings.appCheckToken) {
+      return this.app.settings.appCheckToken;
+    }
     const appCheckTokenResult = await this.appCheckServiceProvider
       .getImmediate({ optional: true })
       ?.getToken();
diff --git a/packages/data-connect/src/api/DataConnect.ts b/packages/data-connect/src/api/DataConnect.ts
@@ -92,7 +92,7 @@ export class DataConnect {
   private _transportOptions?: TransportOptions;
   private _authTokenProvider?: AuthTokenProvider;
   _isUsingGeneratedSdk: boolean = false;
-  private _appCheckTokenProvider?: AppCheckTokenProvider;
+  private _appCheckTokenProvider: AppCheckTokenProvider;
   // @internal
   constructor(
     public readonly app: FirebaseApp,
@@ -149,12 +149,10 @@ export class DataConnect {
         this._authProvider
       );
     }
-    if (this._appCheckProvider) {
-      this._appCheckTokenProvider = new AppCheckTokenProvider(
-        this.app.name,
-        this._appCheckProvider
-      );
-    }
+    this._appCheckTokenProvider = new AppCheckTokenProvider(
+      this.app,
+      this._appCheckProvider
+    );
 
     this._initialized = true;
     this._transport = new this._transportClass(
diff --git a/packages/data-connect/src/core/AppCheckTokenProvider.ts b/packages/data-connect/src/core/AppCheckTokenProvider.ts
@@ -15,6 +15,7 @@
  * limitations under the License.
  */
 
+import { FirebaseApp, _isFirebaseServerApp } from '@firebase/app';
 import {
   AppCheckInternalComponentName,
   AppCheckTokenListener,
@@ -29,10 +30,14 @@ import { Provider } from '@firebase/component';
  */
 export class AppCheckTokenProvider {
   private appCheck?: FirebaseAppCheckInternal;
+  private serverAppAppCheckToken?: string;
   constructor(
-    private appName_: string,
+    app: FirebaseApp,
     private appCheckProvider?: Provider<AppCheckInternalComponentName>
   ) {
+    if (_isFirebaseServerApp(app) && app.settings.appCheckToken) {
+      this.serverAppAppCheckToken = app.settings.appCheckToken;
+    }
     this.appCheck = appCheckProvider?.getImmediate({ optional: true });
     if (!this.appCheck) {
       void appCheckProvider
@@ -43,6 +48,10 @@ export class AppCheckTokenProvider {
   }
 
   getToken(forceRefresh?: boolean): Promise<AppCheckTokenResult> {
+    if (this.serverAppAppCheckToken) {
+      return Promise.resolve({ token: this.serverAppAppCheckToken });
+    }
+
     if (!this.appCheck) {
       return new Promise<AppCheckTokenResult>((resolve, reject) => {
         // Support delayed initialization of FirebaseAppCheck. This allows our
diff --git a/packages/database/src/api/Database.ts b/packages/database/src/api/Database.ts
@@ -164,7 +164,7 @@ export function repoManagerDatabaseFromApp(
     repoInfo,
     app,
     authTokenProvider,
-    new AppCheckTokenProvider(app.name, appCheckProvider)
+    new AppCheckTokenProvider(app, appCheckProvider)
   );
   return new Database(repo, app);
 }
diff --git a/packages/database/src/core/AppCheckTokenProvider.ts b/packages/database/src/core/AppCheckTokenProvider.ts
@@ -15,6 +15,7 @@
  * limitations under the License.
  */
 
+import { FirebaseApp, _isFirebaseServerApp } from '@firebase/app'; // eslint-disable-line import/no-extraneous-dependencies
 import {
   AppCheckInternalComponentName,
   AppCheckTokenListener,
@@ -30,17 +31,26 @@ import { warn } from './util/util';
  */
 export class AppCheckTokenProvider {
   private appCheck?: FirebaseAppCheckInternal;
+  private serverAppAppCheckToken?: string;
+  private appName: string;
   constructor(
-    private appName_: string,
+    app: FirebaseApp,
     private appCheckProvider?: Provider<AppCheckInternalComponentName>
   ) {
+    this.appName = app.name;
+    if (_isFirebaseServerApp(app) && app.settings.appCheckToken) {
+      this.serverAppAppCheckToken = app.settings.appCheckToken;
+    }
     this.appCheck = appCheckProvider?.getImmediate({ optional: true });
     if (!this.appCheck) {
       appCheckProvider?.get().then(appCheck => (this.appCheck = appCheck));
     }
   }
 
   getToken(forceRefresh?: boolean): Promise<AppCheckTokenResult> {
+    if (this.serverAppAppCheckToken) {
+      return Promise.resolve({ token: this.serverAppAppCheckToken });
+    }
     if (!this.appCheck) {
       return new Promise<AppCheckTokenResult>((resolve, reject) => {
         // Support delayed initialization of FirebaseAppCheck. This allows our
@@ -67,7 +77,7 @@ export class AppCheckTokenProvider {
 
   notifyForInvalidToken(): void {
     warn(
-      `Provided AppCheck credentials for the app named "${this.appName_}" ` +
+      `Provided AppCheck credentials for the app named "${this.appName}" ` +
         'are invalid. This usually indicates your app was not initialized correctly.'
     );
   }
diff --git a/packages/firestore/lite/register.ts b/packages/firestore/lite/register.ts
@@ -49,6 +49,7 @@ export function registerFirestore(): void {
             container.getProvider('auth-internal')
           ),
           new LiteAppCheckTokenProvider(
+            app,
             container.getProvider('app-check-internal')
           ),
           databaseIdFromApp(app, databaseId),
diff --git a/packages/firestore/src/api/credentials.ts b/packages/firestore/src/api/credentials.ts
@@ -15,6 +15,7 @@
  * limitations under the License.
  */
 
+import { FirebaseApp, _isFirebaseServerApp } from '@firebase/app';
 import {
   AppCheckInternalComponentName,
   AppCheckTokenListener,
@@ -497,6 +498,7 @@ export class FirebaseAppCheckTokenProvider
   private latestAppCheckToken: string | null = null;
 
   constructor(
+    private app: FirebaseApp,
     private appCheckProvider: Provider<AppCheckInternalComponentName>
   ) {}
 
@@ -562,6 +564,11 @@ export class FirebaseAppCheckTokenProvider
   }
 
   getToken(): Promise<Token | null> {
+    if (_isFirebaseServerApp(this.app) && this.app.settings.appCheckToken) {
+      return Promise.resolve(
+        new AppCheckToken(this.app.settings.appCheckToken)
+      );
+    }
     debugAssert(
       this.tokenListener != null,
       'FirebaseAppCheckTokenProvider not started.'
@@ -622,16 +629,25 @@ export class EmptyAppCheckTokenProvider implements CredentialsProvider<string> {
 /** AppCheck token provider for the Lite SDK. */
 export class LiteAppCheckTokenProvider implements CredentialsProvider<string> {
   private appCheck: FirebaseAppCheckInternal | null = null;
+  private serverAppAppCheckToken?: string;
 
   constructor(
+    private app: FirebaseApp,
     private appCheckProvider: Provider<AppCheckInternalComponentName>
   ) {
+    if (_isFirebaseServerApp(app) && app.settings.appCheckToken) {
+      this.serverAppAppCheckToken = app.settings.appCheckToken;
+    }
     appCheckProvider.onInit(appCheck => {
       this.appCheck = appCheck;
     });
   }
 
   getToken(): Promise<Token | null> {
+    if (this.serverAppAppCheckToken) {
+      return Promise.resolve(new AppCheckToken(this.serverAppAppCheckToken));
+    }
+
     if (!this.appCheck) {
       return Promise.resolve(null);
     }
diff --git a/packages/firestore/src/register.ts b/packages/firestore/src/register.ts
@@ -47,6 +47,7 @@ export function registerFirestore(
             container.getProvider('auth-internal')
           ),
           new FirebaseAppCheckTokenProvider(
+            app,
             container.getProvider('app-check-internal')
           ),
           databaseIdFromApp(app, databaseId),
diff --git a/packages/functions/src/context.ts b/packages/functions/src/context.ts
@@ -16,6 +16,7 @@
  */
 
 import { Provider } from '@firebase/component';
+import { _isFirebaseServerApp, FirebaseApp } from '@firebase/app';
 import {
   AppCheckInternalComponentName,
   FirebaseAppCheckInternal
@@ -47,11 +48,16 @@ export class ContextProvider {
   private auth: FirebaseAuthInternal | null = null;
   private messaging: MessagingInternal | null = null;
   private appCheck: FirebaseAppCheckInternal | null = null;
+  private serverAppAppCheckToken: string | null = null;
   constructor(
+    readonly app: FirebaseApp,
     authProvider: Provider<FirebaseAuthInternalName>,
     messagingProvider: Provider<MessagingInternalComponentName>,
     appCheckProvider: Provider<AppCheckInternalComponentName>
   ) {
+    if (_isFirebaseServerApp(app) && app.settings.appCheckToken) {
+      this.serverAppAppCheckToken = app.settings.appCheckToken;
+    }
     this.auth = authProvider.getImmediate({ optional: true });
     this.messaging = messagingProvider.getImmediate({
       optional: true
@@ -122,6 +128,9 @@ export class ContextProvider {
   async getAppCheckToken(
     limitedUseAppCheckTokens?: boolean
   ): Promise<string | null> {
+    if (this.serverAppAppCheckToken) {
+      return this.serverAppAppCheckToken;
+    }
     if (this.appCheck) {
       const result = limitedUseAppCheckTokens
         ? await this.appCheck.getLimitedUseToken()
diff --git a/packages/functions/src/service.ts b/packages/functions/src/service.ts
@@ -107,6 +107,7 @@ export class FunctionsService implements _FirebaseService {
     regionOrCustomDomain: string = DEFAULT_REGION
   ) {
     this.contextProvider = new ContextProvider(
+      app,
       authProvider,
       messagingProvider,
       appCheckProvider
diff --git a/packages/storage/src/service.ts b/packages/storage/src/service.ts
@@ -24,7 +24,11 @@ import { Provider } from '@firebase/component';
 import { FirebaseAuthInternalName } from '@firebase/auth-interop-types';
 import { AppCheckInternalComponentName } from '@firebase/app-check-interop-types';
 // eslint-disable-next-line import/no-extraneous-dependencies
-import { FirebaseApp, FirebaseOptions } from '@firebase/app';
+import {
+  FirebaseApp,
+  FirebaseOptions,
+  _isFirebaseServerApp
+} from '@firebase/app';
 import {
   CONFIG_STORAGE_BUCKET_KEY,
   DEFAULT_HOST,
@@ -262,6 +266,9 @@ export class FirebaseStorageImpl implements FirebaseStorage {
   }
 
   async _getAppCheckToken(): Promise<string | null> {
+    if (_isFirebaseServerApp(this.app) && this.app.settings.appCheckToken) {
+      return this.app.settings.appCheckToken;
+    }
     const appCheck = this._appCheckProvider.getImmediate({ optional: true });
     if (appCheck) {
       const result = await appCheck.getToken();
diff --git a/packages/vertexai/src/models/generative-model.ts b/packages/vertexai/src/models/generative-model.ts
@@ -46,6 +46,7 @@ import {
 import { VertexAI } from '../public-types';
 import { ApiSettings } from '../types/internal';
 import { VertexAIService } from '../service';
+import { _isFirebaseServerApp } from '@firebase/app';
 
 /**
  * Class for generative model APIs.
@@ -82,7 +83,17 @@ export class GenerativeModel {
         project: vertexAI.app.options.projectId,
         location: vertexAI.location
       };
-      if ((vertexAI as VertexAIService).appCheck) {
+
+      if (
+        vertexAI.app &&
+        _isFirebaseServerApp(vertexAI.app) &&
+        vertexAI.app.settings.appCheckToken
+      ) {
+        const token = vertexAI.app.settings.appCheckToken;
+        this._apiSettings.getAppCheckToken = () => {
+          return Promise.resolve({ token });
+        };
+      } else if ((vertexAI as VertexAIService).appCheck) {
         this._apiSettings.getAppCheckToken = () =>
           (vertexAI as VertexAIService).appCheck!.getToken();
       }

Original file line number	Diff line number	Diff line change
`@@ -79,6 +79,7 @@ export interface FirebaseServerApp extends FirebaseApp {`
`79`	`79`
`80`	`80`	`// @public`
`81`	`81`	`export interface FirebaseServerAppSettings extends Omit<FirebaseAppSettings, 'name'> {`
	`82`	`+ appCheckToken?: string;`
`82`	`83`	`authIdToken?: string;`
`83`	`84`	`releaseOnDeref?: object;`
`84`	`85`	`}`
Original file line number	Diff line number	Diff line change
`@@ -845,6 +845,9 @@ export class AuthImpl implements AuthInternal, _FirebaseService {`
`845`	`845`	`}`
`846`	`846`
`847`	`847`	`async _getAppCheckToken(): Promise<string \| undefined> {`
	`848`	`+ if (_isFirebaseServerApp(this.app) && this.app.settings.appCheckToken) {`
	`849`	`+ return this.app.settings.appCheckToken;`
	`850`	`+ }`
`848`	`851`	`const appCheckTokenResult = await this.appCheckServiceProvider`
`849`	`852`	`.getImmediate({ optional: true })`
`850`	`853`	`?.getToken();`
Original file line number	Diff line number	Diff line change
`@@ -164,7 +164,7 @@ export function repoManagerDatabaseFromApp(`
`164`	`164`	`repoInfo,`
`165`	`165`	`app,`
`166`	`166`	`authTokenProvider,`
`167`		`- new AppCheckTokenProvider(app.name, appCheckProvider)`
	`167`	`+ new AppCheckTokenProvider(app, appCheckProvider)`
`168`	`168`	`);`
`169`	`169`	`return new Database(repo, app);`
`170`	`170`	`}`