All files / json-crdt-patch/clock clock.ts

90.9% Statements 100/110
80.76% Branches 21/26
95.83% Functions 23/24
92.4% Lines 73/79

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 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258      199x   8128409x 8128409x       199x   646014x 646014x 646014x                     4010357x                   563548x                 1994037x             199x 765074x             199x 27657805x 27657805x 27657805x 12642987x 3912908x 3912908x 3912908x 3729987x 3561554x                       199x                                 199x 315694x 267776x 267776x 267776x 161438x 100688x                 199x 110078x 110002x 110002x 110002x                       199x 62953x         199x                 1608996x 1608996x 1608996x               199x       104111x                         2039798x 2039798x 2039798x 1287307x 1287307x 1000697x   2039798x                 2313x                   5896x 5896x   5896x 59903x   5896x                   38x 38x 38x   38x 11692x 11692x 11692x   38x               199x   3915x     50694x 50694x 50693x 50693x       1x       1x                 2x      
import {SESSION} from '../enums';
import type {IClock, IClockVector, ITimestampStruct, ITimespanStruct} from './types';
 
export class Timestamp implements ITimestampStruct {
  constructor(
    public readonly sid: number,
    public time: number,
  ) {}
}
 
export class Timespan implements ITimespanStruct {
  constructor(
    public readonly sid: number,
    public time: number,
    public span: number,
  ) {}
}
 
/**
 * A factory function for creating a new timestamp.
 *
 * @param sid Session ID.
 * @param time Logical clock sequence number.
 * @returns A new timestamp.
 */
export const ts = (sid: number, time: number): ITimestampStruct => new Timestamp(sid, time);
 
/**
 * A factory function for creating a new timespan.
 *
 * @param sid Session ID.
 * @param time Logical clock sequence number.
 * @param span Length of the timespan.
 * @returns A new timespan.
 */
export const tss = (sid: number, time: number, span: number): ITimespanStruct => new Timespan(sid, time, span);
 
/**
 * Advance a timestamp by a number of cycles.
 *
 * @param stamp A reference timestamp.
 * @param cycles Number of cycles to advance.
 * @returns A new timestamp.
 */
export const tick = (stamp: ITimestampStruct, cycles: number): ITimestampStruct => ts(stamp.sid, stamp.time + cycles);
 
/**
 * Compares for equality two timestamps, time first.
 *
 * @returns True if timestamps are equal.
 */
export const equal = (ts1: ITimestampStruct, ts2: ITimestampStruct): boolean =>
  ts1.time === ts2.time && ts1.sid === ts2.sid;
 
/**
 * Compares two timestamps, time first.
 *
 * @returns 1 if current timestamp is larger, -1 if smaller, and 0 otherwise.
 */
export const compare = (ts1: ITimestampStruct, ts2: ITimestampStruct): -1 | 0 | 1 => {
  const t1 = ts1.time;
  const t2 = ts2.time;
  if (t1 > t2) return 1;
  if (t1 < t2) return -1;
  const s1 = ts1.sid;
  const s2 = ts2.sid;
  if (s1 > s2) return 1;
  if (s1 < s2) return -1;
  return 0;
};
 
/**
 * Checks if the first timespan contains the second timespan.
 *
 * @param ts1 Start of container timespan.
 * @param span1 Length of container timespan.
 * @param ts2 Start of contained timespan.
 * @param span2 Length of contained timespan.
 * @returns Returns true if the first timespan contains the second timespan.
 */
export const contains = (ts1: ITimestampStruct, span1: number, ts2: ITimestampStruct, span2: number): boolean => {
  Iif (ts1.sid !== ts2.sid) return false;
  const t1 = ts1.time;
  const t2 = ts2.time;
  Iif (t1 > t2) return false;
  Iif (t1 + span1 < t2 + span2) return false;
  return true;
};
 
/**
 * Checks if a timespan contains the `ts2` point.
 *
 * @param ts1 Start of container timespan.
 * @param span1 Length of container timespan.
 * @param ts2 A point in time.
 * @returns Returns true if the first timespan contains the `ts2` point.
 */
export const containsId = (ts1: ITimestampStruct, span1: number, ts2: ITimestampStruct): boolean => {
  if (ts1.sid !== ts2.sid) return false;
  const t1 = ts1.time;
  const t2 = ts2.time;
  if (t1 > t2) return false;
  if (t1 + span1 < t2 + 1) return false;
  return true;
};
 
/**
 * Returns a human-readable string representation of the timestamp.
 *
 * @param id A timestamp.
 * @returns Human-readable string representation of the timestamp.
 */
