Merge pull request #384 from streamich/crdt-verbose-encoding

JSON CRDT verbose encoding

Author: streamich

src/json-cli/routes/crdt.ts

@@ -1,5 +1,5 @@
 import {Model} from '../../json-crdt';
-import {Encoder as VerboseEncoder} from '../../json-crdt/codec/structural/json/Encoder';
+import {Encoder as VerboseEncoder} from '../../json-crdt/codec/structural/verbose/Encoder';
 import {Encoder as CompactEncoder} from '../../json-crdt/codec/structural/compact/Encoder';
 import {encode as encodePatch} from '../../json-crdt-patch/codec/compact/encode';
 import {TypeRouter, RoutesBase} from '../../json-type/system/TypeRouter';

src/json-crdt/__demos__/codec/verbose.ts

@@ -4,7 +4,7 @@
 // npx nodemon -q -x ts-node src/json-crdt/__demos__/codec/verbose.ts
 
 import {Model} from '../..';
-import {Encoder} from '../../codec/structural/json/Encoder';
+import {Encoder} from '../../codec/structural/verbose/Encoder';
 import {inspect} from 'util';
 
 const encoder = new Encoder();

src/json-crdt/__tests__/fuzzer/SessionLogical.ts

@@ -3,13 +3,13 @@ import {decode as decodeCompact} from '../../../json-crdt-patch/codec/compact/de
 import {decode as decodeJson} from '../../../json-crdt-patch/codec/verbose/decode';
 import {Decoder as BinaryDecoder} from '../../codec/structural/binary/Decoder';
 import {Decoder as CompactDecoder} from '../../codec/structural/compact/Decoder';
-import {Decoder as JsonDecoder} from '../../codec/structural/json/Decoder';
+import {Decoder as JsonDecoder} from '../../codec/structural/verbose/Decoder';
 import {DelOp, InsObjOp, InsStrOp, InsBinOp, InsArrOp} from '../../../json-crdt-patch/operations';
 import {encode as encodeCompact} from '../../../json-crdt-patch/codec/compact/encode';
 import {encode as encodeJson} from '../../../json-crdt-patch/codec/verbose/encode';
 import {Encoder as BinaryEncoder} from '../../codec/structural/binary/Encoder';
 import {Encoder as CompactEncoder} from '../../codec/structural/compact/Encoder';
-import {Encoder as JsonEncoder} from '../../codec/structural/json/Encoder';
+import {Encoder as JsonEncoder} from '../../codec/structural/verbose/Encoder';
 import {generateInteger} from './util';
 import {Model} from '../..';
 import {Patch} from '../../../json-crdt-patch/Patch';

src/json-crdt/codec/structural/binary/__tests__/all-types-smoketest.spec.ts

@@ -1,5 +1,5 @@
 import {Model} from '../../../../model';
