Merge branch 'master' into list-documents

# Conflicts:
#	test/unit/firestore-collection.js

Author: dmurvihill

.gitignore

@@ -3,3 +3,4 @@
 node_modules
 coverage
 browser
+.vscode

.travis.yml

@@ -4,6 +4,7 @@ node_js:
 - "4.5"
 - "5.12"
 - "6.4"
+- "8"
 before_script:
 - gulp lint
 script:

API.md

@@ -12,12 +12,17 @@ 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)
+- [Messaging](#messaging)
+  - [`respondNext(methodName, result)`](#respondnextmethodname-result---undefined)
+  - [`failNext(methodName, err)`](#failnextmethodname-err---undefined)
+  - [`on(methodName, callback)`](#onmethodname-callback---undefined)
 
 ## Core
 
@@ -117,7 +122,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 +174,47 @@ 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.
+`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.
 
-`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 +227,17 @@ 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.
+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
 
 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.
@@ -214,3 +251,31 @@ Instead of using `Date.now()`, MockFirebase will call the `fn` you provide to ge
 ##### `Firebase.restoreClock()` -> `undefined`
 
 After calling `Firebase.setClock`, calling `Firebase.restoreClock` will restore the default timestamp behavior.
+
+## Messaging
+
+API reference of `MockMessaging`.
+
+##### `respondNext(methodName, result)` -> `undefined`
+
+When `methodName` is next invoked, the `Promise` (that is returned from the `methodName`) will be resolved with the specified `result`. This is useful for testing specific results of firebase messaging (e. g. partial success of sending messaging). The result will be triggered with the next `flush`.
+
+If no result is specified, `methodName` will resolve a default response.
+
+`result` must not be undefined.
+
+<hr>
+
+##### `failNext(methodName, err)` -> `undefined`
+
+When `methodName` is next invoked, the `Promise` will be rejected with the specified `err`. This is useful for simulating validation or any other errors. The error will be triggered with the next `flush`.
+
+`err` must be a proper `Error` object and not a string or any other primitive.
+
+<hr>
+
+##### `on(methodName, callback)` -> `undefined`
+
+When `methodName` is next invoked, the `callback` will be triggered. The callback gets an array as argument. The array contains all arguments, that were passed on invoking `methodName`. This is useful to assert the input arguments of `methodName`.
+
+See [docs.js](/test/unit/docs.js) for an example.

CHANGELOG.md

@@ -0,0 +1,37 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [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.
+
+### Fixed
+- `onAuthStateChanged` now correctly calls its callback immediately with
+  the current auth state.  
+- `MockStorage.bucket()` and `MockStorageBucket.file()` now return the
+  existing artifact if one exists, rather than overwriting it with a new
+  one.
+- `DataSnapshot.child` now correctly splits child paths by '/'
+  characters
+- Boolean values are now allowed in RTDB priority fields and as
+  arguments to `Query.startAt`, `Query.endAt`, and `Query.equalTo`.
+- `MockFirestoreDocument.create()` now correctly returns a
+  `Promise<WriteResult>` instead of `Promise<void>`.
+
+
+[Unreleased]: https://github.com/dmurvihill/firebase-mock/compare/v2.2.10...HEAD

README.md

@@ -35,6 +35,7 @@ Firebase Mock supports the client-side [JavaScript API](https://firebase.google.
 * Authentication
   * [Basic](tutorials/admin/authentication.md)
   * [JWT Tokens](tutorials/admin/tokens.md)
+* [Messaging](tutorials/admin/messaging.md)
 * [Realtime Database](tutorials/admin/rtdb.md)
 * [Firestore](tutorials/admin/firestore.md)
 * [Storage](tutorials/admin/storage.md)

bower.json

@@ -1,6 +1,6 @@
 {
   "name": "firebase-mock",
-  "version": "2.2.10",
+  "version": "2.3.0",
   "homepage": "https://github.com/soumak77/firebase-mock",
   "authors": [
     "Kato"