Merge pull request #40 from dmurvihill/get-id-token-result

Add support for getIdTokenResult

Author: dmurvihill

API.md

@@ -12,9 +12,10 @@ Only `MockFirebase` methods are included here. For details on normal Firebase AP
   - [`fakeEvent(event [, key] [, data] [, previousChild] [, priority])`](#fakeeventevent--key--data--previouschild--priority---ref)
   - [`getFlushQueue()`](#getflushqueue---array)
 - [Auth](#auth)
-  - [`changeAuthState(user)`](#changeauthstateauthdata---undefined)
-  - [`getUserByEmail(email)`](#getemailuseremail---objectnull)
-  - [`getUser(uid)`](#getemailuseremail---objectnull)
+  - [`changeAuthState(user)`](#changeauthstateuser---undefined)
+  - [`getUserByEmail(email)`](#getuserbyemailemail---promiseobject)
+  - [`getUser(uid)`](#getuseruid---promiseobject)
+  - [`updateUser(user)`](#updateuseruser---promisemockuser)
 - [Server Timestamps](#server-timestamps)
   - [`setClock(fn)`](#firebasesetclockfn---undefined)
   - [`restoreClock()`](#firebasesetclockfn---undefined)
@@ -117,7 +118,7 @@ function onValue (_snapshot_) {
 }
 ref.on('value', onValue);
 ref.set({
-  foo: 'bar';
+  foo: 'bar',
 });
 ref.flush();
 console.assert(ref.getData().foo === 'bar', 'data has foo');
@@ -169,26 +170,46 @@ ref.flush(); // added foo after null
 
 Authentication methods for simulating changes to the auth state of a Firebase reference.
 
-##### `changeAuthState(authData)` -> `undefined`
+##### `changeAuthState(user)` -> `undefined`
 
-Changes the active authentication credentials to the `authData` object. Before changing the authentication state, `changeAuthState` checks whether the `authData` object is deeply equal to the current authentication data. `onAuth` listeners will only be triggered if the data is not deeply equal. To simulate no user being authenticated, pass `null` for `authData`. This operation is queued until the next `flush`.
+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.
 
-`authData` should adhere to the [documented schema](https://www.firebase.com/docs/web/api/firebase/onauth.html).
+`user` should be a `MockUser` object or an object with the same fields
+as `MockUser`. To simulate no user being authenticated, pass `null` for
+`user`. This operation is queued until the next `flush`.
 
 Example:
 
 ```js
-ref.changeAuthState({
+ref.changeAuthState(new MockUser(ref, {
   uid: 'theUid',
-  provider: 'github',
-  token: 'theToken',
-  expires: Math.floor(new Date() / 1000) + 24 * 60 * 60, // expire in 24 hours
-  auth: {
-    myAuthProperty: true
-  }
-});
+  email: '[email protected]',
+  emailVerified: true,
+  displayName: 'Mr. Meeseeks',
+  phoneNumber: '+1-508-123-4567',
+  photoURL: 'https://example.com/image.png',
+  isAnonymous: false,
+  providerId: 'github',
+  providerData: [],
+  refreshToken: '123e4567-e89b-12d3-a456-426655440000',
+  metadata: {},  // firebase-mock offers limited support for this field
+  customClaims: {
+    isAdmin: true,
+    // etc.
+  },
+  _idtoken: 'theToken',
+  _tokenValidity: {
+    authTime: '2019-11-22T08:46:15Z',
+    issuedAtTime: '2019-11-22T08:46:15Z',
+    expirationTime: '2019-11-22T09:46:15Z',
+  },
+}));
 ref.flush();
-console.assert(ref.getAuth().auth.myAuthProperty, 'authData has custom property');
+console.assert(ref.getAuth().displayName === 'Mr. Meeseeks', 'Auth name is correct');
 ```
 
 <hr>
@@ -201,6 +222,13 @@ Finds a user previously created with [`createUser`](https://www.firebase.com/doc
 
 Finds a user previously created with [`createUser`](https://www.firebase.com/docs/web/api/firebase/createuser.html). If no user was created with the specified `email`, the promise is rejected.
 
+##### `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.
+
 ## Server Timestamps
 
 MockFirebase allow you to simulate the behavior of [server timestamps](https://www.firebase.com/docs/web/api/servervalue/timestamp.html) when using a real Firebase instance. Unless you use `Firebase.setClock`, `Firebase.ServerValue.TIMESTAMP` will be transformed to the current date (`Date.now()`) when your data change is flushed.

src/firebase-auth.js

@@ -75,9 +75,7 @@ FirebaseAuth.prototype.getUser = function (uid, onComplete) {
     var user = null;
     err = err || self._validateExistingUid(uid);
     if (!err) {
-      user = _.find(self._auth.users, function(u) {
-        return u.uid == uid;
-      });
+      user = self._getUser(uid);
       if (onComplete) {
         onComplete(err, user.clone());
       }
@@ -91,6 +89,21 @@ FirebaseAuth.prototype.getUser = function (uid, onComplete) {
   });
 };
 
+FirebaseAuth.prototype.updateUser = function (newUser) {
+  const self = this;
+  return new Promise((resolve, reject) => {
+    this._defer('updateUser', _.toArray(arguments), () => {
+      const i = _.findIndex(self._auth.users, u => u.uid === newUser.uid);
+      if (i === -1) {
+        reject(new Error('Tried to update a nonexistent user'));
+      } else {
+        self._auth.users[i] = newUser.clone();
+        resolve(newUser);
+      }
+    });
+  });
+};
+
 // number of arguments
 var authMethods = {
   authWithCustomToken: 2,
@@ -205,6 +218,12 @@ FirebaseAuth.prototype._triggerAuthEvent = function () {
   });
 };
 
+FirebaseAuth.prototype._getUser = function (uid) {
+  return _.find(this._auth.users, function(u) {
+    return u.uid === uid;
+  });
+};
+
 FirebaseAuth.prototype.getAuth = function () {
   return this.currentUser;
 };
@@ -279,7 +298,8 @@ FirebaseAuth.prototype._createUser = function (method, credentials, onComplete)
           phoneNumber: credentials.phoneNumber,
           emailVerified: credentials.emailVerified,
           displayName: credentials.displayName,
-          photoURL: credentials.photoURL
+          photoURL: credentials.photoURL,
+          _tokenValidity: credentials._tokenValidity
         });
         self._auth.users.push(user);
         if (onComplete) {

src/index.js

@@ -3,6 +3,7 @@
 var MockFirestoreDeltaDocumentSnapshot = require('./firestore-delta-document-snapshot');
 
 exports.MockAuthentication = require('./auth');
+exports.MockUser = require('./user');
 exports.MockFirebase = require('./firebase');
 exports.MockFirebaseSdk = require('./sdk');
 exports.MockFirestore = require('./firestore');

src/user.js

@@ -6,7 +6,10 @@ var Promise = require('rsvp').Promise;
 function MockFirebaseUser(ref, data) {
   this._auth = ref;
   this._idtoken = Math.random().toString();
-  this.customClaims = {};
+  this._tokenValidity = _tokenValidity(
+    data._tokenValidity ? data._tokenValidity : {}
+  );
+  this.customClaims = data.customClaims || {};
   this.uid = data.uid;
   this.email = data.email;
   this.password = data.password;
@@ -21,10 +24,19 @@ function MockFirebaseUser(ref, data) {
   this.refreshToken = data.refreshToken;
 }
 
+MockFirebaseUser.msg_tokenExpiresBeforeIssuance =
+    'Auth token expires before it is issued';
+MockFirebaseUser.msg_tokenIssuedBeforeAuth =
+    'Auth token was issued before the user authenticated';
+MockFirebaseUser.msg_tokenAuthedInTheFuture =
+    'Auth token shows user authenticating in the future';
+MockFirebaseUser.msg_tokenIssuedInTheFuture =
+    'Auth token was issued in the future';
+
 MockFirebaseUser.prototype.clone = function () {
   var user = new MockFirebaseUser(this._auth, this);
   user._idtoken = this._idtoken;
-  user.customClaims = this.customClaims;
+  user.customClaims = _.cloneDeep(this.customClaims);
   return user;
 };
 
@@ -105,10 +117,65 @@ MockFirebaseUser.prototype.getIdToken = function (forceRefresh) {
   var self = this;
   return new Promise(function(resolve) {
     if (forceRefresh) {
-      self._idtoken = Math.random().toString();
+        self._refreshIdToken();
     }
     resolve(self._idtoken);
   });
 };
 
+MockFirebaseUser.prototype.getIdTokenResult = function (forceRefresh) {
+  if (forceRefresh) {
+    this._refreshIdToken();
+  }
+
+  return Promise.resolve({
+    authTime: this._tokenValidity.authTime.toISOString(),
+    issuedAtTime: this._tokenValidity.issuedAtTime.toISOString(),
+    expirationTime: this._tokenValidity.expirationTime.toISOString(),
+    signInProvider: this.providerId || null,
+    claims: this.customClaims,
+    token: this._idtoken,
+  });
+};
+
+MockFirebaseUser.prototype._refreshIdToken = function () {
+  this._tokenValidity.issuedAtTime = new Date();
+  this._tokenValidity.expirationTime = defaultExpirationTime(new Date());
+  this._idtoken = Math.random().toString();
+  return this._auth.updateUser(this)
+    .then(() => this.getIdTokenResult())
+    .catch(() => this.getIdTokenResult());
+};
+
+/** Create a user's internal token validity store
+ *
+ * @param data the `data.idTokenResult` object from the User constructor
+ * @return object that is to become the User's _tokenValidity member
+ */
+function _tokenValidity(data) {
+  const now = new Date();
+  const authTime = data.authTime ?
+    data.authTime : new Date();
+  const issuedTime = data.issuedAtTime || new Date(authTime.getTime());
+  const expirationTime = data.expirationTime ?
+      data.expirationTime : defaultExpirationTime(issuedTime);
+  if (expirationTime < issuedTime) {
+    throw new Error(MockFirebaseUser.msg_tokenExpiresBeforeIssuance);
+  } else if (issuedTime < authTime) {
+    throw new Error(MockFirebaseUser.msg_tokenIssuedBeforeAuth);
+  } else if (now < authTime) {
+    throw new Error(MockFirebaseUser.msg_tokenAuthedInTheFuture);
+  } else if (now < issuedTime) {
+    throw new Error(MockFirebaseUser.msg_tokenIssuedInTheFuture);
+  } else return {
+    authTime: authTime,
+    issuedAtTime: issuedTime,
+    expirationTime: expirationTime,
+  };
+}
+
+function defaultExpirationTime(issuedTime) {
+  return new Date(issuedTime.getTime() + 3600000);
+}
+
 module.exports = MockFirebaseUser;