Merge pull request #24 from creately/improve-change-tracking

improved change tracking not to track if value is same

.gitignore

@@ -1,2 +1,3 @@
 dist
 coverage
+node_modules

changelog.md

@@ -1,3 +1,8 @@
+# 2021-03-16 - v2.4.3
+
+ - improved change tracking. now if the value of a property is updated with the same value it will not track as a change.
+ - es getters/setters configuration.
+
 # 2019-06-18 - v2.4.2
 
  - Cache getters and property descriptors using weakmaps to reduce property lookup overhead.

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@creately/sakota",
-  "version": "2.4.2",
+  "version": "2.4.3",
   "description": "Proxies js objects and records all changes made on an object without modifying the object.",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",

src/__tests__/index.spec.ts

@@ -1,8 +1,5 @@
 import { Sakota } from '../';
 
-Sakota.enableESGetters();
-Sakota.enableESSetters();
-
 /**
  * Function returns an array of different types of values.
  */
@@ -585,6 +582,16 @@ describe('Sakota', () => {
         expect(proxy.__sakota__.getChanges('', /a/)).toEqual({ $set: { a: 1000 } });
         expect(proxy.__sakota__.getChanges('', /c/)).toEqual({ $unset: { c: true } });
       });
+
+      it('should not track changes if value is not changed', () => {
+        const proxy = Sakota.create({ a: 10, b: 20, c: 30 });
+        proxy.a = 10;
+        expect(proxy.__sakota__.getChanges()).toEqual({});
+        proxy.a = 12;
+        expect(proxy.__sakota__.getChanges()).toEqual({ $set: { a: 12 } });
+        proxy.a = 10;
+        expect(proxy.__sakota__.getChanges()).toEqual({});
+      });
     });
 
     describe('hasChanges', () => {

src/deep-equal.ts

@@ -0,0 +1,26 @@
+// ref: https://stackoverflow.com/a/25456134
+
+const deepEqual = (x: any, y: any) => {
+  if (x === y) {
+    return true;
+  } else if (typeof x == 'object' && x != null && (typeof y == 'object' && y != null)) {
+    if (Object.keys(x).length != Object.keys(y).length) {
+      return false;
+    }
+
+    for (var prop in x) {
+      if (y.hasOwnProperty(prop)) {
+        if (!deepEqual(x[prop], y[prop])) {
+          return false;
+        }
+      } else {
+        return false;
+      }
+    }
+
+    return true;
+  }
+  return false;
+};
+
+export default deepEqual;

src/index.ts

@@ -1,3 +1,5 @@
+import deepEqual from './deep-equal';
+
 /**
  * The key used to get the handler.
  */
@@ -41,8 +43,8 @@ export class Sakota<T extends object> implements ProxyHandler<T> {
    */
   private static config = {
     prodmode: false,
-    esgetter: false,
-    essetter: false,
+    esgetter: true,
+    essetter: true,
   };
 
   /**
@@ -55,15 +57,15 @@ export class Sakota<T extends object> implements ProxyHandler<T> {
   /**
    * Makes Sakota support javascript getters (expensive!).
    */
-  public static enableESGetters(): void {
-    this.config.esgetter = true;
+  public static disableESGetters(): void {
+    this.config.esgetter = false;
   }
 
   /**
    * Makes Sakota support javascript getters (expensive!).
    */
-  public static enableESSetters(): void {
-    this.config.essetter = true;
+  public static disableESSetters(): void {
+    this.config.essetter = false;
   }
 
   /**
@@ -237,6 +239,14 @@ export class Sakota<T extends object> implements ProxyHandler<T> {
     if (!this.diff) {
       this.diff = { $set: {}, $unset: {} };
     }
+    if (key in obj && deepEqual(obj[key], val)) {
+      if (this.diff.$unset[key] || this.diff.$set[key]) {
+        delete this.diff.$unset[key];
+        delete this.diff.$set[key];
+        this.onChange();
+      }
+      return true;
+    }
     delete this.diff.$unset[key];
     delete this.kids[key];
     this.diff.$set[key] = val;