@rocicorp/zero 0.2.2024101101 → 0.3.2024102500

package/out/zero-client/src/client/metrics.js

@@ -0,0 +1,268 @@
+export var MetricName;
+(function (MetricName) {
+    MetricName["TimeToConnectMs"] = "time_to_connect_ms";
+    MetricName["LastConnectError"] = "last_connect_error";
+    MetricName["TimeToConnectMsV2"] = "time_to_connect_ms_v2";
+    MetricName["LastConnectErrorV2"] = "last_connect_error_v2";
+    MetricName["TotalTimeToConnectMs"] = "total_time_to_connect_ms";
+    MetricName["NotConnected"] = "not_connected";
+})(MetricName || (MetricName = {}));
+// This value is used to indicate that the client's last connection attempt
+// failed. We don't make this -1 because we want to stack this never connected
+// state in a graph on top of actual connection times, so it should be greater
+// than any other value.
+export const DID_NOT_CONNECT_VALUE = 100 * 1000;
+export const REPORT_INTERVAL_MS = 5_000;
+export function getLastConnectErrorValue(reason) {
+    if ('server' in reason) {
+        return `server_${camelToSnake(reason.server)}`;
+    }
+    return `client_${camelToSnake(reason.client)}`;
+}
+// camelToSnake is used to convert a protocol ErrorKind into a suitable
+// metric name, eg AuthInvalidated => auth_invalidated. It converts
+// both PascalCase and camelCase to snake_case.
+function camelToSnake(s) {
+    return s
+        .split(/\.?(?=[A-Z])/)
+        .join('_')
+        .toLowerCase();
+}
+/**
+ * MetricManager keeps track of the set of metrics in use and flushes them
+ * to a format suitable for reporting.
+ */
+export class MetricManager {
+    #reportIntervalMs;
+    #host;
+    #reporter;
+    #lc;
+    #timerID;
+    constructor(opts) {
+        this.#reportIntervalMs = opts.reportIntervalMs;
+        this.#host = opts.host;
+        this.#reporter = opts.reporter;
+        this.#lc = opts.lc;
+        this.tags.push(`source:${opts.source}`);
+        this.timeToConnectMs.set(DID_NOT_CONNECT_VALUE);
+        this.#setNotConnectedReason('init');
+        this.#timerID = setInterval(() => {
+            void this.flush();
+        }, this.#reportIntervalMs);
+    }
+    #metrics = [];
+    // timeToConnectMs measures the time from the call to connect() to receiving
+    // the 'connected' ws message. We record the DID_NOT_CONNECT_VALUE if the previous
+    // connection attempt failed for any reason.
+    //
+    // We set the gauge using #connectStart as follows:
+    // - #connectStart is undefined if we are disconnected or connected; it is
+    //   defined only in the Connecting state, as a number representing the timestamp
+    //   at which we started connecting.
+    // - #connectStart is set to the current time when connect() is called.
+    // - When we receive the 'connected' message we record the time to connect and
+    //   set #connectStart to undefined.
+    // - If disconnect() is called with a defined #connectStart then we record
+    //   DID_NOT_CONNECT_VALUE and set #connectStart to undefined.
+    //
+    // TODO It's clear after playing with the connection code we should encapsulate
+    // the ConnectionState along with its state transitions and possibly behavior.
+    // In that world the metric gauge(s) and bookkeeping like #connectStart would
+    // be encapsulated with the ConnectionState. This will probably happen as part
+    // of https://github.com/rocicorp/reflect-server/issues/255.
+    timeToConnectMs = this.#register(new Gauge(MetricName.TimeToConnectMs));
+    // lastConnectError records the last error that occurred when connecting,
+    // if any. It is cleared when connecting successfully or when reported, so this
+    // state only gets reported if there was a failure during the reporting period and
+    // we are still not connected.
+    lastConnectError = this.#register(new State(MetricName.LastConnectError, true));
+    // notConnected records the reason why the client is not currently connected.
+    // It is cleared when the client successfully connects.
+    #notConnected = this.#register(new State(MetricName.NotConnected));
+    // The time from the call to connect() to receiving the 'connected' ws message
+    // for the current connection.  Cleared when the client is not connected.
+    // TODO: Not actually currently cleared on disconnect untill there is a
+    // connect error, or client reports disconnected and waiting for visible.
+    // Should have a value iff _notConnected has no value.
+    #timeToConnectMsV2 = this.#register(new Gauge(MetricName.TimeToConnectMsV2));
+    // lastConnectErrorV2 records the last error that occurred when connecting,
+    // if any. It is cleared when the client successfully connects or
+    // stops trying to connect due to being hidden.
+    // Should have a value iff notConnected state is NotConnectedReason.Error.
+    #lastConnectErrorV2 = this.#register(new State(MetricName.LastConnectErrorV2));
+    // The total time it took to connect across retries for the current
+    // connection.  Cleared when the client is not connected.
+    // TODO: Not actually currently cleared on disconnect until there is a
+    // connect error, or client reports disconnected and waiting for visible.
+    // See Zero.#totalToConnectStart for details of how this total is computed.
+    // Should have a value iff _notConnected has no value.
+    #totalTimeToConnectMs = this.#register(new Gauge(MetricName.TotalTimeToConnectMs));
+    #setNotConnectedReason(reason) {
+        this.#notConnected.set(reason);
+    }
+    setConnected(timeToConnectMs, totalTimeToConnectMs) {
+        this.#notConnected.clear();
+        this.#lastConnectErrorV2.clear();
+        this.#timeToConnectMsV2.set(timeToConnectMs);
+        this.#totalTimeToConnectMs.set(totalTimeToConnectMs);
+    }
+    setDisconnectedWaitingForVisible() {
+        this.#timeToConnectMsV2.clear();
+        this.#totalTimeToConnectMs.clear();
+        this.#lastConnectErrorV2.clear();
+        let notConnectedReason;
+        switch (this.#notConnected.get()) {
+            case 'init':
+                notConnectedReason = 'hidden_was_init';
+                break;
+            case 'error':
+                notConnectedReason = 'hidden_was_error';
+                break;
+            default:
+                notConnectedReason = 'hidden';
+                break;
+        }
+        this.#setNotConnectedReason(notConnectedReason);
+    }
+    setConnectError(reason) {
+        this.#timeToConnectMsV2.clear();
+        this.#totalTimeToConnectMs.clear();
+        this.#setNotConnectedReason('error');
+        this.#lastConnectErrorV2.set(getLastConnectErrorValue(reason));
+    }
+    /**
+     * Tags to include in all metrics.
+     */
+    tags = [];
+    // Flushes all metrics to an array of time series (plural), one Series
+    // per metric.
+    async flush() {
+        const lc = this.#lc;
+        if (this.#timerID === null) {
+            lc.error?.('MetricManager.flush() called but already stopped');
+            return;
+        }
+        const allSeries = [];
+        for (const metric of this.#metrics) {
+            const series = metric.flush();
+            if (series !== undefined) {
+                allSeries.push({
+                    ...series,
+                    host: this.#host,
+                    tags: this.tags,
+                });
+            }
+        }
+        if (allSeries.length === 0) {
+            lc?.debug?.('No metrics to report');
+            return;
+        }
+        try {
+            await this.#reporter(allSeries);
+        }
+        catch (e) {
+            lc?.error?.(`Error reporting metrics: ${e}`);
+        }
+    }
+    stop() {
+        if (this.#timerID === null) {
+            this.#lc.error?.('MetricManager.stop() called but already stopped');
+            return;
+        }
+        clearInterval(this.#timerID);
+        this.#timerID = null;
+    }
+    #register(metric) {
+        this.#metrics.push(metric);
+        return metric;
+    }
+}
+function makePoint(ts, value) {
+    return [ts, [value]];
+}
+/**
+ * Gauge is a metric type that represents a single value that can go up and
+ * down. It's typically used to track discrete values or counts eg the number
+ * of active users, number of connections, cpu load, etc. A gauge retains
+ * its value when flushed.
+ *
+ * We use a Gauge to sample at the client. If we are interested in tracking
+ * a metric value *per client*, the client can note the latest value in
+ * a Gauge metric. The metric is periodically reported via Reporter. On the
+ * server, we graph the value of the metric rolled up over the periodic
+ * reporting period, that is, counted over a span of time equal to the
+ * reporting period. The result is ~one point per client per reporting
+ * period.
+ */
+export class Gauge {
+    #name;
+    #value = undefined;
+    constructor(name) {
+        this.#name = name;
+    }
+    set(value) {
+        this.#value = value;
+    }
+    get() {
+        return this.#value;
+    }
+    clear() {
+        this.#value = undefined;
+    }
+    flush() {
+        if (this.#value === undefined) {
+            return undefined;
+        }
+        // Gauge reports the timestamp at flush time, not at the point the value was
+        // recorded.
+        const points = [makePoint(t(), this.#value)];
+        return { metric: this.#name, points };
+    }
+}
+function t() {
+    return Math.round(Date.now() / 1000);
+}
+/**
+ * State is a metric type that represents a specific state that the system is
+ * in, for example the state of a connection which may be 'open' or 'closed'.
+ * The state is given a name/prefix at construction time (eg 'connection') and
+ * then can be set to a specific state (eg 'open'). The prefix is prepended to
+ * the set state (eg, 'connection_open') and a value of 1 is reported.
+ * Unset/cleared states are not reported.
+ *
+ * Example:
+ *   const s = new State('connection');
+ *   s.set('open');
+ *   s.flush(); // returns {metric: 'connection_open', points: [[now(), [1]]]}
+ */
+export class State {
+    #prefix;
+    #clearOnFlush;
+    #current = undefined;
+    constructor(prefix, clearOnFlush = false) {
+        this.#prefix = prefix;
+        this.#clearOnFlush = clearOnFlush;
+    }
+    set(state) {
+        this.#current = state;
+    }
+    get() {
+        return this.#current;
+    }
+    clear() {
+        this.#current = undefined;
+    }
+    flush() {
+        if (this.#current === undefined) {
+            return undefined;
+        }
+        const gauge = new Gauge([this.#prefix, this.#current].join('_'));
+        gauge.set(1);
+        const series = gauge.flush();
+        if (this.#clearOnFlush) {
+            this.clear();
+        }
+        return series;
+    }
+}
+//# sourceMappingURL=metrics.js.map

package/out/zero-client/src/client/metrics.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"metrics.js","sourceRoot":"","sources":["../../../../../zero-client/src/client/metrics.ts"],"names":[],"mappings":"AAIA,MAAM,CAAN,IAAY,UAOX;AAPD,WAAY,UAAU;IACpB,oDAAsC,CAAA;IACtC,qDAAuC,CAAA;IACvC,yDAA2C,CAAA;IAC3C,0DAA4C,CAAA;IAC5C,+DAAiD,CAAA;IACjD,4CAA8B,CAAA;AAChC,CAAC,EAPW,UAAU,KAAV,UAAU,QAOrB;AAED,2EAA2E;AAC3E,8EAA8E;AAC9E,8EAA8E;AAC9E,wBAAwB;AACxB,MAAM,CAAC,MAAM,qBAAqB,GAAG,GAAG,GAAG,IAAI,CAAC;AAEhD,MAAM,CAAC,MAAM,kBAAkB,GAAG,KAAK,CAAC;AA0BxC,MAAM,UAAU,wBAAwB,CAAC,MAAwB;IAC/D,IAAI,QAAQ,IAAI,MAAM,EAAE,CAAC;QACvB,OAAO,UAAU,YAAY,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC;IACjD,CAAC;IACD,OAAO,UAAU,YAAY,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC;AACjD,CAAC;AAED,uEAAuE;AACvE,mEAAmE;AACnE,+CAA+C;AAC/C,SAAS,YAAY,CAAC,CAAS;IAC7B,OAAO,CAAC;SACL,KAAK,CAAC,cAAc,CAAC;SACrB,IAAI,CAAC,GAAG,CAAC;SACT,WAAW,EAAE,CAAC;AACnB,CAAC;AAYD;;;GAGG;AACH,MAAM,OAAO,aAAa;IACxB,iBAAiB,CAAS;IAC1B,KAAK,CAAS;IACd,SAAS,CAAkB;IAC3B,GAAG,CAAa;IAChB,QAAQ,CAAwC;IAEhD,YAAY,IAA0B;QACpC,IAAI,CAAC,iBAAiB,GAAG,IAAI,CAAC,gBAAgB,CAAC;QAC/C,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,IAAI,CAAC;QACvB,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,QAAQ,CAAC;QAC/B,IAAI,CAAC,GAAG,GAAG,IAAI,CAAC,EAAE,CAAC;QAEnB,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC;QAExC,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,qBAAqB,CAAC,CAAC;QAChD,IAAI,CAAC,sBAAsB,CAAC,MAAM,CAAC,CAAC;QAEpC,IAAI,CAAC,QAAQ,GAAG,WAAW,CAAC,GAAG,EAAE;YAC/B,KAAK,IAAI,CAAC,KAAK,EAAE,CAAC;QACpB,CAAC,EAAE,IAAI,CAAC,iBAAiB,CAAC,CAAC;IAC7B,CAAC;IAED,QAAQ,GAAgB,EAAE,CAAC;IAE3B,4EAA4E;IAC5E,kFAAkF;IAClF,4CAA4C;IAC5C,EAAE;IACF,mDAAmD;IACnD,0EAA0E;IAC1E,iFAAiF;IACjF,oCAAoC;IACpC,uEAAuE;IACvE,8EAA8E;IAC9E,oCAAoC;IACpC,0EAA0E;IAC1E,8DAA8D;IAC9D,EAAE;IACF,+EAA+E;IAC/E,8EAA8E;IAC9E,6EAA6E;IAC7E,8EAA8E;IAC9E,4DAA4D;IACnD,eAAe,GAAG,IAAI,CAAC,SAAS,CACvC,IAAI,KAAK,CAAC,UAAU,CAAC,eAAe,CAAC,CACtC,CAAC;IAEF,yEAAyE;IACzE,+EAA+E;IAC/E,kFAAkF;IAClF,8BAA8B;IACrB,gBAAgB,GAAG,IAAI,CAAC,SAAS,CACxC,IAAI,KAAK,CACP,UAAU,CAAC,gBAAgB,EAC3B,IAAI,CACL,CACF,CAAC;IAEF,6EAA6E;IAC7E,uDAAuD;IAC9C,aAAa,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,KAAK,CAAC,UAAU,CAAC,YAAY,CAAC,CAAC,CAAC;IAE5E,8EAA8E;IAC9E,yEAAyE;IACzE,uEAAuE;IACvE,yEAAyE;IACzE,sDAAsD;IAC7C,kBAAkB,GAAG,IAAI,CAAC,SAAS,CAC1C,IAAI,KAAK,CAAC,UAAU,CAAC,iBAAiB,CAAC,CACxC,CAAC;IAEF,2EAA2E;IAC3E,iEAAiE;IACjE,+CAA+C;IAC/C,0EAA0E;IACjE,mBAAmB,GAAG,IAAI,CAAC,SAAS,CAC3C,IAAI,KAAK,CAAC,UAAU,CAAC,kBAAkB,CAAC,CACzC,CAAC;IAEF,mEAAmE;IACnE,yDAAyD;IACzD,sEAAsE;IACtE,yEAAyE;IACzE,2EAA2E;IAC3E,sDAAsD;IAC7C,qBAAqB,GAAG,IAAI,CAAC,SAAS,CAC7C,IAAI,KAAK,CAAC,UAAU,CAAC,oBAAoB,CAAC,CAC3C,CAAC;IAEF,sBAAsB,CAAC,MAA0B;QAC/C,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IACjC,CAAC;IAED,YAAY,CAAC,eAAuB,EAAE,oBAA4B;QAChE,IAAI,CAAC,aAAa,CAAC,KAAK,EAAE,CAAC;QAC3B,IAAI,CAAC,mBAAmB,CAAC,KAAK,EAAE,CAAC;QACjC,IAAI,CAAC,kBAAkB,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC;QAC7C,IAAI,CAAC,qBAAqB,CAAC,GAAG,CAAC,oBAAoB,CAAC,CAAC;IACvD,CAAC;IAED,gCAAgC;QAC9B,IAAI,CAAC,kBAAkB,CAAC,KAAK,EAAE,CAAC;QAChC,IAAI,CAAC,qBAAqB,CAAC,KAAK,EAAE,CAAC;QACnC,IAAI,CAAC,mBAAmB,CAAC,KAAK,EAAE,CAAC;QACjC,IAAI,kBAAsC,CAAC;QAC3C,QAAQ,IAAI,CAAC,aAAa,CAAC,GAAG,EAAE,EAAE,CAAC;YACjC,KAAK,MAAM;gBACT,kBAAkB,GAAG,iBAAiB,CAAC;gBACvC,MAAM;YACR,KAAK,OAAO;gBACV,kBAAkB,GAAG,kBAAkB,CAAC;gBACxC,MAAM;YACR;gBACE,kBAAkB,GAAG,QAAQ,CAAC;gBAC9B,MAAM;QACV,CAAC;QACD,IAAI,CAAC,sBAAsB,CAAC,kBAAkB,CAAC,CAAC;IAClD,CAAC;IAED,eAAe,CAAC,MAAwB;QACtC,IAAI,CAAC,kBAAkB,CAAC,KAAK,EAAE,CAAC;QAChC,IAAI,CAAC,qBAAqB,CAAC,KAAK,EAAE,CAAC;QACnC,IAAI,CAAC,sBAAsB,CAAC,OAAO,CAAC,CAAC;QACrC,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,wBAAwB,CAAC,MAAM,CAAC,CAAC,CAAC;IACjE,CAAC;IAED;;OAEG;IACM,IAAI,GAAa,EAAE,CAAC;IAE7B,sEAAsE;IACtE,cAAc;IACd,KAAK,CAAC,KAAK;QACT,MAAM,EAAE,GAAG,IAAI,CAAC,GAAG,CAAC;QACpB,IAAI,IAAI,CAAC,QAAQ,KAAK,IAAI,EAAE,CAAC;YAC3B,EAAE,CAAC,KAAK,EAAE,CAAC,kDAAkD,CAAC,CAAC;YAC/D,OAAO;QACT,CAAC;QACD,MAAM,SAAS,GAAa,EAAE,CAAC;QAC/B,KAAK,MAAM,MAAM,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;YACnC,MAAM,MAAM,GAAG,MAAM,CAAC,KAAK,EAAE,CAAC;YAC9B,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;gBACzB,SAAS,CAAC,IAAI,CAAC;oBACb,GAAG,MAAM;oBACT,IAAI,EAAE,IAAI,CAAC,KAAK;oBAChB,IAAI,EAAE,IAAI,CAAC,IAAI;iBAChB,CAAC,CAAC;YACL,CAAC;QACH,CAAC;QACD,IAAI,SAAS,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC3B,EAAE,EAAE,KAAK,EAAE,CAAC,sBAAsB,CAAC,CAAC;YACpC,OAAO;QACT,CAAC;QACD,IAAI,CAAC;YACH,MAAM,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC;QAClC,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,EAAE,EAAE,KAAK,EAAE,CAAC,4BAA4B,CAAC,EAAE,CAAC,CAAC;QAC/C,CAAC;IACH,CAAC;IAED,IAAI;QACF,IAAI,IAAI,CAAC,QAAQ,KAAK,IAAI,EAAE,CAAC;YAC3B,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE,CAAC,iDAAiD,CAAC,CAAC;YACpE,OAAO;QACT,CAAC;QACD,aAAa,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAC7B,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC;IACvB,CAAC;IAED,SAAS,CAAsB,MAAS;QACtC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAC3B,OAAO,MAAM,CAAC;IAChB,CAAC;CACF;AAqBD,SAAS,SAAS,CAAC,EAAU,EAAE,KAAa;IAC1C,OAAO,CAAC,EAAE,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC;AACvB,CAAC;AAMD;;;;;;;;;;;;;GAaG;AACH,MAAM,OAAO,KAAK;IACP,KAAK,CAAS;IACvB,MAAM,GAAuB,SAAS,CAAC;IAEvC,YAAY,IAAY;QACtB,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;IACpB,CAAC;IAED,GAAG,CAAC,KAAa;QACf,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;IACtB,CAAC;IAED,GAAG;QACD,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAED,KAAK;QACH,IAAI,CAAC,MAAM,GAAG,SAAS,CAAC;IAC1B,CAAC;IAED,KAAK;QACH,IAAI,IAAI,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;YAC9B,OAAO,SAAS,CAAC;QACnB,CAAC;QACD,4EAA4E;QAC5E,YAAY;QACZ,MAAM,MAAM,GAAG,CAAC,SAAS,CAAC,CAAC,EAAE,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;QAC7C,OAAO,EAAC,MAAM,EAAE,IAAI,CAAC,KAAK,EAAE,MAAM,EAAC,CAAC;IACtC,CAAC;CACF;AAED,SAAS,CAAC;IACR,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,CAAC;AACvC,CAAC;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,OAAO,KAAK;IACP,OAAO,CAAS;IAChB,aAAa,CAAU;IAChC,QAAQ,GAAuB,SAAS,CAAC;IAEzC,YAAY,MAAc,EAAE,YAAY,GAAG,KAAK;QAC9C,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;QACtB,IAAI,CAAC,aAAa,GAAG,YAAY,CAAC;IACpC,CAAC;IAED,GAAG,CAAC,KAAa;QACf,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC;IACxB,CAAC;IAED,GAAG;QACD,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IAED,KAAK;QACH,IAAI,CAAC,QAAQ,GAAG,SAAS,CAAC;IAC5B,CAAC;IAED,KAAK;QACH,IAAI,IAAI,CAAC,QAAQ,KAAK,SAAS,EAAE,CAAC;YAChC,OAAO,SAAS,CAAC;QACnB,CAAC;QACD,MAAM,KAAK,GAAG,IAAI,KAAK,CAAC,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;QACjE,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;QACb,MAAM,MAAM,GAAG,KAAK,CAAC,KAAK,EAAE,CAAC;QAC7B,IAAI,IAAI,CAAC,aAAa,EAAE,CAAC;YACvB,IAAI,CAAC,KAAK,EAAE,CAAC;QACf,CAAC;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;CACF"}

package/out/zero-client/src/client/normalized-schema.d.ts

@@ -0,0 +1,17 @@
+import { NormalizedTableSchema } from '../../../zql/src/zql/query/normalize-table-schema.js';
+import type { Schema } from './zero.js';
+/**
+ * Creates a normalized schema from a schema.
+ *
+ * A normalized schema has all the keys sorted and the primary key and the
+ * primary key columns are checked to be valid.
+ */
+export declare function normalizeSchema(schema: Schema): NormalizedSchema;
+export declare class NormalizedSchema {
+    readonly version: number;
+    readonly tables: {
+        readonly [table: string]: NormalizedTableSchema;
+    };
+    constructor(schema: Schema);
+}
+//# sourceMappingURL=normalized-schema.d.ts.map

package/out/zero-client/src/client/normalized-schema.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"normalized-schema.d.ts","sourceRoot":"","sources":["../../../../../zero-client/src/client/normalized-schema.ts"],"names":[],"mappings":"AAEA,OAAO,EACL,qBAAqB,EAGtB,MAAM,sDAAsD,CAAC;AAC9D,OAAO,KAAK,EAAC,MAAM,EAAC,MAAM,WAAW,CAAC;AAEtC;;;;;GAKG;AACH,wBAAgB,eAAe,CAAC,MAAM,EAAE,MAAM,GAAG,gBAAgB,CAKhE;AAED,qBAAa,gBAAgB;IAC3B,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,MAAM,EAAE;QACf,QAAQ,EAAE,KAAK,EAAE,MAAM,GAAG,qBAAqB,CAAC;KACjD,CAAC;gBAEU,MAAM,EAAE,MAAM;CAI3B"}

package/out/zero-client/src/client/normalized-schema.js

@@ -0,0 +1,31 @@
+import { sortedEntries } from '../../../shared/src/sorted-entries.js';
+import { NormalizedTableSchema, normalizeTableSchemaWithCache, } from '../../../zql/src/zql/query/normalize-table-schema.js';
+/**
+ * Creates a normalized schema from a schema.
+ *
+ * A normalized schema has all the keys sorted and the primary key and the
+ * primary key columns are checked to be valid.
+ */
+export function normalizeSchema(schema) {
+    if (schema instanceof NormalizedSchema) {
+        return schema;
+    }
+    return new NormalizedSchema(schema);
+}
+export class NormalizedSchema {
+    version;
+    tables;
+    constructor(schema) {
+        this.version = schema.version;
+        this.tables = normalizeTables(schema.tables);
+    }
+}
+function normalizeTables(tables) {
+    const rv = {};
+    const tableSchemaCache = new Map();
+    for (const [name, table] of sortedEntries(tables)) {
+        rv[name] = normalizeTableSchemaWithCache(table, name, tableSchemaCache);
+    }
+    return rv;
+}
+//# sourceMappingURL=normalized-schema.js.map

package/out/zero-client/src/client/normalized-schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"normalized-schema.js","sourceRoot":"","sources":["../../../../../zero-client/src/client/normalized-schema.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,aAAa,EAAC,MAAM,uCAAuC,CAAC;AAEpE,OAAO,EACL,qBAAqB,EACrB,6BAA6B,GAE9B,MAAM,sDAAsD,CAAC;AAG9D;;;;;GAKG;AACH,MAAM,UAAU,eAAe,CAAC,MAAc;IAC5C,IAAI,MAAM,YAAY,gBAAgB,EAAE,CAAC;QACvC,OAAO,MAAM,CAAC;IAChB,CAAC;IACD,OAAO,IAAI,gBAAgB,CAAC,MAAM,CAAC,CAAC;AACtC,CAAC;AAED,MAAM,OAAO,gBAAgB;IAClB,OAAO,CAAS;IAChB,MAAM,CAEb;IAEF,YAAY,MAAc;QACxB,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC;QAC9B,IAAI,CAAC,MAAM,GAAG,eAAe,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;IAC/C,CAAC;CACF;AAED,SAAS,eAAe,CAAC,MAAwB;IAG/C,MAAM,EAAE,GAEH,EAAE,CAAC;IACR,MAAM,gBAAgB,GAAqB,IAAI,GAAG,EAAE,CAAC;IACrD,KAAK,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,aAAa,CAAC,MAAM,CAAC,EAAE,CAAC;QAClD,EAAE,CAAC,IAAI,CAAC,GAAG,6BAA6B,CAAC,KAAK,EAAE,IAAI,EAAE,gBAAgB,CAAC,CAAC;IAC1E,CAAC;IACD,OAAO,EAAE,CAAC;AACZ,CAAC"}

package/out/zero-client/src/client/options.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=options.js.map

package/out/zero-client/src/client/options.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"options.js","sourceRoot":"","sources":["../../../../../zero-client/src/client/options.ts"],"names":[],"mappings":""}

package/out/zero-client/src/client/query-manager.d.ts

@@ -1,7 +1,7 @@
 import type { ClientID } from '../../../replicache/src/mod.js';
 import type { ReplicacheImpl } from '../../../replicache/src/replicache-impl.js';
-import type { ChangeDesiredQueriesMessage, QueriesPatch } from '../../../zero-protocol/src/mod.js';
-import { type AST } from '../../../zql/src/zql/ast/ast.js';
+import { type AST } from '../../../zero-protocol/src/ast.js';
+import type { ChangeDesiredQueriesMessage, QueriesPatchOp } from '../../../zero-protocol/src/mod.js';
 import type { GotCallback } from '../../../zql/src/zql/query/query-impl.js';
 import type { ReadTransaction } from '../mod.js';
 /**
@@ -12,7 +12,22 @@ import type { ReadTransaction } from '../mod.js';
 export declare class QueryManager {
     #private;
     constructor(clientID: ClientID, send: (change: ChangeDesiredQueriesMessage) => void, experimentalWatch: InstanceType<typeof ReplicacheImpl>['experimentalWatch']);
-    getQueriesPatch(tx: ReadTransaction): Promise<QueriesPatch>;
+    /**
+     * Get the queries that need to be registered with the server.
+     *
+     * An optional `lastPatch` can be provided. This is the last patch that was
+     * sent to the server and may not yet have been acked. If `lastPatch` is provided,
+     * this method will return a patch that does not include any events sent in `lastPatch`.
+     *
+     * This diffing of last patch and current patch is needed since we send
+     * a set of queries to the server when we first connect inside of the `sec-protocol` as
+     * the `initConnectionMessage`.
+     *
+     * While we're waiting for the `connected` response to come back from the server,
+     * the client may have registered more queries. We need to diff the `initConnectionMessage`
+     * queries with the current set of queries to understand what those were.
+     */
+    getQueriesPatch(tx: ReadTransaction, lastPatch?: Map<string, QueriesPatchOp> | undefined): Promise<Map<string, QueriesPatchOp>>;
     add(ast: AST, gotCallback?: GotCallback | undefined): () => void;
 }
 //# sourceMappingURL=query-manager.d.ts.map

package/out/zero-client/src/client/query-manager.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"query-manager.d.ts","sourceRoot":"","sources":["../../../../../zero-client/src/client/query-manager.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,QAAQ,EAAC,MAAM,gCAAgC,CAAC;AAC7D,OAAO,KAAK,EAAC,cAAc,EAAC,MAAM,4CAA4C,CAAC;AAG/E,OAAO,KAAK,EACV,2BAA2B,EAC3B,YAAY,EACb,MAAM,mCAAmC,CAAC;AAC3C,OAAO,EAAe,KAAK,GAAG,EAAC,MAAM,iCAAiC,CAAC;AACvE,OAAO,KAAK,EAAC,WAAW,EAAC,MAAM,0CAA0C,CAAC;AAC1E,OAAO,KAAK,EAAC,eAAe,EAAC,MAAM,WAAW,CAAC;AAG/C;;;;GAIG;AACH,qBAAa,YAAY;;gBAUrB,QAAQ,EAAE,QAAQ,EAClB,IAAI,EAAE,CAAC,MAAM,EAAE,2BAA2B,KAAK,IAAI,EACnD,iBAAiB,EAAE,YAAY,CAAC,OAAO,cAAc,CAAC,CAAC,mBAAmB,CAAC;IAkCvE,eAAe,CAAC,EAAE,EAAE,eAAe,GAAG,OAAO,CAAC,YAAY,CAAC;IAoBjE,GAAG,CAAC,GAAG,EAAE,GAAG,EAAE,WAAW,CAAC,EAAE,WAAW,GAAG,SAAS,GAAG,MAAM,IAAI;CAsDjE"}
+{"version":3,"file":"query-manager.d.ts","sourceRoot":"","sources":["../../../../../zero-client/src/client/query-manager.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,QAAQ,EAAC,MAAM,gCAAgC,CAAC;AAC7D,OAAO,KAAK,EAAC,cAAc,EAAC,MAAM,4CAA4C,CAAC;AAG/E,OAAO,EAAe,KAAK,GAAG,EAAC,MAAM,mCAAmC,CAAC;AACzE,OAAO,KAAK,EACV,2BAA2B,EAC3B,cAAc,EACf,MAAM,mCAAmC,CAAC;AAC3C,OAAO,KAAK,EAAC,WAAW,EAAC,MAAM,0CAA0C,CAAC;AAC1E,OAAO,KAAK,EAAC,eAAe,EAAC,MAAM,WAAW,CAAC;AAG/C;;;;GAIG;AACH,qBAAa,YAAY;;gBAUrB,QAAQ,EAAE,QAAQ,EAClB,IAAI,EAAE,CAAC,MAAM,EAAE,2BAA2B,KAAK,IAAI,EACnD,iBAAiB,EAAE,YAAY,CAAC,OAAO,cAAc,CAAC,CAAC,mBAAmB,CAAC;IAkC7E;;;;;;;;;;;;;;OAcG;IACG,eAAe,CACnB,EAAE,EAAE,eAAe,EACnB,SAAS,CAAC,EAAE,GAAG,CAAC,MAAM,EAAE,cAAc,CAAC,GAAG,SAAS,GAClD,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC;IAsCvC,GAAG,CAAC,GAAG,EAAE,GAAG,EAAE,WAAW,CAAC,EAAE,WAAW,GAAG,SAAS,GAAG,MAAM,IAAI;CAuDjE"}

package/out/zero-client/src/client/query-manager.js

@@ -0,0 +1,149 @@
+import { must } from '../../../shared/src/must.js';
+import { h64 } from '../../../shared/src/xxhash.js';
+import { normalizeAST } from '../../../zero-protocol/src/ast.js';
+import { desiredQueriesPrefixForClient, GOT_QUERIES_KEY_PREFIX } from './keys.js';
+/**
+ * Tracks what queries the client is currently subscribed to on the server.
+ * Sends `changeDesiredQueries` message to server when this changes.
+ * Deduplicates requests so that we only listen to a given unique query once.
+ */
+export class QueryManager {
+    #clientID;
+    #send;
+    #queries = new Map();
+    #gotQueries = new Set();
+    constructor(clientID, send, experimentalWatch) {
+        this.#clientID = clientID;
+        this.#send = send;
+        experimentalWatch(diff => {
+            for (const diffOp of diff) {
+                const queryHash = diffOp.key.substring(GOT_QUERIES_KEY_PREFIX.length);
+                switch (diffOp.op) {
+                    case 'add':
+                        this.#gotQueries.add(queryHash);
+                        this.#fireGotCallbacks(queryHash, true);
+                        break;
+                    case 'del':
+                        this.#gotQueries.delete(queryHash);
+                        this.#fireGotCallbacks(queryHash, false);
+                        break;
+                }
+            }
+        }, {
+            prefix: GOT_QUERIES_KEY_PREFIX,
+            initialValuesInFirstDiff: true,
+        });
+    }
+    #fireGotCallbacks(queryHash, got) {
+        const gotCallbacks = this.#queries.get(queryHash)?.gotCallbacks ?? [];
+        for (const gotCallback of gotCallbacks) {
+            gotCallback(got);
+        }
+    }
+    /**
+     * Get the queries that need to be registered with the server.
+     *
+     * An optional `lastPatch` can be provided. This is the last patch that was
+     * sent to the server and may not yet have been acked. If `lastPatch` is provided,
+     * this method will return a patch that does not include any events sent in `lastPatch`.
+     *
+     * This diffing of last patch and current patch is needed since we send
+     * a set of queries to the server when we first connect inside of the `sec-protocol` as
+     * the `initConnectionMessage`.
+     *
+     * While we're waiting for the `connected` response to come back from the server,
+     * the client may have registered more queries. We need to diff the `initConnectionMessage`
+     * queries with the current set of queries to understand what those were.
+     */
+    async getQueriesPatch(tx, lastPatch) {
+        const existingQueryHashes = new Set();
+        const prefix = desiredQueriesPrefixForClient(this.#clientID);
+        for await (const key of tx.scan({ prefix }).keys()) {
+            existingQueryHashes.add(key.substring(prefix.length, key.length));
+        }
+        const patch = new Map();
+        for (const hash of existingQueryHashes) {
+            if (!this.#queries.has(hash)) {
+                patch.set(hash, { op: 'del', hash });
+            }
+        }
+        for (const [hash, { normalized }] of this.#queries) {
+            if (!existingQueryHashes.has(hash)) {
+                patch.set(hash, { op: 'put', hash, ast: normalized });
+            }
+        }
+        if (lastPatch) {
+            // if there are any `puts` in `lastPatch` that are not in `patch` then we need to
+            // send a `del` event in `patch`.
+            for (const [hash, { op }] of lastPatch) {
+                if (op === 'put' && !patch.has(hash)) {
+                    patch.set(hash, { op: 'del', hash });
+                }
+            }
+            // Remove everything from `patch` that was already sent in `lastPatch`.
+            for (const [hash, { op }] of patch) {
+                const lastPatchOp = lastPatch.get(hash);
+                if (lastPatchOp && lastPatchOp.op === op) {
+                    patch.delete(hash);
+                }
+            }
+        }
+        return patch;
+    }
+    add(ast, gotCallback) {
+        const normalized = normalizeAST(ast);
+        const astHash = hash(normalized);
+        let entry = this.#queries.get(astHash);
+        if (!entry) {
+            entry = {
+                normalized,
+                count: 1,
+                gotCallbacks: gotCallback === undefined ? [] : [gotCallback],
+            };
+            this.#queries.set(astHash, entry);
+            this.#send([
+                'changeDesiredQueries',
+                {
+                    desiredQueriesPatch: [{ op: 'put', hash: astHash, ast: normalized }],
+                },
+            ]);
+        }
+        else {
+            ++entry.count;
+            if (gotCallback) {
+                entry.gotCallbacks.push(gotCallback);
+            }
+        }
+        if (gotCallback) {
+            queueMicrotask(() => {
+                gotCallback(this.#gotQueries.has(astHash));
+            });
+        }
+        let removed = false;
+        return () => {
+            if (removed) {
+                return;
+            }
+            removed = true;
+            this.#remove(astHash);
+        };
+    }
+    #remove(astHash) {
+        const entry = must(this.#queries.get(astHash));
+        --entry.count;
+        if (entry.count === 0) {
+            this.#queries.delete(astHash);
+            this.#send([
+                'changeDesiredQueries',
+                {
+                    desiredQueriesPatch: [{ op: 'del', hash: astHash }],
+                },
+            ]);
+        }
+        return true;
+    }
+}
+function hash(normalized) {
+    return h64(JSON.stringify(normalized)).toString(36);
+}
+//# sourceMappingURL=query-manager.js.map

