Use getToken instead of getFirebaseToken

Author: mansisampat

common/api-review/auth.api.md

@@ -88,6 +88,7 @@ export interface Auth {
     readonly config: Config;
     readonly currentUser: User | null;
     readonly emulatorConfig: EmulatorConfig | null;
+    readonly firebaseToken: FirebaseToken | null;
     languageCode: string | null;
     readonly name: string;
     onAuthStateChanged(nextOrObserver: NextOrObserver<User | null>, error?: ErrorFn, completed?: CompleteFn): Unsubscribe;
@@ -364,7 +365,7 @@ export interface EmulatorConfig {
 
 export { ErrorFn }
 
-// @public (undocumented)
+// @public
 export function exchangeToken(auth: Auth, idpConfigId: string, customToken: string): Promise<string>;
 
 // Warning: (ae-forgotten-export) The symbol "BaseOAuthProvider" needs to be exported by the entry point index.d.ts
@@ -388,6 +389,14 @@ export const FactorId: {
 // @public
 export function fetchSignInMethodsForEmail(auth: Auth, email: string): Promise<string[]>;
 
+// @public (undocumented)
+export interface FirebaseToken {
+    // (undocumented)
+    readonly expirationTime: number;
+    // (undocumented)
+    readonly token: string;
+}
+
 // @public
 export function getAdditionalUserInfo(userCredential: UserCredential): AdditionalUserInfo | null;
 

packages/auth-interop-types/index.d.ts

@@ -21,7 +21,6 @@ export interface FirebaseAuthTokenData {
 
 export interface FirebaseAuthInternal {
   getToken(refreshToken?: boolean): Promise<FirebaseAuthTokenData | null>;
-  getFirebaseToken(): Promise<FirebaseAuthTokenData | null>;
   getUid(): string | null;
   addAuthTokenListener(fn: (token: string | null) => void): void;
   removeAuthTokenListener(fn: (token: string | null) => void): void;

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

@@ -22,6 +22,7 @@ import { AuthInternal } from '../../model/auth';
 import { UserInternal } from '../../model/user';
 import { _assert } from '../util/assert';
 import { AuthErrorCode } from '../errors';
+import { _logWarn } from '../util/log';
 
 interface TokenListener {
   (tok: string | null): unknown;
@@ -44,6 +45,12 @@ export class AuthInterop implements FirebaseAuthInternal {
   ): Promise<{ accessToken: string } | null> {
     this.assertAuthConfigured();
     await this.auth._initializationPromise;
+    if (this.auth.tenantConfig) {
+      if (forceRefresh) {
+        _logWarn("Refresh token is not a valid operation for Regional Auth instance initialized.");
+      }
+      return this.getTokenForRegionalAuth();
+    }
     if (!this.auth.currentUser) {
       return null;
     }
@@ -52,27 +59,6 @@ export class AuthInterop implements FirebaseAuthInternal {
     return { accessToken };
   }
 
-  async getFirebaseToken(): Promise<{ accessToken: string } | null> {
-    this.assertAuthConfigured();
-    await this.auth._initializationPromise;
-    this.assertRegionalAuthConfigured();
-    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;
-    }
-
-    const accessToken = await this.auth.firebaseToken.token;
-    return { accessToken };
-  }
-
   addAuthTokenListener(listener: TokenListener): void {
     this.assertAuthConfigured();
     if (this.internalListeners.has(listener)) {
@@ -118,4 +104,22 @@ export class AuthInterop implements FirebaseAuthInternal {
       this.auth._stopProactiveRefresh();
     }
   }
+
+  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;
+    }
+
+    const accessToken = await this.auth.firebaseToken.token;
+    return { accessToken };
+  }
 }