Merging local pending Ops when parent property also set in pending Ops

Author: mortenmo

src/ParseObject.ts

@@ -20,6 +20,8 @@ import {
   AddUniqueOp,
   RemoveOp,
   RelationOp,
+  validPendingParentOp,
+  applyOpToParent,
 } from './ParseOp';
 import ParseRelation from './ParseRelation';
 import * as SingleInstanceStateController from './SingleInstanceStateController';
@@ -779,8 +781,14 @@ class ParseObject {
     const last = pendingOps.length - 1;
     const stateController = CoreManager.getObjectStateController();
     for (const attr in newOps) {
-      const nextOp = newOps[attr].mergeWith(pendingOps[last][attr]);
-      stateController.setPendingOp(this._getStateIdentifier(), attr, nextOp);
+      const parentAttr = validPendingParentOp(attr, pendingOps[last]);
+      if (parentAttr) {
+        const parentOp = pendingOps[last][parentAttr];
+        applyOpToParent(parentAttr, parentOp, attr, newOps[attr]);
+      } else {
+        const nextOp = newOps[attr].mergeWith(pendingOps[last][attr]);
+        stateController.setPendingOp(this._getStateIdentifier(), attr, nextOp);
+      }
     }
 
     return this;

src/ParseOp.js

@@ -55,6 +55,56 @@ export function opFromJSON(json: { [key: string]: any }): ?Op {
   return null;
 }
 
+export function validPendingParentOp(attr, pendingOps) {
+  if (!pendingOps || pendingOps[attr]) {
+    return null;
+  }
+
+  const lastDot = attr.lastIndexOf('.');
+  if (lastDot === -1) {
+    return null;
+  }
+
+  // This is an object with dot notation. So need to also match "parents"
+  const parentString = attr.substring(0, lastDot);
+  for (const pendingAttr in pendingOps) {
+    if (parentString.startsWith(pendingAttr)) {
+      return pendingAttr;
+    }
+  }
+}
+
+export function applyOpToParent(parentAttr: string, parent: Op, attr: string, op: Op) {
+  const subAttr = attr.substring(parentAttr.length + 1);
+
+  if (!(parent instanceof SetOp) || !subAttr) {
+    throw new TypeError(`Trying to set sub property on a invalid property (${parentAttr} -> ${subAttr})`);
+  }
+
+  let object = parent._value;
+  const fields = subAttr.split('.');
+  const last = fields[fields.length - 1];
+  for (let i = 0; i < fields.length - 1; i++) {
+    const key = fields[i];
+    if (!(key in object)) {
+      if (op instanceof UnsetOp) {
+        // property already doesn't exist, we don't have to do anytihng
+        return;
+      }
+      object[key] = {};
+    }
+    object = object[key];
+  }
+
+  if (op instanceof UnsetOp) {
+    delete object[last];
+  } else {
+    object[last] = op.applyTo(object[last]);
+  }
+
+  return parent;
+}
+
 export class Op {
   // Empty parent class
   applyTo(value: any): any {} /* eslint-disable-line @typescript-eslint/no-unused-vars */

src/__tests__/ParseObject-test.js

@@ -550,6 +550,84 @@ describe('ParseObject', () => {
     expect(o2.attributes).toEqual({});
   });
 
+  it('can set sub property of a local changed object without creating an op', () => {
+    const o = new ParseObject('Person');
+    o.set('data', { a: 2 });
+    expect(Object.keys(o._getPendingOps()[0]).length).toBe(1);
+
+    o.set('datab', {v: 2});
+    expect(Object.keys(o._getPendingOps()[0]).length).toBe(2);
+
+    o.set('data.b', 3);
+    expect(Object.keys(o._getPendingOps()[0]).length).toBe(2);
+    expect(o._getPendingOps()[0]['data']._value).toStrictEqual({ a: 2, b: 3});
+
+    o.set({"data.c" : 5, "data.d.a": 4});
+    expect(Object.keys(o._getPendingOps()[0]).length).toBe(2);
+    expect(o._getPendingOps()[0]['data']._value).toStrictEqual({ a: 2, b: 3, c: 5, d: { a: 4 }});
+  });
+
+  it('can unset sub property of a local changed object without creating an op', () => {
+    const o = new ParseObject('Person');
+    o.set('data', { a: 2, b: 4 });
+    expect(Object.keys(o._getPendingOps()[0]).length).toBe(1);
+
+    o.unset('data.b');
+    expect(Object.keys(o._getPendingOps()[0]).length).toBe(1);
+    expect(o._getPendingOps()[0]['data']._value).toStrictEqual({ a: 2});
+
+    o.unset('data.c');
+    expect(Object.keys(o._getPendingOps()[0]).length).toBe(1);
+    expect(o._getPendingOps()[0]['data']._value).toStrictEqual({ a: 2});
+
+    o.unset('data.c.d');
+    expect(Object.keys(o._getPendingOps()[0]).length).toBe(1);
+    expect(o._getPendingOps()[0]['data']._value).toStrictEqual({ a: 2});
+
+    o.set('data.b.c', 3);
+    expect(Object.keys(o._getPendingOps()[0]).length).toBe(1);
+    expect(o._getPendingOps()[0]['data']._value).toStrictEqual({ a: 2, b: { c: 3 }});
+
+    o.unset('data.b.c');
+    expect(Object.keys(o._getPendingOps()[0]).length).toBe(1);
+    expect(o._getPendingOps()[0]['data']._value).toStrictEqual({ a: 2, b: {}});
+
+    o.unset('data.b');
+    expect(Object.keys(o._getPendingOps()[0]).length).toBe(1);
+    expect(o._getPendingOps()[0]['data']._value).toStrictEqual({ a: 2});
+  });
+
+  it('can increment sub property of a local changed object without creating an op', () => {
+    const o = new ParseObject('Person');
+    o.set('data', {a: 2, b: 4});
+    expect(Object.keys(o._getPendingOps()[0]).length).toBe(1);
+
+    o.increment('data.a', 3);
+    expect(Object.keys(o._getPendingOps()[0]).length).toBe(1);
+    expect(o._getPendingOps()[0]['data']._value).toStrictEqual({ a: 5, b: 4});
+  });
+
+  it('collapse sub-property sets with parents as well', () => {
+    const o = new ParseObject('Person');
+    o._finishFetch({
+      objectId: 'o12312',
+      data: { a: 3 }
+    });
+    expect(o.dirty()).toBe(false);
+    expect(Object.keys(o._getPendingOps()[0]).length).toBe(0);
+
+    o.set('data.b', { c: 1 });
+    expect(Object.keys(o._getPendingOps()[0]).length).toBe(1);
+
+    o.set('data.boo', 4);
+    expect(Object.keys(o._getPendingOps()[0]).length).toBe(2);
+    expect(o._getPendingOps()[0]['data.boo']._value).toStrictEqual(4);
+
+    o.set('data.b.c', 2);
+    expect(Object.keys(o._getPendingOps()[0]).length).toBe(2);
+    expect(o._getPendingOps()[0]['data.b']._value).toStrictEqual({ c: 2 });
+  });
+
   it('can clear all fields', () => {
     const o = new ParseObject('Person');
     o._finishFetch({