export const printTs = (id: ITimestampStruct): string => {
  if (id.sid === SESSION.SERVER) return '.' + id.time;
  let session = '' + id.sid;
  if (session.length > 4) session = '..' + session.slice(session.length - 4);
  return session + '.' + id.time;
};
 
/**
 * Advances a given timestamp by a number of cycles and then returns a timespan
 * starting from that position.
 *
 * @param ts A start timestamp.
 * @param tick Number of cycles to advance the starting timestamp.
 * @param span Length of the timespan.
 * @returns A new timespan.
 */
export const interval = (ts: ITimestampStruct, tick: number, span: number): ITimespanStruct =>
  new Timespan(ts.sid, ts.time + tick, span);
 
/**
 * Represents a *Logical Clock*, which can be advanced by a number of cycles.
 */
export class LogicalClock extends Timestamp implements IClock {
  /**
   * Returns a new timestamp, which is the current clock value, and advances the
   * clock by a number of cycles.
   *
   * @param cycles Number of cycles to advance the clock.
   * @returns A new timestamp, which is the current clock value.
   */
  public tick(cycles: number): ITimestampStruct {
    const timestamp = new Timestamp(this.sid, this.time);
    this.time += cycles;
    return timestamp;
  }
}
 
/**
 * Represents a clock vector, which is a local logical clock together with a set
 * of logical clocks of other peers.
 */
export class ClockVector extends LogicalClock implements IClockVector {
  /**
   * A set of logical clocks of other peers.
   */
  public readonly peers = new Map<number, ITimestampStruct>();
 
  /**
   * Advances local time every time we see any timestamp with higher time value.
   * This is an idempotent method which can be called every time a new timestamp
   * is observed, it advances the local time only if the observed timestamp is
   * greater than the current local time.
   *
   * @param id The time stamp we observed.
   * @param span Length of the time span.
   */
  public observe(id: ITimestampStruct, span: number) {
    // if (this.time < ts.time) throw new Error('TIME_TRAVEL');
    const edge = id.time + span - 1;
    const sid = id.sid;
    if (sid !== this.sid) {
      const clock = this.peers.get(id.sid);
      if (!clock) this.peers.set(id.sid, ts(sid, edge));
      else if (edge > clock.time) clock.time = edge;
    }
    if (edge >= this.time) this.time = edge + 1;
  }
 
  /**
   * Returns a deep copy of the current vector clock with the same session ID.
   *
   * @returns A new vector clock, which is a clone of the current vector clock.
   */
  public clone(): ClockVector {
    return this.fork(this.sid);
  }
 
  /**
   * Returns a deep copy of the current vector clock with a different session ID.
   *
   * @param sessionId The session ID of the new vector clock.
   * @returns A new vector clock, which is a fork of the current vector clock.
   */
  public fork(sessionId: number): ClockVector {
    const clock = new ClockVector(sessionId, this.time);
    if (sessionId !== this.sid) clock.observe(tick(this, -1), 1);
    // biome-ignore lint: using .forEach() on Map is the fastest way to iterate
    this.peers.forEach((peer) => {
      clock.observe(peer, 1);
    });
    return clock;
  }
 
  /**
   * Returns a human-readable string representation of the clock vector.
   *
   * @param tab String to use for indentation.
   * @returns Human-readable string representation of the clock vector.
   */
  public toString(tab: string = ''): string {
    const last = this.peers.size;
    let i = 1;
    let lines = '';
    // biome-ignore lint: using .forEach() on Map is the fastest way to iterate
    this.peers.forEach((clock) => {
      const isLast = i === last;
      lines += `\n${tab}${isLast ? '└─' : '├─'} ${clock.sid}.${clock.time}`;
      i++;
    });
    return `clock ${this.sid}.${this.time}${lines}`;
  }
}
 
/**
 * Implements a clock vector with a fixed session ID. The *server clock*
 * is used when the CRDT is powered by a central server.
 */
export class ServerClockVector extends LogicalClock implements IClockVector {
  /** A stub for other peers. Not used in the server clock. */
  public readonly peers = new Map<number, ITimespanStruct>();
 
  public observe(ts: ITimespanStruct, span: number) {
    Iif (ts.sid > 8) throw new Error('INVALID_SERVER_SESSION');
    if (this.time < ts.time) throw new Error('TIME_TRAVEL');
    const time = ts.time + span;
    if (time > this.time) this.time = time;
  }
 
  public clone(): ServerClockVector {
    return this.fork();
  }
 
  public fork(): ServerClockVector {
    return new ServerClockVector(SESSION.SERVER, this.time);
  }
 
  /**
   * Returns a human-readable string representation of the clock vector.
   *
   * @returns Human-readable string representation of the clock vector.
   */
  public toString(): string {
    return `clock ${this.sid}.${this.time}`;
  }
}