Initial Impl

Author: DellaBitta

common/api-review/app.api.md

@@ -73,13 +73,18 @@ export interface FirebaseOptions {
 
 // @public
 export interface FirebaseServerApp extends FirebaseApp {
+    // (undocumented)
+    installationsAuthToken?: string;
+    // (undocumented)
+    installationsId?: string;
     name: string;
     readonly settings: FirebaseServerAppSettings;
 }
 
 // @public
 export interface FirebaseServerAppSettings extends Omit<FirebaseAppSettings, 'name'> {
     authIdToken?: string;
+    installationsAuthToken?: string;
     releaseOnDeref?: object;
 }
 

packages/app/src/errors.ts

@@ -31,7 +31,8 @@ export const enum AppError {
   IDB_WRITE = 'idb-set',
   IDB_DELETE = 'idb-delete',
   FINALIZATION_REGISTRY_NOT_SUPPORTED = 'finalization-registry-not-supported',
-  INVALID_SERVER_APP_ENVIRONMENT = 'invalid-server-app-environment'
+  INVALID_SERVER_APP_ENVIRONMENT = 'invalid-server-app-environment',
+  INVALID_SERVER_APP_INSTALLATIONS_AUTH_TOKEN = 'invalid-server-installations-auth-token'
 }
 
 const ERRORS: ErrorMap<AppError> = {
@@ -61,7 +62,9 @@ const ERRORS: ErrorMap<AppError> = {
   [AppError.FINALIZATION_REGISTRY_NOT_SUPPORTED]:
     'FirebaseServerApp deleteOnDeref field defined but the JS runtime does not support FinalizationRegistry.',
   [AppError.INVALID_SERVER_APP_ENVIRONMENT]:
-    'FirebaseServerApp is not for use in browser environments.'
+    'FirebaseServerApp is not for use in browser environments.',
+  [AppError.INVALID_SERVER_APP_INSTALLATIONS_AUTH_TOKEN]:
+    'FirebaseServerApp could not initialize due to an invalid Installations auth token'
 };
 
 interface ErrorParams {

packages/app/src/firebaseServerApp.ts

@@ -26,14 +26,15 @@ import { ComponentContainer } from '@firebase/component';
 import { FirebaseAppImpl } from './firebaseApp';
 import { ERROR_FACTORY, AppError } from './errors';
 import { name as packageName, version } from '../package.json';
+import { base64Decode } from '@firebase/util';
 
 export class FirebaseServerAppImpl
   extends FirebaseAppImpl
-  implements FirebaseServerApp
-{
+  implements FirebaseServerApp {
   private readonly _serverConfig: FirebaseServerAppSettings;
   private _finalizationRegistry: FinalizationRegistry<object> | null;
   private _refCount: number;
+  private _installationsId: string | null;
 
   constructor(
     options: FirebaseOptions | FirebaseAppImpl,
@@ -67,6 +68,20 @@ export class FirebaseServerAppImpl
       ...serverConfig
     };
 
+    // Parse the installationAuthToken if provided.
+    if (this._serverConfig.installationsAuthToken !== undefined) {
+      const thirdPart = this._serverConfig.installationsAuthToken.split(".")[1].split(".")[0];
+      const decodedToken = base64Decode(thirdPart);
+      const tokenJSON = JSON.parse(decodedToken ? decodedToken : "");
+      if (!decodedToken || !tokenJSON || tokenJSON.fid === undefined) {
+        throw ERROR_FACTORY.create(AppError.INVALID_SERVER_APP_INSTALLATIONS_AUTH_TOKEN);
+      } else {
+        this._installationsId = tokenJSON.fid;
+      }
+    } else {
+      this._installationsId = null;
+    }
+
     this._finalizationRegistry = null;
     if (typeof FinalizationRegistry !== 'undefined') {
       this._finalizationRegistry = new FinalizationRegistry(() => {
@@ -125,6 +140,20 @@ export class FirebaseServerAppImpl
     return this._serverConfig;
   }
 
+  get installationsAuthToken(): string | null {
+    this.checkDestroyed();
+    if (this._serverConfig.installationsAuthToken !== undefined) {
+      return this._serverConfig.installationsAuthToken;
+    } else {
+      return null;
+    }
+  }
+
+  get installationsId(): string | null {
+    this.checkDestroyed();
+    return this._installationsId;
+  }
+
   /**
    * This function will throw an Error if the App has already been deleted -
    * use before performing API actions on the App.

packages/app/src/public-types.ts

@@ -100,6 +100,9 @@ export interface FirebaseServerApp extends FirebaseApp {
    * ```
    */
   readonly settings: FirebaseServerAppSettings;
+
+  readonly installationsId : string | null;
+  readonly installationsAuthToken : string | null;
 }
 
 /**
@@ -196,6 +199,26 @@ export interface FirebaseServerAppSettings
    */
   authIdToken?: string;
 
+  /**
+   * An optional Installations Auth token which allows the use of Remote Config SDK in
+   * SSR enviornments.
+   *
+   * If provided, the `FirebaseServerApp` will attempt to parse the Installations id
+   * from the token.
+   * 
+   * If the token is deemed to be malformed then an error will be
+   * thrown during the invocation of `initializeServerApp`.
+   * 
+   * If the the Installations Id and the provided `installationsAuthToken` are successfully parsed,
+   * then they will be used by the Installations implementation when `getToken` and `getId` are
+   * invoked.
+   * 
+   * Attempting to use Remote Config without providing an `installationsAuthToken` here will cause
+   * Installations to throw errors when Remote Config attempts to query the Installations id and
+   * authToken.
+   */
+  installationsAuthToken?: string;
+
   /**
    * An optional object. If provided, the Firebase SDK uses a `FinalizationRegistry`
    * object to monitor the garbage collection status of the provided object. The

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

@@ -19,6 +19,8 @@ import { getInstallationEntry } from '../helpers/get-installation-entry';
 import { refreshAuthToken } from '../helpers/refresh-auth-token';
 import { FirebaseInstallationsImpl } from '../interfaces/installation-impl';
 import { Installations } from '../interfaces/public-types';
+import { _isFirebaseServerApp } from '@firebase/app';
+import { ERROR_FACTORY, ErrorCode } from '../util/errors';
 
 /**
  * Creates a Firebase Installation if there isn't one for the app and
@@ -28,6 +30,13 @@ import { Installations } from '../interfaces/public-types';
  * @public
  */
 export async function getId(installations: Installations): Promise<string> {
+  if(_isFirebaseServerApp(installations.app)) {
+    if(!installations.app.installationsId) {
+      throw ERROR_FACTORY.create(ErrorCode.SERVER_APP_MISSING_AUTH_TOKEN);
+    } 
+    return installations.app.installationsId;
+  }
+
   const installationsImpl = installations as FirebaseInstallationsImpl;
   const { installationEntry, registrationPromise } = await getInstallationEntry(
     installationsImpl

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

@@ -19,6 +19,8 @@ import { getInstallationEntry } from '../helpers/get-installation-entry';
 import { refreshAuthToken } from '../helpers/refresh-auth-token';
 import { FirebaseInstallationsImpl } from '../interfaces/installation-impl';
 import { Installations } from '../interfaces/public-types';
+import { _isFirebaseServerApp } from '@firebase/app';
+import { ERROR_FACTORY, ErrorCode } from '../util/errors';
 
 /**
  * Returns a Firebase Installations auth token, identifying the current
@@ -32,6 +34,12 @@ export async function getToken(
   installations: Installations,
   forceRefresh = false
 ): Promise<string> {
+  if(_isFirebaseServerApp(installations.app)) {
+    if(installations.app.installationsAuthToken === undefined) {
+      throw ERROR_FACTORY.create(ErrorCode.SERVER_APP_MISSING_AUTH_TOKEN);
+    } 
+    return installations.app.installationsAuthToken;
+  }
   const installationsImpl = installations as FirebaseInstallationsImpl;
   await completeInstallationRegistration(installationsImpl);
 

packages/installations/src/util/errors.ts

@@ -24,7 +24,8 @@ export const enum ErrorCode {
   INSTALLATION_NOT_FOUND = 'installation-not-found',
   REQUEST_FAILED = 'request-failed',
   APP_OFFLINE = 'app-offline',
-  DELETE_PENDING_REGISTRATION = 'delete-pending-registration'
+  DELETE_PENDING_REGISTRATION = 'delete-pending-registration',
+  SERVER_APP_MISSING_AUTH_TOKEN = 'server-app-missing-auth-token'
 }
 
 const ERROR_DESCRIPTION_MAP: { readonly [key in ErrorCode]: string } = {
@@ -36,7 +37,9 @@ const ERROR_DESCRIPTION_MAP: { readonly [key in ErrorCode]: string } = {
     '{$requestName} request failed with error "{$serverCode} {$serverStatus}: {$serverMessage}"',
   [ErrorCode.APP_OFFLINE]: 'Could not process request. Application offline.',
   [ErrorCode.DELETE_PENDING_REGISTRATION]:
-    "Can't delete installation while there is a pending registration request."
+    "Can't delete installation while there is a pending registration request.",
+  [ErrorCode.SERVER_APP_MISSING_AUTH_TOKEN]:
+    "The instance of FirebaseServerApp was not initialized with a valid installationsAuthToken"
 };
 
 interface ErrorParams {