feat(json-crdt): 🎸 add ability to print file to human-readable string

Author: streamich

src/json-crdt/file/File.ts

@@ -6,10 +6,12 @@ import {Encoder as StructuralEncoderCompact} from '../codec/structural/compact/E
 import {Encoder as StructuralEncoderVerbose} from '../codec/structural/verbose/Encoder';
 import {encode as encodeCompact} from '../../json-crdt-patch/codec/compact/encode';
 import {encode as encodeVerbose} from '../../json-crdt-patch/codec/verbose/encode';
+import {printTree} from "../../util/print/printTree";
 import type * as types from "./types";
+import type {Printable} from "../../util/print/types";
 
-export class File {
-  public static fromModel(model: Model): File {
+export class File implements Printable {
+  public static fromModel(model: Model<any>): File {
     return new File(model, PatchLog.fromModel(model));
   }
 
@@ -89,4 +91,14 @@ export class File {
       history,
     ];
   }
+
+  // ---------------------------------------------------------------- Printable
+
+  public toString(tab?: string) {
+    return `file` + printTree(tab, [
+      (tab) => this.model.toString(tab),
+      () => '',
+      (tab) => this.history.toString(tab),
+    ]);
+  }
 }

src/json-crdt/file/PatchLog.ts

@@ -1,9 +1,11 @@
-import {ITimestampStruct, Patch, ServerClockVector, compare} from "../../json-crdt-patch";
+import {ITimestampStruct, Patch, compare} from "../../json-crdt-patch";
+import {printTree} from "../../util/print/printTree";
 import {AvlMap} from "../../util/trees/avl/AvlMap";
 import {Model} from "../model";
+import type {Printable} from "../../util/print/types";
 
-export class PatchLog {
-  public static fromModel (model: Model): PatchLog {
+export class PatchLog implements Printable {
+  public static fromModel(model: Model<any>): PatchLog {
     const start = new Model(model.clock.clone());
     const log = new PatchLog(start);
     if (model.api.builder.patch.ops.length) {
@@ -22,4 +24,16 @@ export class PatchLog {
     if (!id) return;
     this.patches.set(id, patch);
   }
+
+  // ---------------------------------------------------------------- Printable
+
+  public toString(tab?: string) {
+    const log: Patch[] = [];
+    this.patches.forEach(({v}) => log.push(v));
+    return `log` + printTree(tab, [
+      (tab) => this.start.toString(tab),
+      () => '',
+      (tab) => 'history' + printTree(tab, log.map((patch, i) => (tab) => `${i}: ${patch.toString(tab)}`)),
+    ]);
+  }
 }

src/json-crdt/file/__tests__/File.spec.ts

@@ -0,0 +1,19 @@
+import {s} from '../../../json-crdt-patch';
+import {Model} from '../../model';
+import {File} from '../File';
+
+test('can create File from new model', () => {
+  const model = Model.withServerClock()
+    .setSchema(s.obj({
+      foo: s.str('bar'),
+    }));
+  const file = File.fromModel(model);
+  expect(file.history.start.view()).toBe(undefined);
+  expect(file.model.view()).toEqual({
+    foo: 'bar',
+  });
+  expect(file.history.start.clock.sid).toBe(file.model.clock.sid);
+});
+
+test.todo('patches are flushed and stored in memory');
+test.todo('can replay history');

src/json-crdt/model/Model.ts

@@ -21,7 +21,7 @@ export const UNDEFINED = new ConNode(ORIGIN, undefined);
  * In instance of Model class represents the underlying data structure,
  * i.e. model, of the JSON CRDT document.
  */
-export class Model<N extends JsonNode = JsonNode> implements Printable {
+export class Model<N extends JsonNode = JsonNode<any>> implements Printable {
   /**
    * Create a CRDT model which uses logical clock. Logical clock assigns a
    * logical timestamp to every node and operation. Logical timestamp consists