package/out/zero-client/src/client/query-manager.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"query-manager.js","sourceRoot":"","sources":["../../../../../zero-client/src/client/query-manager.ts"],"names":[],"mappings":"AAEA,OAAO,EAAC,IAAI,EAAC,MAAM,6BAA6B,CAAC;AACjD,OAAO,EAAC,GAAG,EAAC,MAAM,+BAA+B,CAAC;AAClD,OAAO,EAAC,YAAY,EAAW,MAAM,mCAAmC,CAAC;AAOzE,OAAO,EAAC,6BAA6B,EAAE,sBAAsB,EAAC,MAAM,WAAW,CAAC;AAEhF;;;;GAIG;AACH,MAAM,OAAO,YAAY;IACd,SAAS,CAAW;IACpB,KAAK,CAAgD;IACrD,QAAQ,GAGb,IAAI,GAAG,EAAE,CAAC;IACL,WAAW,GAAgB,IAAI,GAAG,EAAE,CAAC;IAE9C,YACE,QAAkB,EAClB,IAAmD,EACnD,iBAA2E;QAE3E,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAC;QAC1B,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;QAClB,iBAAiB,CACf,IAAI,CAAC,EAAE;YACL,KAAK,MAAM,MAAM,IAAI,IAAI,EAAE,CAAC;gBAC1B,MAAM,SAAS,GAAG,MAAM,CAAC,GAAG,CAAC,SAAS,CAAC,sBAAsB,CAAC,MAAM,CAAC,CAAC;gBACtE,QAAQ,MAAM,CAAC,EAAE,EAAE,CAAC;oBAClB,KAAK,KAAK;wBACR,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;wBAChC,IAAI,CAAC,iBAAiB,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC;wBACxC,MAAM;oBACR,KAAK,KAAK;wBACR,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;wBACnC,IAAI,CAAC,iBAAiB,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC;wBACzC,MAAM;gBACV,CAAC;YACH,CAAC;QACH,CAAC,EACD;YACE,MAAM,EAAE,sBAAsB;YAC9B,wBAAwB,EAAE,IAAI;SAC/B,CACF,CAAC;IACJ,CAAC;IAED,iBAAiB,CAAC,SAAiB,EAAE,GAAY;QAC/C,MAAM,YAAY,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,SAAS,CAAC,EAAE,YAAY,IAAI,EAAE,CAAC;QACtE,KAAK,MAAM,WAAW,IAAI,YAAY,EAAE,CAAC;YACvC,WAAW,CAAC,GAAG,CAAC,CAAC;QACnB,CAAC;IACH,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,KAAK,CAAC,eAAe,CACnB,EAAmB,EACnB,SAAmD;QAEnD,MAAM,mBAAmB,GAAG,IAAI,GAAG,EAAU,CAAC;QAC9C,MAAM,MAAM,GAAG,6BAA6B,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAC7D,IAAI,KAAK,EAAE,MAAM,GAAG,IAAI,EAAE,CAAC,IAAI,CAAC,EAAC,MAAM,EAAC,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC;YACjD,mBAAmB,CAAC,GAAG,CAAC,GAAG,CAAC,SAAS,CAAC,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC;QACpE,CAAC;QACD,MAAM,KAAK,GAAgC,IAAI,GAAG,EAAE,CAAC;QACrD,KAAK,MAAM,IAAI,IAAI,mBAAmB,EAAE,CAAC;YACvC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC;gBAC7B,KAAK,CAAC,GAAG,CAAC,IAAI,EAAE,EAAC,EAAE,EAAE,KAAK,EAAE,IAAI,EAAC,CAAC,CAAC;YACrC,CAAC;QACH,CAAC;QACD,KAAK,MAAM,CAAC,IAAI,EAAE,EAAC,UAAU,EAAC,CAAC,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;YACjD,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC;gBACnC,KAAK,CAAC,GAAG,CAAC,IAAI,EAAE,EAAC,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,GAAG,EAAE,UAAU,EAAC,CAAC,CAAC;YACtD,CAAC;QACH,CAAC;QAED,IAAI,SAAS,EAAE,CAAC;YACd,iFAAiF;YACjF,iCAAiC;YACjC,KAAK,MAAM,CAAC,IAAI,EAAE,EAAC,EAAE,EAAC,CAAC,IAAI,SAAS,EAAE,CAAC;gBACrC,IAAI,EAAE,KAAK,KAAK,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC;oBACrC,KAAK,CAAC,GAAG,CAAC,IAAI,EAAE,EAAC,EAAE,EAAE,KAAK,EAAE,IAAI,EAAC,CAAC,CAAC;gBACrC,CAAC;YACH,CAAC;YACD,uEAAuE;YACvE,KAAK,MAAM,CAAC,IAAI,EAAE,EAAC,EAAE,EAAC,CAAC,IAAI,KAAK,EAAE,CAAC;gBACjC,MAAM,WAAW,GAAG,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;gBACxC,IAAI,WAAW,IAAI,WAAW,CAAC,EAAE,KAAK,EAAE,EAAE,CAAC;oBACzC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;gBACrB,CAAC;YACH,CAAC;QACH,CAAC;QAED,OAAO,KAAK,CAAC;IACf,CAAC;IAED,GAAG,CAAC,GAAQ,EAAE,WAAqC;QACjD,MAAM,UAAU,GAAG,YAAY,CAAC,GAAG,CAAC,CAAC;QACrC,MAAM,OAAO,GAAG,IAAI,CAAC,UAAU,CAAC,CAAC;QACjC,IAAI,KAAK,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;QACvC,IAAI,CAAC,KAAK,EAAE,CAAC;YACX,KAAK,GAAG;gBACN,UAAU;gBACV,KAAK,EAAE,CAAC;gBACR,YAAY,EAAE,WAAW,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC;aAC7D,CAAC;YACF,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;YAElC,IAAI,CAAC,KAAK,CAAC;gBACT,sBAAsB;gBACtB;oBACE,mBAAmB,EAAE,CAAC,EAAC,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,EAAE,UAAU,EAAC,CAAC;iBACnE;aACF,CAAC,CAAC;QACL,CAAC;aAAM,CAAC;YACN,EAAE,KAAK,CAAC,KAAK,CAAC;YACd,IAAI,WAAW,EAAE,CAAC;gBAChB,KAAK,CAAC,YAAY,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;YACvC,CAAC;QACH,CAAC;QAED,IAAI,WAAW,EAAE,CAAC;YAChB,cAAc,CAAC,GAAG,EAAE;gBAClB,WAAW,CAAC,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC;YAC7C,CAAC,CAAC,CAAC;QACL,CAAC;QAED,IAAI,OAAO,GAAG,KAAK,CAAC;QACpB,OAAO,GAAG,EAAE;YACV,IAAI,OAAO,EAAE,CAAC;gBACZ,OAAO;YACT,CAAC;YACD,OAAO,GAAG,IAAI,CAAC;YACf,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACxB,CAAC,CAAC;IACJ,CAAC;IAED,OAAO,CAAC,OAAe;QACrB,MAAM,KAAK,GAAG,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC;QAC/C,EAAE,KAAK,CAAC,KAAK,CAAC;QACd,IAAI,KAAK,CAAC,KAAK,KAAK,CAAC,EAAE,CAAC;YACtB,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;YAC9B,IAAI,CAAC,KAAK,CAAC;gBACT,sBAAsB;gBACtB;oBACE,mBAAmB,EAAE,CAAC,EAAC,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,OAAO,EAAC,CAAC;iBAClD;aACF,CAAC,CAAC;QACL,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AAID,SAAS,IAAI,CAAC,UAAe;IAC3B,OAAO,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;AACtD,CAAC"}

