Fix some incorrect typings / missing pieces in the new auth SDK (#4187)

* Fix incorrect type for setPersistence, add missing static methods to OAuthCredential

* Formatting

* api review

* Fix the signature of getAuth / initializeAuth

* Fix tests

Author: sam-gc

common/api-review/auth-exp.api.md

@@ -146,7 +146,7 @@ export function fetchSignInMethodsForEmail(auth: externs.Auth, email: string): P
 export function getAdditionalUserInfo(userCredential: externs.UserCredential): externs.AdditionalUserInfo | null;
 
 // @public
-export function getAuth(app?: FirebaseApp): Auth;
+export function getAuth(app: FirebaseApp): Auth;
 
 // @public
 export function getIdToken(user: externs.User, forceRefresh?: boolean): Promise<string>;
@@ -186,7 +186,7 @@ export const indexedDBLocalPersistence: externs.Persistence;
 // Warning: (ae-forgotten-export) The symbol "Dependencies" needs to be exported by the entry point index.d.ts
 //
 // @public (undocumented)
-export function initializeAuth(app?: FirebaseApp, deps?: Dependencies): externs.Auth;
+export function initializeAuth(app: FirebaseApp, deps?: Dependencies): externs.Auth;
 
 // @public
 export const inMemoryPersistence: externs.Persistence;
@@ -247,8 +247,10 @@ export class OAuthProvider implements externs.AuthProvider {
     constructor(providerId: string);
     addScope(scope: string): externs.AuthProvider;
     credential(params: OAuthCredentialOptions): externs.OAuthCredential;
+    static credentialFromError(error: FirebaseError): externs.OAuthCredential | null;
     // (undocumented)
     static credentialFromJSON(json: object | string): externs.OAuthCredential;
+    static credentialFromResult(userCredential: externs.UserCredential): externs.OAuthCredential | null;
     // @internal (undocumented)
     defaultLanguageCode: string | null;
     getCustomParameters(): CustomParameters;
@@ -363,7 +365,7 @@ export function sendPasswordResetEmail(auth: externs.Auth, email: string, action
 export function sendSignInLinkToEmail(auth: externs.Auth, email: string, actionCodeSettings?: externs.ActionCodeSettings): Promise<void>;
 
 // @public
-export function setPersistence(auth: externs.Auth, persistence: externs.Persistence): void;
+export function setPersistence(auth: externs.Auth, persistence: externs.Persistence): Promise<void>;
 
 // @public
 export function signInAnonymously(auth: externs.Auth): Promise<externs.UserCredential>;

packages-exp/auth-exp/index.node.ts

@@ -42,7 +42,7 @@ FetchProvider.initialize(
 // Core functionality shared by all clients
 export * from './src';
 
-export function getAuth(app?: FirebaseApp): Auth {
+export function getAuth(app: FirebaseApp): Auth {
   return initializeAuth(app);
 }
 

packages-exp/auth-exp/index.rn.ts

@@ -39,7 +39,7 @@ export const reactNativeLocalPersistence = getReactNativePersistence(
   AsyncStorage
 );
 
-export function getAuth(app?: FirebaseApp): Auth {
+export function getAuth(app: FirebaseApp): Auth {
   return initializeAuth(app, {
     persistence: reactNativeLocalPersistence
   });

packages-exp/auth-exp/index.ts

@@ -70,7 +70,7 @@ export { PhoneMultiFactorGenerator } from './src/platform_browser/mfa/assertions
  *
  * @public
  */
-export function getAuth(app?: FirebaseApp): Auth {
+export function getAuth(app: FirebaseApp): Auth {
   return initializeAuth(app, {
     popupRedirectResolver: browserPopupRedirectResolver,
     persistence: [indexedDBLocalPersistence, browserLocalPersistence]

packages-exp/auth-exp/index.webworker.ts

@@ -15,7 +15,8 @@
  * limitations under the License.
  */
 
-import { _getProvider, getApp } from '@firebase/app-exp';
+import { _getProvider } from '@firebase/app-exp';
+import { FirebaseApp } from '@firebase/app-types-exp';
 import { Auth } from '@firebase/auth-types-exp';
 
 import { AuthImpl } from './src/core/auth/auth_impl';
@@ -34,7 +35,7 @@ export { indexedDBLocalPersistence } from './src/platform_browser/persistence/in
 
 registerAuth(ClientPlatform.WORKER);
 
-export function getAuth(app = getApp()): Auth {
+export function getAuth(app: FirebaseApp): Auth {
   // Unlike the other environments, we need to explicitly check if indexedDb is
   // available. That means doing the whole rigamarole
   const auth = _getProvider(

packages-exp/auth-exp/src/core/auth/initialize.ts

@@ -15,7 +15,7 @@
  * limitations under the License.
  */
 
-import { _getProvider, getApp } from '@firebase/app-exp';
+import { _getProvider } from '@firebase/app-exp';
 import { FirebaseApp } from '@firebase/app-types-exp';
 import * as externs from '@firebase/auth-types-exp';
 
@@ -26,7 +26,7 @@ import { AuthImpl } from './auth_impl';
 
 /** @public */
 export function initializeAuth(
-  app: FirebaseApp = getApp(),
+  app: FirebaseApp,
   deps?: Dependencies
 ): externs.Auth {
   const auth = _getProvider(app, 'auth-exp').getImmediate() as AuthImpl;

packages-exp/auth-exp/src/core/index.ts

@@ -38,14 +38,15 @@ export { debugErrorMap, prodErrorMap } from './errors';
  *
  * @param auth - The Auth instance.
  * @param persistence - The {@link @firebase/auth-types#Persistence} to use.
+ * @returns A promise that resolves once the persistence change has completed
  *
  * @public
  */
 export function setPersistence(
   auth: externs.Auth,
   persistence: externs.Persistence
-): void {
-  auth.setPersistence(persistence);
+): Promise<void> {
+  return auth.setPersistence(persistence);
 }
 /**
  * Adds an observer for changes to the signed-in user's ID token, which includes sign-in,

packages-exp/auth-exp/src/core/providers/oauth.test.ts

@@ -0,0 +1,98 @@
+/**
+ * @license
+ * Copyright 2020 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { expect } from 'chai';
+
+import {
+  OperationType,
+  ProviderId,
+  SignInMethod
+} from '@firebase/auth-types-exp';
+
+import { TEST_ID_TOKEN_RESPONSE } from '../../../test/helpers/id_token_response';
+import { testUser, testAuth } from '../../../test/helpers/mock_auth';
+import { TaggedWithTokenResponse } from '../../model/id_token';
+import { AuthErrorCode } from '../errors';
+import { UserCredentialImpl } from '../user/user_credential_impl';
+import { _createError } from '../util/assert';
+import { OAuthProvider } from './oauth';
+
+describe('core/providers/oauth', () => {
+  it('generates the correct type of oauth credential', () => {
+    const cred = new OAuthProvider('google.com').credential({
+      idToken: 'id-token',
+      accessToken: 'access-token'
+    });
+    expect(cred.accessToken).to.eq('access-token');
+    expect(cred.idToken).to.eq('id-token');
+    expect(cred.providerId).to.eq(ProviderId.GOOGLE);
+    expect(cred.signInMethod).to.eq(SignInMethod.GOOGLE);
+  });
+
+  it('credentialFromResult creates the cred from a tagged result', async () => {
+    const auth = await testAuth();
+    const userCred = new UserCredentialImpl({
+      user: testUser(auth, 'uid'),
+      providerId: ProviderId.GOOGLE,
+      _tokenResponse: {
+        ...TEST_ID_TOKEN_RESPONSE,
+        oauthAccessToken: 'access-token',
+        oauthIdToken: 'id-token',
+        providerId: ProviderId.FACEBOOK
+      },
+      operationType: OperationType.SIGN_IN
+    });
+    const cred = OAuthProvider.credentialFromResult(userCred)!;
+    expect(cred.accessToken).to.eq('access-token');
+    expect(cred.idToken).to.eq('id-token');
+    expect(cred.providerId).to.eq(ProviderId.FACEBOOK);
+    expect(cred.signInMethod).to.eq(SignInMethod.FACEBOOK);
+  });
+
+  it('credentialFromResult returns null if provider ID not specified', async () => {
+    const auth = await testAuth();
+    const userCred = new UserCredentialImpl({
+      user: testUser(auth, 'uid'),
+      providerId: ProviderId.GOOGLE,
+      _tokenResponse: {
+        ...TEST_ID_TOKEN_RESPONSE,
+        oauthAccessToken: 'access-token',
+        oauthIdToken: 'id-token'
+      },
+      operationType: OperationType.SIGN_IN
+    });
+    expect(OAuthProvider.credentialFromResult(userCred)).to.be.null;
+  });
+
+  it('credentialFromError creates the cred from a tagged error', () => {
+    const error = _createError(AuthErrorCode.NEED_CONFIRMATION, {
+      appName: 'foo'
+    });
+    (error.customData! as TaggedWithTokenResponse)._tokenResponse = {
+      ...TEST_ID_TOKEN_RESPONSE,
+      oauthAccessToken: 'access-token',
+      oauthIdToken: 'id-token',
+      providerId: ProviderId.FACEBOOK
+    };
+
+    const cred = OAuthProvider.credentialFromError(error)!;
+    expect(cred.accessToken).to.eq('access-token');
+    expect(cred.idToken).to.eq('id-token');
+    expect(cred.providerId).to.eq(ProviderId.FACEBOOK);
+    expect(cred.signInMethod).to.eq(SignInMethod.FACEBOOK);
+  });
+});

packages-exp/auth-exp/src/core/providers/oauth.ts

@@ -21,6 +21,10 @@ import { _assert } from '../util/assert';
 import { AuthErrorCode } from '../errors';
 
 import { OAuthCredential } from '../credentials/oauth';
+import { UserCredential } from '../../model/user';
+import { FirebaseError } from '@firebase/util';
+import { TaggedWithTokenResponse } from '../../model/id_token';
+import { SignInWithIdpResponse } from '../../../internal';
 
 /**
  * Map of OAuth Custom Parameters.
@@ -203,4 +207,71 @@ export class OAuthProvider implements externs.AuthProvider {
   getScopes(): string[] {
     return [...this.scopes];
   }
+
+  /**
+   * Used to extract the underlying {@link OAuthCredential} from a {@link @firebase/auth-types#UserCredential}.
+   *
+   * @param userCredential - The user credential.
+   */
+  static credentialFromResult(
+    userCredential: externs.UserCredential
+  ): externs.OAuthCredential | null {
+    return OAuthProvider.oauthCredentialFromTaggedObject(
+      userCredential as UserCredential
+    );
+  }
+  /**
+   * Used to extract the underlying {@link OAuthCredential} from a {@link @firebase/auth-types#AuthError} which was
+   * thrown during a sign-in, link, or reauthenticate operation.
+   *
+   * @param userCredential - The user credential.
+   */
+  static credentialFromError(
+    error: FirebaseError
+  ): externs.OAuthCredential | null {
+    return OAuthProvider.oauthCredentialFromTaggedObject(
+      (error.customData || {}) as TaggedWithTokenResponse
+    );
+  }
+
+  // This needs to have a different name so it doesn't conflict with the
+  // subclasses
+  private static oauthCredentialFromTaggedObject({
+    _tokenResponse: tokenResponse
+  }: TaggedWithTokenResponse): externs.OAuthCredential | null {
+    if (!tokenResponse) {
+      return null;
+    }
+
+    const {
+      oauthIdToken,
+      oauthAccessToken,
+      oauthTokenSecret,
+      pendingToken,
+      nonce,
+      providerId
+    } = tokenResponse as SignInWithIdpResponse;
+    if (
+      !oauthAccessToken &&
+      !oauthTokenSecret &&
+      !oauthIdToken &&
+      !pendingToken
+    ) {
+      return null;
+    }
+
+    if (!providerId) {
+      return null;
+    }
+
+    try {
+      return new OAuthProvider(providerId).credential({
+        idToken: oauthIdToken,
+        accessToken: oauthAccessToken,
+        rawNonce: nonce
+      });
+    } catch (e) {
+      return null;
+    }
+  }
 }

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

@@ -215,7 +215,7 @@ export interface Auth {
    *
    * @param persistence - The {@link Persistence} to use.
    */
-  setPersistence(persistence: Persistence): void;
+  setPersistence(persistence: Persistence): Promise<void>;
   /**
    * The Auth instance's language code.
    *