Changes to make FirebaseToken interface internal

Author: mansisampat

packages/auth/demo/src/index.js

@@ -2094,15 +2094,16 @@ function initApp() {
   });
 
   const firebaseTokenStatus = document.getElementById('firebase-token-status');
-  setTimeout(() => {
-    if (regionalAuth.firebaseToken) {
+  setTimeout(async () => {
+    const firebaseToken = await regionalAuth.getFirebaseAccessToken();
+    if (firebaseToken) {
       firebaseTokenStatus.textContent =
-        '✅ Firebase token is set: ' + regionalAuth.firebaseToken.token;
+        '✅ Firebase token is set: ' + firebaseToken;
     } else {
       firebaseTokenStatus.textContent =
         'No CIAM token found. User not logged in.';
     }
-    console.log('firebaseToken after delay: ', regionalAuth.firebaseToken);
+    console.log('firebaseToken after delay: ', firebaseToken);
   }, 1000);
 
   tempApp = initializeApp(

packages/auth/src/core/auth/auth_impl.test.ts

@@ -32,7 +32,7 @@ import {
   testAuth,
   testUser
 } from '../../../test/helpers/mock_auth';
-import { AuthInternal } from '../../model/auth';
+import { AuthInternal, FirebaseToken } from '../../model/auth';
 import { UserInternal } from '../../model/user';
 import { PersistenceInternal } from '../persistence';
 import { inMemoryPersistence } from '../persistence/in_memory';
@@ -49,7 +49,6 @@ import * as mockFetch from '../../../test/helpers/mock_fetch';
 import { AuthErrorCode } from '../errors';
 import * as exchangeTokenModule from '../strategies/exhange_token';
 import {
-  FirebaseToken,
   PasswordValidationStatus,
   TokenRefreshHandler
 } from '../../model/public_types';
@@ -450,7 +449,7 @@ describe('core/auth/auth_impl', () => {
       await regionalAuth._updateFirebaseToken(token);
       await regionalAuth.signOut();
       expect(persistenceStub._remove).to.have.been.called;
-      expect(regionalAuth.firebaseToken).to.be.null;
+      expect(regionalAuth.getFirebaseAccessToken()).to.be.null;
     });
     it('is blocked if a beforeAuthStateChanged callback throws', async () => {
       await auth._updateCurrentUser(testUser(auth, 'test'));

packages/auth/src/core/auth/auth_impl.ts

@@ -38,7 +38,6 @@ import {
   Unsubscribe,
   PasswordValidationStatus,
   TenantConfig,
-  FirebaseToken,
   RefreshIdpTokenResult,
   TokenRefreshHandler
 } from '../../model/public_types';
@@ -51,7 +50,7 @@ import {
   Subscribe
 } from '@firebase/util';
 
-import { AuthInternal, ConfigInternal } from '../../model/auth';
+import { AuthInternal, ConfigInternal, FirebaseToken } from '../../model/auth';
 import { PopupRedirectResolverInternal } from '../../model/popup_redirect';
 import { UserInternal } from '../../model/user';
 import {
@@ -104,7 +103,7 @@ export const enum DefaultConfig {
 export class AuthImpl implements AuthInternal, _FirebaseService {
   currentUser: User | null = null;
   emulatorConfig: EmulatorConfig | null = null;
-  firebaseToken: FirebaseToken | null = null;
+  private firebaseToken: FirebaseToken | null = null;
   private tokenRefreshHandler?: TokenRefreshHandler;
   private operations = Promise.resolve();
   private persistenceManager?: PersistenceUserManager;
@@ -249,9 +248,7 @@ export class AuthImpl implements AuthInternal, _FirebaseService {
     await this._updateCurrentUser(user, /* skipBeforeStateCallbacks */ true);
   }
 
-  async getFirebaseAccessToken(
-    forceRefresh?: boolean
-  ): Promise<FirebaseToken | null> {
+  async getFirebaseAccessToken(forceRefresh?: boolean): Promise<string | null> {
     const firebaseAccessToken =
       (await this.persistenceManager?.getFirebaseToken()) ?? null;
 
@@ -262,7 +259,7 @@ export class AuthImpl implements AuthInternal, _FirebaseService {
     ) {
       this.firebaseToken = firebaseAccessToken;
       this.firebaseTokenSubscription.next(this.firebaseToken);
-      return firebaseAccessToken;
+      return firebaseAccessToken.token;
     }
 
     if (firebaseAccessToken && this.tokenRefreshHandler) {

packages/auth/src/core/auth/firebase_internal.ts

@@ -51,7 +51,8 @@ export class AuthInterop implements FirebaseAuthInternal {
           'Refresh token is not a valid operation for Regional Auth instance initialized.'
         );
       }
-      return this.getTokenForRegionalAuth();
+      const accessToken = await this.getTokenForRegionalAuth(forceRefresh);
+      return accessToken ? { accessToken } : null;
     }
     if (!this.auth.currentUser) {
       return null;
@@ -103,23 +104,11 @@ export class AuthInterop implements FirebaseAuthInternal {
     }
   }
 
-  private async getTokenForRegionalAuth(): Promise<{
-    accessToken: string;
-  } | null> {
-    if (!this.auth.firebaseToken) {
-      return null;
-    }
-
-    if (
-      !this.auth.firebaseToken.expirationTime ||
-      Date.now() >
-        this.auth.firebaseToken.expirationTime - this.TOKEN_EXPIRATION_BUFFER
-    ) {
-      await this.auth._updateFirebaseToken(null);
-      return null;
-    }
+  private async getTokenForRegionalAuth(
+    forceRefresh?: boolean
+  ): Promise<string | null> {
+    const firebaseToken = await this.auth.getFirebaseAccessToken(forceRefresh);
 
-    const accessToken = await this.auth.firebaseToken.token;
-    return { accessToken };
+    return firebaseToken;
   }
 }

packages/auth/src/core/persistence/persistence_user_manager.ts

@@ -16,8 +16,7 @@
  */
 
 import { getAccountInfo } from '../../api/account_management/account';
-import { ApiKey, AppName, AuthInternal } from '../../model/auth';
-import { FirebaseToken } from '../../model/public_types';
+import { ApiKey, AppName, AuthInternal, FirebaseToken } from '../../model/auth';
 import { UserInternal } from '../../model/user';
 import { PersistedBlob, PersistenceInternal } from '../persistence';
 import { UserImpl } from '../user/user_impl';

packages/auth/src/model/auth.ts

@@ -20,7 +20,6 @@ import {
   AuthSettings,
   Config,
   EmulatorConfig,
-  FirebaseToken,
   PasswordPolicy,
   PasswordValidationStatus,
   PopupRedirectResolver,
@@ -58,6 +57,16 @@ export interface ConfigInternal extends Config {
   clientPlatform: ClientPlatform;
 }
 
+/**
+ * @internal
+ */
+export interface FirebaseToken {
+  // The firebase access token (JWT signed by Firebase Auth).
+  readonly token: string;
+  // The time in milliseconds when the access token expires.
+  readonly expirationTime: number;
+}
+
 /**
  * UserInternal and AuthInternal reference each other, so both of them are included in the public typings.
  * In order to exclude them, we mark them as internal explicitly.
@@ -67,7 +76,7 @@ export interface ConfigInternal extends Config {
 export interface AuthInternal extends Auth {
   currentUser: User | null;
   emulatorConfig: EmulatorConfig | null;
-  getFirebaseAccessToken(forceRefresh?: boolean): Promise<FirebaseToken | null>;
+  getFirebaseAccessToken(forceRefresh?: boolean): Promise<string | null>;
   _agentRecaptchaConfig: RecaptchaConfig | null;
   _tenantRecaptchaConfigs: Record<string, RecaptchaConfig>;
   _projectPasswordPolicy: PasswordPolicy | null;

packages/auth/src/model/public_types.ts

@@ -398,14 +398,6 @@ export interface Auth {
    * {@link @firebase/app#FirebaseServerApp}.
    */
   signOut(): Promise<void>;
-  /**
-   * The token response initialized via {@link exchangeToken} endpoint.
-   *
-   * @remarks
-   * This field is only supported for {@link Auth} instance that have defined
-   * {@link TenantConfig}.
-   */
-  readonly firebaseToken: FirebaseToken | null;
 }
 
 /**
@@ -1038,13 +1030,6 @@ export interface ReactNativeAsyncStorage {
   removeItem(key: string): Promise<void>;
 }
 
-export interface FirebaseToken {
-  // The firebase access token (JWT signed by Firebase Auth).
-  readonly token: string;
-  // The time in milliseconds when the access token expires.
-  readonly expirationTime: number;
-}
-
 /**
  * A user account.
  *