package/out/zero-client/src/client/reload-error-handler.js

@@ -0,0 +1,23 @@
+export const RELOAD_REASON_STORAGE_KEY = '_zeroReloadReason';
+// TODO: This should get pushed down into Replicache and used for reloads we
+// do there.
+export function reloadWithReason(lc, reload, reason) {
+    if (typeof localStorage === 'undefined') {
+        lc.error?.('Zero reloaded the page.', reason);
+    }
+    else {
+        localStorage[RELOAD_REASON_STORAGE_KEY] = reason;
+    }
+    reload();
+}
+export function reportReloadReason(lc) {
+    if (typeof localStorage === 'undefined') {
+        return;
+    }
+    const reason = localStorage[RELOAD_REASON_STORAGE_KEY];
+    if (reason) {
+        delete localStorage[RELOAD_REASON_STORAGE_KEY];
+        lc.error?.('Zero reloaded the page.', reason);
+    }
+}
+//# sourceMappingURL=reload-error-handler.js.map

package/out/zero-client/src/client/reload-error-handler.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"reload-error-handler.js","sourceRoot":"","sources":["../../../../../zero-client/src/client/reload-error-handler.ts"],"names":[],"mappings":"AAEA,MAAM,CAAC,MAAM,yBAAyB,GAAG,mBAAmB,CAAC;AAE7D,4EAA4E;AAC5E,YAAY;AACZ,MAAM,UAAU,gBAAgB,CAC9B,EAAc,EACd,MAAkB,EAClB,MAAc;IAEd,IAAI,OAAO,YAAY,KAAK,WAAW,EAAE,CAAC;QACxC,EAAE,CAAC,KAAK,EAAE,CAAC,yBAAyB,EAAE,MAAM,CAAC,CAAC;IAChD,CAAC;SAAM,CAAC;QACN,YAAY,CAAC,yBAAyB,CAAC,GAAG,MAAM,CAAC;IACnD,CAAC;IACD,MAAM,EAAE,CAAC;AACX,CAAC;AAED,MAAM,UAAU,kBAAkB,CAAC,EAAc;IAC/C,IAAI,OAAO,YAAY,KAAK,WAAW,EAAE,CAAC;QACxC,OAAO;IACT,CAAC;IACD,MAAM,MAAM,GAAG,YAAY,CAAC,yBAAyB,CAAC,CAAC;IACvD,IAAI,MAAM,EAAE,CAAC;QACX,OAAO,YAAY,CAAC,yBAAyB,CAAC,CAAC;QAC/C,EAAE,CAAC,KAAK,EAAE,CAAC,yBAAyB,EAAE,MAAM,CAAC,CAAC;IAChD,CAAC;AACH,CAAC"}

