resolved code review comments and updated tests

Author: AngelAngelXie

packages/auth/demo/src/index.js

@@ -130,7 +130,7 @@ function activeUser() {
  * Returns the active user after sign in (i.e. currentUser or lastUser).
  * @return {!firebase.User}
  */
-async function getActiveUserAfterSignIn() {
+async function getActiveUserBlocking() {
   const type = $('input[name=toggle-user-selection]:checked').val();
   if (type === 'lastUser') {
     return lastUser;
@@ -150,7 +150,7 @@ async function getActiveUserAfterSignIn() {
  */
 async function refreshUserData() {
   try {
-    let user = await getActiveUserAfterSignIn();
+    let user = await getActiveUserBlocking();
     if (user) {
       $('.profile').show();
       $('body').addClass('user-info-displayed');
@@ -456,7 +456,6 @@ function onReauthenticateWithEmailLink() {
   const link = $('#link-with-email-link-link').val() || undefined;
   const credential = EmailAuthProvider.credentialWithLink(email, link);
   // This will not set auth.currentUser to lastUser if the lastUser is reauthenticated.
-
   reauthenticateWithCredential(activeUser(), credential).then(result => {
     logAdditionalUserInfo(result);
     refreshUserData();

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

@@ -789,24 +789,18 @@ describe('core/auth/auth_impl', () => {
 
   describe('AuthStateReady', () => {
     let user: UserInternal;
-    let onAuthStateChangedCallback: sinon.SinonSpy;
     let authStateChangedSpy: sinon.SinonSpy;
 
     beforeEach(async () => {
       user = testUser(auth, 'uid');
 
-      onAuthStateChangedCallback = sinon.spy();
-      auth.onAuthStateChanged(onAuthStateChangedCallback);
       authStateChangedSpy = sinon.spy(auth, 'onAuthStateChanged');
 
       await auth._updateCurrentUser(null);
     });
 
-    //case one: if(this.currentUser) is true --> resolves immediately
     it('immediately returns resolved promise if the user is previously logged in', async () => {
-      expect(onAuthStateChangedCallback).to.be.calledOnce;
       await auth._updateCurrentUser(user);
-      expect(onAuthStateChangedCallback).to.be.calledTwice;
 
       await auth
         .authStateReady()
@@ -817,11 +811,8 @@ describe('core/auth/auth_impl', () => {
         .catch(error => {
           throw new Error(error);
         });
-
-      expect(onAuthStateChangedCallback).to.be.calledTwice;
     });
 
-    //case two: if(this.currentUser) is false --> calls onAuthStateChanged
     it('returns resolved promise once the user is initialized to object of type UserInternal', async () => {
       expect(authStateChangedSpy).to.not.have.been.called;
       const promiseVar = auth.authStateReady();
@@ -831,19 +822,16 @@ describe('core/auth/auth_impl', () => {
 
       await promiseVar
         .then(() => {
-          // onAuthStateChangedCallback();
           expect(auth.currentUser).to.eq(user);
         })
         .catch(error => {
           throw new Error(error);
         });
 
       expect(authStateChangedSpy).to.be.calledOnce;
-      // expect(onAuthStateChangedCallback).to.be.calledThrice;
     });
 
-    //case three: if user logged out more than once, promise should still be resolved with currentUser remained as null
-    it('resolves promise with currentUser remains as null when user logs out more than once', async () => {
+    it('resolves the promise during repeated logout', async () => {
       expect(authStateChangedSpy).to.not.have.been.called;
       const promiseVar = auth.authStateReady();
       expect(authStateChangedSpy).to.be.calledOnce;
@@ -861,7 +849,6 @@ describe('core/auth/auth_impl', () => {
       expect(authStateChangedSpy).to.be.calledOnce;
     });
 
-    //case four: user sign in failed, expect promise to resolve and allow currentUser to be null.
     it('resolves the promise with currentUser remain null during log in failure', async () => {
       expect(authStateChangedSpy).to.not.have.been.called;
       const promiseVar = auth.authStateReady();
@@ -886,7 +873,6 @@ describe('core/auth/auth_impl', () => {
       expect(authStateChangedSpy).to.be.calledOnce;
     });
 
-    //case five: user sign in delay, promise should be resolved after delay.
     it('resolves the promise in a delayed user log in process', async () => {
       setTimeout(async () => {
         await auth._updateCurrentUser(user);

packages/auth/src/model/public_types.ts

@@ -293,7 +293,8 @@ export interface Auth {
   ): Unsubscribe;
   /**
    * return a promise that resolves immediately when the initial
-   * auth state is settled and currentUser is available
+   * auth state is settled. The current user might be a valid user,
+   * or null if there is no user signed in currently.
    */
   authStateReady(): Promise<void>;
   /** The currently signed-in user (or null). */