-import {runCodecAllTypesSmokeTests} from '../../json/__tests__/runCodecAllTypesSmokeTests';
+import {runCodecAllTypesSmokeTests} from '../../verbose/__tests__/runCodecAllTypesSmokeTests';
 import {ViewDecoder} from '../ViewDecoder';
 
 const assertCodec = (doc: Model) => {

src/json-crdt/codec/structural/compact-binary/__tests__/all-types-smoketest.spec.ts

@@ -1,7 +1,7 @@
 import {Model} from '../../../../model';
 import {Encoder} from '../Encoder';
 import {Decoder} from '../Decoder';
-import {runCodecAllTypesSmokeTests} from '../../json/__tests__/runCodecAllTypesSmokeTests';
+import {runCodecAllTypesSmokeTests} from '../../verbose/__tests__/runCodecAllTypesSmokeTests';
 
 const encoder = new Encoder();
 const decoder = new Decoder();

src/json-crdt/codec/structural/compact/__tests__/all-types-smoketest.spec.ts

@@ -1,7 +1,7 @@
 import {Model} from '../../../../model';
 import {Encoder} from '../Encoder';
 import {Decoder} from '../Decoder';
-import {runCodecAllTypesSmokeTests} from '../../json/__tests__/runCodecAllTypesSmokeTests';
+import {runCodecAllTypesSmokeTests} from '../../verbose/__tests__/runCodecAllTypesSmokeTests';
 
 const encoder = new Encoder();
 const decoder = new Decoder();

src/json-crdt/codec/structural/json/types.ts

@@ -3,33 +3,17 @@ import {fromBase64} from '../../../../util/base64/fromBase64';
 import {ITimestampStruct, ts, VectorClock} from '../../../../json-crdt-patch/clock';
 import {Model} from '../../../model';
 import {SESSION} from '../../../../json-crdt-patch/constants';
-import {
-  JsonCrdtNode,
-  ObjectJsonCrdtNode,
-  ArrayJsonCrdtNode,
-  ArrayJsonCrdtChunk,
-  JsonCrdtRgaTombstone,
-  ValueJsonCrdtNode,
-  StringJsonCrdtNode,
-  StringJsonCrdtChunk,
-  ConstantJsonCrdtNode,
-  BinaryJsonCrdtNode,
-  BinaryJsonCrdtChunk,
-  JsonCrdtSnapshot,
-  JsonCrdtLogicalTimestamp,
-  JsonCrdtTimestamp,
-  TupleJsonCrdtNode,
-} from './types';
+import * as types from './types';
 
 export class Decoder {
-  public decode({time, root}: JsonCrdtSnapshot): Model {
+  public decode({time, root}: types.JsonCrdtVerboseDocument): Model {
     const isServerClock = typeof time === 'number';
     const doc = isServerClock ? Model.withServerClock(time) : Model.withLogicalClock(this.cClock(time));
     this.cRoot(doc, root);
     return doc;
   }
 
-  protected cClock(timestamps: JsonCrdtLogicalTimestamp[]): VectorClock {
+  protected cClock(timestamps: types.JsonCrdtVerboseLogicalTimestamp[]): VectorClock {
     const [stamp] = timestamps;
     const vectorClock = new VectorClock(stamp[0], stamp[1]);
     const length = timestamps.length;
@@ -41,18 +25,18 @@ export class Decoder {
     return vectorClock;
   }
 
-  protected cTs(stamp: JsonCrdtTimestamp): ITimestampStruct {
+  protected cTs(stamp: types.JsonCrdtVerboseTimestamp): ITimestampStruct {
     const isServerClock = typeof stamp === 'number';
     return isServerClock ? ts(SESSION.SERVER, stamp) : ts(stamp[0], stamp[1]);
   }
 
-  protected cRoot(doc: Model, {node}: ValueJsonCrdtNode): void {
-    const val = node ? this.cNode(doc, node) : new nodes.ConNode(doc.clock.tick(0), null);
+  protected cRoot(doc: Model, {value}: types.JsonCrdtVerboseVal): void {
+    const val = value ? this.cNode(doc, value) : new nodes.ConNode(doc.clock.tick(0), null);
     const root = new nodes.RootNode(doc, val.id);
     doc.root = root;
   }
 
-  protected cNode(doc: Model, node: JsonCrdtNode): nodes.JsonNode {
+  protected cNode(doc: Model, node: types.JsonCrdtNode): nodes.JsonNode {
     switch (node.type) {
       case 'obj':
         return this.cObj(doc, node);
@@ -62,44 +46,45 @@ export class Decoder {
         return this.cStr(doc, node);
       case 'val':
         return this.cVal(doc, node);
-      case 'const':
-        return this.cConst(doc, node);
-      case 'tup':
-        return this.cTup(doc, node);
+      case 'con':
+        return this.cCon(doc, node);
+      case 'vec':
+        return this.cVec(doc, node);
       case 'bin':
         return this.cBin(doc, node);
     }
     throw new Error('UNKNOWN_NODE');
   }
 
-  protected cObj(doc: Model, node: ObjectJsonCrdtNode): nodes.ObjNode {
+  protected cObj(doc: Model, node: types.JsonCrdtVerboseObj): nodes.ObjNode {
     const id = this.cTs(node.id);
     const obj = new nodes.ObjNode(doc, id);
-    const keys = Object.keys(node.keys);
+    const map = node.map;
+    const keys = Object.keys(map);
     for (const key of keys) {
-      const keyNode = node.keys[key];
+      const keyNode = map[key];
       obj.put(key, this.cNode(doc, keyNode).id);
     }
     doc.index.set(id, obj);
     return obj;
   }
 
-  protected cTup(doc: Model, node: TupleJsonCrdtNode): nodes.VecNode {
+  protected cVec(doc: Model, node: types.JsonCrdtVerboseVec): nodes.VecNode {
     const id = this.cTs(node.id);
     const obj = new nodes.VecNode(doc, id);
     const elements = obj.elements;
-    const components = node.components;
-    const length = components.length;
+    const map = node.map;
+    const length = map.length;
     for (let i = 0; i < length; i++) {
-      const component = components[i];
+      const component = map[i];
       if (!component) elements.push(undefined);
       else elements.push(this.cNode(doc, component).id);
     }
     doc.index.set(id, obj);
     return obj;
   }
 
-  protected cArr(doc: Model, node: ArrayJsonCrdtNode): nodes.ArrNode {
+  protected cArr(doc: Model, node: types.JsonCrdtVerboseArr): nodes.ArrNode {
     const id = this.cTs(node.id);
     const rga = new nodes.ArrNode(doc, id);
     const chunks = node.chunks;
@@ -110,10 +95,10 @@ export class Decoder {
       rga.ingest(length, () => {
         const c = chunks[i++];
         const id = self.cTs(c.id);
-        if (typeof (c as JsonCrdtRgaTombstone).span === 'number')
-          return new nodes.ArrChunk(id, (c as JsonCrdtRgaTombstone).span, undefined);
+        if (typeof (c as types.JsonCrdtVerboseTombstone).span === 'number')
+          return new nodes.ArrChunk(id, (c as types.JsonCrdtVerboseTombstone).span, undefined);
         else {
-          const ids = (c as ArrayJsonCrdtChunk).nodes.map((n) => this.cNode(doc, n).id);
+          const ids = (c as types.JsonCrdtVerboseArrChunk).value.map((n) => this.cNode(doc, n).id);
           return new nodes.ArrChunk(id, ids.length, ids);
         }
       });
@@ -122,7 +107,7 @@ export class Decoder {
     return rga;
   }
 
-  protected cStr(doc: Model, node: StringJsonCrdtNode): nodes.StrNode {
+  protected cStr(doc: Model, node: types.JsonCrdtVerboseStr): nodes.StrNode {
     const id = this.cTs(node.id);
     const rga = new nodes.StrNode(id);
     const chunks = node.chunks;
@@ -133,10 +118,10 @@ export class Decoder {
       rga.ingest(length, () => {
         const c = chunks[i++];
         const id = self.cTs(c.id);
-        if (typeof (c as JsonCrdtRgaTombstone).span === 'number')
-          return new nodes.StrChunk(id, (c as JsonCrdtRgaTombstone).span, '');
+        if (typeof (c as types.JsonCrdtVerboseTombstone).span === 'number')
+          return new nodes.StrChunk(id, (c as types.JsonCrdtVerboseTombstone).span, '');
         else {
-          const value = (c as StringJsonCrdtChunk).value;
+          const value = (c as types.JsonCrdtVerboseStrChunk).value;
           return new nodes.StrChunk(id, value.length, value);
         }
       });
@@ -145,7 +130,7 @@ export class Decoder {
     return rga;
   }
 
-  protected cBin(doc: Model, node: BinaryJsonCrdtNode): nodes.BinNode {
+  protected cBin(doc: Model, node: types.JsonCrdtVerboseBin): nodes.BinNode {
     const id = this.cTs(node.id);
     const rga = new nodes.BinNode(id);
     const chunks = node.chunks;
@@ -156,10 +141,10 @@ export class Decoder {
       rga.ingest(length, () => {
         const c = chunks[i++];
         const id = self.cTs(c.id);
-        if (typeof (c as JsonCrdtRgaTombstone).span === 'number')
-          return new nodes.BinChunk(id, (c as JsonCrdtRgaTombstone).span, undefined);
+        if (typeof (c as types.JsonCrdtVerboseTombstone).span === 'number')
+          return new nodes.BinChunk(id, (c as types.JsonCrdtVerboseTombstone).span, undefined);
         else {
-          const value = (c as BinaryJsonCrdtChunk).value;
+          const value = (c as types.JsonCrdtVerboseBinChunk).value;
           const buf = fromBase64(value);
           return new nodes.BinChunk(id, buf.length, buf);
         }
@@ -169,17 +154,17 @@ export class Decoder {
     return rga;
   }
 
-  protected cVal(doc: Model, node: ValueJsonCrdtNode): nodes.ValNode {
+  protected cVal(doc: Model, node: types.JsonCrdtVerboseVal): nodes.ValNode {
     const id = this.cTs(node.id);
-    const val = this.cNode(doc, node.node);
+    const val = this.cNode(doc, node.value);
     const obj = new nodes.ValNode(doc, id, val.id);
     doc.index.set(id, obj);
     return obj;
   }
 
-  protected cConst(doc: Model, node: ConstantJsonCrdtNode): nodes.ConNode {
+  protected cCon(doc: Model, node: types.JsonCrdtVerboseCon): nodes.ConNode {
     const id = this.cTs(node.id);
-    const val = node.timestamp ? this.cTs(node.value as JsonCrdtLogicalTimestamp) : node.value;
+    const val = node.timestamp ? this.cTs(node.value as types.JsonCrdtVerboseLogicalTimestamp) : node.value;
     const obj = new nodes.ConNode(id, val);
     doc.index.set(id, obj);
     return obj;