package/out/zero-client/src/client/replicache-types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=replicache-types.js.map

package/out/zero-client/src/client/replicache-types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"replicache-types.js","sourceRoot":"","sources":["../../../../../zero-client/src/client/replicache-types.ts"],"names":[],"mappings":""}

package/out/zero-client/src/client/server-error.js

@@ -0,0 +1,22 @@
+import { ErrorKind } from '../../../zero-protocol/src/mod.js';
+/**
+ * Represents an error sent by server as part of Zero protocol.
+ */
+export class ServerError extends Error {
+    kind;
+    name = 'ServerError';
+    constructor(kind, message) {
+        super(kind + ': ' + message);
+        this.kind = kind;
+    }
+}
+export function isServerError(ex) {
+    return ex instanceof ServerError;
+}
+export function isAuthError(ex) {
+    return isServerError(ex) && isAuthErrorKind(ex.kind);
+}
+function isAuthErrorKind(kind) {
+    return kind === ErrorKind.AuthInvalidated || kind === ErrorKind.Unauthorized;
+}
+//# sourceMappingURL=server-error.js.map

package/out/zero-client/src/client/server-error.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"server-error.js","sourceRoot":"","sources":["../../../../../zero-client/src/client/server-error.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,SAAS,EAAC,MAAM,mCAAmC,CAAC;AAE5D;;GAEG;AACH,MAAM,OAAO,WAA6C,SAAQ,KAAK;IAC5D,IAAI,CAAI;IACR,IAAI,GAAG,aAAa,CAAC;IAC9B,YAAY,IAAO,EAAE,OAAe;QAClC,KAAK,CAAC,IAAI,GAAG,IAAI,GAAG,OAAO,CAAC,CAAC;QAC7B,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACnB,CAAC;CACF;AAED,MAAM,UAAU,aAAa,CAAC,EAAW;IACvC,OAAO,EAAE,YAAY,WAAW,CAAC;AACnC,CAAC;AAED,MAAM,UAAU,WAAW,CACzB,EAAW;IAIX,OAAO,aAAa,CAAC,EAAE,CAAC,IAAI,eAAe,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC;AACvD,CAAC;AAED,SAAS,eAAe,CACtB,IAAe;IAEf,OAAO,IAAI,KAAK,SAAS,CAAC,eAAe,IAAI,IAAI,KAAK,SAAS,CAAC,YAAY,CAAC;AAC/E,CAAC"}

