Merge branch 'onIdTokenChanged'

# Conflicts:
#	CHANGELOG.md

Author: dmurvihill

API.md

@@ -179,8 +179,9 @@ Authentication methods for simulating changes to the auth state of a Firebase re
 Changes the active authentication credentials to the `authData` object.
 Before changing the authentication state, `changeAuthState` checks the
 `user` object against the current authentication data.
-`onAuthStateChanged` listeners will only be triggered if the data is not
-deeply equal.
+`onIdTokenChanged` listeners will be triggered if the data is not
+deeply equal. `onAuthStateChanged` listeners will be triggered if the
+data is deeply equal but with different ID token validity.
 
 `user` should be a `MockUser` object or an object with the same fields
 as `MockUser`. To simulate no user being authenticated, pass `null` for
@@ -229,9 +230,13 @@ Finds a user previously created with [`createUser`](https://www.firebase.com/doc
 ##### `updateUser(user)` -> `Promise<MockUser>`
 
 Replace the existing user with a new one, by matching uid. Throws an
-error if no user exists whose uid matches the given user's uid. Resolves
-with the updated user when complete. This operation is queued until the
-next flush.
+error if no user exists whose uid matches the given user's uid.
+Appropriate `onAuthStateChanged` and `onIdTokenChanged` listeners will
+be triggered if the new user has the same `uid` as the current
+authenticated user.
+
+Resolves with the updated user when complete. This operation is queued
+until the next flush.
 
 ## Server Timestamps
 

CHANGELOG.md

@@ -7,9 +7,15 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ## [Unreleased]
 ### Added
 - Changelog
+- Mock `auth.Auth.onIdTokenChanged()` method, matching the previous
+  behavior of `onAuthStateChanged()` (see below)
 - Support for Firebase Messaging (Admin API)
 
 ### Changed
+- (Breaking) Consistent with Firebase SDK [version 4.0.0](https://firebase.google.com/support/release-notes/js#version_500_-_may_8_2018) and later,
+  and later, `onAuthStateChanged` no longer issues an event when a new
+  ID token is issued for the same user. The `onIdTokenChanged` method is
+  now mocked, keeping the previous behavior.
 - `MockStorageFile.download()` now allows omitting the destination arg;
   in that case, it simply resolves the `Promise` with the file contents
   and does not write it anywhere else.

src/firebase-auth.js

@@ -9,6 +9,7 @@ function FirebaseAuth () {
   this.currentUser = null;
   this._auth = {
     listeners: [],
+    idTokenListeners: [],
     completionListeners: [],
     users: [],
     uidCounter: 1
@@ -17,10 +18,10 @@ function FirebaseAuth () {
 
 FirebaseAuth.prototype.changeAuthState = function (userData) {
   this._defer('changeAuthState', _.toArray(arguments), function() {
-    if (!_.isEqual(this.currentUser, userData)) {
-      this.currentUser = _.isObject(userData) ? userData : null;
-      this._triggerAuthEvent();
-    }
+    userData = _.isObject(userData) ? userData : null;
+    const oldUser = _.cloneDeep(this.currentUser);
+    this.currentUser = userData;
+    this._notify_state_listeners(oldUser);
   });
 };
 
@@ -47,6 +48,13 @@ FirebaseAuth.prototype.onAuthStateChanged = function (callback) {
   }
 };
 
+FirebaseAuth.prototype.onIdTokenChanged = function (callback) {
+  const currentUser = this.currentUser;
+  this._auth.idTokenListeners.push({fn: callback});
+  callback.call(null, _.cloneDeep(currentUser));
+  return () => this.offAuth(callback);
+};
+
 FirebaseAuth.prototype.getUserByEmail = function (email, onComplete) {
   var err = this._nextErr('getUserByEmail');
   var self = this;
@@ -100,6 +108,11 @@ FirebaseAuth.prototype.updateUser = function (newUser) {
         reject(new Error('Tried to update a nonexistent user'));
       } else {
         self._auth.users[i] = newUser.clone();
+        if (this.currentUser && this.currentUser.uid === newUser.uid) {
+          const oldUser = this.currentUser.clone();
+          this.currentUser = self._auth.users[i];
+          this._notify_state_listeners(oldUser);
+        }
         resolve(newUser);
       }
     });
@@ -167,15 +180,14 @@ Object.keys(signinMethods)
     FirebaseAuth.prototype[method] = function () {
       var self = this;
       var user = getUser.apply(this, arguments);
-      var promise = new Promise(function(resolve, reject) {
+      return new Promise(function(resolve, reject) {
         self._authEvent(method, function(err) {
           if (err) reject(err);
           self.currentUser = user;
           resolve(user);
           self._triggerAuthEvent();
         }, true);
       });
-      return promise;
     };
   });
 
@@ -218,6 +230,15 @@ FirebaseAuth.prototype._triggerAuthEvent = function () {
   listeners.forEach(function (parts) {
     parts.fn.call(parts.context, _.cloneDeep(user));
   });
+  this._triggerIdTokenEvent();
+};
+
+FirebaseAuth.prototype._triggerIdTokenEvent = function () {
+  var user = this.currentUser;
+  var listeners = _.cloneDeep(this._auth.idTokenListeners);
+  listeners.forEach(function (parts) {
+    parts.fn.call(parts.context, _.cloneDeep(user));
+  });
 };
 
 FirebaseAuth.prototype._getUser = function (uid) {
@@ -239,12 +260,11 @@ FirebaseAuth.prototype.onAuth = function (onComplete, context) {
 };
 
 FirebaseAuth.prototype.offAuth = function (onComplete, context) {
-  var index = _.findIndex(this._auth.listeners, function (listener) {
+  function shouldRemove(listener) {
     return listener.fn === onComplete && listener.context === context;
-  });
-  if (index > -1) {
-    this._auth.listeners.splice(index, 1);
   }
+  [this._auth.listeners, this._auth.idTokenListeners]
+    .forEach(event => _.remove(event, shouldRemove));
 };
 
 FirebaseAuth.prototype.unauth = function () {
@@ -256,7 +276,7 @@ FirebaseAuth.prototype.unauth = function () {
 
 FirebaseAuth.prototype.signOut = function () {
   var self = this, updateuser = this.currentUser !== null;
-  var promise = new Promise(function(resolve, reject) {
+  return new Promise(function(resolve, reject) {
     self._authEvent('signOut', function(err) {
       if (err) reject(err);
       self.currentUser = null;
@@ -267,7 +287,6 @@ FirebaseAuth.prototype.signOut = function () {
       }
     }, true);
   });
-  return promise;
 };
 
 FirebaseAuth.prototype.createUserWithEmailAndPassword = function (email, password) {
@@ -502,14 +521,54 @@ FirebaseAuth.prototype.setCustomUserClaims = function (uid, claims) {
   });
 };
 
+FirebaseAuth.prototype._notify_state_listeners = function (previousUser) {
+  const difference = scanDifference(previousUser, this.currentUser);
+  if (difference === 'different_user') {
+    this._triggerAuthEvent();
+  } else if(difference === 'different_token') {
+    this._triggerIdTokenEvent();
+  } else if (difference === 'same') {
+    // do nothing
+  } else {
+    throw new Error('Unexpected result from scanDifference');
+  }
+
+  function scanDifference(oldUser, newUser) {
+    if (_.isObject(oldUser)) {
+      if (_.isObject(newUser)) {
+        if (_.isEqual(oldUser, newUser)) {
+          return 'same';
+        } else {
+          return equalExceptToken(oldUser, newUser) ?
+            'different_token' : 'different_user';
+        }
+      } else {
+        return 'different_user';
+      }
+    } else {
+      return _.isObject(newUser) ? 'different_user' : 'same';
+    }
+  }
+
+  function equalExceptToken(user1, user2) {
+    const u1 = user1.clone();
+    const u2 = user2.clone();
+    delete u1._idtoken;
+    delete u1._tokenValidity;
+    delete u2._idtoken;
+    delete u2._tokenValidity;
+    return _.isEqual(u1, u2);
+  }
+};
+
 FirebaseAuth.prototype._nextUid = function () {
   return 'simplelogin:' + (this._auth.uidCounter++);
 };
 
 FirebaseAuth.prototype._validateNewUid = function (uid) {
   if (uid) {
     var user = _.find(this._auth.users, function(user) {
-      return user.uid == uid;
+      return user.uid === uid;
     });
     if (user) {
       var err = new Error('The provided uid is already in use by an existing user. Each user must have a unique uid.');
@@ -523,7 +582,7 @@ FirebaseAuth.prototype._validateNewUid = function (uid) {
 FirebaseAuth.prototype._validateExistingUid = function (uid) {
   if (uid) {
     var user = _.find(this._auth.users, function(user) {
-      return user.uid == uid;
+      return user.uid === uid;
     });
     if (!user) {
       var err = new Error('There is no existing user record corresponding to the provided identifier.');

src/user.js

@@ -114,13 +114,8 @@ MockFirebaseUser.prototype.updateProfile = function (profile) {
 };
 
 MockFirebaseUser.prototype.getIdToken = function (forceRefresh) {
-  var self = this;
-  return new Promise(function(resolve) {
-    if (forceRefresh) {
-        self._refreshIdToken();
-    }
-    resolve(self._idtoken);
-  });
+  return (forceRefresh ? this._refreshIdToken() : Promise.resolve())
+    .then(() => this._idtoken);
 };
 
 MockFirebaseUser.prototype.toJSON = function() {