fix: nested fields only supported w/ firestore.update

Author: Bobby

src/utils/mutate.js

@@ -83,30 +83,38 @@ const serverTimestamp = (firebase, key) =>
  * @returns
  */
 function atomize(firebase, operation) {
-  return Object.keys(operation).reduce((data, key) => {
-    const clone = { ...data };
-    const val = clone[key];
-    if (!val) return clone;
-
-    const value =
-      primaryValue(val) ||
-      serverTimestamp(firebase, val[0]) ||
-      arrayUnion(firebase, val[0], val[1]) ||
-      arrayRemove(firebase, val[0], val[1]) ||
-      increment(firebase, val[0], val[1]);
-
-    if (Array.isArray(val) && val.length > 0) {
-      // eslint-disable-next-line no-param-reassign
-      clone[key] = value;
-    }
-    return clone;
-  }, cloneDeep(operation));
+  let requiresUpdate = false;
+  return [
+    Object.keys(operation).reduce((data, key) => {
+      const clone = { ...data };
+      const val = clone[key];
+      if (key.includes('.')) {
+        requiresUpdate = true;
+      }
+      if (!val) return clone;
+
+      const value =
+        primaryValue(val) ||
+        serverTimestamp(firebase, val[0]) ||
+        arrayUnion(firebase, val[0], val[1]) ||
+        arrayRemove(firebase, val[0], val[1]) ||
+        increment(firebase, val[0], val[1]);
+
+      if (Array.isArray(val) && val.length > 0) {
+        // eslint-disable-next-line no-param-reassign
+        clone[key] = value;
+      }
+      return clone;
+    }, cloneDeep(operation)),
+    requiresUpdate,
+  ];
 }
 
 // ----- write functions -----
 
 /**
- *
+ * For details between set & udpate see:
+ * https://firebase.google.com/docs/reference/js/firebase.firestore.Transaction#update
  * @param {object} firebase
  * @param {Mutation_v1 | Mutation_v2} operation
  * @param {Batch | Transaction} writer
@@ -115,15 +123,23 @@ function atomize(firebase, operation) {
 function write(firebase, operation = {}, writer = null) {
   const { collection, path, doc, id, data, ...rest } = operation;
   const ref = docRef(firebase.firestore(), path || collection, id || doc);
-  const changes = atomize(firebase, data || rest);
+  const [changes, useUpdate = false] = atomize(firebase, data || rest);
 
   if (writer) {
     const writeType = writer.commit ? 'Batching' : 'Transaction.set';
     info(writeType, { id: ref.id, path: ref.parent.path, ...changes });
-    writer.set(ref, changes, { merge: true });
+    if (useUpdate) {
+      writer.update(ref, changes);
+    } else {
+      writer.set(ref, changes, { merge: true });
+    }
     return { id: ref.id, path: ref.parent.path, ...changes };
   }
   info('Writing', { id: ref.id, path: ref.parent.path, ...changes });
+  if (useUpdate) {
+    return ref.update(changes);
+  }
+
   return ref.set(changes, { merge: true });
 }
 

test/unit/utils/mutate.spec.js

@@ -120,7 +120,7 @@ describe('firestore.mutate()', () => {
     const withConverter = sinon.spy(() => ({ get: firestoreGet }));
     const where = sinon.spy(() => ({ get: firestoreGet, withConverter }));
     const collection = sinon.spy(() => ({ doc, withConverter, where }));
-    const set = sinon.spy();
+    const update = sinon.spy();
     function* mock() {
       yield Promise.resolve({
         ref: { id: 'sprint-1', parent: { path: 'sprints' } },
@@ -139,7 +139,7 @@ describe('firestore.mutate()', () => {
     }
     const mocked = mock();
     const transactionGet = () => mocked.next().value;
-    const transaction = { set, get: transactionGet };
+    const transaction = { update, get: transactionGet };
     const runTransaction = sinon.spy((cb) => cb(transaction));
     const doc = sinon.spy((val) => ({
       doc: val,
@@ -172,6 +172,7 @@ describe('firestore.mutate()', () => {
               collection: 'orgs/tara-ai/tasks',
               doc: task.id,
               data: {
+                'nested.field': 'new-value',
                 nextSprintId:
                   team?.sprintSettings.moveRemainingTasksTo === 'Backlog'
                     ? null
@@ -182,18 +183,18 @@ describe('firestore.mutate()', () => {
       },
     );
 
-    expect(set.calledTwice);
+    expect(update.calledTwice);
     expect(
-      set.calledWith(
+      update.calledWith(
         { doc: 'task-id-1' },
-        { nextSprintId: 'next-sprint-id-123' },
+        { nextSprintId: 'next-sprint-id-123', 'nested.field': 'new-value' },
         { merge: true },
       ),
     );
     expect(
-      set.calledWith(
+      update.calledWith(
         { doc: 'task-id-2' },
-        { nextSprintId: 'next-sprint-id-123' },
+        { nextSprintId: 'next-sprint-id-123', 'nested.field': 'new-value' },
         { merge: true },
       ),
     );
@@ -279,8 +280,10 @@ describe('firestore.mutate()', () => {
 
   it('handles stringified Field Values', async () => {
     const set = sinon.spy();
+    const update = sinon.spy();
     const doc = sinon.spy(() => ({
       set,
+      update,
       id: 'id',
       parent: { path: 'path' },
     }));
@@ -312,7 +315,8 @@ describe('firestore.mutate()', () => {
 
     expect(collection.calledWith('orgs/tara-ai/teams'));
     expect(doc.calledWith('team-bravo'));
-    expect(set.calledWith({ name: 'Bravo Team 🎄' }, { merge: true }));
+    expect(update.calledWith({ name: 'Bravo Team 🎄' }));
+    expect(set.notCalled);
     expect(firestore.FieldValue.serverTimestamp).to.have.been.calledOnce;
     expect(firestore.FieldValue.increment).to.have.been.calledOnce;
     expect(firestore.FieldValue.arrayRemove).to.have.been.calledOnce;