fix: handle dots in key names

Author: theKashey

_tests/smoke.spec.js

@@ -14,6 +14,7 @@ import {
   proxyObjectRest,
   proxyArrayRest, isKnownObject
 } from '../src';
+import {unescapeKey} from "../src/escapeKey";
 
 describe('proxy', () => {
   it('arrays', () => {
@@ -317,6 +318,20 @@ describe('proxy', () => {
     expect(o1.isPrototypeOf(trapped.state)).to.be.true;
   });
 
+  it('handles dots in names', () => {
+    const o1 = {
+      'test.object.1': 1
+    };
+    const o2 = {
+      'test.object.2': 2
+    };
+    const trapped = proxyState(o1);
+    expect(trapped.state['test.object.1']).to.be.equal(1);
+    expect(trapped.affected).not.to.be.deep.equal(['.test.object.1']);
+    expect(unescapeKey(trapped.affected[0])).to.be.equal('.test.object.1');
+    expect(proxyEqual(o1, o2, trapped.affected)).to.be.equal(false);
+  });
+
   it('detect self', () => {
     const A = {a: 1};
     const B = proxyState(A).state;

src/escapeKey.js

@@ -0,0 +1,29 @@
+const dotReplacement = String.fromCharCode(1);
+// const symbolReplacement = String.fromCharCode(2);
+//
+// let escapeRefCount = 0;
+// const escapeReference = new WeakMap();
+
+export const unescapeKey = (key) => {
+  return key.replace(/\u0001/g, '.');
+};
+
+export const escapeKey = (key) => {
+  const type = typeof key;
+  // if(type!=="string" || type!=="number"){
+  //   const ref = escapeReference.get(key);
+  //   if(ref) {
+  //     return ref;
+  //   }
+  //   escapeRefCount++;
+  //   escapeReference.set(key, escapeRefCount);
+  //   const keyCode = symbolReplacement+escapeRefCount;
+  //
+  //   return keyCode
+  // }
+  if (type === "number") {
+    return key;
+  }
+
+  return String(key).replace(/\./g, dotReplacement);
+};

src/proxyEqual.js

@@ -1,10 +1,13 @@
+/* eslint-disable no-control-regex */
+
 import {str as crc32_str} from "crc-32";
 
 import {getCollectionHandlers, shouldInstrument} from "./shouldInstrument";
 import {weakMemoizeArray} from "./weakMemoize";
 import {EDGE, memoizedBuildTrie} from "./objectTrie";
 import {addDiffer, resetDiffers} from "./differs";
 import {proxyPolyfill} from './proxy-polyfill';
+import {escapeKey, unescapeKey} from "./escapeKey";
 
 const hasProxy = typeof Proxy !== 'undefined';
 const ProxyConstructor = hasProxy ? Proxy : proxyPolyfill();
@@ -98,7 +101,7 @@ export function proxyfy(state, report, suffix = '', fingerPrint, ProxyMap, contr
           if (nextItem.done && !nextItem.value) {
             return;
           }
-          return proxyValue(subKey, nextItem.value)
+          return proxyValue(subKey, subKey, nextItem.value)
         }
       };
     };
@@ -110,8 +113,8 @@ export function proxyfy(state, report, suffix = '', fingerPrint, ProxyMap, contr
     }
   };
 
-  const proxyValue = (key, value) => {
-    const thisId = report(suffix, key);
+  const proxyValue = (key, reportValue, value) => {
+    const thisId = report(suffix, reportValue);
     const type = typeof value;
 
 
@@ -122,9 +125,9 @@ export function proxyfy(state, report, suffix = '', fingerPrint, ProxyMap, contr
     if (hasCollectionHandlers) {
       switch (key) {
         case 'get':
-          return key => proxyValue(key, state.get(key));
+          return key => proxyValue(key, escapeKey(key), state.get(key));
         case 'has':
-          return key => proxyValue(key, state.has(key));
+          return key => proxyValue(key, escapeKey(key), state.has(key));
         case 'keys':
           return () => state.keys();
         case 'values':
@@ -173,7 +176,7 @@ export function proxyfy(state, report, suffix = '', fingerPrint, ProxyMap, contr
       }
 
       if (typeof prop === 'string') {
-        return proxyValue(prop, storedValue);
+        return proxyValue(prop, escapeKey(prop), storedValue);
       }
 
       return storedValue;
@@ -249,7 +252,7 @@ const memoizedCollectValuables = weakMemoizeArray(collectValuables);
 const get = (target, path) => {
   let result = target;
   for (let i = 1; i < path.length && result; ++i) {
-    const key = path[i];
+    const key = unescapeKey(path[i]);
     if (key[0] === '!') {
       if (key === objectKeysMarker) {
         return Object.keys(result).map(crc32_str).reduce((acc, x) => acc ^ x, 0);