package/out/zero-client/src/client/server-option.js

@@ -0,0 +1,37 @@
+function validateServerParam(paramName, server) {
+    const expectedProtocol = 'http';
+    const forExample = () => ` For example: "${expectedProtocol}s://myapp-myteam.zero.ms/".`;
+    if (!server.startsWith(`${expectedProtocol}://`) &&
+        !server.startsWith(`${expectedProtocol}s://`)) {
+        throw new Error(`ZeroOptions.${paramName} must use the "${expectedProtocol}" or "${expectedProtocol}s" scheme.`);
+    }
+    let url;
+    try {
+        url = new URL(server);
+    }
+    catch {
+        throw new Error(`ZeroOptions.${paramName} must be a valid URL.${forExample()}`);
+    }
+    const urlString = url.toString();
+    if (url.pathname !== '/') {
+        throw new Error(`ZeroOptions.${paramName} must not contain a path component (other than "/").${forExample()}`);
+    }
+    for (const [property, invalidEndsWith] of [
+        ['search', '?'],
+        ['hash', '#'],
+    ]) {
+        if (url[property] || urlString.endsWith(invalidEndsWith)) {
+            throw new Error(`ZeroOptions.${paramName} must not contain a ${property} component.${forExample()}`);
+        }
+    }
+    return urlString;
+}
+export function getServer(server) {
+    if (server === undefined || server === null) {
+        console.warn('Zero starting up with no server URL. This is supported for unit testing ' +
+            'and prototyping, but no data will be synced.');
+        return null;
+    }
+    return validateServerParam('server', server);
+}
+//# sourceMappingURL=server-option.js.map

