Merge pull request #371 from streamich/crdt-improvements

JSON CRDT .toString(), and equal object identity

Author: streamich

src/json-crdt/__demos__/type-safety.ts

@@ -8,6 +8,8 @@
 
 import {Model, n} from '..';
 
+console.clear();
+
 const model = Model.withLogicalClock(1234) as Model<
   n.obj<{
     num: n.con<number>;

src/json-crdt/model/Model.ts

@@ -8,6 +8,7 @@ import {
   VectorClock,
   ServerVectorClock,
   compare,
+  toDisplayString,
 } from '../../json-crdt-patch/clock';
 import {JsonCrdtPatchOperation, Patch} from '../../json-crdt-patch/Patch';
 import {ModelApi} from './api/ModelApi';
@@ -340,8 +341,24 @@ export class Model<RootJsonNode extends JsonNode = JsonNode> implements Printabl
       this.constructor.name +
       printTree(tab, [
         (tab) => this.root.toString(tab),
-        // nl,
-        // (tab) => this.index.toString(tab),
+        nl,
+        (tab) => {
+          const nodes: JsonNode[] = [];
+          this.index.forEach((item) => nodes.push(item.v));
+          return (
+            `Index (${nodes.length} nodes)` +
+            (nodes.length
+              ? printTree(
+                  tab,
+                  nodes.map((node) => (tab) => `${node.constructor.name} ${toDisplayString(node.id)}`),
+                )
+              : '')
+          );
+        },
+        nl,
+        // (tab) => `View ${toTree(this.view(), tab)}`,
+        (tab) =>
+          `View${printTree(tab, [(tab) => String(JSON.stringify(this.view(), null, 2)).replace(/\n/g, '\n' + tab)])}`,
         nl,
         (tab) => this.clock.toString(tab),
         hasExtensions ? nl : null,

src/json-crdt/model/__tests__/Model.view.spec.ts

@@ -0,0 +1,19 @@
+import {Model} from '../Model';
+
+test('"obj" node returns same object if deep equality does not change', () => {
+  const model = Model.withLogicalClock();
+  model.api.root({
+    foo: 'bar',
+    qux: [1, 2, 3],
+  });
+  const view1 = model.view();
+  const time1 = model.clock.time;
+  model.api.obj([]).set({
+    foo: 'bar',
+  });
+  model.api.val(['qux', 1]).set(2);
+  const view2 = model.view();
+  const time2 = model.clock.time;
+  expect(view1).toBe(view2);
+  expect(time2 > time1).toBe(true);
+});

src/json-crdt/nodes/obj/ObjNode.ts

@@ -128,7 +128,7 @@ export class ObjNode<Value extends Record<string, JsonNode> = Record<string, Jso
   // ---------------------------------------------------------------- Printable
 
   public toString(tab: string = ''): string {
-    const header = this.constructor.name + ' "obj" ' + toDisplayString(this.id);
+    const header = this.constructor.name + ' ' + toDisplayString(this.id);
     return (
       header +
       printTree(

src/json-crdt/nodes/val/ValNode.ts

@@ -85,7 +85,7 @@ export class ValNode<Value extends JsonNode = JsonNode> implements JsonNode<Read
 
   public toString(tab: string = ''): string {
     const node = this.node();
-    const header = this.constructor.name + toDisplayString(this.id);
+    const header = this.constructor.name + ' ' + toDisplayString(this.id);
     return header + printTree(tab, [(tab) => (node ? node.toString(tab) : toDisplayString(this.val))]);
   }
 }

src/json-crdt/nodes/vec/VecNode.ts

@@ -175,10 +175,7 @@ export class VecNode<Value extends JsonNode[] = JsonNode[]>
   public toString(tab: string = ''): string {
     const extNode = this.ext();
     const header =
-      this.constructor.name +
-      ' "vec" ' +
-      toDisplayString(this.id) +
-      (extNode ? ` { extension = ${this.getExtId()} }` : '');
+      this.constructor.name + ' ' + toDisplayString(this.id) + (extNode ? ` { extension = ${this.getExtId()} }` : '');
     if (extNode) {
       return this.child()!.toString(tab);
     }