fix(json-crdt): 🐛 make CBOR-based codec pass all tests

Author: streamich

src/json-crdt/codec/structural/binary/Decoder.ts

@@ -80,26 +80,13 @@ export class Decoder extends CborDecoderBase<CrdtReader> {
     return !peek ? UNDEFINED : this.cNode();
   }
 
-  protected nodeLength(minor: number): number {
-    if (minor < 24) return minor;
-    switch (minor) {
-      case 24:
-        return this.reader.u8();
-      case 25:
-        return this.reader.u16();
-      case 26:
-        return this.reader.u32();
-    }
-    return 0;
-  }
-
-  public cNode(): JsonNode {
+  protected cNode(): JsonNode {
     const reader = this.reader;
     const id = this.ts();
     const octet = reader.u8();
     const major = octet >> 5;
     const minor = octet & 0b11111;
-    const length = this.nodeLength(minor);
+    const length = minor < 24 ? minor : minor === 24 ? reader.u8() : minor === 25 ? reader.u16() : reader.u32();
     switch (major) {
       case CRDT_MAJOR.CON: return this.cCon(id, length);
       case CRDT_MAJOR.VAL: return this.cVal(id);
@@ -112,35 +99,35 @@ export class Decoder extends CborDecoderBase<CrdtReader> {
     throw new Error('UNKNOWN_NODE');
   }
 
-  public cCon(id: ITimestampStruct, length: number): ConNode {
+  protected cCon(id: ITimestampStruct, length: number): ConNode {
     const doc = this.doc;
     const data = !length ? this.val() : this.ts();
     const node = new ConNode(id, data);
     doc.index.set(id, node);
     return node;
   }
 
-  public cVal(id: ITimestampStruct): ValNode {
+  protected cVal(id: ITimestampStruct): ValNode {
     const child = this.cNode();
     const doc = this.doc;
     const node = new ValNode(doc, id, child.id);
     doc.index.set(id, node);
     return node;
   }
 
-  public cObj(id: ITimestampStruct, length: number): ObjNode {
+  protected cObj(id: ITimestampStruct, length: number): ObjNode {
     const obj = new ObjNode(this.doc, id);
     for (let i = 0; i < length; i++) this.cObjChunk(obj);
     this.doc.index.set(id, obj);
     return obj;
   }
 
-  private cObjChunk(obj: ObjNode): void {
+  protected cObjChunk(obj: ObjNode): void {
     const key: string = this.key();
     obj.keys.set(key, this.cNode().id);
   }
 
-  public cVec(id: ITimestampStruct, length: number): VecNode {
+  protected cVec(id: ITimestampStruct, length: number): VecNode {
     const reader = this.reader;
     const obj = new VecNode(this.doc, id);
     const elements = obj.elements;
@@ -155,7 +142,7 @@ export class Decoder extends CborDecoderBase<CrdtReader> {
     return obj;
   }
 
-  public cArr(id: ITimestampStruct, length: number): ArrNode {
+  protected cArr(id: ITimestampStruct, length: number): ArrNode {
     const obj = new ArrNode(this.doc, id);
     obj.ingest(length, this.cArrChunk);
     this.doc.index.set(id, obj);
@@ -171,7 +158,7 @@ export class Decoder extends CborDecoderBase<CrdtReader> {
     return new ArrChunk(id, length, ids);
   };
 
-  public cStr(id: ITimestampStruct, length: number): StrNode {
+  protected cStr(id: ITimestampStruct, length: number): StrNode {
     const node = new StrNode(id);
     if (length) node.ingest(length, this.cStrChunk);
     this.doc.index.set(id, node);
@@ -191,7 +178,7 @@ export class Decoder extends CborDecoderBase<CrdtReader> {
     return new StrChunk(id, text.length, text);
   };
 
-  public cBin(id: ITimestampStruct, length: number): BinNode {
+  protected cBin(id: ITimestampStruct, length: number): BinNode {
     const node = new BinNode(id);
     if (length) node.ingest(length, this.cBinChunk);
     this.doc.index.set(id, node);

src/json-crdt/codec/structural/binary/Encoder.ts

@@ -125,7 +125,7 @@ export class Encoder extends CborEncoder<CrdtWriter> {
     const ts = this.ts;
     const writer = this.writer;
     ts(obj.id);
-    this.writeTL(CRDT_MAJOR_OVERLAY.VEC, obj.size());
+    this.writeTL(CRDT_MAJOR_OVERLAY.ARR, obj.size());
     const index = this.doc.index;
     for (let chunk = obj.first(); chunk; chunk = obj.next(chunk)) {
       const span = chunk.span;
@@ -152,12 +152,12 @@ export class Encoder extends CborEncoder<CrdtWriter> {
     }
   }
 
-  protected cBin(obj: BinNode): void {
+  protected cBin(node: BinNode): void {
     const ts = this.ts;
     const writer = this.writer;
-    ts(obj.id);
-    this.writeTL(CRDT_MAJOR_OVERLAY.STR, obj.size());
-    for (let chunk = obj.first(); chunk; chunk = obj.next(chunk)) {
+    ts(node.id);
+    this.writeTL(CRDT_MAJOR_OVERLAY.BIN, node.size());
+    for (let chunk = node.first(); chunk; chunk = node.next(chunk)) {
       const length = chunk.span;
       const deleted = chunk.del;
       writer.b1vu28(chunk.del, length);
@@ -167,15 +167,15 @@ export class Encoder extends CborEncoder<CrdtWriter> {
     }
   }
 
-  protected cVal(obj: ValNode): void {
-    this.ts(obj.id);
+  protected cVal(node: ValNode): void {
+    this.ts(node.id);
     this.writeTL(CRDT_MAJOR_OVERLAY.VAL, 0);
-    this.cNode(obj.node());
+    this.cNode(node.node());
   }
 
-  protected cCon(obj: ConNode): void {
-    const val = obj.val;
-    this.ts(obj.id);
+  protected cCon(node: ConNode): void {
+    const val = node.val;
+    this.ts(node.id);
     if (val instanceof Timestamp) {
       this.writeTL(CRDT_MAJOR_OVERLAY.CON, 1);
       this.ts(val as Timestamp);

src/json-crdt/codec/structural/binary/__tests__/ViewDecoder.spec.ts

@@ -1,12 +1,12 @@
-import {Timestamp, VectorClock, equal} from '../../../../../json-crdt-patch/clock';
+import {Timestamp, VectorClock} from '../../../../../json-crdt-patch/clock';
 import {Model} from '../../../../model';
 import {Encoder} from '../Encoder';
 import {Decoder} from '../Decoder';
 import {ViewDecoder} from '../ViewDecoder';
 import {konst} from '../../../../../json-crdt-patch/builder/Konst';
 
 describe('logical', () => {
-  test('decodes clock', () => {
+  test('can decode various documents', () => {
     const doc1 = Model.withLogicalClock(new VectorClock(222, 1));
     const encoder = new Encoder();
     const viewDecoder = new ViewDecoder();
@@ -15,6 +15,9 @@ describe('logical', () => {
       const encoded = encoder.encode(doc1);
       const decoded = viewDecoder.decode(encoded);
       const decoded2 = decoder.decode(encoded).view();
+      // console.log(decoded);
+      // console.log(decoded2);
+      // console.log(doc1.view());
       expect(decoded).toStrictEqual(doc1.view());
       expect(decoded2).toStrictEqual(doc1.view());
     };
@@ -39,7 +42,7 @@ describe('logical', () => {
     assertCanDecode();
   });
 
-  test('can decode ID as const value', () => {
+  test('decodes "con" timestamp as null', () => {
     const model = Model.withLogicalClock();
     model.api.root({
       foo: konst(new Timestamp(model.clock.sid, 2)),
@@ -50,4 +53,34 @@ describe('logical', () => {
     const view = viewDecoder.decode(encoded);
     expect((view as any).foo).toBe(null);
   });
+
+  test('can decode a simple number', () => {
+    const model = Model.withLogicalClock();
+    model.api.root(123);
+    const encoder = new Encoder();
+    const viewDecoder = new ViewDecoder();
+    const encoded = encoder.encode(model);
+    const view = viewDecoder.decode(encoded);
+    expect(view).toStrictEqual(123);
+  });
+
+  test('can decode a simple string', () => {
+    const model = Model.withLogicalClock();
+    model.api.root('asdf');
+    const encoder = new Encoder();
+    const viewDecoder = new ViewDecoder();
+    const encoded = encoder.encode(model);
+    const view = viewDecoder.decode(encoded);
+    expect(view).toStrictEqual('asdf');
+  });
+
+  test('can decode a simple object', () => {
+    const model = Model.withLogicalClock();
+    model.api.root({yes: false});
+    const encoder = new Encoder();
+    const viewDecoder = new ViewDecoder();
+    const encoded = encoder.encode(model);
+    const view = viewDecoder.decode(encoded);
+    expect(view).toStrictEqual({yes: false});
+  });
 });

src/json-crdt/codec/structural/json/__tests__/runCodecAllTypesSmokeTests.ts

@@ -1,6 +1,5 @@
 import {konst} from '../../../../../json-crdt-patch/builder/Konst';
 import {vec} from '../../../../../json-crdt-patch/builder/Tuple';
-import {Timestamp} from '../../../../../json-crdt-patch/clock';
 import {Model} from '../../../../model';
 
 export const runCodecAllTypesSmokeTests = (assertCodec: (doc: Model) => void) => {
@@ -16,13 +15,13 @@ export const runCodecAllTypesSmokeTests = (assertCodec: (doc: Model) => void) =>
     assertCodec(model);
   });
 
-  test('number with server clock', () => {
+  test('numbers with server clock', () => {
     const model = Model.withServerClock();
     model.api.root([1, 0, -4, 1.132, 8324.234234, 888888888888]);
     assertCodec(model);
   });
 
-  test('string', () => {
+  test('strings', () => {
     const model = Model.withLogicalClock();
     model.api.root(['', 'abc', '😛']);
     assertCodec(model);