package/out/zero-client/src/client/server-option.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"server-option.js","sourceRoot":"","sources":["../../../../../zero-client/src/client/server-option.ts"],"names":[],"mappings":"AAEA,SAAS,mBAAmB,CAAC,SAAiB,EAAE,MAAc;IAC5D,MAAM,gBAAgB,GAAG,MAAM,CAAC;IAChC,MAAM,UAAU,GAAG,GAAG,EAAE,CACtB,kBAAkB,gBAAgB,6BAA6B,CAAC;IAElE,IACE,CAAC,MAAM,CAAC,UAAU,CAAC,GAAG,gBAAgB,KAAK,CAAC;QAC5C,CAAC,MAAM,CAAC,UAAU,CAAC,GAAG,gBAAgB,MAAM,CAAC,EAC7C,CAAC;QACD,MAAM,IAAI,KAAK,CACb,eAAe,SAAS,kBAAkB,gBAAgB,SAAS,gBAAgB,YAAY,CAChG,CAAC;IACJ,CAAC;IACD,IAAI,GAAG,CAAC;IACR,IAAI,CAAC;QACH,GAAG,GAAG,IAAI,GAAG,CAAC,MAAM,CAAC,CAAC;IACxB,CAAC;IAAC,MAAM,CAAC;QACP,MAAM,IAAI,KAAK,CACb,eAAe,SAAS,wBAAwB,UAAU,EAAE,EAAE,CAC/D,CAAC;IACJ,CAAC;IAED,MAAM,SAAS,GAAG,GAAG,CAAC,QAAQ,EAAE,CAAC;IAEjC,IAAI,GAAG,CAAC,QAAQ,KAAK,GAAG,EAAE,CAAC;QACzB,MAAM,IAAI,KAAK,CACb,eAAe,SAAS,uDAAuD,UAAU,EAAE,EAAE,CAC9F,CAAC;IACJ,CAAC;IAED,KAAK,MAAM,CAAC,QAAQ,EAAE,eAAe,CAAC,IAAI;QACxC,CAAC,QAAQ,EAAE,GAAG,CAAC;QACf,CAAC,MAAM,EAAE,GAAG,CAAC;KACL,EAAE,CAAC;QACX,IAAI,GAAG,CAAC,QAAQ,CAAC,IAAI,SAAS,CAAC,QAAQ,CAAC,eAAe,CAAC,EAAE,CAAC;YACzD,MAAM,IAAI,KAAK,CACb,eAAe,SAAS,uBAAuB,QAAQ,cAAc,UAAU,EAAE,EAAE,CACpF,CAAC;QACJ,CAAC;IACH,CAAC;IAED,OAAO,SAAuB,CAAC;AACjC,CAAC;AAED,MAAM,UAAU,SAAS,CACvB,MAAiC;IAEjC,IAAI,MAAM,KAAK,SAAS,IAAI,MAAM,KAAK,IAAI,EAAE,CAAC;QAC5C,OAAO,CAAC,IAAI,CACV,0EAA0E;YACxE,8CAA8C,CACjD,CAAC;QACF,OAAO,IAAI,CAAC;IACd,CAAC;IACD,OAAO,mBAAmB,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;AAC/C,CAAC"}