@rocicorp/zero 0.25.0 → 0.26.0-canary.0

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

@@ -0,0 +1,249 @@
+import { AbruptClose, CleanClose, UserDisconnect, ClientClosed, Hidden } from "./client-error-kind-enum.js";
+import { isClientError, isServerError } from "./error.js";
+import { TimeToConnectMs, LastConnectError, NotConnected, TimeToConnectMsV2, LastConnectErrorV2, TotalTimeToConnectMs } from "./metric-name-enum.js";
+const DID_NOT_CONNECT_VALUE = 100 * 1e3;
+const REPORT_INTERVAL_MS = 5e3;
+function getLastConnectErrorValue(reason) {
+  return `${isServerError(reason) ? "server_" : "client_"}${camelToSnake(reason.kind)}`;
+}
+function camelToSnake(kind) {
+  return kind.split(/\.?(?=[A-Z])/).join("_").toLowerCase();
+}
+function shouldReportConnectError(reason) {
+  if (!isClientError(reason)) {
+    return true;
+  }
+  switch (reason.kind) {
+    case Hidden:
+    case ClientClosed:
+    case UserDisconnect:
+    case CleanClose:
+    case AbruptClose:
+      return false;
+    default:
+      return true;
+  }
+}
+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: this should be folded into the ConnectionManager.
+  timeToConnectMs = this.#register(
+    new Gauge(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(
+      LastConnectError,
+      true
+      // clearOnFlush
+    )
+  );
+  // notConnected records the reason why the client is not currently connected.
+  // It is cleared when the client successfully connects.
+  #notConnected = this.#register(new State(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(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(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(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 !== void 0) {
+        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]];
+}
+class Gauge {
+  #name;
+  #value = void 0;
+  constructor(name) {
+    this.#name = name;
+  }
+  set(value) {
+    this.#value = value;
+  }
+  get() {
+    return this.#value;
+  }
+  clear() {
+    this.#value = void 0;
+  }
+  flush() {
+    if (this.#value === void 0) {
+      return void 0;
+    }
+    const points = [makePoint(t(), this.#value)];
+    return { metric: this.#name, points };
+  }
+}
+function t() {
+  return Math.round(Date.now() / 1e3);
+}
+class State {
+  #prefix;
+  #clearOnFlush;
+  #current = void 0;
+  constructor(prefix, clearOnFlush = false) {
+    this.#prefix = prefix;
+    this.#clearOnFlush = clearOnFlush;
+  }
+  set(state) {
+    this.#current = state;
+  }
+  get() {
+    return this.#current;
+  }
+  clear() {
+    this.#current = void 0;
+  }
+  flush() {
+    if (this.#current === void 0) {
+      return void 0;
+    }
+    const gauge = new Gauge([this.#prefix, this.#current].join("_"));
+    gauge.set(1);
+    const series = gauge.flush();
+    if (this.#clearOnFlush) {
+      this.clear();
+    }
+    return series;
+  }
+}
+export {
+  DID_NOT_CONNECT_VALUE,
+  Gauge,
+  MetricManager,
+  REPORT_INTERVAL_MS,
+  State,
+  getLastConnectErrorValue,
+  shouldReportConnectError
+};
+//# sourceMappingURL=metrics.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"metrics.js","sources":["../../../../../zero-client/src/client/metrics.ts"],"sourcesContent":["import type {LogContext} from '@rocicorp/logger';\nimport type {MaybePromise} from '../../../shared/src/types.ts';\nimport {ClientErrorKind} from './client-error-kind.ts';\nimport {\n  isClientError,\n  isServerError,\n  type ZeroError,\n  type ZeroErrorKind,\n} from './error.ts';\nimport {MetricName} from './metric-name.ts';\n\n// This value is used to indicate that the client's last connection attempt\n// failed. We don't make this -1 because we want to stack this never connected\n// state in a graph on top of actual connection times, so it should be greater\n// than any other value.\nexport const DID_NOT_CONNECT_VALUE = 100 * 1000;\n\nexport const REPORT_INTERVAL_MS = 5_000;\n\ntype NotConnectedReason =\n  | 'init'\n  | 'error'\n  | 'hidden'\n  | 'hidden_was_init'\n  | 'hidden_was_error';\n\nexport function getLastConnectErrorValue(reason: ZeroError) {\n  return `${isServerError(reason) ? 'server_' : 'client_'}${camelToSnake(reason.kind)}` as const;\n}\n\n// camelToSnake is used to convert a ZeroErrorKind into a suitable\n// metric name, eg AuthInvalidated => auth_invalidated. It converts\n// both PascalCase and camelCase to snake_case.\nfunction camelToSnake(kind: ZeroErrorKind): string {\n  return kind\n    .split(/\\.?(?=[A-Z])/)\n    .join('_')\n    .toLowerCase();\n}\n\n/**\n * Returns whether an error should be reported in metrics and\n * increment the connect error count.\n *\n * Returns `true` for all server errors and client errors that represent actual\n * connection problems. Returns `false` for expected client-side disconnections\n * (user disconnect, client closed, hidden tab, clean/abrupt close).\n */\nexport function shouldReportConnectError(reason: ZeroError): boolean {\n  if (!isClientError(reason)) {\n    return true;\n  }\n  switch (reason.kind) {\n    case ClientErrorKind.Hidden:\n    case ClientErrorKind.ClientClosed:\n    case ClientErrorKind.UserDisconnect:\n    case ClientErrorKind.CleanClose:\n    case ClientErrorKind.AbruptClose:\n      return false;\n    default:\n      return true;\n  }\n}\n\ntype MetricsReporter = (metrics: Series[]) => MaybePromise<void>;\n\nexport type MetricManagerOptions = {\n  reportIntervalMs: number;\n  host: string;\n  source: string;\n  reporter: MetricsReporter;\n  lc: LogContext;\n};\n\n/**\n * MetricManager keeps track of the set of metrics in use and flushes them\n * to a format suitable for reporting.\n */\nexport class MetricManager {\n  #reportIntervalMs: number;\n  #host: string;\n  #reporter: MetricsReporter;\n  #lc: LogContext;\n  #timerID: ReturnType<typeof setInterval> | null;\n\n  constructor(opts: MetricManagerOptions) {\n    this.#reportIntervalMs = opts.reportIntervalMs;\n    this.#host = opts.host;\n    this.#reporter = opts.reporter;\n    this.#lc = opts.lc;\n\n    this.tags.push(`source:${opts.source}`);\n\n    this.timeToConnectMs.set(DID_NOT_CONNECT_VALUE);\n    this.#setNotConnectedReason('init');\n\n    this.#timerID = setInterval(() => {\n      void this.flush();\n    }, this.#reportIntervalMs);\n  }\n\n  #metrics: Flushable[] = [];\n\n  // timeToConnectMs measures the time from the call to connect() to receiving\n  // the 'connected' ws message. We record the DID_NOT_CONNECT_VALUE if the previous\n  // connection attempt failed for any reason.\n  //\n  // We set the gauge using #connectStart as follows:\n  // - #connectStart is undefined if we are disconnected or connected; it is\n  //   defined only in the Connecting state, as a number representing the timestamp\n  //   at which we started connecting.\n  // - #connectStart is set to the current time when connect() is called.\n  // - When we receive the 'connected' message we record the time to connect and\n  //   set #connectStart to undefined.\n  // - If disconnect() is called with a defined #connectStart then we record\n  //   DID_NOT_CONNECT_VALUE and set #connectStart to undefined.\n  //\n  // TODO: this should be folded into the ConnectionManager.\n  readonly timeToConnectMs = this.#register(\n    new Gauge(MetricName.TimeToConnectMs),\n  );\n\n  // lastConnectError records the last error that occurred when connecting,\n  // if any. It is cleared when connecting successfully or when reported, so this\n  // state only gets reported if there was a failure during the reporting period and\n  // we are still not connected.\n  readonly lastConnectError = this.#register(\n    new State(\n      MetricName.LastConnectError,\n      true, // clearOnFlush\n    ),\n  );\n\n  // notConnected records the reason why the client is not currently connected.\n  // It is cleared when the client successfully connects.\n  readonly #notConnected = this.#register(new State(MetricName.NotConnected));\n\n  // The time from the call to connect() to receiving the 'connected' ws message\n  // for the current connection.  Cleared when the client is not connected.\n  // TODO: Not actually currently cleared on disconnect untill there is a\n  // connect error, or client reports disconnected and waiting for visible.\n  // Should have a value iff _notConnected has no value.\n  readonly #timeToConnectMsV2 = this.#register(\n    new Gauge(MetricName.TimeToConnectMsV2),\n  );\n\n  // lastConnectErrorV2 records the last error that occurred when connecting,\n  // if any. It is cleared when the client successfully connects or\n  // stops trying to connect due to being hidden.\n  // Should have a value iff notConnected state is NotConnectedReason.Error.\n  readonly #lastConnectErrorV2 = this.#register(\n    new State(MetricName.LastConnectErrorV2),\n  );\n\n  // The total time it took to connect across retries for the current\n  // connection.  Cleared when the client is not connected.\n  // TODO: Not actually currently cleared on disconnect until there is a\n  // connect error, or client reports disconnected and waiting for visible.\n  // See Zero.#totalToConnectStart for details of how this total is computed.\n  // Should have a value iff _notConnected has no value.\n  readonly #totalTimeToConnectMs = this.#register(\n    new Gauge(MetricName.TotalTimeToConnectMs),\n  );\n\n  #setNotConnectedReason(reason: NotConnectedReason) {\n    this.#notConnected.set(reason);\n  }\n\n  setConnected(timeToConnectMs: number, totalTimeToConnectMs: number) {\n    this.#notConnected.clear();\n    this.#lastConnectErrorV2.clear();\n    this.#timeToConnectMsV2.set(timeToConnectMs);\n    this.#totalTimeToConnectMs.set(totalTimeToConnectMs);\n  }\n\n  setDisconnectedWaitingForVisible() {\n    this.#timeToConnectMsV2.clear();\n    this.#totalTimeToConnectMs.clear();\n    this.#lastConnectErrorV2.clear();\n    let notConnectedReason: NotConnectedReason;\n    switch (this.#notConnected.get()) {\n      case 'init':\n        notConnectedReason = 'hidden_was_init';\n        break;\n      case 'error':\n        notConnectedReason = 'hidden_was_error';\n        break;\n      default:\n        notConnectedReason = 'hidden';\n        break;\n    }\n    this.#setNotConnectedReason(notConnectedReason);\n  }\n\n  setConnectError(reason: ZeroError) {\n    this.#timeToConnectMsV2.clear();\n    this.#totalTimeToConnectMs.clear();\n    this.#setNotConnectedReason('error');\n    this.#lastConnectErrorV2.set(getLastConnectErrorValue(reason));\n  }\n\n  /**\n   * Tags to include in all metrics.\n   */\n  readonly tags: string[] = [];\n\n  // Flushes all metrics to an array of time series (plural), one Series\n  // per metric.\n  async flush() {\n    const lc = this.#lc;\n    if (this.#timerID === null) {\n      lc.error?.('MetricManager.flush() called but already stopped');\n      return;\n    }\n    const allSeries: Series[] = [];\n    for (const metric of this.#metrics) {\n      const series = metric.flush();\n      if (series !== undefined) {\n        allSeries.push({\n          ...series,\n          host: this.#host,\n          tags: this.tags,\n        });\n      }\n    }\n    if (allSeries.length === 0) {\n      lc?.debug?.('No metrics to report');\n      return;\n    }\n    try {\n      await this.#reporter(allSeries);\n    } catch (e) {\n      lc?.error?.('Error reporting metrics', e);\n    }\n  }\n\n  stop() {\n    if (this.#timerID === null) {\n      this.#lc.error?.('MetricManager.stop() called but already stopped');\n      return;\n    }\n    clearInterval(this.#timerID);\n    this.#timerID = null;\n  }\n\n  #register<M extends Flushable>(metric: M) {\n    this.#metrics.push(metric);\n    return metric;\n  }\n}\n\n// These two types are influenced by Datadog's API's needs. We could change what\n// we use internally if necessary, but we'd just have to convert to/from before\n// sending to DD. So for convenience we go with their format.\n\n/** Series is a time series of points for a single metric. */\nexport type Series = {\n  host: string;\n  metric: string; // We call this 'name' bc 'metric' is overloaded in code.\n  points: Point[];\n  tags?: string[];\n};\n/**\n * A point is a second-resolution timestamp and a set of values for that\n * timestamp. A point represents exactly one second in time and the values\n * are those recorded for that second. The first element of this array\n * is the timestamp and the second element is an array of values.\n */\nexport type Point = [number, number[]];\n\nfunction makePoint(ts: number, value: number): Point {\n  return [ts, [value]];\n}\n\ntype Flushable = {\n  flush(): Pick<Series, 'metric' | 'points'> | undefined;\n};\n\n/**\n * Gauge is a metric type that represents a single value that can go up and\n * down. It's typically used to track discrete values or counts eg the number\n * of active users, number of connections, cpu load, etc. A gauge retains\n * its value when flushed.\n *\n * We use a Gauge to sample at the client. If we are interested in tracking\n * a metric value *per client*, the client can note the latest value in\n * a Gauge metric. The metric is periodically reported via Reporter. On the\n * server, we graph the value of the metric rolled up over the periodic\n * reporting period, that is, counted over a span of time equal to the\n * reporting period. The result is ~one point per client per reporting\n * period.\n */\nexport class Gauge implements Flushable {\n  readonly #name: string;\n  #value: number | undefined = undefined;\n\n  constructor(name: string) {\n    this.#name = name;\n  }\n\n  set(value: number) {\n    this.#value = value;\n  }\n\n  get() {\n    return this.#value;\n  }\n\n  clear() {\n    this.#value = undefined;\n  }\n\n  flush() {\n    if (this.#value === undefined) {\n      return undefined;\n    }\n    // Gauge reports the timestamp at flush time, not at the point the value was\n    // recorded.\n    const points = [makePoint(t(), this.#value)];\n    return {metric: this.#name, points};\n  }\n}\n\nfunction t() {\n  return Math.round(Date.now() / 1000);\n}\n\n/**\n * State is a metric type that represents a specific state that the system is\n * in, for example the state of a connection which may be 'open' or 'closed'.\n * The state is given a name/prefix at construction time (eg 'connection') and\n * then can be set to a specific state (eg 'open'). The prefix is prepended to\n * the set state (eg, 'connection_open') and a value of 1 is reported.\n * Unset/cleared states are not reported.\n *\n * Example:\n *   const s = new State('connection');\n *   s.set('open');\n *   s.flush(); // returns {metric: 'connection_open', points: [[now(), [1]]]}\n */\nexport class State implements Flushable {\n  readonly #prefix: string;\n  readonly #clearOnFlush: boolean;\n  #current: string | undefined = undefined;\n\n  constructor(prefix: string, clearOnFlush = false) {\n    this.#prefix = prefix;\n    this.#clearOnFlush = clearOnFlush;\n  }\n\n  set(state: string) {\n    this.#current = state;\n  }\n\n  get() {\n    return this.#current;\n  }\n\n  clear() {\n    this.#current = undefined;\n  }\n\n  flush() {\n    if (this.#current === undefined) {\n      return undefined;\n    }\n    const gauge = new Gauge([this.#prefix, this.#current].join('_'));\n    gauge.set(1);\n    const series = gauge.flush();\n    if (this.#clearOnFlush) {\n      this.clear();\n    }\n    return series;\n  }\n}\n"],"names":["ClientErrorKind.Hidden","ClientErrorKind.ClientClosed","ClientErrorKind.UserDisconnect","ClientErrorKind.CleanClose","ClientErrorKind.AbruptClose","MetricName.TimeToConnectMs","MetricName.LastConnectError","MetricName.NotConnected","MetricName.TimeToConnectMsV2","MetricName.LastConnectErrorV2","MetricName.TotalTimeToConnectMs"],"mappings":";;;AAeO,MAAM,wBAAwB,MAAM;AAEpC,MAAM,qBAAqB;AAS3B,SAAS,yBAAyB,QAAmB;AAC1D,SAAO,GAAG,cAAc,MAAM,IAAI,YAAY,SAAS,GAAG,aAAa,OAAO,IAAI,CAAC;AACrF;AAKA,SAAS,aAAa,MAA6B;AACjD,SAAO,KACJ,MAAM,cAAc,EACpB,KAAK,GAAG,EACR,YAAA;AACL;AAUO,SAAS,yBAAyB,QAA4B;AACnE,MAAI,CAAC,cAAc,MAAM,GAAG;AAC1B,WAAO;AAAA,EACT;AACA,UAAQ,OAAO,MAAA;AAAA,IACb,KAAKA;AAAAA,IACL,KAAKC;AAAAA,IACL,KAAKC;AAAAA,IACL,KAAKC;AAAAA,IACL,KAAKC;AACH,aAAO;AAAA,IACT;AACE,aAAO;AAAA,EAAA;AAEb;AAgBO,MAAM,cAAc;AAAA,EACzB;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EAEA,YAAY,MAA4B;AACtC,SAAK,oBAAoB,KAAK;AAC9B,SAAK,QAAQ,KAAK;AAClB,SAAK,YAAY,KAAK;AACtB,SAAK,MAAM,KAAK;AAEhB,SAAK,KAAK,KAAK,UAAU,KAAK,MAAM,EAAE;AAEtC,SAAK,gBAAgB,IAAI,qBAAqB;AAC9C,SAAK,uBAAuB,MAAM;AAElC,SAAK,WAAW,YAAY,MAAM;AAChC,WAAK,KAAK,MAAA;AAAA,IACZ,GAAG,KAAK,iBAAiB;AAAA,EAC3B;AAAA,EAEA,WAAwB,CAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAiBf,kBAAkB,KAAK;AAAA,IAC9B,IAAI,MAAMC,eAA0B;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAO7B,mBAAmB,KAAK;AAAA,IAC/B,IAAI;AAAA,MACFC;AAAAA,MACA;AAAA;AAAA,IAAA;AAAA,EACF;AAAA;AAAA;AAAA,EAKO,gBAAgB,KAAK,UAAU,IAAI,MAAMC,YAAuB,CAAC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOjE,qBAAqB,KAAK;AAAA,IACjC,IAAI,MAAMC,iBAA4B;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAO/B,sBAAsB,KAAK;AAAA,IAClC,IAAI,MAAMC,kBAA6B;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAShC,wBAAwB,KAAK;AAAA,IACpC,IAAI,MAAMC,oBAA+B;AAAA,EAAA;AAAA,EAG3C,uBAAuB,QAA4B;AACjD,SAAK,cAAc,IAAI,MAAM;AAAA,EAC/B;AAAA,EAEA,aAAa,iBAAyB,sBAA8B;AAClE,SAAK,cAAc,MAAA;AACnB,SAAK,oBAAoB,MAAA;AACzB,SAAK,mBAAmB,IAAI,eAAe;AAC3C,SAAK,sBAAsB,IAAI,oBAAoB;AAAA,EACrD;AAAA,EAEA,mCAAmC;AACjC,SAAK,mBAAmB,MAAA;AACxB,SAAK,sBAAsB,MAAA;AAC3B,SAAK,oBAAoB,MAAA;AACzB,QAAI;AACJ,YAAQ,KAAK,cAAc,IAAA,GAAI;AAAA,MAC7B,KAAK;AACH,6BAAqB;AACrB;AAAA,MACF,KAAK;AACH,6BAAqB;AACrB;AAAA,MACF;AACE,6BAAqB;AACrB;AAAA,IAAA;AAEJ,SAAK,uBAAuB,kBAAkB;AAAA,EAChD;AAAA,EAEA,gBAAgB,QAAmB;AACjC,SAAK,mBAAmB,MAAA;AACxB,SAAK,sBAAsB,MAAA;AAC3B,SAAK,uBAAuB,OAAO;AACnC,SAAK,oBAAoB,IAAI,yBAAyB,MAAM,CAAC;AAAA,EAC/D;AAAA;AAAA;AAAA;AAAA,EAKS,OAAiB,CAAA;AAAA;AAAA;AAAA,EAI1B,MAAM,QAAQ;AACZ,UAAM,KAAK,KAAK;AAChB,QAAI,KAAK,aAAa,MAAM;AAC1B,SAAG,QAAQ,kDAAkD;AAC7D;AAAA,IACF;AACA,UAAM,YAAsB,CAAA;AAC5B,eAAW,UAAU,KAAK,UAAU;AAClC,YAAM,SAAS,OAAO,MAAA;AACtB,UAAI,WAAW,QAAW;AACxB,kBAAU,KAAK;AAAA,UACb,GAAG;AAAA,UACH,MAAM,KAAK;AAAA,UACX,MAAM,KAAK;AAAA,QAAA,CACZ;AAAA,MACH;AAAA,IACF;AACA,QAAI,UAAU,WAAW,GAAG;AAC1B,UAAI,QAAQ,sBAAsB;AAClC;AAAA,IACF;AACA,QAAI;AACF,YAAM,KAAK,UAAU,SAAS;AAAA,IAChC,SAAS,GAAG;AACV,UAAI,QAAQ,2BAA2B,CAAC;AAAA,IAC1C;AAAA,EACF;AAAA,EAEA,OAAO;AACL,QAAI,KAAK,aAAa,MAAM;AAC1B,WAAK,IAAI,QAAQ,iDAAiD;AAClE;AAAA,IACF;AACA,kBAAc,KAAK,QAAQ;AAC3B,SAAK,WAAW;AAAA,EAClB;AAAA,EAEA,UAA+B,QAAW;AACxC,SAAK,SAAS,KAAK,MAAM;AACzB,WAAO;AAAA,EACT;AACF;AAqBA,SAAS,UAAU,IAAY,OAAsB;AACnD,SAAO,CAAC,IAAI,CAAC,KAAK,CAAC;AACrB;AAoBO,MAAM,MAA2B;AAAA,EAC7B;AAAA,EACT,SAA6B;AAAA,EAE7B,YAAY,MAAc;AACxB,SAAK,QAAQ;AAAA,EACf;AAAA,EAEA,IAAI,OAAe;AACjB,SAAK,SAAS;AAAA,EAChB;AAAA,EAEA,MAAM;AACJ,WAAO,KAAK;AAAA,EACd;AAAA,EAEA,QAAQ;AACN,SAAK,SAAS;AAAA,EAChB;AAAA,EAEA,QAAQ;AACN,QAAI,KAAK,WAAW,QAAW;AAC7B,aAAO;AAAA,IACT;AAGA,UAAM,SAAS,CAAC,UAAU,KAAK,KAAK,MAAM,CAAC;AAC3C,WAAO,EAAC,QAAQ,KAAK,OAAO,OAAA;AAAA,EAC9B;AACF;AAEA,SAAS,IAAI;AACX,SAAO,KAAK,MAAM,KAAK,IAAA,IAAQ,GAAI;AACrC;AAeO,MAAM,MAA2B;AAAA,EAC7B;AAAA,EACA;AAAA,EACT,WAA+B;AAAA,EAE/B,YAAY,QAAgB,eAAe,OAAO;AAChD,SAAK,UAAU;AACf,SAAK,gBAAgB;AAAA,EACvB;AAAA,EAEA,IAAI,OAAe;AACjB,SAAK,WAAW;AAAA,EAClB;AAAA,EAEA,MAAM;AACJ,WAAO,KAAK;AAAA,EACd;AAAA,EAEA,QAAQ;AACN,SAAK,WAAW;AAAA,EAClB;AAAA,EAEA,QAAQ;AACN,QAAI,KAAK,aAAa,QAAW;AAC/B,aAAO;AAAA,IACT;AACA,UAAM,QAAQ,IAAI,MAAM,CAAC,KAAK,SAAS,KAAK,QAAQ,EAAE,KAAK,GAAG,CAAC;AAC/D,UAAM,IAAI,CAAC;AACX,UAAM,SAAS,MAAM,MAAA;AACrB,QAAI,KAAK,eAAe;AACtB,WAAK,MAAA;AAAA,IACP;AACA,WAAO;AAAA,EACT;AACF;"}

package/out/zero-client/src/client/mutation-tracker.d.ts

@@ -1,22 +1,29 @@
-import type { EphemeralID, MutationTrackingData } from '../../../replicache/src/replicache-options.ts';
+import type { LogContext } from '@rocicorp/logger';
 import type { ReplicacheImpl } from '../../../replicache/src/impl.ts';
+import type { EphemeralID, MutationTrackingData } from '../../../replicache/src/replicache-options.ts';
 import { type MutationID, type PushResponseBody } from '../../../zero-protocol/src/push.ts';
+import type { MutatorResultSuccessDetails } from './custom.ts';
 import { type ZeroError } from './error.ts';
-import type { ZeroLogContext } from './zero-log-context.ts';
+type MutationSuccessType = MutatorResultSuccessDetails;
 /**
  * Tracks what pushes are in-flight and resolves promises when they're acked.
  */
 export declare class MutationTracker {
     #private;
-    constructor(lc: ZeroLogContext, ackMutations: (upTo: MutationID) => void, onFatalError: (error: ZeroError) => void);
+    constructor(lc: LogContext, ackMutations: (upTo: MutationID) => void, onFatalError: (error: ZeroError) => void);
     setClientIDAndWatch(clientID: string, experimentalWatch: ReplicacheImpl['experimentalWatch']): void;
-    trackMutation(): MutationTrackingData;
+    trackMutation(): MutationTrackingData<MutationSuccessType>;
     mutationIDAssigned(id: EphemeralID, mutationID: number): void;
     /**
      * Reject the mutation due to an unhandled exception on the client.
      * The mutation must not have been persisted to the client store.
      */
     rejectMutation(id: EphemeralID, e: unknown): void;
+    /**
+     * Reject all outstanding mutations. Called when the client is in a state
+     * that prevents mutations from being applied, such as offline or closed.
+     */
+    rejectAllOutstandingMutations(error: ZeroError): void;
     processPushResponse(response: PushResponseBody): void;
     /**
      * DEPRECATED: to be removed when we switch to fully driving
@@ -61,4 +68,5 @@ export declare class MutationTracker {
      */
     onAllMutationsApplied(listener: () => void): void;
 }
+export {};
 //# sourceMappingURL=mutation-tracker.d.ts.map

package/out/zero-client/src/client/mutation-tracker.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"mutation-tracker.d.ts","sourceRoot":"","sources":["../../../../../zero-client/src/client/mutation-tracker.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EACV,WAAW,EACX,oBAAoB,EACrB,MAAM,+CAA+C,CAAC;AACvD,OAAO,KAAK,EAAC,cAAc,EAAC,MAAM,iCAAiC,CAAC;AAOpE,OAAO,EAGL,KAAK,UAAU,EAIf,KAAK,gBAAgB,EACtB,MAAM,oCAAoC,CAAC;AAC5C,OAAO,EAAC,KAAK,SAAS,EAAC,MAAM,YAAY,CAAC;AAE1C,OAAO,KAAK,EAAC,cAAc,EAAC,MAAM,uBAAuB,CAAC;AAoB1D;;GAEG;AACH,qBAAa,eAAe;;gBAmBxB,EAAE,EAAE,cAAc,EAClB,YAAY,EAAE,CAAC,IAAI,EAAE,UAAU,KAAK,IAAI,EACxC,YAAY,EAAE,CAAC,KAAK,EAAE,SAAS,KAAK,IAAI;IAY1C,mBAAmB,CACjB,QAAQ,EAAE,MAAM,EAChB,iBAAiB,EAAE,cAAc,CAAC,mBAAmB,CAAC;IAexD,aAAa,IAAI,oBAAoB;IAUrC,kBAAkB,CAAC,EAAE,EAAE,WAAW,EAAE,UAAU,EAAE,MAAM,GAAG,IAAI;IAY7D;;;OAGG;IACH,cAAc,CAAC,EAAE,EAAE,WAAW,EAAE,CAAC,EAAE,OAAO,GAAG,IAAI;IA+CjD,mBAAmB,CAAC,QAAQ,EAAE,gBAAgB,GAAG,IAAI;IAuDrD;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,WAAW,CAAC,cAAc,EAAE,MAAM;IAIlC;;;;;;OAMG;IACH,YAAY,CAAC,cAAc,EAAE,MAAM,GAAG,IAAI;IAoB1C,IAAI,IAAI,WAEP;IAuID;;;;;;;;;OASG;IACH,qBAAqB,CAAC,QAAQ,EAAE,MAAM,IAAI,GAAG,IAAI;CASlD"}
+{"version":3,"file":"mutation-tracker.d.ts","sourceRoot":"","sources":["../../../../../zero-client/src/client/mutation-tracker.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,UAAU,EAAC,MAAM,kBAAkB,CAAC;AAGjD,OAAO,KAAK,EAAC,cAAc,EAAC,MAAM,iCAAiC,CAAC;AACpE,OAAO,KAAK,EACV,WAAW,EACX,oBAAoB,EACrB,MAAM,+CAA+C,CAAC;AAevD,OAAO,EAGL,KAAK,UAAU,EAIf,KAAK,gBAAgB,EACtB,MAAM,oCAAoC,CAAC;AAC5C,OAAO,KAAK,EAAC,2BAA2B,EAAC,MAAM,aAAa,CAAC;AAC7D,OAAO,EAAc,KAAK,SAAS,EAAC,MAAM,YAAY,CAAC;AAGvD,KAAK,mBAAmB,GAAG,2BAA2B,CAAC;AAUvD;;GAEG;AACH,qBAAa,eAAe;;gBAoBxB,EAAE,EAAE,UAAU,EACd,YAAY,EAAE,CAAC,IAAI,EAAE,UAAU,KAAK,IAAI,EACxC,YAAY,EAAE,CAAC,KAAK,EAAE,SAAS,KAAK,IAAI;IAY1C,mBAAmB,CACjB,QAAQ,EAAE,MAAM,EAChB,iBAAiB,EAAE,cAAc,CAAC,mBAAmB,CAAC;IAexD,aAAa,IAAI,oBAAoB,CAAC,mBAAmB,CAAC;IAU1D,kBAAkB,CAAC,EAAE,EAAE,WAAW,EAAE,UAAU,EAAE,MAAM,GAAG,IAAI;IAY7D;;;OAGG;IACH,cAAc,CAAC,EAAE,EAAE,WAAW,EAAE,CAAC,EAAE,OAAO,GAAG,IAAI;IAOjD;;;OAGG;IACH,6BAA6B,CAAC,KAAK,EAAE,SAAS,GAAG,IAAI;IAmDrD,mBAAmB,CAAC,QAAQ,EAAE,gBAAgB,GAAG,IAAI;IAuDrD;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,WAAW,CAAC,cAAc,EAAE,MAAM;IAIlC;;;;;;OAMG;IACH,YAAY,CAAC,cAAc,EAAE,MAAM,GAAG,IAAI;IAoB1C,IAAI,IAAI,WAEP;IAwJD;;;;;;;;;OASG;IACH,qBAAqB,CAAC,QAAQ,EAAE,MAAM,IAAI,GAAG,IAAI;CASlD"}