@rocicorp/zero 0.0.0-202410031711

package/out/zero-cache/src/services/view-syncer/snapshotter.js

@@ -0,0 +1,374 @@
+import { LogContext } from '@rocicorp/logger';
+import { ident } from 'pg-format';
+import { assert } from '../../../../shared/src/asserts.js';
+import * as v from '../../../../shared/src/valita.js';
+import { StatementRunner } from '../../../../zero-cache/src/db/statements.js';
+import { jsonObjectSchema, } from '../../../../zero-cache/src/types/bigint-json.js';
+import { normalizedKeyOrder, } from '../../../../zero-cache/src/types/row-key.js';
+import { Database } from '../../../../zqlite/src/db.js';
+import { changeLogEntrySchema as schema, SET_OP, TRUNCATE_OP, } from '../replicator/schema/change-log.js';
+import { getReplicationVersions, ZERO_VERSION_COLUMN_NAME as ROW_VERSION, } from '../replicator/schema/replication-state.js';
+/**
+ * A `Snapshotter` manages the progression of database snapshots for a
+ * ViewSyncer.
+ *
+ * The Replicator and ViewSyncers operate on the same SQLite file, with the
+ * Replicator being the sole writer to the database. The IVM logic in
+ * ViewSyncers, however, rely on incrementally applying changes to the DB to
+ * update the state of its pipelines.
+ *
+ * To avoid coupling the progress of the Replicator and all IVM pipelines on
+ * each other, ViewSyncers operate on ephemeral forks of the database by holding
+ * [concurrent](https://sqlite.org/src/doc/begin-concurrent/doc/begin_concurrent.md)
+ * snapshots of the database and simulating (but ultimately rolling back)
+ * mutations on these snapshots.
+ *
+ * Example:
+ * 1. ViewSyncer takes `snapshot_a` at version `t1` of the database and
+ *    hydrates its pipeline(s).
+ * 2. Replicator applies a new transaction to the database and notifies
+ *    subscribers.
+ * 3. ViewSyncer takes `snapshot_b` at `t2`, and queries the `ChangeLog` at
+ *    that snapshot for changes since `t1`.
+ * 4. ViewSyncer applies those changes to `snapshot_a` for IVM, but does not
+ *    commit them. (Recall that the Replicator is the sole writer to the db, so
+ *    the ViewSyncer never commits any writes.)
+ * 5. Replicator applies the next transaction and advances the database to `t3`.
+ * 6. ViewSyncer rolls back `snapshot_a` and opens `snapshot_c` at `t3`, using
+ *    `snapshot_b` to simulate changes from `t2` to `t3`.
+ *
+ * ```
+ * Replicator:  t1 --------------> t2 --------------> t3 --------------->
+ * ViewSyncer:       [snapshot_a] ----> [snapshot_b] ----> [snapshot_c]
+ * ```
+ *
+ * Note that the Replicator (and ViewSyncers) do not wait on the progress of
+ * other ViewSyncers. If a ViewSyncer is busy hydrating at `t1`, the Replicator
+ * and other ViewSyncers can progress through `t2`, `t3`, etc. independently,
+ * as the busy ViewSyncer simply takes its own snapshot when it is ready.
+ *
+ * ```
+ * Replicator:   t1 --------------> t2 --------------> t3 --------------->
+ * ViewSyncer1:       [snapshot_a] ----> [snapshot_b] ----> [snapshot_c]
+ * ViewSyncer2:       [.......... snapshot_a ..........] ----> [snapshot_b]
+ * ```
+ *
+ * To minimize Database connections (and statement preparation, etc.), the
+ * Snapshotter reuses the connection from the previous (rolled back)
+ * snapshot when opening the new one.
+ *
+ * ```
+ * Replicator:  t1 --------------> t2 --------------> t3 --------------->
+ * ViewSyncer:       [snapshot_a] ----> [snapshot_b] ----> [snapshot_c]
+ *                     (conn_1)           (conn_2)           (conn_1)
+ * ```
+ *
+ * In this manner, each ViewSyncer uses two connections that continually
+ * "leapfrog" each other to replay the timeline of changes in isolation from
+ * the Replicator and other ViewSyncers.
+ */
+export class Snapshotter {
+    #lc;
+    #dbFile;
+    #curr;
+    #prev;
+    constructor(lc, dbFile) {
+        this.#lc = lc;
+        this.#dbFile = dbFile;
+    }
+    /**
+     * Initializes the snapshot to the current head of the database. This must be
+     * only be called once. The state of whether a Snapshotter has been initialized
+     * can be determined by calling {@link initialized()}.
+     */
+    init() {
+        assert(this.#curr === undefined, 'Already initialized');
+        this.#curr = Snapshot.create(this.#lc, this.#dbFile);
+        this.#lc.debug?.(`Initial snapshot at version ${this.#curr.version}`);
+        return this;
+    }
+    initialized() {
+        return this.#curr !== undefined;
+    }
+    /** Returns the current snapshot. Asserts if {@link initialized()} is false. */
+    current() {
+        assert(this.#curr?.hasLock, 'Snapshotter uninitialized or released');
+        return this.#curr;
+    }
+    /**
+     * Advances to the head of the Database, returning a diff between the
+     * previously current Snapshot and a new Snapshot at head. This is called
+     * in response to a notification from a Replicator subscription. Subsequent
+     * calls to {@link current()} return the new Snapshot. Note that the Snapshotter
+     * must be initialized before advancing.
+     *
+     * The returned {@link SnapshotDiff} contains snapshots at the endpoints
+     * of the database timeline. Iterating over the diff generates a sequence
+     * of {@link Change}s between the two snapshots.
+     *
+     * Note that this sequence is not chronological; rather, the sequence is
+     * ordered by `<table, row-key>`, such that a row can appear at most once
+     * in the common case, or twice if its table is `TRUNCATE`'d and a new value
+     * is subsequently `INSERT`'ed. This results in dropping most intermediate
+     * changes to a row and bounds the amount of work needed to catch up;
+     * however, as a consequence, a consistent database state is only guaranteed
+     * when the sequence has been fully consumed.
+     *
+     * Note that Change generation relies on the state of the underlying
+     * database connections, and because the connection for the previous snapshot
+     * is reused to produce the next snapshot, the diff object is only valid
+     * until the next call to `advance()`.
+     *
+     * It is okay for the caller to apply `Change`s to the `prev` snapshot
+     * during the iteration (e.g. this is necessary for IVM); the remainder
+     * of the iteration is not affected because a given row can appear at most
+     * once in the sequence (with the exception being TRUNCATE, after which the
+     * deleted rows can be re-inserted, but this will also behave correctly if
+     * the changes are applied).
+     *
+     * Once the changes have been applied, however, a _subsequent_ iteration
+     * will not produce the correct results. In order to perform multiple
+     * change-applying iterations, the caller must (1) create a save point
+     * on `prev` before each iteration, and (2) rollback to the save point after
+     * the iteration.
+     */
+    advance() {
+        assert(this.#curr !== undefined, 'Snapshotter has not been initialized');
+        const next = this.#prev
+            ? this.#prev.resetToHead()
+            : Snapshot.create(this.#lc, this.#curr.db.db.name);
+        this.#prev = this.#curr;
+        this.#curr = next;
+        return new Diff(this.#prev, this.#curr);
+    }
+    /**
+     * Releases all locks on the database. Call {@link advance()}
+     * to reestablish a snapshot.
+     *
+     * This must only be called if the Snapshotter has been initialized.
+     */
+    release() {
+        assert(this.#curr !== undefined, 'Snapshotter has not been initialized');
+        this.#curr.release();
+        this.#prev?.release();
+    }
+    /**
+     * Call this to close the database connections when the Snapshotter is
+     * no longer needed.
+     */
+    destroy() {
+        this.#curr?.db.db.close();
+        this.#prev?.db.db.close();
+        this.#lc.debug?.('closed database connections');
+    }
+}
+class Snapshot {
+    static create(lc, dbFile) {
+        const conn = new Database(lc, dbFile);
+        conn.pragma('synchronous = OFF'); // Applied changes are ephemeral; COMMIT is never called.
+        const db = new StatementRunner(conn);
+        db.beginConcurrent();
+        // Note: The subsequent read is necessary to acquire the read lock
+        // (which results in the logical creation of the snapshot). Calling
+        // `BEGIN CONCURRENT` alone does not result in acquiring the read lock.
+        const { stateVersion } = getReplicationVersions(db);
+        return new Snapshot(db, stateVersion);
+    }
+    db;
+    version;
+    constructor(db, version) {
+        this.db = db;
+        this.version = version;
+    }
+    numChangesSince(prevVersion) {
+        const { count } = this.db.get('SELECT COUNT(*) AS count FROM "_zero.ChangeLog" WHERE stateVersion > ?', prevVersion);
+        return count;
+    }
+    changesSince(prevVersion) {
+        const cached = this.db.statementCache.get('SELECT * FROM "_zero.ChangeLog" WHERE stateVersion > ?');
+        return {
+            changes: cached.statement.iterate(prevVersion),
+            cleanup: () => this.db.statementCache.return(cached),
+        };
+    }
+    getRow(table, rowKey) {
+        const key = normalizedKeyOrder(rowKey);
+        const conds = Object.keys(key).map(c => `${ident(c)}=?`);
+        const cached = this.db.statementCache.get(`SELECT * FROM ${ident(table)} WHERE ${conds.join(' AND ')}`);
+        cached.statement.safeIntegers(true);
+        try {
+            // eslint-disable-next-line @typescript-eslint/no-explicit-any
+            return cached.statement.get(Object.values(key));
+        }
+        finally {
+            this.db.statementCache.return(cached);
+        }
+    }
+    getRows(table) {
+        const cached = this.db.statementCache.get(`SELECT * FROM ${ident(table)}`);
+        cached.statement.safeIntegers(true);
+        return {
+            rows: cached.statement.iterate(),
+            cleanup: () => this.db.statementCache.return(cached),
+        };
+    }
+    get hasLock() {
+        return this.db.db.inTransaction;
+    }
+    release() {
+        if (this.hasLock) {
+            this.db.rollback();
+        }
+    }
+    resetToHead() {
+        this.release();
+        this.db.beginConcurrent();
+        const { stateVersion } = getReplicationVersions(this.db);
+        return new Snapshot(this.db, stateVersion);
+    }
+}
+class Diff {
+    prev;
+    curr;
+    changes;
+    constructor(prev, curr) {
+        this.prev = prev;
+        this.curr = curr;
+        this.changes = curr.numChangesSince(prev.version);
+    }
+    [Symbol.iterator]() {
+        const { changes, cleanup: done } = this.curr.changesSince(this.prev.version);
+        const truncates = new TruncateTracker(this.prev);
+        const cleanup = () => {
+            done();
+            truncates.done();
+        };
+        return {
+            next: () => {
+                for (;;) {
+                    // Exhaust the TRUNCATE iteration before continuing the Change sequence.
+                    const truncatedRow = truncates.next();
+                    if (truncatedRow) {
+                        return truncatedRow;
+                    }
+                    const { value, done } = changes.next();
+                    if (done) {
+                        cleanup();
+                        return { value, done: true };
+                    }
+                    const { table, rowKey, op, stateVersion } = v.parse(value, schema);
+                    if (op === TRUNCATE_OP) {
+                        truncates.startTruncate(table);
+                        continue; // loop around to pull rows from the TruncateTracker.
+                    }
+                    assert(rowKey !== null);
+                    const prevValue = truncates.getRowIfNotTruncated(table, rowKey) ?? null;
+                    const nextValue = op === SET_OP ? this.curr.getRow(table, rowKey) : null;
+                    // Sanity check detects if the diff is being accessed after the Snapshots have advanced.
+                    this.checkThatDiffIsValid(stateVersion, op, prevValue, nextValue);
+                    if (prevValue === null && nextValue === null) {
+                        // Filter out no-op changes (e.g. a delete of a row that does not exist in prev).
+                        // TODO: Consider doing this for deep-equal values.
+                        continue;
+                    }
+                    return { value: { table, prevValue, nextValue } };
+                }
+            },
+            return: (value) => {
+                try {
+                    // Allow open iterators to clean up their state.
+                    truncates.iterReturn(value);
+                    changes.return?.(value);
+                    return { value, done: true };
+                }
+                finally {
+                    cleanup();
+                }
+            },
+            throw: (err) => {
+                try {
+                    // Allow open iterators to clean up their state.
+                    truncates.iterThrow(err);
+                    changes.throw?.(err);
+                    return { value: undefined, done: true };
+                }
+                finally {
+                    cleanup();
+                }
+            },
+        };
+    }
+    checkThatDiffIsValid(stateVersion, op, prevValue, nextValue) {
+        // Sanity checks to detect that the diff is not being accessed after
+        // the Snapshots have advanced.
+        if (stateVersion > this.curr.version) {
+            throw new InvalidDiffError(`Diff is no longer valid. curr db has advanced past ${this.curr.version}`);
+        }
+        if (prevValue !== null &&
+            (prevValue[ROW_VERSION] ?? '~') > this.prev.version) {
+            throw new InvalidDiffError(`Diff is no longer valid. prev db has advanced past ${this.prev.version}.`);
+        }
+        if (op === SET_OP && nextValue[ROW_VERSION] !== stateVersion) {
+            throw new InvalidDiffError('Diff is no longer valid. curr db has advanced.');
+        }
+    }
+}
+/**
+ * `TRUNCATE` changes are handled by:
+ * 1. Iterating over all of the rows in the `prev` Snapshot and returning
+ *    corresponding `DELETE` row operations for them (i.e. `nextValue: null`).
+ * 2. Tracking the fact that a table has been truncated (i.e. all row-deletes
+ *    have been returned) so that subsequent lookups of prevValues (e.g. for
+ *    inserts after the truncate) correctly return `null`.
+ */
+class TruncateTracker {
+    #prev;
+    #truncated = new Set();
+    #truncating = null;
+    constructor(prev) {
+        this.#prev = prev;
+    }
+    startTruncate(table) {
+        assert(this.#truncating === null);
+        const { rows, cleanup } = this.#prev.getRows(table);
+        this.#truncating = { table, rows, cleanup };
+    }
+    next() {
+        if (this.#truncating === null) {
+            return null;
+        }
+        const { table } = this.#truncating;
+        const { value, done } = this.#truncating.rows.next();
+        if (done) {
+            this.#truncating.cleanup();
+            this.#truncating = null;
+            this.#truncated.add(table);
+            return null;
+        }
+        const prevValue = v.parse(value, jsonObjectSchema);
+        // Sanity check detects if the diff is being accessed after the Snapshots have advanced.
+        if ((prevValue[ROW_VERSION] ?? '~') > this.#prev.version) {
+            throw new InvalidDiffError(`Diff is no longer valid. prev db has advanced past ${this.#prev.version}.`);
+        }
+        return { value: { table, prevValue, nextValue: null } };
+    }
+    getRowIfNotTruncated(table, rowKey) {
+        // If the row has been returned in a TRUNCATE iteration, its prevValue is henceforth null.
+        return this.#truncated.has(table) ? null : this.#prev.getRow(table, rowKey);
+    }
+    iterReturn(value) {
+        this.#truncating?.rows.return?.(value);
+    }
+    iterThrow(err) {
+        this.#truncating?.rows.throw?.(err);
+    }
+    done() {
+        this.#truncating?.cleanup();
+    }
+}
+export class InvalidDiffError extends Error {
+    constructor(msg) {
+        super(msg);
+    }
+}
+//# sourceMappingURL=snapshotter.js.map

package/out/zero-cache/src/services/view-syncer/snapshotter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"snapshotter.js","sourceRoot":"","sources":["../../../../../../zero-cache/src/services/view-syncer/snapshotter.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,UAAU,EAAC,MAAM,kBAAkB,CAAC;AAC5C,OAAO,EAAC,KAAK,EAAC,MAAM,WAAW,CAAC;AAChC,OAAO,EAAC,MAAM,EAAC,MAAM,uBAAuB,CAAC;AAC7C,OAAO,KAAK,CAAC,MAAM,sBAAsB,CAAC;AAC1C,OAAO,EAAC,eAAe,EAAC,MAAM,iCAAiC,CAAC;AAChE,OAAO,EACL,gBAAgB,GAEjB,MAAM,qCAAqC,CAAC;AAC7C,OAAO,EACL,kBAAkB,GAGnB,MAAM,iCAAiC,CAAC;AACzC,OAAO,EAAC,QAAQ,EAAC,MAAM,kBAAkB,CAAC;AAC1C,OAAO,EACL,oBAAoB,IAAI,MAAM,EAC9B,MAAM,EACN,WAAW,GACZ,MAAM,oCAAoC,CAAC;AAC5C,OAAO,EACL,sBAAsB,EACtB,wBAAwB,IAAI,WAAW,GACxC,MAAM,2CAA2C,CAAC;AAEnD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA0DG;AACH,MAAM,OAAO,WAAW;IACb,GAAG,CAAa;IAChB,OAAO,CAAS;IACzB,KAAK,CAAuB;IAC5B,KAAK,CAAuB;IAE5B,YAAY,EAAc,EAAE,MAAc;QACxC,IAAI,CAAC,GAAG,GAAG,EAAE,CAAC;QACd,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;IACxB,CAAC;IAED;;;;OAIG;IACH,IAAI;QACF,MAAM,CAAC,IAAI,CAAC,KAAK,KAAK,SAAS,EAAE,qBAAqB,CAAC,CAAC;QACxD,IAAI,CAAC,KAAK,GAAG,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;QACrD,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE,CAAC,+BAA+B,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC;QACtE,OAAO,IAAI,CAAC;IACd,CAAC;IAED,WAAW;QACT,OAAO,IAAI,CAAC,KAAK,KAAK,SAAS,CAAC;IAClC,CAAC;IAED,+EAA+E;IAC/E,OAAO;QACL,MAAM,CAAC,IAAI,CAAC,KAAK,EAAE,OAAO,EAAE,uCAAuC,CAAC,CAAC;QACrE,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAoCG;IACH,OAAO;QACL,MAAM,CAAC,IAAI,CAAC,KAAK,KAAK,SAAS,EAAE,sCAAsC,CAAC,CAAC;QACzE,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK;YACrB,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,WAAW,EAAE;YAC1B,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC;QACrD,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC;QACxB,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;QAClB,OAAO,IAAI,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC;IAC1C,CAAC;IAED;;;;;OAKG;IACH,OAAO;QACL,MAAM,CAAC,IAAI,CAAC,KAAK,KAAK,SAAS,EAAE,sCAAsC,CAAC,CAAC;QACzE,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC;QACrB,IAAI,CAAC,KAAK,EAAE,OAAO,EAAE,CAAC;IACxB,CAAC;IAED;;;OAGG;IACH,OAAO;QACL,IAAI,CAAC,KAAK,EAAE,EAAE,CAAC,EAAE,CAAC,KAAK,EAAE,CAAC;QAC1B,IAAI,CAAC,KAAK,EAAE,EAAE,CAAC,EAAE,CAAC,KAAK,EAAE,CAAC;QAC1B,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE,CAAC,6BAA6B,CAAC,CAAC;IAClD,CAAC;CACF;AAuCD,MAAM,QAAQ;IACZ,MAAM,CAAC,MAAM,CAAC,EAAc,EAAE,MAAc;QAC1C,MAAM,IAAI,GAAG,IAAI,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC,CAAC;QACtC,IAAI,CAAC,MAAM,CAAC,mBAAmB,CAAC,CAAC,CAAC,yDAAyD;QAE3F,MAAM,EAAE,GAAG,IAAI,eAAe,CAAC,IAAI,CAAC,CAAC;QACrC,EAAE,CAAC,eAAe,EAAE,CAAC;QACrB,kEAAkE;QAClE,mEAAmE;QACnE,uEAAuE;QACvE,MAAM,EAAC,YAAY,EAAC,GAAG,sBAAsB,CAAC,EAAE,CAAC,CAAC;QAClD,OAAO,IAAI,QAAQ,CAAC,EAAE,EAAE,YAAY,CAAC,CAAC;IACxC,CAAC;IAEQ,EAAE,CAAkB;IACpB,OAAO,CAAS;IAEzB,YAAY,EAAmB,EAAE,OAAe;QAC9C,IAAI,CAAC,EAAE,GAAG,EAAE,CAAC;QACb,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;IACzB,CAAC;IAED,eAAe,CAAC,WAAmB;QACjC,MAAM,EAAC,KAAK,EAAC,GAAG,IAAI,CAAC,EAAE,CAAC,GAAG,CACzB,wEAAwE,EACxE,WAAW,CACZ,CAAC;QACF,OAAO,KAAK,CAAC;IACf,CAAC;IAED,YAAY,CAAC,WAAmB;QAC9B,MAAM,MAAM,GAAG,IAAI,CAAC,EAAE,CAAC,cAAc,CAAC,GAAG,CACvC,wDAAwD,CACzD,CAAC;QACF,OAAO;YACL,OAAO,EAAE,MAAM,CAAC,SAAS,CAAC,OAAO,CAAC,WAAW,CAAC;YAC9C,OAAO,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,cAAc,CAAC,MAAM,CAAC,MAAM,CAAC;SACrD,CAAC;IACJ,CAAC;IAED,MAAM,CAAC,KAAa,EAAE,MAAiB;QACrC,MAAM,GAAG,GAAG,kBAAkB,CAAC,MAAgB,CAAC,CAAC;QACjD,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;QACzD,MAAM,MAAM,GAAG,IAAI,CAAC,EAAE,CAAC,cAAc,CAAC,GAAG,CACvC,iBAAiB,KAAK,CAAC,KAAK,CAAC,UAAU,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAC7D,CAAC;QACF,MAAM,CAAC,SAAS,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;QACpC,IAAI,CAAC;YACH,8DAA8D;YAC9D,OAAO,MAAM,CAAC,SAAS,CAAC,GAAG,CAAM,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC;QACvD,CAAC;gBAAS,CAAC;YACT,IAAI,CAAC,EAAE,CAAC,cAAc,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QACxC,CAAC;IACH,CAAC;IAED,OAAO,CAAC,KAAa;QACnB,MAAM,MAAM,GAAG,IAAI,CAAC,EAAE,CAAC,cAAc,CAAC,GAAG,CAAC,iBAAiB,KAAK,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;QAC3E,MAAM,CAAC,SAAS,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;QACpC,OAAO;YACL,IAAI,EAAE,MAAM,CAAC,SAAS,CAAC,OAAO,EAAE;YAChC,OAAO,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,cAAc,CAAC,MAAM,CAAC,MAAM,CAAC;SACrD,CAAC;IACJ,CAAC;IAED,IAAI,OAAO;QACT,OAAO,IAAI,CAAC,EAAE,CAAC,EAAE,CAAC,aAAa,CAAC;IAClC,CAAC;IAED,OAAO;QACL,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;YACjB,IAAI,CAAC,EAAE,CAAC,QAAQ,EAAE,CAAC;QACrB,CAAC;IACH,CAAC;IAED,WAAW;QACT,IAAI,CAAC,OAAO,EAAE,CAAC;QACf,IAAI,CAAC,EAAE,CAAC,eAAe,EAAE,CAAC;QAC1B,MAAM,EAAC,YAAY,EAAC,GAAG,sBAAsB,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACvD,OAAO,IAAI,QAAQ,CAAC,IAAI,CAAC,EAAE,EAAE,YAAY,CAAC,CAAC;IAC7C,CAAC;CACF;AAED,MAAM,IAAI;IACC,IAAI,CAAW;IACf,IAAI,CAAW;IACf,OAAO,CAAS;IAEzB,YAAY,IAAc,EAAE,IAAc;QACxC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IACpD,CAAC;IAED,CAAC,MAAM,CAAC,QAAQ,CAAC;QACf,MAAM,EAAC,OAAO,EAAE,OAAO,EAAE,IAAI,EAAC,GAAG,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC3E,MAAM,SAAS,GAAG,IAAI,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAEjD,MAAM,OAAO,GAAG,GAAG,EAAE;YACnB,IAAI,EAAE,CAAC;YACP,SAAS,CAAC,IAAI,EAAE,CAAC;QACnB,CAAC,CAAC;QAEF,OAAO;YACL,IAAI,EAAE,GAAG,EAAE;gBACT,SAAS,CAAC;oBACR,wEAAwE;oBACxE,MAAM,YAAY,GAAG,SAAS,CAAC,IAAI,EAAE,CAAC;oBACtC,IAAI,YAAY,EAAE,CAAC;wBACjB,OAAO,YAAY,CAAC;oBACtB,CAAC;oBAED,MAAM,EAAC,KAAK,EAAE,IAAI,EAAC,GAAG,OAAO,CAAC,IAAI,EAAE,CAAC;oBACrC,IAAI,IAAI,EAAE,CAAC;wBACT,OAAO,EAAE,CAAC;wBACV,OAAO,EAAC,KAAK,EAAE,IAAI,EAAE,IAAI,EAAC,CAAC;oBAC7B,CAAC;oBAED,MAAM,EAAC,KAAK,EAAE,MAAM,EAAE,EAAE,EAAE,YAAY,EAAC,GAAG,CAAC,CAAC,KAAK,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;oBACjE,IAAI,EAAE,KAAK,WAAW,EAAE,CAAC;wBACvB,SAAS,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;wBAC/B,SAAS,CAAC,qDAAqD;oBACjE,CAAC;oBAED,MAAM,CAAC,MAAM,KAAK,IAAI,CAAC,CAAC;oBACxB,MAAM,SAAS,GACb,SAAS,CAAC,oBAAoB,CAAC,KAAK,EAAE,MAAM,CAAC,IAAI,IAAI,CAAC;oBACxD,MAAM,SAAS,GACb,EAAE,KAAK,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;oBAEzD,wFAAwF;oBACxF,IAAI,CAAC,oBAAoB,CAAC,YAAY,EAAE,EAAE,EAAE,SAAS,EAAE,SAAS,CAAC,CAAC;oBAElE,IAAI,SAAS,KAAK,IAAI,IAAI,SAAS,KAAK,IAAI,EAAE,CAAC;wBAC7C,iFAAiF;wBACjF,mDAAmD;wBACnD,SAAS;oBACX,CAAC;oBAED,OAAO,EAAC,KAAK,EAAE,EAAC,KAAK,EAAE,SAAS,EAAE,SAAS,EAAkB,EAAC,CAAC;gBACjE,CAAC;YACH,CAAC;YAED,MAAM,EAAE,CAAC,KAAc,EAAE,EAAE;gBACzB,IAAI,CAAC;oBACH,gDAAgD;oBAChD,SAAS,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;oBAC5B,OAAO,CAAC,MAAM,EAAE,CAAC,KAAK,CAAC,CAAC;oBACxB,OAAO,EAAC,KAAK,EAAE,IAAI,EAAE,IAAI,EAAC,CAAC;gBAC7B,CAAC;wBAAS,CAAC;oBACT,OAAO,EAAE,CAAC;gBACZ,CAAC;YACH,CAAC;YAED,KAAK,EAAE,CAAC,GAAY,EAAE,EAAE;gBACtB,IAAI,CAAC;oBACH,gDAAgD;oBAChD,SAAS,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;oBACzB,OAAO,CAAC,KAAK,EAAE,CAAC,GAAG,CAAC,CAAC;oBACrB,OAAO,EAAC,KAAK,EAAE,SAAS,EAAE,IAAI,EAAE,IAAI,EAAC,CAAC;gBACxC,CAAC;wBAAS,CAAC;oBACT,OAAO,EAAE,CAAC;gBACZ,CAAC;YACH,CAAC;SACF,CAAC;IACJ,CAAC;IAED,oBAAoB,CAClB,YAAoB,EACpB,EAAU,EACV,SAAmB,EACnB,SAAmB;QAEnB,oEAAoE;QACpE,+BAA+B;QAC/B,IAAI,YAAY,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC;YACrC,MAAM,IAAI,gBAAgB,CACxB,sDAAsD,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,CAC1E,CAAC;QACJ,CAAC;QACD,IACE,SAAS,KAAK,IAAI;YAClB,CAAC,SAAS,CAAC,WAAW,CAAC,IAAI,GAAG,CAAC,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,EACnD,CAAC;YACD,MAAM,IAAI,gBAAgB,CACxB,sDAAsD,IAAI,CAAC,IAAI,CAAC,OAAO,GAAG,CAC3E,CAAC;QACJ,CAAC;QACD,IAAI,EAAE,KAAK,MAAM,IAAI,SAAS,CAAC,WAAW,CAAC,KAAK,YAAY,EAAE,CAAC;YAC7D,MAAM,IAAI,gBAAgB,CACxB,gDAAgD,CACjD,CAAC;QACJ,CAAC;IACH,CAAC;CACF;AAED;;;;;;;GAOG;AACH,MAAM,eAAe;IACV,KAAK,CAAW;IAChB,UAAU,GAAG,IAAI,GAAG,EAAU,CAAC;IAExC,WAAW,GAIA,IAAI,CAAC;IAEhB,YAAY,IAAc;QACxB,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;IACpB,CAAC;IAED,aAAa,CAAC,KAAa;QACzB,MAAM,CAAC,IAAI,CAAC,WAAW,KAAK,IAAI,CAAC,CAAC;QAClC,MAAM,EAAC,IAAI,EAAE,OAAO,EAAC,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QAClD,IAAI,CAAC,WAAW,GAAG,EAAC,KAAK,EAAE,IAAI,EAAE,OAAO,EAAC,CAAC;IAC5C,CAAC;IAED,IAAI;QACF,IAAI,IAAI,CAAC,WAAW,KAAK,IAAI,EAAE,CAAC;YAC9B,OAAO,IAAI,CAAC;QACd,CAAC;QACD,MAAM,EAAC,KAAK,EAAC,GAAG,IAAI,CAAC,WAAW,CAAC;QACjC,MAAM,EAAC,KAAK,EAAE,IAAI,EAAC,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;QACnD,IAAI,IAAI,EAAE,CAAC;YACT,IAAI,CAAC,WAAW,CAAC,OAAO,EAAE,CAAC;YAC3B,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC;YACxB,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;YAC3B,OAAO,IAAI,CAAC;QACd,CAAC;QACD,MAAM,SAAS,GAAG,CAAC,CAAC,KAAK,CAAC,KAAK,EAAE,gBAAgB,CAAC,CAAC;QAEnD,wFAAwF;QACxF,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,IAAI,GAAG,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC;YACzD,MAAM,IAAI,gBAAgB,CACxB,sDACE,IAAI,CAAC,KAAK,CAAC,OACb,GAAG,CACJ,CAAC;QACJ,CAAC;QAED,OAAO,EAAC,KAAK,EAAE,EAAC,KAAK,EAAE,SAAS,EAAE,SAAS,EAAE,IAAI,EAAkB,EAAC,CAAC;IACvE,CAAC;IAED,oBAAoB,CAAC,KAAa,EAAE,MAAc;QAChD,0FAA0F;QAC1F,OAAO,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;IAC9E,CAAC;IAED,UAAU,CAAC,KAAc;QACvB,IAAI,CAAC,WAAW,EAAE,IAAI,CAAC,MAAM,EAAE,CAAC,KAAK,CAAC,CAAC;IACzC,CAAC;IAED,SAAS,CAAC,GAAY;QACpB,IAAI,CAAC,WAAW,EAAE,IAAI,CAAC,KAAK,EAAE,CAAC,GAAG,CAAC,CAAC;IACtC,CAAC;IAED,IAAI;QACF,IAAI,CAAC,WAAW,EAAE,OAAO,EAAE,CAAC;IAC9B,CAAC;CACF;AAED,MAAM,OAAO,gBAAiB,SAAQ,KAAK;IACzC,YAAY,GAAW;QACrB,KAAK,CAAC,GAAG,CAAC,CAAC;IACb,CAAC;CACF"}

package/out/zero-cache/src/services/view-syncer/view-syncer.d.ts

@@ -0,0 +1,37 @@
+import type { LogContext } from '@rocicorp/logger';
+import type { ChangeDesiredQueriesMessage, Downstream, InitConnectionMessage } from '../../../../zero-protocol/src/mod.js';
+import type { PostgresDB } from '../../types/pg.js';
+import type { Source } from '../../types/streams.js';
+import { Subscription } from '../../types/subscription.js';
+import type { ReplicaState } from '../replicator/replicator.js';
+import type { ActivityBasedService } from '../service.js';
+import { PipelineDriver } from './pipeline-driver.js';
+export type SyncContext = {
+    readonly clientID: string;
+    readonly wsID: string;
+    readonly baseCookie: string | null;
+};
+export interface ViewSyncer {
+    initConnection(ctx: SyncContext, msg: InitConnectionMessage): Promise<Source<Downstream>>;
+    changeDesiredQueries(ctx: SyncContext, msg: ChangeDesiredQueriesMessage): Promise<void>;
+}
+export declare class ViewSyncerService implements ViewSyncer, ActivityBasedService {
+    #private;
+    readonly id: string;
+    constructor(lc: LogContext, clientGroupID: string, db: PostgresDB, pipelineDriver: PipelineDriver, versionChanges: Subscription<ReplicaState>, keepaliveMs?: number);
+    run(): Promise<void>;
+    /**
+     * Guarantees that the ViewSyncer will remain running for at least
+     * its configured `keepaliveMs`. This is called when establishing a
+     * new connection to ensure that its associated ViewSyncer isn't
+     * shutdown before it receives the connection.
+     *
+     * @return `true` if the ViewSyncer will stay alive, `false` if the
+     *         ViewSyncer is shutting down.
+     */
+    keepalive(): boolean;
+    initConnection(ctx: SyncContext, initConnectionMessage: InitConnectionMessage): Promise<Source<Downstream>>;
+    changeDesiredQueries(ctx: SyncContext, msg: ChangeDesiredQueriesMessage): Promise<void>;
+    stop(): Promise<void>;
+}
+//# sourceMappingURL=view-syncer.d.ts.map

package/out/zero-cache/src/services/view-syncer/view-syncer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"view-syncer.d.ts","sourceRoot":"","sources":["../../../../../../zero-cache/src/services/view-syncer/view-syncer.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAC,UAAU,EAAC,MAAM,kBAAkB,CAAC;AAOjD,OAAO,KAAK,EAEV,2BAA2B,EAC3B,UAAU,EACV,qBAAqB,EACtB,MAAM,eAAe,CAAC;AAGvB,OAAO,KAAK,EAAC,UAAU,EAAC,MAAM,mBAAmB,CAAC;AAClD,OAAO,KAAK,EAAC,MAAM,EAAC,MAAM,wBAAwB,CAAC;AACnD,OAAO,EAAC,YAAY,EAAC,MAAM,6BAA6B,CAAC;AACzD,OAAO,KAAK,EAAC,YAAY,EAAC,MAAM,6BAA6B,CAAC;AAE9D,OAAO,KAAK,EAAC,oBAAoB,EAAC,MAAM,eAAe,CAAC;AAaxD,OAAO,EAAC,cAAc,EAAiB,MAAM,sBAAsB,CAAC;AASpE,MAAM,MAAM,WAAW,GAAG;IACxB,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;CACpC,CAAC;AAEF,MAAM,WAAW,UAAU;IACzB,cAAc,CACZ,GAAG,EAAE,WAAW,EAChB,GAAG,EAAE,qBAAqB,GACzB,OAAO,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC;IAE/B,oBAAoB,CAClB,GAAG,EAAE,WAAW,EAChB,GAAG,EAAE,2BAA2B,GAC/B,OAAO,CAAC,IAAI,CAAC,CAAC;CAClB;AAQD,qBAAa,iBAAkB,YAAW,UAAU,EAAE,oBAAoB;;IACxE,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;gBAiBlB,EAAE,EAAE,UAAU,EACd,aAAa,EAAE,MAAM,EACrB,EAAE,EAAE,UAAU,EACd,cAAc,EAAE,cAAc,EAC9B,cAAc,EAAE,YAAY,CAAC,YAAY,CAAC,EAC1C,WAAW,SAAuB;IAyB9B,GAAG,IAAI,OAAO,CAAC,IAAI,CAAC;IAwF1B;;;;;;;;OAQG;IACH,SAAS,IAAI,OAAO;IAyBd,cAAc,CAClB,GAAG,EAAE,WAAW,EAChB,qBAAqB,EAAE,qBAAqB,GAC3C,OAAO,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;IAmCxB,oBAAoB,CACxB,GAAG,EAAE,WAAW,EAChB,GAAG,EAAE,2BAA2B,GAC/B,OAAO,CAAC,IAAI,CAAC;IAkbV,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;CAe5B"}