Add create method to FakeFirestore.DocumentReference (#181)

* feat: add create to document API * fix: package version conflict
sbatson5 · Jan 4, 2024 · ae4d073 · ae4d073
1 parent 57d2241
commit ae4d073
Show file tree

Hide file tree

Showing 4 changed files with 39 additions and 21 deletions.
diff --git a/__tests__/full-setup-library-firestore.test.js b/__tests__/full-setup-library-firestore.test.js
@@ -23,6 +23,7 @@ describe.each([
     mockOnSnapShot,
     mockListCollections,
     mockTimestampNow,
+    mockCreate,
   } = require('firestore-jest-mock/mocks/firestore');
 
   describe('we can start a firestore application', () => {
@@ -195,6 +196,26 @@ describe.each([
           });
       });
 
+      test('create a city', () => {
+        const firestore = new this.Firestore();
+
+        return firestore
+          .collection('cities')
+          .doc('LA')
+          .create({
+            name: 'Los Angeles',
+            state: 'CA',
+            country: 'USA',
+          })
+          .then(function() {
+            expect(mockCreate).toHaveBeenCalledWith({
+              name: 'Los Angeles',
+              state: 'CA',
+              country: 'USA',
+            });
+          });
+      });
+
       test('updating a city', () => {
         const firestore = new this.Firestore();
         const now = Timestamp._fromMillis(new Date().getTime());
@@ -243,21 +264,15 @@ describe.each([
       test('listCollections returns a promise', async () => {
         const firestore = new this.Firestore();
 
-        const listCollectionsPromise = firestore
-          .collection('cities')
-          .doc('LA')
-          .listCollections();
+        const listCollectionsPromise = firestore.collection('cities').doc('LA').listCollections();
 
         expect(listCollectionsPromise).toEqual(expect.any(Promise));
       });
 
       test('listCollections resolves with child collections', async () => {
         const firestore = new this.Firestore();
 
-        const result = await firestore
-          .collection('users')
-          .doc('123abc')
-          .listCollections();
+        const result = await firestore.collection('users').doc('123abc').listCollections();
 
         expect(result).toEqual(expect.any(Array));
         expect(result).toHaveLength(1);
@@ -268,10 +283,7 @@ describe.each([
       test('listCollections resolves with empty array if there are no collections in document', async () => {
         const firestore = new this.Firestore();
 
-        const result = await firestore
-          .collection('users')
-          .doc('abc123')
-          .listCollections();
+        const result = await firestore.collection('users').doc('abc123').listCollections();
 
         expect(result).toEqual(expect.any(Array));
         expect(result).toHaveLength(0);
@@ -280,10 +292,7 @@ describe.each([
       test('listCollections calls mockListCollections', async () => {
         const firestore = new this.Firestore();
 
-        await firestore
-          .collection('users')
-          .doc('abc123')
-          .listCollections();
+        await firestore.collection('users').doc('abc123').listCollections();
 
         expect(mockListCollections).toHaveBeenCalled();
       });

diff --git a/package-lock.json b/package-lock.json
diff --git a/src/mocks/firestore.d.ts b/src/mocks/firestore.d.ts
@@ -68,6 +68,7 @@ declare class DocumentReference {
   delete(): Promise<void>;
   get(): Promise<MockedDocument>;
 
+  create(object: DocumentData): Promise<MockedDocument>;
   update(object: DocumentData): Promise<MockedDocument>;
   set(object: DocumentData): Promise<MockedDocument>;
 
@@ -121,6 +122,7 @@ export const mockRunTransaction: jest.Mock;
 export const mockCollection: jest.Mock;
 export const mockCollectionGroup: jest.Mock;
 export const mockDoc: jest.Mock;
+export const mockCreate: jest.Mock;
 export const mockUpdate: jest.Mock;
 export const mockSet: jest.Mock;
 export const mockAdd: jest.Mock;

diff --git a/src/mocks/firestore.js b/src/mocks/firestore.js
@@ -6,6 +6,7 @@ const mockSettings = jest.fn();
 const mockUseEmulator = jest.fn();
 const mockCollection = jest.fn();
 const mockDoc = jest.fn();
+const mockCreate = jest.fn();
 const mockUpdate = jest.fn();
 const mockSet = jest.fn();
 const mockAdd = jest.fn();
@@ -242,10 +243,7 @@ FakeFirestore.DocumentReference = class {
     this.id = id;
     this.parent = parent;
     this.firestore = parent.firestore;
-    this.path = parent.path
-      .split('/')
-      .concat(id)
-      .join('/');
+    this.path = parent.path.split('/').concat(id).join('/');
   }
 
   collection(collectionName) {
@@ -308,6 +306,14 @@ FakeFirestore.DocumentReference = class {
     return Promise.resolve(data);
   }
 
+  create(object) {
+    mockCreate(...arguments);
+    this.firestore._updateData(this.path, object, false);
+    return Promise.resolve(
+      buildDocFromHash({ ...object, _ref: this, _updateTime: timestamp.Timestamp.now() }),
+    );
+  }
+
   update(object) {
     mockUpdate(...arguments);
     if (this._get().exists) {
@@ -543,6 +549,7 @@ module.exports = {
   mockDoc,
   mockAdd,
   mockDelete,
+  mockCreate,
   mockUpdate,
   mockSet,
   mockSettings,