Add redirect strategy (#3416)

* Redirect strategy

* Redirect strategy updates & test

* Formatting

* Moving the ts files in demo/ to 'broken' since they cause 'yarn test' to break and Alex is unavailable this week

Author: sam-gc

packages-exp/auth-exp/demo/src/config.d.ts renamed to packages-exp/auth-exp/demo/src/config.d.ts.broken

@@ -31,7 +31,6 @@ import {
   createUserWithEmailAndPassword,
   EmailAuthProvider,
   fetchSignInMethodsForEmail,
-  getMultiFactorResolver,
   indexedDBLocalPersistence,
   initializeAuth,
   inMemoryPersistence,
@@ -54,10 +53,15 @@ import {
   updatePassword,
   updateProfile,
   verifyPasswordResetCode,
+  getMultiFactorResolver,
   OAuthProvider,
   signInWithPopup,
   linkWithPopup,
   reauthenticateWithPopup,
+  signInWithRedirect,
+  linkWithRedirect,
+  reauthenticateWithRedirect,
+  getRedirectResult,
   browserPopupRedirectResolver
 } from '@firebase/auth-exp/dist/index.browser';
 
@@ -1240,12 +1244,16 @@ function signInWithPopupRedirect(provider) {
   const glob = {
     signInWithPopup,
     linkWithPopup,
-    reauthenticateWithPopup
+    reauthenticateWithPopup,
+    signInWithRedirect,
+    linkWithRedirect,
+    reauthenticateWithRedirect
   };
   let action = $('input[name=popup-redirect-action]:checked').val();
   let type = $('input[name=popup-redirect-type]:checked').val();
   let method = null;
   let inst = null;
+
   if (action == 'link' || action == 'reauthenticate') {
     if (!activeUser()) {
       alertError('No user logged in.');
@@ -1310,13 +1318,14 @@ function signInWithPopupRedirect(provider) {
       onAuthError
     );
   } else {
-    alertNotImplemented();
-    // try {
-    //   inst[method](provider).catch(onAuthError);
-    // } catch (error) {
-    //   console.log('Error while calling ' + method);
-    //   console.error(error);
-    // }
+    try {
+      glob[method](inst, provider, browserPopupRedirectResolver).catch(
+        onAuthError
+      );
+    } catch (error) {
+      console.log('Error while calling ' + method);
+      console.error(error);
+    }
   }
 }
 
@@ -1334,24 +1343,26 @@ function onAuthUserCredentialSuccess(result) {
  * Displays redirect result.
  */
 function onGetRedirectResult() {
-  alertNotImplemented();
-  // auth.getRedirectResult().then(function(response) {
-  //   log('Redirect results:');
-  //   if (response.credential) {
-  //     log('Credential:');
-  //     log(response.credential);
-  //   } else {
-  //     log('No credential');
-  //   }
-  //   if (response.user) {
-  //     log('User\'s id:');
-  //     log(response.user.uid);
-  //   } else {
-  //     log('No user');
-  //   }
-  //   logAdditionalUserInfo(response);
-  //   console.log(response);
-  // }, onAuthError);
+  getRedirectResult(auth, browserPopupRedirectResolver).then(function(
+    response
+  ) {
+    log('Redirect results:');
+    if (response.credential) {
+      log('Credential:');
+      log(response.credential);
+    } else {
+      log('No credential');
+    }
+    if (response.user) {
+      log("User's id:");
+      log(response.user.uid);
+    } else {
+      log('No user');
+    }
+    logAdditionalUserInfo(response);
+    console.log(response);
+  },
+  onAuthError);
 }
 
 /**
@@ -1632,7 +1643,8 @@ function initApp() {
   log('Initializing app...');
   app = initializeApp(config);
   auth = initializeAuth(app, {
-    persistence: browserSessionPersistence
+    persistence: browserSessionPersistence,
+    popupRedirectResolver: browserPopupRedirectResolver
   });
 
   // tempApp = initializeApp({
@@ -1764,11 +1776,13 @@ function initApp() {
   }
 
   // We check for redirect result to refresh user's data.
-  // TODO: redirect result
-  // auth.getRedirectResult().then(function(response) {
-  //   refreshUserData();
-  //   logAdditionalUserInfo(response);
-  // }, onAuthError);
+  getRedirectResult(auth, browserPopupRedirectResolver).then(function(
+    response
+  ) {
+    refreshUserData();
+    logAdditionalUserInfo(response);
+  },
+  onAuthError);
 
   // Bootstrap tooltips.
   $('[data-toggle="tooltip"]').tooltip();

packages-exp/auth-exp/demo/src/index.js

@@ -38,6 +38,12 @@ export {
   linkWithPopup,
   reauthenticateWithPopup
 } from './src/core/strategies/popup';
+export {
+  signInWithRedirect,
+  linkWithRedirect,
+  reauthenticateWithRedirect,
+  getRedirectResult
+} from './src/core/strategies/redirect';
 
 // platform_browser
 export { RecaptchaVerifier } from './src/platform_browser/recaptcha/recaptcha_verifier';

packages-exp/auth-exp/demo/src/worker/index.ts renamed to packages-exp/auth-exp/demo/src/worker/index.ts.broken

@@ -145,7 +145,8 @@ describe('src/core/auth/auth_event_manager', () => {
       consumer = makeConsumer([
         AuthEventType.SIGN_IN_VIA_REDIRECT,
         AuthEventType.LINK_VIA_REDIRECT,
-        AuthEventType.REAUTH_VIA_REDIRECT
+        AuthEventType.REAUTH_VIA_REDIRECT,
+        AuthEventType.UNKNOWN
       ]);
     });
 
@@ -181,15 +182,13 @@ describe('src/core/auth/auth_event_manager', () => {
       expect(consumerB.onAuthEvent).not.to.have.been.called;
     });
 
-    it('unknown auth error prevents consumption of future redirect events', () => {
+    it('queues unknown events', () => {
       const event = makeEvent(AuthEventType.UNKNOWN);
       event.error = { code: 'auth/no-auth-event' } as AuthEventError;
       expect(manager.onEvent(event)).to.be.true;
-      expect(manager.onEvent(makeEvent(AuthEventType.SIGN_IN_VIA_REDIRECT))).to
-        .be.false;
 
       manager.registerConsumer(consumer);
-      expect(consumer.onAuthEvent).not.to.have.been.called;
+      expect(consumer.onAuthEvent).to.have.been.calledWith(event);
     });
   });
 });

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

@@ -47,13 +47,6 @@ export class AuthEventManager implements EventManager {
   }
 
   onEvent(event: AuthEvent): boolean {
-    if (isNullRedirectEvent(event)) {
-      // A null redirect event comes through as the first event when no pending
-      // redirect actions are in the auth domain
-      this.hasHandledPotentialRedirect = true;
-      return true;
-    }
-
     let handled = false;
     this.consumers.forEach(consumer => {
       if (this.isEventForConsumer(event, consumer)) {
@@ -62,7 +55,7 @@ export class AuthEventManager implements EventManager {
       }
     });
 
-    if (this.hasHandledPotentialRedirect || !isRedirectEvent(event.type)) {
+    if (this.hasHandledPotentialRedirect || !isRedirectEvent(event)) {
       // If we've already seen a redirect before, or this is a popup event,
       // bail now
       return handled;
@@ -80,7 +73,7 @@ export class AuthEventManager implements EventManager {
   }
 
   private sendToConsumer(event: AuthEvent, consumer: AuthEventConsumer): void {
-    if (event.error) {
+    if (event.error && !isNullRedirectEvent(event)) {
       const code =
         (event.error.code?.split('auth/')[1] as AuthErrorCode) ||
         AuthErrorCode.INTERNAL_ERROR;
@@ -112,12 +105,14 @@ function isNullRedirectEvent({ type, error }: AuthEvent): boolean {
   );
 }
 
-function isRedirectEvent(type: AuthEventType): boolean {
-  switch (type) {
+function isRedirectEvent(event: AuthEvent): boolean {
+  switch (event.type) {
     case AuthEventType.SIGN_IN_VIA_REDIRECT:
     case AuthEventType.LINK_VIA_REDIRECT:
     case AuthEventType.REAUTH_VIA_REDIRECT:
       return true;
+    case AuthEventType.UNKNOWN:
+      return isNullRedirectEvent(event);
     default:
       return false;
   }

packages-exp/auth-exp/src/core/auth/auth_event_manager.test.ts

@@ -60,6 +60,7 @@ export class AuthImpl implements Auth {
   private idTokenSubscription = new Subscription<User>(this);
   private redirectUser: User | null = null;
   _isInitialized = false;
+  _popupRedirectResolver: PopupRedirectResolver | null = null;
 
   // Tracks the last notified UID for state change listeners to prevent
   // repeated calls to the callbacks
@@ -79,21 +80,23 @@ export class AuthImpl implements Auth {
     popupRedirectResolver?: externs.PopupRedirectResolver
   ): Promise<void> {
     return this.queue(async () => {
+      if (popupRedirectResolver) {
+        this._popupRedirectResolver = _getInstance(popupRedirectResolver);
+      }
+
       this.persistenceManager = await PersistenceUserManager.create(
         this,
         persistenceHierarchy
       );
 
-      await this.initializeCurrentUser(popupRedirectResolver);
+      await this.initializeCurrentUser();
 
       this._isInitialized = true;
       this.notifyAuthListeners();
     });
   }
 
-  private async initializeCurrentUser(
-    popupRedirectResolver?: externs.PopupRedirectResolver
-  ): Promise<void> {
+  private async initializeCurrentUser(): Promise<void> {
     const storedUser = await this.assertedPersistence.getCurrentUser();
     if (!storedUser) {
       return this.directlySetCurrentUser(storedUser);
@@ -104,16 +107,12 @@ export class AuthImpl implements Auth {
       return this.reloadAndSetCurrentUserOrClear(storedUser);
     }
 
-    assert(popupRedirectResolver, this.name, AuthErrorCode.ARGUMENT_ERROR);
-    const resolver: PopupRedirectResolver = _getInstance(popupRedirectResolver);
-
-    this.redirectPersistenceManager = await PersistenceUserManager.create(
-      this,
-      [_getInstance(resolver._redirectPersistence)],
-      _REDIRECT_USER_KEY_NAME
+    assert(
+      this._popupRedirectResolver,
+      this.name,
+      AuthErrorCode.ARGUMENT_ERROR
     );
-
-    this.redirectUser = await this.redirectPersistenceManager.getCurrentUser();
+    await this.getOrInitRedirectPersistenceManager();
 
     // If the redirect user's event ID matches the current user's event ID,
     // DO NOT reload the current user, otherwise they'll be cleared from storage.
@@ -189,11 +188,41 @@ export class AuthImpl implements Auth {
     );
   }
 
-  async _setRedirectUser(user: User): Promise<void> {
-    return this.redirectPersistenceManager?.setCurrentUser(user);
+  async _setRedirectUser(
+    user: User | null,
+    popupRedirectResolver?: externs.PopupRedirectResolver
+  ): Promise<void> {
+    const redirectManager = await this.getOrInitRedirectPersistenceManager(
+      popupRedirectResolver
+    );
+    return user === null
+      ? redirectManager.removeCurrentUser()
+      : redirectManager.setCurrentUser(user);
   }
 
-  _redirectUserForId(id: string): User | null {
+  private async getOrInitRedirectPersistenceManager(
+    popupRedirectResolver?: externs.PopupRedirectResolver
+  ): Promise<PersistenceUserManager> {
+    if (!this.redirectPersistenceManager) {
+      const resolver: PopupRedirectResolver | null =
+        (popupRedirectResolver && _getInstance(popupRedirectResolver)) ||
+        this._popupRedirectResolver;
+      assert(resolver, this.name, AuthErrorCode.ARGUMENT_ERROR);
+      this.redirectPersistenceManager = await PersistenceUserManager.create(
+        this,
+        [_getInstance(resolver._redirectPersistence)],
+        _REDIRECT_USER_KEY_NAME
+      );
+      this.redirectUser = await this.redirectPersistenceManager.getCurrentUser();
+    }
+
+    return this.redirectPersistenceManager;
+  }
+
+  async _redirectUserForId(id: string): Promise<User | null> {
+    // Make sure we've cleared any pending ppersistence actions
+    await this.queue(async () => {});
+
     if (this.currentUser?._redirectEventId === id) {
       return this.currentUser;
     }

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

@@ -144,7 +144,7 @@ describe('src/core/strategies/abstract_popup_redirect_operation', () => {
 
     it('emits the user credential returned from idp task', async () => {
       finishPromise(authEvent());
-      const cred = await operation.execute();
+      const cred = (await operation.execute())!;
       expect(cred.user.uid).to.eq('uid');
       expect(cred.credential).to.be.null;
       expect(cred.operationType).to.eq(OperationType.SIGN_IN);

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

@@ -31,7 +31,7 @@ import { debugAssert, fail } from '../util/assert';
 import { _link, _reauth, _signIn, IdpTask, IdpTaskParams } from './idp';
 
 interface PendingPromise {
-  resolve: (cred: UserCredential) => void;
+  resolve: (cred: UserCredential | null) => void;
   reject: (error: Error) => void;
 }
 
@@ -58,8 +58,8 @@ export abstract class AbstractPopupRedirectOperation
 
   abstract onExecution(): Promise<void>;
 
-  execute(): Promise<UserCredential> {
-    return new Promise<UserCredential>(async (resolve, reject) => {
+  execute(): Promise<UserCredential | null> {
+    return new Promise<UserCredential | null>(async (resolve, reject) => {
       this.pendingPromise = { resolve, reject };
 
       try {
@@ -115,7 +115,7 @@ export abstract class AbstractPopupRedirectOperation
     }
   }
 
-  protected resolve(cred: UserCredential): void {
+  protected resolve(cred: UserCredential | null): void {
     debugAssert(this.pendingPromise, 'Pending promise was never set');
     this.pendingPromise.resolve(cred);
     this.unregisterAndCleanUp();