Add tests for user state change

Author: sam-gc

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

@@ -24,16 +24,13 @@ import { FirebaseError } from '@firebase/util';
 
 import { testUser } from '../../../test/mock_auth';
 import { Auth } from '../../model/auth';
+import { User } from '../../model/user';
 import { Persistence } from '../persistence';
 import { browserLocalPersistence } from '../persistence/browser';
 import { inMemoryPersistence } from '../persistence/in_memory';
 import { PersistenceUserManager } from '../persistence/persistence_user_manager';
 import { ClientPlatform, getClientVersion } from '../util/version';
-import {
-  DEFAULT_API_HOST,
-  DEFAULT_API_SCHEME,
-  initializeAuth
-} from './auth_impl';
+import { DEFAULT_API_HOST, DEFAULT_API_SCHEME, initializeAuth } from './auth_impl';
 
 use(sinonChai);
 
@@ -117,6 +114,102 @@ describe('AuthImpl', () => {
       );
     });
   });
+
+  describe('change listeners', () => {
+    // // Helpers to convert auth state change results to promise
+    // function onAuthStateChange(callback: NextFn<User|null>)
+
+    it('immediately calls authStateChange if initialization finished', (done) => {
+      const user = testUser('uid');
+      auth.currentUser = user;
+      auth._isInitialized = true;
+      auth.onAuthStateChanged(user => {
+        expect(user).to.eq(user);
+        done();
+      });
+    });
+  
+    it('immediately calls idTokenChange if initialization finished', (done) => {
+      const user = testUser('uid');
+      auth.currentUser = user;
+      auth._isInitialized = true;
+      auth.onIdTokenChange(user => {
+        expect(user).to.eq(user);
+        done();
+      });
+    });
+
+    it('immediate callback is done async', () => {
+      auth._isInitialized = true;
+      let callbackCalled = false;
+      auth.onIdTokenChange(() => {
+        callbackCalled = true;
+      });
+
+      expect(callbackCalled).to.be.false;
+    });
+
+    describe('user logs in/out, tokens refresh', () => {
+      let user: User;
+      let callback: sinon.SinonSpy;
+
+      beforeEach(() => {
+        user = testUser('uid');
+        callback = sinon.spy();
+      });
+
+      it('onAuthStateChange triggers on log in', async () => {
+        await auth.updateCurrentUser(null);
+        auth.onAuthStateChanged(callback);
+        await auth.updateCurrentUser(user);
+        expect(callback).to.have.been.calledTwice;
+      });
+
+      it('onAuthStateChange triggers on log out', async () => {
+        await auth.updateCurrentUser(user);
+        auth.onAuthStateChanged(callback);
+        await auth.updateCurrentUser(null);
+        expect(callback).to.have.been.calledTwice;
+      });
+
+      it('onIdTokenChange triggers on log in', async () => {
+        await auth.updateCurrentUser(null);
+        auth.onIdTokenChange(callback);
+        await auth.updateCurrentUser(user);
+        expect(callback).to.have.been.calledTwice;
+      });
+
+      it('onIdTokenChange triggers on log out', async () => {
+        await auth.updateCurrentUser(user);
+        auth.onIdTokenChange(callback);
+        await auth.updateCurrentUser(null);
+        expect(callback).to.have.been.calledTwice;
+      });
+
+      it('onAuthStateChange does not trigger for user props change', async () => {
+        await auth.updateCurrentUser(user);
+        auth.onAuthStateChanged(callback);
+        user.refreshToken = 'hey look I changed';
+        await auth.updateCurrentUser(user);
+        expect(callback).to.have.been.calledOnce;
+      });
+
+      it('onIdTokenChange triggers for user props change', async () => {
+        await auth.updateCurrentUser(user);
+        auth.onIdTokenChange(callback);
+        user.refreshToken = 'hey look I changed';
+        await auth.updateCurrentUser(user);
+        expect(callback).to.have.been.calledTwice;
+      });
+
+      it('onAuthStateChange triggers if uid changes', async () => {
+        await auth.updateCurrentUser(user);
+        auth.onAuthStateChanged(callback);
+        await auth.updateCurrentUser(testUser('different-uid'));
+        expect(callback).to.have.been.calledTwice;
+      });
+    });
+  });
 });
 
 describe('initializeAuth', () => {

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

@@ -42,7 +42,7 @@ class AuthImpl implements Auth {
   private persistenceManager?: PersistenceUserManager;
   private authStateSubscription = new Subscription<User>(this);
   private idTokenSubscription = new Subscription<User>(this);
-  private isInitialized = false;
+  _isInitialized = false;
 
   // Tracks the last notified UID for state change listeners to prevent
   // repeated calls to the callbacks
@@ -68,7 +68,7 @@ class AuthImpl implements Auth {
         await this.directlySetCurrentUser(storedUser);
       }
 
-      this.isInitialized = true;
+      this._isInitialized = true;
       this._notifyStateListeners();
     });
   }
@@ -100,7 +100,7 @@ class AuthImpl implements Auth {
   }
 
   _notifyStateListeners(): void {
-    if (!this.isInitialized) {
+    if (!this._isInitialized) {
       return;
     }
 
@@ -115,9 +115,10 @@ class AuthImpl implements Auth {
   private registerStateListener(subscription: Subscription<User>, nextOrObserver: NextOrObserver<User>,
     error?: ErrorFn,
     completed?: CompleteFn): Unsubscribe {
-    if (this.isInitialized) {
+    if (this._isInitialized) {
       const cb = typeof nextOrObserver === 'function' ? nextOrObserver : nextOrObserver.next;
-      // The callback needs to be called asynchronously per the spec
+      // The callback needs to be called asynchronously per the spec. 
+      // eslint-disable-next-line @typescript-eslint/no-floating-promises
       Promise.resolve().then(() => cb(this.currentUser));
     }
 
@@ -187,6 +188,7 @@ class Subscription<T> {
   constructor(readonly auth: Auth) {}
 
   get next(): NextFn<T|null> {
-    return assert(this.observer, this.auth.name).next;
+    const observer = assert(this.observer, this.auth.name);
+    return observer.next.bind(observer);
   }
 }

packages-exp/auth-exp/src/model/auth.d.ts

@@ -37,12 +37,14 @@ export interface Auth {
   currentUser: User | null;
   readonly name: AppName;
   readonly config: Config;
+  _isInitialized: boolean;
 
   setPersistence(persistence: Persistence): Promise<void>;
   updateCurrentUser(user: User | null): Promise<void>;
   signOut(): Promise<void>;
   onAuthStateChanged(nextOrObserver: NextOrObserver<User>, error?: ErrorFn, completed?: CompleteFn): Unsubscribe;
   onIdTokenChange(nextOrObserver: NextOrObserver<User>, error?: ErrorFn, completed?: CompleteFn): Unsubscribe;
+  _notifyStateListeners(): void;
 }
 
 export interface Dependencies {

packages-exp/auth-exp/test/mock_auth.ts

@@ -32,12 +32,14 @@ export const mockAuth: Auth = {
     apiScheme: TEST_SCHEME,
     sdkClientVersion: 'testSDK/0.0.0'
   },
+  _isInitialized: true,
   currentUser: null,
   async setPersistence() {},
   async updateCurrentUser() {},
   async signOut() {},
-  onAuthStateChanged() {return () => {}},
-  onIdTokenChange() { return () => {}},
+  onAuthStateChanged() {return () => {};},
+  onIdTokenChange() { return () => {};},
+  _notifyStateListeners() {},
 };
 
 export function testUser(uid: string, email?: string): User {