Changed protocol (undefined is now delete instruction)

Author: Josema

package.json

@@ -1,6 +1,6 @@
 {
   "name": "dop",
-  "version": "0.27.0",
+  "version": "0.28.0",
   "main": "./dist/dop.nodejs.js",
   "browser": "./dist/dop.js",
   "unpkg": "./dist/dop.min.js",
@@ -57,7 +57,7 @@
     "tape-run": "^2.1.4"
   },
   "scripts": {
-    "grunt": "grunt",
+    "dev": "grunt",
     "build": "grunt --build",
     "test": "tap test/**.js test/protocol/**.js",
     "test-proxy": "tap test/**.js test/protocol/**.js --test-arg=proxy",

src/core/mutators/set.js

@@ -8,7 +8,7 @@ dop.core.set = function(object, property, value, options) {
     options.shadow = typeof options.shadow == 'boolean' ? options.shadow : false
 
     // If is a different value
-    if (object[property] !== value) {
+    if (object[property] !== value || !object.hasOwnProperty(property)) {
 
         var descriptor = Object.getOwnPropertyDescriptor(object, property);
 

src/core/objects/injectMutationInPatch.js

@@ -4,6 +4,7 @@ dop.core.injectMutationInPatch = function(patch, mutation) {
     var prop = mutation.prop,
         path = mutation.path,
         value = mutation.value,
+        isMutationDelete = !mutation.hasOwnProperty('value'),
         isMutationSplice = mutation.splice!==undefined,
         isMutationSwaps = mutation.swaps!==undefined,
         isMutationArray = isMutationSplice || isMutationSwaps,
@@ -79,7 +80,6 @@ dop.core.injectMutationInPatch = function(patch, mutation) {
         }
     }
 
-
     // Mutations over arrays
     else if (isMutationArray) {
         if (isNewObject)
@@ -106,6 +106,9 @@ dop.core.injectMutationInPatch = function(patch, mutation) {
         }
     }
 
+    // Delete
+    else if (isMutationDelete)
+        chunk[prop] = [instructionsPatchs.delete];
 
     // Others values
     else

src/core/objects/setPatch.js

@@ -27,8 +27,12 @@ dop.core.setPatchMutator = function(destiny, prop, value, typeofValue) {
     if (typeofValue == 'array') {
         typeInstruction = value[0];
 
+        // Delete
+        if (typeInstruction === instructionsPatchs.delete)
+            dop.del(destiny, prop);
+
         // New object/array
-        if (typeInstruction === instructionsPatchs.object)
+        else if (typeInstruction === instructionsPatchs.object)
             dop.set(destiny, prop, dop.util.clone(value[1]));
 
         // Array mutations
@@ -51,9 +55,7 @@ dop.core.setPatchMutator = function(destiny, prop, value, typeofValue) {
         return true; // Skiping to dont go inside of [instructionPatch, ...]
     }
 
-    // Delete
-    else if (typeofValue=='undefined')
-        dop.del(destiny, prop);
+
 
     // Set value
     else if (typeofValue!='object')

src/protocol/instructionsPatchs.js

@@ -1,12 +1,13 @@
 
 dop.protocol.instructionsPatchs = {
-    undefined: '~U', // Delete
+    delete: 0, // Delete
+    object: 1, // New object or array
+    splice: 2, // Splice array
+    swaps: 3, // Swap array
     function: '~F', // Remote function
-    object: 0, // New object or array
-    splice: 1, // Splice array
-    swaps: 2, // Swap array
 
     // Non standards, only for JavaScript
+    undefined: '~U', // Undefined
     nan: '~N',
     regex: '~R',
     infinity: '~I',

test/getpatchs.js

@@ -50,7 +50,7 @@ test(header+'Changing property', function(t) {
     var collector = dop.collect();
     set(objectServer, 'one', 11);
     var patchGenerated = getPatch(collector);
-    t.equal(collector.mutations.length, 1, 'Mutations expecteds: '+collector.mutations.length);
+    t.equal(collector.mutations.length, mutationsExpected, 'Mutations expecteds: '+collector.mutations.length);
     maketest(t, patchGenerated, patchExpected);
 });
 
@@ -70,7 +70,7 @@ test(header+'Changing property with the same value', function(t) {
 
 test(header+'Deleting property', function(t) {
     var objectServer = dop.register({one:11});
-    var patchExpected = [{one:undefined}];
+    var patchExpected = [{one:[0]}];
     var mutationsExpected = 1;
 
     var collector = dop.collect();
@@ -82,7 +82,7 @@ test(header+'Deleting property', function(t) {
 
 test(header+'Change and delete a removed item', function(t) {
     var objectServer = dop.register({one:11});
-    var patchExpected = [{two:2,one:undefined}];
+    var patchExpected = [{two:2,one:[0]}];
     var mutationsExpected = 3;
 
     var collector = dop.collect();
@@ -91,7 +91,7 @@ test(header+'Change and delete a removed item', function(t) {
     set(objectServer, 'two', 2);
     var patchGenerated = getPatch(collector);
     t.equal(collector.mutations.length, mutationsExpected, 'Mutations expecteds: '+collector.mutations.length);
-    maketest(t, patchGenerated, patchExpected);
+    maketest(t, patchGenerated, patchExpected, false);
 });
 
 
@@ -112,6 +112,20 @@ test(header+'Setting property array', function(t) {
 
 
 
+test(header+'Adding undefineds', function(t) {
+    var objectServer = dop.register({one:1,array:[]});
+    var patchExpected = [{array: [ 2, [ 0, 0, undefined ] ], one:undefined,two:undefined}];
+    var mutationsExpected = 3;
+
+
+    var collector = dop.collect();
+    set(objectServer, 'one', undefined);
+    set(objectServer, 'two', undefined);
+    objectServer.array.push(undefined)
+    var patchGenerated = getPatch(collector);
+    t.equal(collector.mutations.length, mutationsExpected, 'Mutations expecteds: '+collector.mutations.length);
+    maketest(t, patchGenerated, patchExpected);
+});
 
 
 
@@ -125,7 +139,7 @@ test(header+'Setting an array and mutating it', function(t) {
     var collector = dop.collect();
 
 
-    var patchExpected = [{"array":[0,["c","b",{"B1":"string"},false,true]]}];
+    var patchExpected = [{"array":[1,["c","b",{"B1":"string"},false,true]]}];
     var mutationsExpected = 5;
     set(object, 'array', [true,false]);
     object.array.push('a','b','c')
@@ -149,7 +163,7 @@ test(header+'Mutating array then mutating nested objects', function(t) {
     var collector = dop.collect();
 
 
-    var patchExpected = [{"array":[2,[0,1]]},{"array":{"2":[0,{"B1":false}],"length":3}}];
+    var patchExpected = [{"array":[3,[0,1]]},{"array":{"2":[1,{"B1":false}],"length":3}}];
     var mutationsExpected = 3;
     object.array.reverse();
     set(object.array, 2, {B1:false});
@@ -170,7 +184,7 @@ test(header+'Mutating nested objects then mutating parent array', function(t) {
     var collector = dop.collect();
 
 
-    var patchExpected = [{"array":{"2":[0,{"B1":false}],"length":3}},{"array":[2,[0,2]]}];
+    var patchExpected = [{"array":{"2":[1,{"B1":false}],"length":3}},{"array":[3,[0,2]]}];
     var mutationsExpected = 3;
     set(object.array, 2, {B1:false});
     object.array.reverse();
@@ -191,7 +205,7 @@ test(header+'Mutating array twice', function(t) {
     var collector = dop.collect();
 
 
-    var patchExpected = [{"array":[[1,[3,0,5,4,6]],[2,[0,1,1,2,3,4]]]}];
+    var patchExpected = [{"array":[[2,[3,0,5,4,6]],[3,[0,1,1,2,3,4]]]}];
     var mutationsExpected = 2;
     object.array.push(5,4,6);
     object.array.sort();
@@ -211,7 +225,7 @@ test(header+'Mutating array and mutating array deeper', function(t) {
     var collector = dop.collect();
 
 
-    var patchExpected = [{"array":[2,[0,2]]},{"array":{"0":[2,[0,1]]}}];
+    var patchExpected = [{"array":[3,[0,2]]},{"array":{"0":[3,[0,1]]}}];
     var mutationsExpected = 2;
     object.array.reverse();
     object.array[0].reverse();
@@ -230,7 +244,7 @@ test(header+'Mutating array deeper and mutating container', function(t) {
     var collector = dop.collect();
 
 
-    var patchExpected = [{"array":{"2":[2,[0,1]]}},{"array":[2,[0,2]]}];
+    var patchExpected = [{"array":{"2":[3,[0,1]]}},{"array":[3,[0,2]]}];
     var mutationsExpected = 2;
     object.array[2].reverse();
     object.array.reverse();

test/getunpatchs.js

@@ -30,7 +30,7 @@ var header = '--- ';
 
 test(header+'Adding property', function(t) {
     var objectServer = dop.register({});
-    var patchExpected = [{one:undefined}];
+    var patchExpected = [{one:[0]}];
     var mutationsExpected = 1;
 
 
@@ -88,15 +88,15 @@ test(header+'Change and delete a removed item', function(t) {
 
 
     var mutationsExpected = 3;
-    var patchExpected = [{one:11,two:undefined}];
+    var patchExpected = [{one:11,two:[0]}];
     set(objectServer, 'one', 'Changeddd');
     del(objectServer, 'one');
     set(objectServer, 'two', 2);
 
 
     var patchGenerated = applyPatch(collector);
     t.equal(collector.mutations.length, mutationsExpected, 'Mutations expecteds: '+collector.mutations.length);
-    maketest(t, patchGenerated, patchExpected);
+    maketest(t, patchGenerated, patchExpected, false);
 });
 
 
@@ -107,7 +107,7 @@ test(header+'Setting property array', function(t) {
     var collector = dop.collect();
 
 
-    var patchExpected = [{"array":{"5":undefined,"length":2}}];
+    var patchExpected = [{"array":{"5":[0],"length":2}}];
     var mutationsExpected = 2;
     set(object.array, 5, "three");
 
@@ -130,7 +130,7 @@ test(header+'Setting an array and mutating it', function(t) {
     var collector = dop.collect();
 
 
-    var patchExpected = [{"array":[2,[2,0]]},{"array":undefined}];
+    var patchExpected = [{"array":[3,[2,0]]},{"array":[0]}];
     var mutationsExpected = 4;
     set(object, 'array', [true,false]);
     set(object.array, 2, {B1:[true,false]});
@@ -152,7 +152,7 @@ test(header+'Mutating array then mutating nested objects', function(t) {
     var collector = dop.collect();
 
 
-    var patchExpected = [{"array":{"2":undefined,"length":2}},{"array":[2,[1,0]]}];
+    var patchExpected = [{"array":{"2":[0],"length":2}},{"array":[3,[1,0]]}];
     var mutationsExpected = 3;
     object.array.reverse();
     set(object.array, 2, {B1:false});
@@ -173,7 +173,7 @@ test(header+'Mutating nested objects then mutating parent array', function(t) {
     var collector = dop.collect();
 
 
-    var patchExpected = [{"array":[2,[2,0]]},{"array":{"2":undefined,"length":2}}];
+    var patchExpected = [{"array":[3,[2,0]]},{"array":{"2":[0],"length":2}}];
     var mutationsExpected = 3;
     set(object.array, 2, {B1:false});
     object.array.reverse();
@@ -194,7 +194,7 @@ test(header+'Mutating array twice', function(t) {
     var collector = dop.collect();
 
 
-    var patchExpected = [{"array":[[2,[4,3,2,1,1,0]],[1,[3,3]]]}];
+    var patchExpected = [{"array":[[3,[4,3,2,1,1,0]],[2,[3,3]]]}];
     var mutationsExpected = 2;
     object.array.push(5,4,6);
     object.array.sort();
@@ -213,7 +213,7 @@ test(header+'Mutating array and mutating array deeper', function(t) {
     var collector = dop.collect();
 
 
-    var patchExpected = [{"array":{"0":[2,[1,0]]}},{"array":[2,[2,0]]}];
+    var patchExpected = [{"array":{"0":[3,[1,0]]}},{"array":[3,[2,0]]}];
     var mutationsExpected = 2;
     object.array.reverse();
     object.array[0].reverse();
@@ -232,7 +232,7 @@ test(header+'Mutating array deeper and mutating container', function(t) {
     var collector = dop.collect();
 
 
-    var patchExpected = [{"array":[2,[2,0]]},{"array":{"2":[2,[1,0]]}}];
+    var patchExpected = [{"array":[3,[2,0]]},{"array":{"2":[3,[1,0]]}}];
     var mutationsExpected = 2;
     object.array[2].reverse();
     object.array.reverse();

test/undoredo.js

@@ -8,13 +8,15 @@ var del = dop.del;
 
 function makeTest(t, snapshot, original, object, mutated) {
 
-    var patch, unpatch;
     var object_id = dop.getObjectId(object)
     var target = dop.getObjectTarget(object)
+    var unpatch = snapshot.getUnpatch()[object_id].chunks
+    var patch = snapshot.getPatch()[object_id].chunks
 
-    unpatch = dop.decode(dop.encode(snapshot.getUnpatch()[object_id].chunks))
+
+    unpatch = dop.decode(dop.encode(unpatch))
     // console.log('UNDO', unpatch.length, JSON.stringify(unpatch))
-    patch = dop.decode(dop.encode(snapshot.getPatch()[object_id].chunks))
+    patch = dop.decode(dop.encode(patch))
     // console.log('REDO', patch.length, JSON.stringify(patch))
 
     // Undo
@@ -61,6 +63,7 @@ test('Set array', function(t) {
     var original = dop.util.clone(object)
     var collector = dop.collect()
     set(object, 'dos', {e:4})
+    set(object, 'three', undefined)
     var snapshot = collector.emit()
     var mutated = dop.util.clone(object)