bugfix: execute does not work with new ValidatedChangeset (#169)

* Improve new validated changeset

* prettier

* fix lint

* properly handle deep merging with structuredClone

* add comment

* prettier

package.json

@@ -68,5 +68,11 @@
   },
   "volta": {
     "node": "14.19.1"
+  },
+  "dependencies": {
+    "@types/ungap__structured-clone": "^0.3.0",
+    "@ungap/structured-clone": "^0.3.4",
+    "i": "^0.3.7",
+    "npm": "^8.7.0"
   }
 }

src/utils/get-key-values.ts

@@ -5,6 +5,7 @@ import { PublicErrors } from '../types';
 
 /**
  * traverse through target and return leaf nodes with `value` property and key as 'person.name'
+ * Only detects key paths with Changes
  *
  * @method getKeyValues
  * @return {Array} [{ 'person.name': value }]

src/utils/merge-nested.ts

@@ -5,8 +5,6 @@ const { keys } = Object;
 /**
  * Given an array of objects, merge their keys into a new object and
  * return the new object.
- *
- * This function merges using `setNestedProperty`.
  */
 export default function mergeNested<T>(
   ...objects: Array<{ [key: string]: T }>

src/validated.ts

@@ -15,6 +15,7 @@ import mergeDeep from './utils/merge-deep';
 import setDeep from './utils/set-deep';
 import getDeep, { getSubObject } from './utils/get-deep';
 import { objectToArray, arrayToObject } from './utils/array-object';
+import structuredClone from '@ungap/structured-clone';
 
 import {
   Changes,
@@ -303,7 +304,10 @@ export class ValidatedChangeset {
 
       // we want mutation on original object
       // @tracked
-      this[CONTENT] = this.mergeDeep(content, changes);
+      this[CONTENT] = this.mergeDeep(content, changes, {
+        safeGet: this.safeGet,
+        safeSet: this.safeSet
+      });
     }
 
     // trigger any registered callbacks by same keyword as method name
@@ -387,7 +391,8 @@ export class ValidatedChangeset {
     const changes = this[CHANGES];
     const content = this[CONTENT];
 
-    return cb({ ...normalizeObject(content), ...normalizeObject(changes) });
+    // return an object that does not poison original model and provides user with full set of data + changes to validate
+    return cb(this.mergeDeep(structuredClone(content), changes));
   }
 
   /**

test/utils/get-key-values.test.ts

@@ -11,6 +11,10 @@ describe('Unit | Utility | getKeyValues', function() {
 
   it('it works with nested keys', () => {
     const result = getKeyValues({
+      lastLogin: new Date(), // not a change
+      team: {
+        name: 'scoot'
+      },
       user: {
         firstName: { [VALUE]: 'Michael' },
         lastName: { [VALUE]: 'Bolton' },

test/utils/merge-deep.test.ts

@@ -102,6 +102,7 @@ describe('Unit | Utility | merge deep', () => {
       }
 
       foo = { baz: 'ba' };
+      jam = new Change(['Jull', 'Olafur']);
     }
 
     class B extends A {
@@ -117,5 +118,14 @@ describe('Unit | Utility | merge deep', () => {
     expect(value.boo).toBe('doo');
     expect(value.other).toBe('Ivan');
     expect(value.foo).toEqual({ baz: 'bar' });
+    expect(value.jam).toEqual(new Change(['Jull', 'Olafur']));
+
+    expect(objA.jam).toEqual(new Change(['Jull', 'Olafur']));
+    expect(objA.foo).toEqual({ baz: 'bar' });
+    expect(objA._boo).toEqual('doo');
+    expect(objB.boo).toEqual(new Change('doo'));
+    expect(objA.other).toEqual('Ivan');
+    expect(objB.foo).toEqual({ baz: new Change('bar') });
+    expect(objA.other).toEqual('Ivan');
   });
 });

test/utils/normalize-object.test.ts

@@ -24,10 +24,10 @@ describe('Unit | Utility | normalize object', () => {
   });
 
   it('it returns multiple values from nested', () => {
-    const objA = { name: new Change('Ivan'), foo: new Change('bar') };
+    const objA = { name: new Change('Ivan'), foo: new Change('bar'), bar: 'zoo' };
     const value = normalizeObject(objA);
 
-    expect(value).toEqual({ name: 'Ivan', foo: 'bar' });
+    expect(value).toEqual({ name: 'Ivan', foo: 'bar', bar: 'zoo' });
   });
 
   it('it returns for deep nested', () => {