firestore-node-mock 0.0.1 → 0.0.2

package/README.md

@@ -1,6 +1,8 @@
+> WIP: this was forked from `firestore-jest-mock`. It works in my tests when consuming in ESM, but your results may vary.
+
 # Mock Firestore
 
-> Jest Mock for testing Google Cloud Firestore
+> Node.js native mock for testing Google Cloud Firestore
 
 A simple way to mock calls to Cloud Firestore, allowing you to assert that you are requesting data correctly.
 
@@ -50,20 +52,20 @@ This library provides an easy to use mocked version of firestore.
 With [npm](https://www.npmjs.com):
 
 ```shell
-npm install --save-dev firestore-jest-mock
+npm install --save-dev firestore-node-mock
 ```
 
 With [yarn](https://yarnpkg.com/):
 
 ```shell
-yarn add --dev firestore-jest-mock
+yarn add --dev firestore-node-mock
 ```
 
 ## Usage
 
 ### `mockFirebase`
 
-The default method to use is `mockFirebase`, which returns a jest mock, overwriting `firebase` and `firebase-admin`. It accepts an object with two pieces:
+The default method to use is `mockFirebase`, which returns a mock, overwriting `firebase` and `firebase-admin`. It accepts an object with two pieces:
 
 - `database` -- A mock of your collections
 - `currentUser` -- (optional) overwrites the currently logged in user
@@ -71,7 +73,7 @@ The default method to use is `mockFirebase`, which returns a jest mock, overwrit
 Example usage:
 
 ```js
-const { mockFirebase } = require('firestore-jest-mock');
+const { mockFirebase } = require('firestore-node-mock');
 
 // Create a fake Firestore with a `users` and `posts` collection
 mockFirebase({
@@ -88,7 +90,7 @@ mockFirebase({
 If you are using TypeScript, you can import `mockFirebase` using ES module syntax:
 
 ```TypeScript
-import { mockFirebase } from 'firestore-jest-mock';
+import { mockFirebase } from 'firestore-node-mock';
 ```
 
 This will populate a fake database with a `users` and `posts` collection. This database is read-only by default, meaning that any Firestore write calls will not actually persist across invocations.
@@ -96,7 +98,7 @@ This will populate a fake database with a `users` and `posts` collection. This d
 Now you can write queries or requests for data just as you would with Firestore:
 
 ```js
-const { mockCollection } = require('firestore-jest-mock/mocks/firestore');
+const { mockCollection } = require('firestore-node-mock/mocks/firestore');
 
 test('testing stuff', () => {
   const firebase = require('firebase'); // or import firebase from 'firebase';
@@ -117,7 +119,7 @@ test('testing stuff', () => {
 In TypeScript, you would import `mockCollection` using ES module syntax:
 
 ```TypeScript
-import { mockCollection } from 'firestore-jest-mock/mocks/firestore';
+import { mockCollection } from 'firestore-node-mock/mocks/firestore';
 ```
 
 The other mock functions may be imported similarly.
@@ -127,7 +129,7 @@ The other mock functions may be imported similarly.
 If you use `@google-cloud/firestore`, use `mockGoogleCloudFirestore` instead of `mockFirebase` in all the documentation.
 
 ```js
-const { mockGoogleCloudFirestore } = require('firestore-jest-mock');
+const { mockGoogleCloudFirestore } = require('firestore-node-mock');
 
 mockGoogleCloudFirestore({
   database: {
@@ -139,7 +141,7 @@ mockGoogleCloudFirestore({
   },
 });
 
-const { mockCollection } = require('firestore-jest-mock/mocks/firestore');
+const { mockCollection } = require('firestore-node-mock/mocks/firestore');
 
 test('testing stuff', () => {
   const { Firestore } = require('@google-cloud/firestore');
@@ -163,7 +165,7 @@ The `Auth` module is not available for `@google-cloud/firestore` compatibility._
 If you use `@react-native-firebase/firestore`, use `mockReactNativeFirestore` instead of `mockFirebase` in all the documentation.
 
 ```js
-const { mockReactNativeFirestore } = require('firestore-jest-mock');
+const { mockReactNativeFirestore } = require('firestore-node-mock');
 
 mockReactNativeFirestore({
   database: {
@@ -175,7 +177,7 @@ mockReactNativeFirestore({
   },
 });
 
-const { mockCollection } = require('firestore-jest-mock/mocks/firestore');
+const { mockCollection } = require('firestore-node-mock/mocks/firestore');
 
 test('testing stuff', () => {
   const { Firestore } = require('@react-native-firebase/firestore');
@@ -196,10 +198,10 @@ The `Auth` module is not available for `@react-native-firebase/firestore` compat
 
 ### Subcollections
 
-A common Firestore use case is to store data in document [subcollections](https://firebase.google.com/docs/firestore/manage-data/structure-data#subcollections). You can model these with firestore-jest-mock like so:
+A common Firestore use case is to store data in document [subcollections](https://firebase.google.com/docs/firestore/manage-data/structure-data#subcollections). You can model these with firestore-node-mock like so:
 
 ```js
-const { mockFirebase } = require('firestore-jest-mock');
+const { mockFirebase } = require('firestore-node-mock');
 // Using our fake Firestore from above:
 mockFirebase({
   database: {
@@ -226,12 +228,12 @@ mockFirebase({
 });
 ```
 
-Similar to how the `id` key defines a document object to firestore-jest-mock, the `_collections` key defines a subcollection. You model each subcollection structure in the same way that `database` is modeled above: an object keyed by collection IDs and populated with document arrays.
+Similar to how the `id` key defines a document object to firestore-node-mock, the `_collections` key defines a subcollection. You model each subcollection structure in the same way that `database` is modeled above: an object keyed by collection IDs and populated with document arrays.
 
 This lets you model and validate more complex document access:
 
 ```js
-const { mockCollection, mockDoc } = require('firestore-jest-mock/mocks/firestore');
+const { mockCollection, mockDoc } = require('firestore-node-mock/mocks/firestore');
 
 test('testing stuff', () => {
   const firebase = require('firebase');
@@ -274,10 +276,10 @@ function maybeGetUsersInState(state) {
 We have a conditional query here. If you pass `state` to this function, we will query against it; otherwise, we just get all of the users. So, you may want to write a test that ensures you are querying correctly:
 
 ```js
-const { mockFirebase } = require('firestore-jest-mock');
+const { mockFirebase } = require('firestore-node-mock');
 
 // Import the mock versions of the functions you expect to be called
-const { mockCollection, mockWhere } = require('firestore-jest-mock/mocks/firestore');
+const { mockCollection, mockWhere } = require('firestore-node-mock/mocks/firestore');
 describe('we can query', () => {
   mockFirebase({
     database: {

package/mocks/firestore.js

@@ -68,8 +68,9 @@ export class FakeFirestore {
     mockBatch(...arguments);
     return {
       _ref: this,
-      delete() {
+      delete(doc) {
         mockBatchDelete(...arguments);
+        this._ref._deleteData(doc.path);
         return this;
       },
       set(doc, data, setOptions = {}) {
@@ -239,6 +240,46 @@ export class FakeFirestore {
     };
   }
 
+  _deleteData(path) {
+    // Do not update unless explicity set to mutable.
+    if (!this.options.mutable) {
+      return;
+    }
+
+    const pathArray = path.replace(/^\/+/, '').split('/');
+
+    // Must be document-level, so even-numbered elements
+    if (pathArray.length % 2 !== 0) {
+      throw new Error(
+        `FakeFirebaseError: Invalid document reference. Document references must have an even number of segments, but ${path} has ${pathArray.length}`,
+      );
+    }
+
+    // The parent entry is the id of the document
+    const docId = pathArray.pop();
+    // Find the parent of docId.
+    const parent = pathArray.reduce((last, entry, index) => {
+      if (!last) return null;
+      const isCollection = index % 2 === 0;
+      if (isCollection) {
+        return last[entry];
+      } else {
+        const existingDoc = last.find(doc => doc.id === entry);
+        if (existingDoc) {
+          return existingDoc._collections;
+        }
+        return null;
+      }
+    }, this.database);
+
+    if (parent) {
+      const oldIndex = parent.findIndex(doc => doc.id === docId);
+      if (oldIndex >= 0) {
+        parent.splice(oldIndex, 1);
+      }
+    }
+  }
+
   recursiveDelete(ref, bulkWriter) {
     mockRecursiveDelete(...arguments);
   	return Promise.resolve();
@@ -289,6 +330,7 @@ FakeFirestore.DocumentReference = class DocumentReference {
 
   delete() {
     mockDelete(...arguments);
+    this.firestore._deleteData(this.path);
     return Promise.resolve();
   }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "firestore-node-mock",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "description": "Helper for mocking Google Cloud Firestore with Node.js test runner",
   "author": "",
   "license": "MIT",