All files / json-crdt/nodes/arr ArrNode.ts

97.89% Statements 93/95
85.18% Branches 23/27
92% Functions 23/25
97.59% Lines 81/83

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216159x 159x   159x 159x                   159x                             72136x 72136x 72136x 72136x 72136x 72136x 72136x 72136x 72136x       23x 23x       739x 739x 739x 732x 732x 732x 732x   7x       9913x 9913x               1x                   159x         69722x     69722x                   91x 91x 90x                   91x 91x 90x       10171x 10171x 9928x 9928x             28372x             43x                       70x       69722x   69722x   54364x 54364x 54364x 54364x 54257x 54257x 54257x 54257x 42261x 39073x 56129x 56129x 2x 2x   56127x 56127x 56127x     54257x 54257x 54257x         1555x 1555x 4783x       69722x     85x             267x 267x 267x 167x 167x     196x 196x 194x     267x       140x 84x          
import {AbstractRga, type Chunk} from '../rga/AbstractRga';
import {type ITimestampStruct, tick} from '../../../json-crdt-patch/clock';
import type {Model} from '../../model';
import {printBinary} from 'tree-dump/lib/printBinary';
import {printTree} from 'tree-dump/lib/printTree';
import type {JsonNode, JsonNodeView} from '..';
import type {Printable} from 'tree-dump/lib/types';
 
type E = ITimestampStruct;
 
/**
 * @ignore
 * @category CRDT Node
 */
export class ArrChunk implements Chunk<E[]> {
  public readonly id: ITimestampStruct;
  public span: number;
  public del: boolean;
  public data: E[] | undefined;
  public len: number;
  public p: ArrChunk | undefined;
  public l: ArrChunk | undefined;
  public r: ArrChunk | undefined;
  public p2: ArrChunk | undefined;
  public l2: ArrChunk | undefined;
  public r2: ArrChunk | undefined;
  public s: ArrChunk | undefined;
 
  constructor(id: ITimestampStruct, span: number, data: E[] | undefined) {
    this.id = id;
    this.span = span;
    this.len = data ? span : 0;
    this.del = !data;
    this.p = undefined;
    this.l = undefined;
    this.r = undefined;
    this.s = undefined;
    this.data = data;
  }
 
  public merge(data: E[]) {
    this.data!.push(...data);
    this.span = this.data!.length;
  }
 
  public split(ticks: number): ArrChunk {
    const span = this.span;
    this.span = ticks;
    if (!this.del) {
      const data = this.data!;
      const rightData = data.splice(ticks);
      const chunk = new ArrChunk(tick(this.id, ticks), span - ticks, rightData);
      return chunk;
    }
    return new ArrChunk(tick(this.id, ticks), span - ticks, undefined);
  }
 
  public delete(): void {
    this.del = true;
    this.data = undefined;
  }
 
  public clone(): ArrChunk {
    return new ArrChunk(this.id, this.span, this.data ? [...this.data] : undefined);
  }
 
  public view(): E[] {
    return this.data ? [...this.data] : [];
  }
}
 
/**
 * Represents the `arr` JSON CRDT type, which is a Replicated Growable Array
 * (RGA). Each element ot the array is a reference to another JSON CRDT node.
 *
 * @category CRDT Node
 */
export class ArrNode<Element extends JsonNode = JsonNode>
  extends AbstractRga<E[]>
  implements JsonNode<JsonNodeView<Element>[]>, Printable
{
  constructor(
    public readonly doc: Model<any>,
    id: ITimestampStruct,
  ) {
    super(id);
  }
 
  /**
   * Returns a reference to an element at a given position in the array.
   *
   * @param position The position of the element to get.
   * @returns An element of the array, if any.
   */
  public get(position: number): E | undefined {
    const pair = this.findChunk(position);
    if (!pair) return undefined;
    return pair[0].data![pair[1]];
  }
 
  /**
   * Returns a JSON node at a given position in the array.
   *
   * @param position The position of the element to get.
   * @returns A JSON node, if any.
   */
  public getNode(position: number): JsonNode | undefined {
    const id = this.get(position);
    if (!id) return undefined;
    return this.doc.index.get(id);
  }
 
  public getById(id: ITimestampStruct): E | undefined {
    const chunk = this.findById(id);
    if (!chunk || chunk.del) return undefined;
    const offset = id.time - chunk.id.time;
    return chunk.data![offset];
  }
 
  // -------------------------------------------------------------- AbstractRga
 
  /** @ignore */
  public createChunk(id: ITimestampStruct, data: E[] | undefined): ArrChunk {
    return new ArrChunk(id, data ? data.length : 0, data);
  }
 
  /** @ignore */
  protected onChange(): void {}
 
  protected toStringName(): string {
    return this.name();
  }
 
  // ----------------------------------------------------------------- JsonNode
 
  /** @ignore */
  public child() {
    return undefined;
  }
 
  /** @ignore */
  public container(): JsonNode | undefined {
    return this;
  }
 
  /** @ignore */
  private _tick: number = 0;
  /** @ignore */
  private _view: unknown[] = [];
  public view(): JsonNodeView<Element>[] {
    const doc = this.doc;
    const tick = doc.clock.time + doc.tick;
    const _view = this._view;
    if (this._tick === tick) return _view as JsonNodeView<Element>[];
    const view = [] as unknown[];
    const index = doc.index;
    let useCache = true;
    for (let chunk = this.first(); chunk; chunk = this.next(chunk)) {
      if (chunk.del) continue;
      for (const node of chunk.data!) {
        const elementNode = index.get(node);
        if (!elementNode) {
          useCache = false;
          continue;
        }
        const element = elementNode.view() as JsonNodeView<Element>;
        if (_view[view.length] !== element) useCache = false;
        view.push(element);
      }
    }
    if (_view.length !== view.length) useCache = false;
    const result = useCache ? _view : ((this._tick = tick), (this._view = view));
    return result as JsonNodeView<Element>[];
  }
 
  /** @ignore */
  public children(callback: (node: JsonNode) => void) {
    const index = this.doc.index;
    for (let chunk = this.first(); chunk; chunk = this.next(chunk))
      if (!chunk.del) for (const node of chunk.data!) callback(index.get(node)!);
  }
 
  /** @ignore */
  public api: undefined | unknown = undefined;
 
  public name(): string {
    return 'arr';
  }
 
  // ---------------------------------------------------------------- Printable
 
  /** @ignore */
  protected printChunk(tab: string, chunk: ArrChunk): string {
    const pos = this.pos(chunk);
    let valueTree = '';
    if (!chunk.del) {
      const index = this.doc.index;
      valueTree = printTree(
        tab,
        chunk
          .data!.map((id) => index.get(id))
          .filter((node) => !!node)
          .map((node, i) => (tab) => `[${pos + i}]: ${node!.toString(tab + '    ' + ' '.repeat(String(i).length))}`),
      );
    }
    return (
      this.formatChunk(chunk) +
      valueTree +
      printBinary(tab, [
        chunk.l ? (tab) => this.printChunk(tab, chunk.l!) : null,
        chunk.r ? (tab) => this.printChunk(tab, chunk.r!) : null,
      ])
    );
  }
}