@rocicorp/zero 1.11.0-canary.2 → 1.11.0-canary.21

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

@@ -1,10 +1,17 @@
 import { assert } from "../../../shared/src/asserts.js";
+import { getBrowserGlobal } from "../../../shared/src/browser-env.js";
 import { Internal } from "../../../zero-protocol/src/error-kind-enum.js";
 import { MeasurePushOperator } from "../../../zql/src/query/measure-push-operator.js";
 import { QueryDelegateBase } from "../../../zql/src/query/query-delegate-base.js";
 import "./ivm-branch.js";
 //#region ../zero-client/src/client/context.ts
 /**
+* How long pipelines are hydrated for before yielding to the event loop. Short
+* enough to keep a frame or two, long enough that the yields themselves (a
+* `setTimeout(0)` is clamped to 4ms in browsers) stay in the noise.
+*/
+var HYDRATE_SLICE_MS = 12;
+/**
 * ZeroContext glues together zql and Replicache. It listens to changes in
 * Replicache data and pushes them into IVM and on tells the server about new
 * queries.
@@ -19,8 +26,10 @@ var ZeroContext = class extends QueryDelegateBase {
 	flushQueryChanges;
 	#batchViewUpdates;
 	#commitListeners = /* @__PURE__ */ new Set();
-	#pipelinesReady = true;
+	#pipelinesReady = false;
 	#pendingPipelines = /* @__PURE__ */ new Set();
+	#hydratingPipelines = false;
+	#visibilityWatcher;
 	assertValidRunOptions;
 	/**
 	* Client-side queries start out as "unknown" and are then updated to
@@ -28,7 +37,7 @@ var ZeroContext = class extends QueryDelegateBase {
 	*/
 	defaultQueryComplete = false;
 	addMetric;
-	constructor(lc, mainSources, addQuery, addCustomQuery, updateQuery, updateCustomQuery, flushQueryChanges, batchViewUpdates, addMetric, assertValidRunOptions) {
+	constructor(lc, mainSources, addQuery, addCustomQuery, updateQuery, updateCustomQuery, flushQueryChanges, batchViewUpdates, addMetric, assertValidRunOptions, visibilityWatcher) {
 		super();
 		this.#lc = lc;
 		this.#mainSources = mainSources;
@@ -40,6 +49,7 @@ var ZeroContext = class extends QueryDelegateBase {
 		this.addCustomQuery = addCustomQuery;
 		this.flushQueryChanges = flushQueryChanges;
 		this.addMetric = addMetric;
+		this.#visibilityWatcher = visibilityWatcher;
 	}
 	applyFiltersAnyway;
 	debug;
@@ -57,36 +67,92 @@ var ZeroContext = class extends QueryDelegateBase {
 		};
 	}
 	/**
-	* Stop building pipelines for materialized queries until
-	* {@link markPipelinesReady} is called. Views materialized in the meantime
-	* are empty and `unknown`, exactly as they would be over empty sources.
+	* Build and hydrate every pipeline deferred since construction, in
+	* materialization order, as a single view-update batch. Views materialized
+	* before this is called are empty and `unknown` in the meantime, exactly as
+	* they would be over empty sources. A pipeline that fails to build is
+	* logged and its view reports an error; the rest are still built.
+	*
+	* Returns `this` so it can be chained onto the constructor call.
 	*/
-	deferPipelines() {
-		this.#pipelinesReady = false;
+	markPipelinesReady() {
+		if (this.#pipelinesReady) return this;
+		assert(!this.#hydratingPipelines, "Pipelines are already being hydrated");
+		if (this.#pendingPipelines.size === 0) {
+			this.#pipelinesReady = true;
+			return this;
+		}
+		this.batchViewUpdates(() => {
+			const releases = [];
+			this.#attachPending(releases, () => false);
+			this.#release(releases);
+		});
+		return this;
 	}
 	/**
-	* Build and hydrate every pipeline deferred since {@link deferPipelines},
-	* in materialization order, as a single view-update batch. A pipeline that
-	* fails to build is logged and its view reports an error; the rest are
-	* still built.
+	* Like {@link markPipelinesReady} but hydrates in time slices, yielding to
+	* the event loop in between so a burst of queries registered at startup does
+	* not monopolize the thread. It only ever yields *between* pipelines.
+	*
+	* No view is exposed until all of them are hydrated: they are released, and
+	* the commit listeners notified, in one synchronous batch at the end.
+	* Queries materialized in the meantime are still deferred and join that
+	* batch. The caller must not call {@link processChanges} until the returned
+	* promise resolves.
 	*/
-	markPipelinesReady() {
+	async hydratePendingPipelines(sliceMs = HYDRATE_SLICE_MS, yieldToEventLoop = this.#yieldToEventLoop) {
 		if (this.#pipelinesReady) return;
-		this.#pipelinesReady = true;
-		if (this.#pendingPipelines.size === 0) return;
-		const pending = [...this.#pendingPipelines];
-		this.#pendingPipelines.clear();
-		this.batchViewUpdates(() => {
+		assert(!this.#hydratingPipelines, "Pipelines are already being hydrated");
+		if (this.#pendingPipelines.size === 0) {
+			this.#pipelinesReady = true;
+			return;
+		}
+		this.#hydratingPipelines = true;
+		const releases = [];
+		for (;;) {
+			const sliceEnd = performance.now() + sliceMs;
+			this.batchViewUpdates(() => {
+				this.#attachPending(releases, () => performance.now() >= sliceEnd);
+			});
+			if (this.#pendingPipelines.size === 0) break;
+			await yieldToEventLoop();
+		}
+		this.#hydratingPipelines = false;
+		this.batchViewUpdates(() => this.#release(releases));
+	}
+	#yieldToEventLoop = () => {
+		const scheduler = getBrowserGlobal("scheduler");
+		if (typeof scheduler?.yield === "function") return scheduler.yield();
+		if (this.#visibilityWatcher?.visibilityState === "hidden") return Promise.resolve();
+		return new Promise((resolve) => setTimeout(resolve, 0));
+	};
+	/**
+	* Attaches pending pipelines, always at least one, until none are left or
+	* `shouldStop` says the slice is over.
+	*/
+	#attachPending(releases, shouldStop) {
+		for (const attach of this.#pendingPipelines) {
+			this.#pendingPipelines.delete(attach);
 			try {
-				for (const attach of pending) try {
-					attach();
-				} catch (e) {
-					this.#lc.error?.(Internal, "Failed to build a deferred query pipeline", e);
-				}
-			} finally {
-				this.#endTransaction();
+				releases.push(attach());
+			} catch (e) {
+				this.#lc.error?.(Internal, "Failed to build a deferred query pipeline", e);
 			}
-		});
+			if (shouldStop()) return;
+		}
+	}
+	/** Must be called inside `batchViewUpdates`. */
+	#release(releases) {
+		this.#pipelinesReady = true;
+		try {
+			for (const release of releases) try {
+				release();
+			} catch (e) {
+				this.#lc.error?.(Internal, "Failed to release a deferred query pipeline", e);
+			}
+		} finally {
+			this.#endTransaction();
+		}
 	}
 	mapAst(ast) {
 		return ast;
@@ -111,6 +177,7 @@ var ZeroContext = class extends QueryDelegateBase {
 		return result;
 	}
 	processChanges(expectedHead, newHead, changes) {
+		assert(!this.#hydratingPipelines, "processChanges called while pipelines are being hydrated");
 		this.batchViewUpdates(() => {
 			try {
 				this.#mainSources.advance(expectedHead, newHead, changes);

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

@@ -1 +1 @@
-{"version":3,"file":"context.js","names":["#lc","#mainSources","#batchViewUpdates","#commitListeners","#pendingPipelines","#pipelinesReady","#endTransaction"],"sources":["../../../../../zero-client/src/client/context.ts"],"sourcesContent":["import type {LogContext} from '@rocicorp/logger';\nimport type {NoIndexDiff} from '../../../replicache/src/btree/node.ts';\nimport type {Hash} from '../../../replicache/src/hash.ts';\nimport {assert} from '../../../shared/src/asserts.ts';\nimport type {AST} from '../../../zero-protocol/src/ast.ts';\nimport {ErrorKind} from '../../../zero-protocol/src/error-kind.ts';\nimport type {DebugDelegate} from '../../../zql/src/builder/debug-delegate.ts';\nimport type {Input} from '../../../zql/src/ivm/operator.ts';\nimport type {Source, SourceInput} from '../../../zql/src/ivm/source.ts';\nimport {MeasurePushOperator} from '../../../zql/src/query/measure-push-operator.ts';\nimport type {MetricsDelegate} from '../../../zql/src/query/metrics-delegate.ts';\nimport {QueryDelegateBase} from '../../../zql/src/query/query-delegate-base.ts';\nimport type {CommitListener} from '../../../zql/src/query/query-delegate.ts';\nimport type {RunOptions} from '../../../zql/src/query/query.ts';\nimport {type IVMSourceBranch} from './ivm-branch.ts';\nimport type {QueryManager} from './query-manager.ts';\n\nexport type AddQuery = QueryManager['addLegacy'];\nexport type AddCustomQuery = QueryManager['addCustom'];\n\nexport type UpdateQuery = QueryManager['updateLegacy'];\nexport type UpdateCustomQuery = QueryManager['updateCustom'];\nexport type FlushQueryChanges = QueryManager['flushBatch'];\n\n/**\n * ZeroContext glues together zql and Replicache. It listens to changes in\n * Replicache data and pushes them into IVM and on tells the server about new\n * queries.\n */\nexport class ZeroContext extends QueryDelegateBase {\n  readonly #lc: LogContext;\n\n  // It is a bummer to have to maintain separate MemorySources here and copy the\n  // data in from the Replicache db. But we want the data to be accessible via\n  // pipelines *synchronously* and the core Replicache infra is all async. So\n  // that needs to be fixed.\n  readonly #mainSources: IVMSourceBranch;\n\n  readonly addServerQuery: AddQuery;\n  readonly addCustomQuery: AddCustomQuery;\n  readonly updateServerQuery: UpdateQuery;\n  readonly updateCustomQuery: UpdateCustomQuery;\n  readonly flushQueryChanges: () => void;\n  readonly #batchViewUpdates: (applyViewUpdates: () => void) => void;\n  readonly #commitListeners: Set<CommitListener> = new Set();\n\n  // Pipeline construction is deferred between `deferPipelines()` and\n  // `markPipelinesReady()`. Zero calls the former at construction and the\n  // latter once the replica has been loaded into the IVM sources, so cold\n  // boot loads the sources once instead of pushing every row through every\n  // already-materialized pipeline.\n  #pipelinesReady = true;\n  readonly #pendingPipelines: Set<() => void> = new Set();\n\n  readonly assertValidRunOptions: (options?: RunOptions) => void;\n\n  /**\n   * Client-side queries start out as \"unknown\" and are then updated to\n   * \"complete\" once the server has sent back the query result.\n   */\n  readonly defaultQueryComplete = false;\n\n  readonly addMetric: MetricsDelegate['addMetric'];\n\n  constructor(\n    lc: LogContext,\n    mainSources: IVMSourceBranch,\n    addQuery: AddQuery,\n    addCustomQuery: AddCustomQuery,\n    updateQuery: UpdateQuery,\n    updateCustomQuery: UpdateCustomQuery,\n    flushQueryChanges: () => void,\n    batchViewUpdates: (applyViewUpdates: () => void) => void,\n    addMetric: MetricsDelegate['addMetric'],\n    assertValidRunOptions: (options?: RunOptions) => void,\n  ) {\n    super();\n    this.#lc = lc;\n    this.#mainSources = mainSources;\n    this.addServerQuery = addQuery;\n    this.updateServerQuery = updateQuery;\n    this.updateCustomQuery = updateCustomQuery;\n    this.#batchViewUpdates = batchViewUpdates;\n    this.assertValidRunOptions = assertValidRunOptions;\n    this.addCustomQuery = addCustomQuery;\n    this.flushQueryChanges = flushQueryChanges;\n    this.addMetric = addMetric;\n  }\n\n  applyFiltersAnyway?: boolean | undefined;\n\n  debug?: DebugDelegate | undefined;\n\n  getSource(name: string): Source | undefined {\n    return this.#mainSources.getSource(name);\n  }\n\n  override get pipelinesReady(): boolean {\n    return this.#pipelinesReady;\n  }\n\n  override onPipelinesReady(cb: () => void): () => void {\n    assert(\n      !this.#pipelinesReady,\n      'onPipelinesReady called while pipelines are ready',\n    );\n    this.#pendingPipelines.add(cb);\n    return () => {\n      this.#pendingPipelines.delete(cb);\n    };\n  }\n\n  /**\n   * Stop building pipelines for materialized queries until\n   * {@link markPipelinesReady} is called. Views materialized in the meantime\n   * are empty and `unknown`, exactly as they would be over empty sources.\n   */\n  deferPipelines(): void {\n    this.#pipelinesReady = false;\n  }\n\n  /**\n   * Build and hydrate every pipeline deferred since {@link deferPipelines},\n   * in materialization order, as a single view-update batch. A pipeline that\n   * fails to build is logged and its view reports an error; the rest are\n   * still built.\n   */\n  markPipelinesReady(): void {\n    if (this.#pipelinesReady) {\n      return;\n    }\n    this.#pipelinesReady = true;\n    if (this.#pendingPipelines.size === 0) {\n      return;\n    }\n    const pending = [...this.#pendingPipelines];\n    this.#pendingPipelines.clear();\n    this.batchViewUpdates(() => {\n      try {\n        for (const attach of pending) {\n          try {\n            attach();\n          } catch (e) {\n            // The failing view has already been marked as errored; keep\n            // building the others rather than aborting startup.\n            this.#lc.error?.(\n              ErrorKind.Internal,\n              'Failed to build a deferred query pipeline',\n              e,\n            );\n          }\n        }\n      } finally {\n        this.#endTransaction();\n      }\n    });\n  }\n\n  mapAst(ast: AST): AST {\n    return ast;\n  }\n\n  override decorateSourceInput(input: SourceInput, queryID: string): Input {\n    return new MeasurePushOperator(input, queryID, this, 'query-update-client');\n  }\n\n  onTransactionCommit(cb: CommitListener): () => void {\n    this.#commitListeners.add(cb);\n    return () => {\n      this.#commitListeners.delete(cb);\n    };\n  }\n\n  override batchViewUpdates<T>(applyViewUpdates: () => T) {\n    let result: T | undefined;\n    let viewChangesPerformed = false;\n    this.#batchViewUpdates(() => {\n      result = applyViewUpdates();\n      viewChangesPerformed = true;\n    });\n    assert(\n      viewChangesPerformed,\n      'batchViewUpdates must call applyViewUpdates synchronously.',\n    );\n    return result as T;\n  }\n\n  processChanges(\n    expectedHead: Hash | undefined,\n    newHead: Hash,\n    changes: NoIndexDiff,\n  ) {\n    this.batchViewUpdates(() => {\n      try {\n        this.#mainSources.advance(expectedHead, newHead, changes);\n      } finally {\n        this.#endTransaction();\n      }\n    });\n  }\n\n  #endTransaction() {\n    for (const listener of this.#commitListeners) {\n      try {\n        listener();\n      } catch (e) {\n        // We should not fatal the inner-workings of Zero due to the user's application\n        // code throwing an error.\n        // Hence we wrap notifications in a try-catch block.\n        this.#lc.error?.(\n          ErrorKind.Internal,\n          'Failed notifying a commit listener of IVM updates',\n          e,\n        );\n      }\n    }\n  }\n}\n"],"mappings":";;;;;;;;;;;AA6BA,IAAa,cAAb,cAAiC,kBAAkB;CACjD;CAMA;CAEA;CACA;CACA;CACA;CACA;CACA;CACA,mCAAiD,IAAI,IAAI;CAOzD,kBAAkB;CAClB,oCAA8C,IAAI,IAAI;CAEtD;;;;;CAMA,uBAAgC;CAEhC;CAEA,YACE,IACA,aACA,UACA,gBACA,aACA,mBACA,mBACA,kBACA,WACA,uBACA;EACA,MAAM;EACN,KAAKA,MAAM;EACX,KAAKC,eAAe;EACpB,KAAK,iBAAiB;EACtB,KAAK,oBAAoB;EACzB,KAAK,oBAAoB;EACzB,KAAKC,oBAAoB;EACzB,KAAK,wBAAwB;EAC7B,KAAK,iBAAiB;EACtB,KAAK,oBAAoB;EACzB,KAAK,YAAY;CACnB;CAEA;CAEA;CAEA,UAAU,MAAkC;EAC1C,OAAO,KAAKD,aAAa,UAAU,IAAI;CACzC;CAEA,IAAa,iBAA0B;EACrC,OAAO,KAAKI;CACd;CAEA,iBAA0B,IAA4B;EACpD,OACE,CAAC,KAAKA,iBACN,mDACF;EACA,KAAKD,kBAAkB,IAAI,EAAE;EAC7B,aAAa;GACX,KAAKA,kBAAkB,OAAO,EAAE;EAClC;CACF;;;;;;CAOA,iBAAuB;EACrB,KAAKC,kBAAkB;CACzB;;;;;;;CAQA,qBAA2B;EACzB,IAAI,KAAKA,iBACP;EAEF,KAAKA,kBAAkB;EACvB,IAAI,KAAKD,kBAAkB,SAAS,GAClC;EAEF,MAAM,UAAU,CAAC,GAAG,KAAKA,iBAAiB;EAC1C,KAAKA,kBAAkB,MAAM;EAC7B,KAAK,uBAAuB;GAC1B,IAAI;IACF,KAAK,MAAM,UAAU,SACnB,IAAI;KACF,OAAO;IACT,SAAS,GAAG;KAGV,KAAKJ,IAAI,QACP,UACA,6CACA,CACF;IACF;GAEJ,UAAU;IACR,KAAKM,gBAAgB;GACvB;EACF,CAAC;CACH;CAEA,OAAO,KAAe;EACpB,OAAO;CACT;CAEA,oBAA6B,OAAoB,SAAwB;EACvE,OAAO,IAAI,oBAAoB,OAAO,SAAS,MAAM,qBAAqB;CAC5E;CAEA,oBAAoB,IAAgC;EAClD,KAAKH,iBAAiB,IAAI,EAAE;EAC5B,aAAa;GACX,KAAKA,iBAAiB,OAAO,EAAE;EACjC;CACF;CAEA,iBAA6B,kBAA2B;EACtD,IAAI;EACJ,IAAI,uBAAuB;EAC3B,KAAKD,wBAAwB;GAC3B,SAAS,iBAAiB;GAC1B,uBAAuB;EACzB,CAAC;EACD,OACE,sBACA,4DACF;EACA,OAAO;CACT;CAEA,eACE,cACA,SACA,SACA;EACA,KAAK,uBAAuB;GAC1B,IAAI;IACF,KAAKD,aAAa,QAAQ,cAAc,SAAS,OAAO;GAC1D,UAAU;IACR,KAAKK,gBAAgB;GACvB;EACF,CAAC;CACH;CAEA,kBAAkB;EAChB,KAAK,MAAM,YAAY,KAAKH,kBAC1B,IAAI;GACF,SAAS;EACX,SAAS,GAAG;GAIV,KAAKH,IAAI,QACP,UACA,qDACA,CACF;EACF;CAEJ;AACF"}
+{"version":3,"file":"context.js","names":["#lc","#mainSources","#batchViewUpdates","#commitListeners","#pendingPipelines","#visibilityWatcher","#pipelinesReady","#hydratingPipelines","#attachPending","#release","#yieldToEventLoop","#endTransaction"],"sources":["../../../../../zero-client/src/client/context.ts"],"sourcesContent":["import type {LogContext} from '@rocicorp/logger';\nimport type {NoIndexDiff} from '../../../replicache/src/btree/node.ts';\nimport type {Hash} from '../../../replicache/src/hash.ts';\nimport {assert} from '../../../shared/src/asserts.ts';\nimport {getBrowserGlobal} from '../../../shared/src/browser-env.ts';\nimport type {DocumentVisibilityWatcher} from '../../../shared/src/document-visible.ts';\nimport type {AST} from '../../../zero-protocol/src/ast.ts';\nimport {ErrorKind} from '../../../zero-protocol/src/error-kind.ts';\nimport type {DebugDelegate} from '../../../zql/src/builder/debug-delegate.ts';\nimport type {Input} from '../../../zql/src/ivm/operator.ts';\nimport type {Source, SourceInput} from '../../../zql/src/ivm/source.ts';\nimport {MeasurePushOperator} from '../../../zql/src/query/measure-push-operator.ts';\nimport type {MetricsDelegate} from '../../../zql/src/query/metrics-delegate.ts';\nimport {QueryDelegateBase} from '../../../zql/src/query/query-delegate-base.ts';\nimport type {\n  AttachPipeline,\n  CommitListener,\n} from '../../../zql/src/query/query-delegate.ts';\nimport type {RunOptions} from '../../../zql/src/query/query.ts';\nimport {type IVMSourceBranch} from './ivm-branch.ts';\nimport type {QueryManager} from './query-manager.ts';\n\nexport type AddQuery = QueryManager['addLegacy'];\nexport type AddCustomQuery = QueryManager['addCustom'];\n\nexport type UpdateQuery = QueryManager['updateLegacy'];\nexport type UpdateCustomQuery = QueryManager['updateCustom'];\nexport type FlushQueryChanges = QueryManager['flushBatch'];\n\n/**\n * How long pipelines are hydrated for before yielding to the event loop. Short\n * enough to keep a frame or two, long enough that the yields themselves (a\n * `setTimeout(0)` is clamped to 4ms in browsers) stay in the noise.\n */\nconst HYDRATE_SLICE_MS = 12;\n\n/**\n * ZeroContext glues together zql and Replicache. It listens to changes in\n * Replicache data and pushes them into IVM and on tells the server about new\n * queries.\n */\nexport class ZeroContext extends QueryDelegateBase {\n  readonly #lc: LogContext;\n\n  // It is a bummer to have to maintain separate MemorySources here and copy the\n  // data in from the Replicache db. But we want the data to be accessible via\n  // pipelines *synchronously* and the core Replicache infra is all async. So\n  // that needs to be fixed.\n  readonly #mainSources: IVMSourceBranch;\n\n  readonly addServerQuery: AddQuery;\n  readonly addCustomQuery: AddCustomQuery;\n  readonly updateServerQuery: UpdateQuery;\n  readonly updateCustomQuery: UpdateCustomQuery;\n  readonly flushQueryChanges: () => void;\n  readonly #batchViewUpdates: (applyViewUpdates: () => void) => void;\n  readonly #commitListeners: Set<CommitListener> = new Set();\n\n  // Pipeline construction is deferred until `markPipelinesReady()` is called.\n  // Zero calls it once the replica has been loaded into the IVM sources, so\n  // cold boot loads the sources once instead of pushing every row through\n  // every already-materialized pipeline. Contexts whose sources are already\n  // populated at construction (custom mutator transactions, tests) call it\n  // right away.\n  #pipelinesReady = false;\n  readonly #pendingPipelines: Set<AttachPipeline> = new Set();\n  #hydratingPipelines = false;\n  readonly #visibilityWatcher: DocumentVisibilityWatcher | undefined;\n\n  readonly assertValidRunOptions: (options?: RunOptions) => void;\n\n  /**\n   * Client-side queries start out as \"unknown\" and are then updated to\n   * \"complete\" once the server has sent back the query result.\n   */\n  readonly defaultQueryComplete = false;\n\n  readonly addMetric: MetricsDelegate['addMetric'];\n\n  constructor(\n    lc: LogContext,\n    mainSources: IVMSourceBranch,\n    addQuery: AddQuery,\n    addCustomQuery: AddCustomQuery,\n    updateQuery: UpdateQuery,\n    updateCustomQuery: UpdateCustomQuery,\n    flushQueryChanges: () => void,\n    batchViewUpdates: (applyViewUpdates: () => void) => void,\n    addMetric: MetricsDelegate['addMetric'],\n    assertValidRunOptions: (options?: RunOptions) => void,\n    visibilityWatcher?: DocumentVisibilityWatcher | undefined,\n  ) {\n    super();\n    this.#lc = lc;\n    this.#mainSources = mainSources;\n    this.addServerQuery = addQuery;\n    this.updateServerQuery = updateQuery;\n    this.updateCustomQuery = updateCustomQuery;\n    this.#batchViewUpdates = batchViewUpdates;\n    this.assertValidRunOptions = assertValidRunOptions;\n    this.addCustomQuery = addCustomQuery;\n    this.flushQueryChanges = flushQueryChanges;\n    this.addMetric = addMetric;\n    this.#visibilityWatcher = visibilityWatcher;\n  }\n\n  applyFiltersAnyway?: boolean | undefined;\n\n  debug?: DebugDelegate | undefined;\n\n  getSource(name: string): Source | undefined {\n    return this.#mainSources.getSource(name);\n  }\n\n  override get pipelinesReady(): boolean {\n    return this.#pipelinesReady;\n  }\n\n  override onPipelinesReady(cb: AttachPipeline): () => void {\n    assert(\n      !this.#pipelinesReady,\n      'onPipelinesReady called while pipelines are ready',\n    );\n    this.#pendingPipelines.add(cb);\n    return () => {\n      this.#pendingPipelines.delete(cb);\n    };\n  }\n\n  /**\n   * Build and hydrate every pipeline deferred since construction, in\n   * materialization order, as a single view-update batch. Views materialized\n   * before this is called are empty and `unknown` in the meantime, exactly as\n   * they would be over empty sources. A pipeline that fails to build is\n   * logged and its view reports an error; the rest are still built.\n   *\n   * Returns `this` so it can be chained onto the constructor call.\n   */\n  markPipelinesReady(): this {\n    if (this.#pipelinesReady) {\n      return this;\n    }\n    assert(!this.#hydratingPipelines, 'Pipelines are already being hydrated');\n    if (this.#pendingPipelines.size === 0) {\n      this.#pipelinesReady = true;\n      return this;\n    }\n    this.batchViewUpdates(() => {\n      const releases: (() => void)[] = [];\n      this.#attachPending(releases, () => false);\n      this.#release(releases);\n    });\n    return this;\n  }\n\n  /**\n   * Like {@link markPipelinesReady} but hydrates in time slices, yielding to\n   * the event loop in between so a burst of queries registered at startup does\n   * not monopolize the thread. It only ever yields *between* pipelines.\n   *\n   * No view is exposed until all of them are hydrated: they are released, and\n   * the commit listeners notified, in one synchronous batch at the end.\n   * Queries materialized in the meantime are still deferred and join that\n   * batch. The caller must not call {@link processChanges} until the returned\n   * promise resolves.\n   */\n  async hydratePendingPipelines(\n    sliceMs = HYDRATE_SLICE_MS,\n    yieldToEventLoop: () => Promise<void> = this.#yieldToEventLoop,\n  ): Promise<void> {\n    if (this.#pipelinesReady) {\n      return;\n    }\n    assert(!this.#hydratingPipelines, 'Pipelines are already being hydrated');\n    if (this.#pendingPipelines.size === 0) {\n      this.#pipelinesReady = true;\n      return;\n    }\n    this.#hydratingPipelines = true;\n    const releases: (() => void)[] = [];\n    for (;;) {\n      const sliceEnd = performance.now() + sliceMs;\n      this.batchViewUpdates(() => {\n        this.#attachPending(releases, () => performance.now() >= sliceEnd);\n      });\n      if (this.#pendingPipelines.size === 0) {\n        break;\n      }\n      await yieldToEventLoop();\n    }\n    this.#hydratingPipelines = false;\n    this.batchViewUpdates(() => this.#release(releases));\n  }\n\n  #yieldToEventLoop = (): Promise<void> => {\n    // Not in React Native or Safari.\n    const scheduler = getBrowserGlobal('scheduler');\n    if (typeof scheduler?.yield === 'function') {\n      return scheduler.yield();\n    }\n    // Timers are throttled to a second or more in a background tab, which would\n    // stretch startup to minutes, and a hidden page has nothing to keep\n    // responsive anyway.\n    if (this.#visibilityWatcher?.visibilityState === 'hidden') {\n      return Promise.resolve();\n    }\n    return new Promise(resolve => setTimeout(resolve, 0));\n  };\n\n  /**\n   * Attaches pending pipelines, always at least one, until none are left or\n   * `shouldStop` says the slice is over.\n   */\n  #attachPending(releases: (() => void)[], shouldStop: () => boolean) {\n    for (const attach of this.#pendingPipelines) {\n      this.#pendingPipelines.delete(attach);\n      try {\n        releases.push(attach());\n      } catch (e) {\n        // The failing view has already been marked as errored; keep\n        // building the others rather than aborting startup.\n        this.#lc.error?.(\n          ErrorKind.Internal,\n          'Failed to build a deferred query pipeline',\n          e,\n        );\n      }\n      if (shouldStop()) {\n        return;\n      }\n    }\n  }\n\n  /** Must be called inside `batchViewUpdates`. */\n  #release(releases: (() => void)[]) {\n    this.#pipelinesReady = true;\n    try {\n      for (const release of releases) {\n        try {\n          release();\n        } catch (e) {\n          // One view must not keep the rest from being released.\n          this.#lc.error?.(\n            ErrorKind.Internal,\n            'Failed to release a deferred query pipeline',\n            e,\n          );\n        }\n      }\n    } finally {\n      this.#endTransaction();\n    }\n  }\n\n  mapAst(ast: AST): AST {\n    return ast;\n  }\n\n  override decorateSourceInput(input: SourceInput, queryID: string): Input {\n    return new MeasurePushOperator(input, queryID, this, 'query-update-client');\n  }\n\n  onTransactionCommit(cb: CommitListener): () => void {\n    this.#commitListeners.add(cb);\n    return () => {\n      this.#commitListeners.delete(cb);\n    };\n  }\n\n  override batchViewUpdates<T>(applyViewUpdates: () => T) {\n    let result: T | undefined;\n    let viewChangesPerformed = false;\n    this.#batchViewUpdates(() => {\n      result = applyViewUpdates();\n      viewChangesPerformed = true;\n    });\n    assert(\n      viewChangesPerformed,\n      'batchViewUpdates must call applyViewUpdates synchronously.',\n    );\n    return result as T;\n  }\n\n  processChanges(\n    expectedHead: Hash | undefined,\n    newHead: Hash,\n    changes: NoIndexDiff,\n  ) {\n    // Views hydrated so far would flush ahead of the rest of their batch.\n    assert(\n      !this.#hydratingPipelines,\n      'processChanges called while pipelines are being hydrated',\n    );\n    this.batchViewUpdates(() => {\n      try {\n        this.#mainSources.advance(expectedHead, newHead, changes);\n      } finally {\n        this.#endTransaction();\n      }\n    });\n  }\n\n  #endTransaction() {\n    for (const listener of this.#commitListeners) {\n      try {\n        listener();\n      } catch (e) {\n        // We should not fatal the inner-workings of Zero due to the user's application\n        // code throwing an error.\n        // Hence we wrap notifications in a try-catch block.\n        this.#lc.error?.(\n          ErrorKind.Internal,\n          'Failed notifying a commit listener of IVM updates',\n          e,\n        );\n      }\n    }\n  }\n}\n"],"mappings":";;;;;;;;;;;;AAkCA,IAAM,mBAAmB;;;;;;AAOzB,IAAa,cAAb,cAAiC,kBAAkB;CACjD;CAMA;CAEA;CACA;CACA;CACA;CACA;CACA;CACA,mCAAiD,IAAI,IAAI;CAQzD,kBAAkB;CAClB,oCAAkD,IAAI,IAAI;CAC1D,sBAAsB;CACtB;CAEA;;;;;CAMA,uBAAgC;CAEhC;CAEA,YACE,IACA,aACA,UACA,gBACA,aACA,mBACA,mBACA,kBACA,WACA,uBACA,mBACA;EACA,MAAM;EACN,KAAKA,MAAM;EACX,KAAKC,eAAe;EACpB,KAAK,iBAAiB;EACtB,KAAK,oBAAoB;EACzB,KAAK,oBAAoB;EACzB,KAAKC,oBAAoB;EACzB,KAAK,wBAAwB;EAC7B,KAAK,iBAAiB;EACtB,KAAK,oBAAoB;EACzB,KAAK,YAAY;EACjB,KAAKG,qBAAqB;CAC5B;CAEA;CAEA;CAEA,UAAU,MAAkC;EAC1C,OAAO,KAAKJ,aAAa,UAAU,IAAI;CACzC;CAEA,IAAa,iBAA0B;EACrC,OAAO,KAAKK;CACd;CAEA,iBAA0B,IAAgC;EACxD,OACE,CAAC,KAAKA,iBACN,mDACF;EACA,KAAKF,kBAAkB,IAAI,EAAE;EAC7B,aAAa;GACX,KAAKA,kBAAkB,OAAO,EAAE;EAClC;CACF;;;;;;;;;;CAWA,qBAA2B;EACzB,IAAI,KAAKE,iBACP,OAAO;EAET,OAAO,CAAC,KAAKC,qBAAqB,sCAAsC;EACxE,IAAI,KAAKH,kBAAkB,SAAS,GAAG;GACrC,KAAKE,kBAAkB;GACvB,OAAO;EACT;EACA,KAAK,uBAAuB;GAC1B,MAAM,WAA2B,CAAC;GAClC,KAAKE,eAAe,gBAAgB,KAAK;GACzC,KAAKC,SAAS,QAAQ;EACxB,CAAC;EACD,OAAO;CACT;;;;;;;;;;;;CAaA,MAAM,wBACJ,UAAU,kBACV,mBAAwC,KAAKC,mBAC9B;EACf,IAAI,KAAKJ,iBACP;EAEF,OAAO,CAAC,KAAKC,qBAAqB,sCAAsC;EACxE,IAAI,KAAKH,kBAAkB,SAAS,GAAG;GACrC,KAAKE,kBAAkB;GACvB;EACF;EACA,KAAKC,sBAAsB;EAC3B,MAAM,WAA2B,CAAC;EAClC,SAAS;GACP,MAAM,WAAW,YAAY,IAAI,IAAI;GACrC,KAAK,uBAAuB;IAC1B,KAAKC,eAAe,gBAAgB,YAAY,IAAI,KAAK,QAAQ;GACnE,CAAC;GACD,IAAI,KAAKJ,kBAAkB,SAAS,GAClC;GAEF,MAAM,iBAAiB;EACzB;EACA,KAAKG,sBAAsB;EAC3B,KAAK,uBAAuB,KAAKE,SAAS,QAAQ,CAAC;CACrD;CAEA,0BAAyC;EAEvC,MAAM,YAAY,iBAAiB,WAAW;EAC9C,IAAI,OAAO,WAAW,UAAU,YAC9B,OAAO,UAAU,MAAM;EAKzB,IAAI,KAAKJ,oBAAoB,oBAAoB,UAC/C,OAAO,QAAQ,QAAQ;EAEzB,OAAO,IAAI,SAAQ,YAAW,WAAW,SAAS,CAAC,CAAC;CACtD;;;;;CAMA,eAAe,UAA0B,YAA2B;EAClE,KAAK,MAAM,UAAU,KAAKD,mBAAmB;GAC3C,KAAKA,kBAAkB,OAAO,MAAM;GACpC,IAAI;IACF,SAAS,KAAK,OAAO,CAAC;GACxB,SAAS,GAAG;IAGV,KAAKJ,IAAI,QACP,UACA,6CACA,CACF;GACF;GACA,IAAI,WAAW,GACb;EAEJ;CACF;;CAGA,SAAS,UAA0B;EACjC,KAAKM,kBAAkB;EACvB,IAAI;GACF,KAAK,MAAM,WAAW,UACpB,IAAI;IACF,QAAQ;GACV,SAAS,GAAG;IAEV,KAAKN,IAAI,QACP,UACA,+CACA,CACF;GACF;EAEJ,UAAU;GACR,KAAKW,gBAAgB;EACvB;CACF;CAEA,OAAO,KAAe;EACpB,OAAO;CACT;CAEA,oBAA6B,OAAoB,SAAwB;EACvE,OAAO,IAAI,oBAAoB,OAAO,SAAS,MAAM,qBAAqB;CAC5E;CAEA,oBAAoB,IAAgC;EAClD,KAAKR,iBAAiB,IAAI,EAAE;EAC5B,aAAa;GACX,KAAKA,iBAAiB,OAAO,EAAE;EACjC;CACF;CAEA,iBAA6B,kBAA2B;EACtD,IAAI;EACJ,IAAI,uBAAuB;EAC3B,KAAKD,wBAAwB;GAC3B,SAAS,iBAAiB;GAC1B,uBAAuB;EACzB,CAAC;EACD,OACE,sBACA,4DACF;EACA,OAAO;CACT;CAEA,eACE,cACA,SACA,SACA;EAEA,OACE,CAAC,KAAKK,qBACN,0DACF;EACA,KAAK,uBAAuB;GAC1B,IAAI;IACF,KAAKN,aAAa,QAAQ,cAAc,SAAS,OAAO;GAC1D,UAAU;IACR,KAAKU,gBAAgB;GACvB;EACF,CAAC;CACH;CAEA,kBAAkB;EAChB,KAAK,MAAM,YAAY,KAAKR,kBAC1B,IAAI;GACF,SAAS;EACX,SAAS,GAAG;GAIV,KAAKH,IAAI,QACP,UACA,qDACA,CACF;EACF;CAEJ;AACF"}

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

@@ -53,10 +53,10 @@ function makeReplicacheMutator(lc, mutator, schema, context) {
 	};
 }
 function assertValidRunOptions(options) {
-	assert(options?.type !== "complete", "Cannot wait for complete results in custom mutations");
+	assert(options?.type !== "complete" && options?.type !== "cached", "Cannot wait for cached or complete results in custom mutations");
 }
 function newZeroContext(lc, ivmBranch) {
-	return new ZeroContext(lc, ivmBranch, () => emptyFunction, () => emptyFunction, emptyFunction, emptyFunction, emptyFunction, (applyViewUpdates) => applyViewUpdates(), emptyFunction, assertValidRunOptions);
+	return new ZeroContext(lc, ivmBranch, () => emptyFunction, () => emptyFunction, emptyFunction, emptyFunction, emptyFunction, (applyViewUpdates) => applyViewUpdates(), emptyFunction, assertValidRunOptions).markPipelinesReady();
 }
 //#endregion
 export { TransactionImpl, makeReplicacheMutator };

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

@@ -1 +1 @@
-{"version":3,"file":"custom.js","names":["#repTx","#zeroContext"],"sources":["../../../../../zero-client/src/client/custom.ts"],"sourcesContent":["import type {LogContext} from '@rocicorp/logger';\nimport type {ZeroTxData} from '../../../replicache/src/replicache-options.ts';\nimport type {WriteTransactionImpl} from '../../../replicache/src/transactions.ts';\nimport {zeroData} from '../../../replicache/src/transactions.ts';\nimport {assert} from '../../../shared/src/asserts.ts';\nimport type {ReadonlyJSONValue} from '../../../shared/src/json.ts';\nimport {must} from '../../../shared/src/must.ts';\nimport {emptyFunction} from '../../../shared/src/sentinels.ts';\nimport type {DefaultSchema} from '../../../zero-types/src/default-types.ts';\nimport type {Schema} from '../../../zero-types/src/schema.ts';\nimport {\n  makeTransactionMutate,\n  type TransactionMutate,\n} from '../../../zql/src/mutate/crud.ts';\nimport type {\n  ClientTransaction,\n  Transaction,\n} from '../../../zql/src/mutate/custom.ts';\nimport {createRunnableBuilder} from '../../../zql/src/query/create-builder.ts';\nimport {\n  type HumanReadable,\n  type Query,\n  type RunOptions,\n} from '../../../zql/src/query/query.ts';\nimport type {ConditionalSchemaQuery} from '../../../zql/src/query/schema-query.ts';\nimport type {ClientID} from '../types/client-state.ts';\nimport {ZeroContext} from './context.ts';\nimport {makeCRUDExecutor} from './crud.ts';\nimport type {IVMSourceBranch} from './ivm-branch.ts';\nimport type {WriteTransaction} from './replicache-types.ts';\n\n/**\n * The shape which a user's custom mutator definitions must conform to.\n * Supports arbitrary depth nesting of namespaces.\n */\nexport type CustomMutatorDefs = {\n  // oxlint-disable-next-line no-explicit-any\n  [namespaceOrKey: string]: CustomMutatorImpl<any> | CustomMutatorDefs;\n};\n\nexport type MutatorResultDetails =\n  | {\n      readonly type: 'success';\n    }\n  | {\n      readonly type: 'error';\n      readonly error:\n        | {\n            readonly type: 'app';\n            readonly message: string;\n            readonly details: ReadonlyJSONValue | undefined;\n          }\n        | {\n            readonly type: 'zero';\n            readonly message: string;\n          };\n    };\n\nexport type MutatorResultSuccessDetails = Extract<\n  MutatorResultDetails,\n  {type: 'success'}\n>;\nexport type MutatorResultErrorDetails = Extract<\n  MutatorResultDetails,\n  {type: 'error'}\n>;\n\nexport type MutatorResult = {\n  client: Promise<MutatorResultDetails & {}>;\n  server: Promise<MutatorResultDetails & {}>;\n} & {};\n\nexport type CustomMutatorImpl<\n  S extends Schema,\n  TWrappedTransaction = unknown,\n  // oxlint-disable-next-line @typescript-eslint/no-explicit-any\n  TArgs = any,\n  Context = unknown,\n> = (\n  tx: Transaction<S, TWrappedTransaction>,\n  // TODO: many args. See commit: 52657c2f934b4a458d628ea77e56ce92b61eb3c6 which did have many args.\n  // The issue being that it will be a protocol change to support varargs.\n  args: TArgs,\n  ctx: Context,\n) => Promise<void>;\n\n/**\n * The shape exposed on the `Zero.mutate` instance.\n * The signature of a custom mutator takes a `transaction` as its first arg\n * but the user does not provide this arg when calling the mutator.\n *\n * This utility strips the `tx` arg from the user's custom mutator signatures.\n * Supports arbitrary depth nesting of namespaces.\n */\nexport type MakeCustomMutatorInterfaces<\n  S extends Schema,\n  MD extends CustomMutatorDefs,\n  TContext,\n> = {\n  readonly [NamespaceOrName in keyof MD]: MD[NamespaceOrName] extends (\n    tx: Transaction<S>,\n    ...args: infer Args\n  ) => Promise<void>\n    ? (...args: Args) => MutatorResult\n    : MD[NamespaceOrName] extends CustomMutatorDefs\n      ? MakeCustomMutatorInterfaces<S, MD[NamespaceOrName], TContext>\n      : never;\n};\n\nexport type MakeCustomMutatorInterface<TSchema extends Schema, F> = F extends (\n  tx: ClientTransaction<TSchema>,\n  ...args: infer Args\n) => Promise<void>\n  ? (...args: Args) => MutatorResult\n  : never;\n\nexport class TransactionImpl<\n  TSchema extends Schema = DefaultSchema,\n> implements ClientTransaction<TSchema> {\n  readonly location = 'client';\n  readonly mutate: TransactionMutate<TSchema>;\n  /**\n   * @deprecated Use {@linkcode createBuilder} with `tx.run(zql.table.where(...))` instead.\n   */\n  readonly query: ConditionalSchemaQuery<TSchema>;\n\n  readonly #repTx: WriteTransaction;\n  readonly #zeroContext: ZeroContext;\n\n  constructor(lc: LogContext, repTx: WriteTransaction, schema: TSchema) {\n    must(repTx.reason === 'initial' || repTx.reason === 'rebase');\n    const txData = getZeroTxData(repTx);\n    const ivmBranch = txData.ivmSources as IVMSourceBranch;\n\n    this.#repTx = repTx;\n\n    const executor = makeCRUDExecutor(repTx, schema, ivmBranch);\n    this.mutate = makeTransactionMutate(schema, executor);\n\n    const zeroContext = newZeroContext(\n      lc,\n      txData.ivmSources as IVMSourceBranch,\n    );\n\n    this.query = createRunnableBuilder(zeroContext, schema);\n\n    this.#zeroContext = zeroContext;\n  }\n\n  get clientID(): ClientID {\n    return this.#repTx.clientID;\n  }\n\n  get mutationID(): number {\n    return this.#repTx.mutationID;\n  }\n\n  get reason(): 'optimistic' | 'rebase' {\n    return this.#repTx.reason === 'initial' ? 'optimistic' : 'rebase';\n  }\n\n  get token(): string | undefined {\n    return (this.#repTx as WriteTransactionImpl)[zeroData]?.token;\n  }\n\n  run<TTable extends keyof TSchema['tables'] & string, TReturn>(\n    query: Query<TTable, TSchema, TReturn>,\n    options?: RunOptions,\n  ): Promise<HumanReadable<TReturn>> {\n    return this.#zeroContext.run(query, options);\n  }\n}\n\nexport function getZeroTxData(repTx: WriteTransaction): ZeroTxData {\n  const txData = must(\n    (repTx as WriteTransactionImpl)[zeroData],\n    'zero was not set on replicache internal options!',\n  );\n  return txData as ZeroTxData;\n}\n\nexport function makeReplicacheMutator<\n  S extends Schema,\n  TWrappedTransaction,\n  Context,\n>(\n  lc: LogContext,\n  mutator: CustomMutatorImpl<S, TWrappedTransaction>,\n  schema: S,\n  context: Context,\n): (repTx: WriteTransaction, args: ReadonlyJSONValue) => Promise<void> {\n  return async (\n    repTx: WriteTransaction,\n    args: ReadonlyJSONValue,\n  ): Promise<void> => {\n    const tx = new TransactionImpl(lc, repTx, schema);\n    await mutator(tx, args, context);\n  };\n}\n\nfunction assertValidRunOptions(options: RunOptions | undefined): void {\n  // TODO(arv): We should enforce this with the type system too.\n  assert(\n    options?.type !== 'complete',\n    'Cannot wait for complete results in custom mutations',\n  );\n}\n\nfunction newZeroContext(lc: LogContext, ivmBranch: IVMSourceBranch) {\n  return new ZeroContext(\n    lc,\n    ivmBranch,\n    () => emptyFunction,\n    () => emptyFunction,\n    emptyFunction,\n    emptyFunction,\n    emptyFunction,\n    applyViewUpdates => applyViewUpdates(),\n    emptyFunction,\n    assertValidRunOptions,\n  );\n}\n"],"mappings":";;;;;;;;;;AAoHA,IAAa,kBAAb,MAEwC;CACtC,WAAoB;CACpB;;;;CAIA;CAEA;CACA;CAEA,YAAY,IAAgB,OAAyB,QAAiB;EACpE,KAAK,MAAM,WAAW,aAAa,MAAM,WAAW,QAAQ;EAC5D,MAAM,SAAS,cAAc,KAAK;EAClC,MAAM,YAAY,OAAO;EAEzB,KAAKA,SAAS;EAEd,MAAM,WAAW,iBAAiB,OAAO,QAAQ,SAAS;EAC1D,KAAK,SAAS,sBAAsB,QAAQ,QAAQ;EAEpD,MAAM,cAAc,eAClB,IACA,OAAO,UACT;EAEA,KAAK,QAAQ,sBAAsB,aAAa,MAAM;EAEtD,KAAKC,eAAe;CACtB;CAEA,IAAI,WAAqB;EACvB,OAAO,KAAKD,OAAO;CACrB;CAEA,IAAI,aAAqB;EACvB,OAAO,KAAKA,OAAO;CACrB;CAEA,IAAI,SAAkC;EACpC,OAAO,KAAKA,OAAO,WAAW,YAAY,eAAe;CAC3D;CAEA,IAAI,QAA4B;EAC9B,OAAQ,KAAKA,OAAgC,WAAW;CAC1D;CAEA,IACE,OACA,SACiC;EACjC,OAAO,KAAKC,aAAa,IAAI,OAAO,OAAO;CAC7C;AACF;AAEA,SAAgB,cAAc,OAAqC;CAKjE,OAJe,KACZ,MAA+B,WAChC,kDAEK;AACT;AAEA,SAAgB,sBAKd,IACA,SACA,QACA,SACqE;CACrE,OAAO,OACL,OACA,SACkB;EAElB,MAAM,QAAQ,IADC,gBAAgB,IAAI,OAAO,MAC5B,GAAI,MAAM,OAAO;CACjC;AACF;AAEA,SAAS,sBAAsB,SAAuC;CAEpE,OACE,SAAS,SAAS,YAClB,sDACF;AACF;AAEA,SAAS,eAAe,IAAgB,WAA4B;CAClE,OAAO,IAAI,YACT,IACA,iBACM,qBACA,eACN,eACA,eACA,gBACA,qBAAoB,iBAAiB,GACrC,eACA,qBACF;AACF"}
+{"version":3,"file":"custom.js","names":["#repTx","#zeroContext"],"sources":["../../../../../zero-client/src/client/custom.ts"],"sourcesContent":["import type {LogContext} from '@rocicorp/logger';\nimport type {ZeroTxData} from '../../../replicache/src/replicache-options.ts';\nimport type {WriteTransactionImpl} from '../../../replicache/src/transactions.ts';\nimport {zeroData} from '../../../replicache/src/transactions.ts';\nimport {assert} from '../../../shared/src/asserts.ts';\nimport type {ReadonlyJSONValue} from '../../../shared/src/json.ts';\nimport {must} from '../../../shared/src/must.ts';\nimport {emptyFunction} from '../../../shared/src/sentinels.ts';\nimport type {DefaultSchema} from '../../../zero-types/src/default-types.ts';\nimport type {Schema} from '../../../zero-types/src/schema.ts';\nimport {\n  makeTransactionMutate,\n  type TransactionMutate,\n} from '../../../zql/src/mutate/crud.ts';\nimport type {\n  ClientTransaction,\n  Transaction,\n} from '../../../zql/src/mutate/custom.ts';\nimport {createRunnableBuilder} from '../../../zql/src/query/create-builder.ts';\nimport {\n  type HumanReadable,\n  type Query,\n  type RunOptions,\n} from '../../../zql/src/query/query.ts';\nimport type {ConditionalSchemaQuery} from '../../../zql/src/query/schema-query.ts';\nimport type {ClientID} from '../types/client-state.ts';\nimport {ZeroContext} from './context.ts';\nimport {makeCRUDExecutor} from './crud.ts';\nimport type {IVMSourceBranch} from './ivm-branch.ts';\nimport type {WriteTransaction} from './replicache-types.ts';\n\n/**\n * The shape which a user's custom mutator definitions must conform to.\n * Supports arbitrary depth nesting of namespaces.\n */\nexport type CustomMutatorDefs = {\n  // oxlint-disable-next-line no-explicit-any\n  [namespaceOrKey: string]: CustomMutatorImpl<any> | CustomMutatorDefs;\n};\n\nexport type MutatorResultDetails =\n  | {\n      readonly type: 'success';\n    }\n  | {\n      readonly type: 'error';\n      readonly error:\n        | {\n            readonly type: 'app';\n            readonly message: string;\n            readonly details: ReadonlyJSONValue | undefined;\n          }\n        | {\n            readonly type: 'zero';\n            readonly message: string;\n          };\n    };\n\nexport type MutatorResultSuccessDetails = Extract<\n  MutatorResultDetails,\n  {type: 'success'}\n>;\nexport type MutatorResultErrorDetails = Extract<\n  MutatorResultDetails,\n  {type: 'error'}\n>;\n\nexport type MutatorResult = {\n  client: Promise<MutatorResultDetails & {}>;\n  server: Promise<MutatorResultDetails & {}>;\n} & {};\n\nexport type CustomMutatorImpl<\n  S extends Schema,\n  TWrappedTransaction = unknown,\n  // oxlint-disable-next-line @typescript-eslint/no-explicit-any\n  TArgs = any,\n  Context = unknown,\n> = (\n  tx: Transaction<S, TWrappedTransaction>,\n  // TODO: many args. See commit: 52657c2f934b4a458d628ea77e56ce92b61eb3c6 which did have many args.\n  // The issue being that it will be a protocol change to support varargs.\n  args: TArgs,\n  ctx: Context,\n) => Promise<void>;\n\n/**\n * The shape exposed on the `Zero.mutate` instance.\n * The signature of a custom mutator takes a `transaction` as its first arg\n * but the user does not provide this arg when calling the mutator.\n *\n * This utility strips the `tx` arg from the user's custom mutator signatures.\n * Supports arbitrary depth nesting of namespaces.\n */\nexport type MakeCustomMutatorInterfaces<\n  S extends Schema,\n  MD extends CustomMutatorDefs,\n  TContext,\n> = {\n  readonly [NamespaceOrName in keyof MD]: MD[NamespaceOrName] extends (\n    tx: Transaction<S>,\n    ...args: infer Args\n  ) => Promise<void>\n    ? (...args: Args) => MutatorResult\n    : MD[NamespaceOrName] extends CustomMutatorDefs\n      ? MakeCustomMutatorInterfaces<S, MD[NamespaceOrName], TContext>\n      : never;\n};\n\nexport type MakeCustomMutatorInterface<TSchema extends Schema, F> = F extends (\n  tx: ClientTransaction<TSchema>,\n  ...args: infer Args\n) => Promise<void>\n  ? (...args: Args) => MutatorResult\n  : never;\n\nexport class TransactionImpl<\n  TSchema extends Schema = DefaultSchema,\n> implements ClientTransaction<TSchema> {\n  readonly location = 'client';\n  readonly mutate: TransactionMutate<TSchema>;\n  /**\n   * @deprecated Use {@linkcode createBuilder} with `tx.run(zql.table.where(...))` instead.\n   */\n  readonly query: ConditionalSchemaQuery<TSchema>;\n\n  readonly #repTx: WriteTransaction;\n  readonly #zeroContext: ZeroContext;\n\n  constructor(lc: LogContext, repTx: WriteTransaction, schema: TSchema) {\n    must(repTx.reason === 'initial' || repTx.reason === 'rebase');\n    const txData = getZeroTxData(repTx);\n    const ivmBranch = txData.ivmSources as IVMSourceBranch;\n\n    this.#repTx = repTx;\n\n    const executor = makeCRUDExecutor(repTx, schema, ivmBranch);\n    this.mutate = makeTransactionMutate(schema, executor);\n\n    const zeroContext = newZeroContext(\n      lc,\n      txData.ivmSources as IVMSourceBranch,\n    );\n\n    this.query = createRunnableBuilder(zeroContext, schema);\n\n    this.#zeroContext = zeroContext;\n  }\n\n  get clientID(): ClientID {\n    return this.#repTx.clientID;\n  }\n\n  get mutationID(): number {\n    return this.#repTx.mutationID;\n  }\n\n  get reason(): 'optimistic' | 'rebase' {\n    return this.#repTx.reason === 'initial' ? 'optimistic' : 'rebase';\n  }\n\n  get token(): string | undefined {\n    return (this.#repTx as WriteTransactionImpl)[zeroData]?.token;\n  }\n\n  run<TTable extends keyof TSchema['tables'] & string, TReturn>(\n    query: Query<TTable, TSchema, TReturn>,\n    options?: RunOptions,\n  ): Promise<HumanReadable<TReturn>> {\n    return this.#zeroContext.run(query, options);\n  }\n}\n\nexport function getZeroTxData(repTx: WriteTransaction): ZeroTxData {\n  const txData = must(\n    (repTx as WriteTransactionImpl)[zeroData],\n    'zero was not set on replicache internal options!',\n  );\n  return txData as ZeroTxData;\n}\n\nexport function makeReplicacheMutator<\n  S extends Schema,\n  TWrappedTransaction,\n  Context,\n>(\n  lc: LogContext,\n  mutator: CustomMutatorImpl<S, TWrappedTransaction>,\n  schema: S,\n  context: Context,\n): (repTx: WriteTransaction, args: ReadonlyJSONValue) => Promise<void> {\n  return async (\n    repTx: WriteTransaction,\n    args: ReadonlyJSONValue,\n  ): Promise<void> => {\n    const tx = new TransactionImpl(lc, repTx, schema);\n    await mutator(tx, args, context);\n  };\n}\n\nfunction assertValidRunOptions(options: RunOptions | undefined): void {\n  // TODO(arv): We should enforce this with the type system too.\n  assert(\n    options?.type !== 'complete' && options?.type !== 'cached',\n    'Cannot wait for cached or complete results in custom mutations',\n  );\n}\n\nfunction newZeroContext(lc: LogContext, ivmBranch: IVMSourceBranch) {\n  // The forked branch is already populated, so there is nothing to defer.\n  return new ZeroContext(\n    lc,\n    ivmBranch,\n    () => emptyFunction,\n    () => emptyFunction,\n    emptyFunction,\n    emptyFunction,\n    emptyFunction,\n    applyViewUpdates => applyViewUpdates(),\n    emptyFunction,\n    assertValidRunOptions,\n  ).markPipelinesReady();\n}\n"],"mappings":";;;;;;;;;;AAoHA,IAAa,kBAAb,MAEwC;CACtC,WAAoB;CACpB;;;;CAIA;CAEA;CACA;CAEA,YAAY,IAAgB,OAAyB,QAAiB;EACpE,KAAK,MAAM,WAAW,aAAa,MAAM,WAAW,QAAQ;EAC5D,MAAM,SAAS,cAAc,KAAK;EAClC,MAAM,YAAY,OAAO;EAEzB,KAAKA,SAAS;EAEd,MAAM,WAAW,iBAAiB,OAAO,QAAQ,SAAS;EAC1D,KAAK,SAAS,sBAAsB,QAAQ,QAAQ;EAEpD,MAAM,cAAc,eAClB,IACA,OAAO,UACT;EAEA,KAAK,QAAQ,sBAAsB,aAAa,MAAM;EAEtD,KAAKC,eAAe;CACtB;CAEA,IAAI,WAAqB;EACvB,OAAO,KAAKD,OAAO;CACrB;CAEA,IAAI,aAAqB;EACvB,OAAO,KAAKA,OAAO;CACrB;CAEA,IAAI,SAAkC;EACpC,OAAO,KAAKA,OAAO,WAAW,YAAY,eAAe;CAC3D;CAEA,IAAI,QAA4B;EAC9B,OAAQ,KAAKA,OAAgC,WAAW;CAC1D;CAEA,IACE,OACA,SACiC;EACjC,OAAO,KAAKC,aAAa,IAAI,OAAO,OAAO;CAC7C;AACF;AAEA,SAAgB,cAAc,OAAqC;CAKjE,OAJe,KACZ,MAA+B,WAChC,kDAEK;AACT;AAEA,SAAgB,sBAKd,IACA,SACA,QACA,SACqE;CACrE,OAAO,OACL,OACA,SACkB;EAElB,MAAM,QAAQ,IADC,gBAAgB,IAAI,OAAO,MAC5B,GAAI,MAAM,OAAO;CACjC;AACF;AAEA,SAAS,sBAAsB,SAAuC;CAEpE,OACE,SAAS,SAAS,cAAc,SAAS,SAAS,UAClD,gEACF;AACF;AAEA,SAAS,eAAe,IAAgB,WAA4B;CAElE,OAAO,IAAI,YACT,IACA,iBACM,qBACA,eACN,eACA,eACA,gBACA,qBAAoB,iBAAiB,GACrC,eACA,qBACF,EAAE,mBAAmB;AACvB"}

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

@@ -128,6 +128,6 @@ function getErrorConnectionTransition(ex) {
 	};
 }
 //#endregion
-export { ClientError, NO_STATUS_TRANSITION, getBackoffParams, getErrorConnectionTransition, isAuthError, isClientError, isServerError, isZeroError };
+export { ClientError, NO_STATUS_TRANSITION, getBackoffParams, getErrorConnectionTransition, isClientError, isServerError, isZeroError };
 
 //# sourceMappingURL=error.js.map

package/out/zero-client/src/client/ivm-branch.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ivm-branch.d.ts","sourceRoot":"","sources":["../../../../../zero-client/src/client/ivm-branch.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAGV,WAAW,EACZ,MAAM,uCAAuC,CAAC;AAC/C,OAAO,KAAK,EAAC,SAAS,EAAC,MAAM,2CAA2C,CAAC;AACzE,OAAO,EAAY,KAAK,KAAK,EAAC,MAAM,sCAAsC,CAAC;AAG3E,OAAO,KAAK,EAAC,IAAI,EAAC,MAAM,iCAAiC,CAAC;AAC1D,OAAO,KAAK,EAAC,eAAe,EAAC,MAAM,+CAA+C,CAAC;AASnF,OAAO,KAAK,EAAC,WAAW,EAAC,MAAM,0CAA0C,CAAC;AAC1E,OAAO,EAAC,YAAY,EAAC,MAAM,uCAAuC,CAAC;AASnE;;;;;;;;;;;;;;;GAeG;AACH,qBAAa,eAAe;;IAI1B,IAAI,EAAE,IAAI,GAAG,SAAS,CAAC;IAEvB,YACE,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,EACnC,IAAI,CAAC,EAAE,IAAI,EACX,OAAO,GAAE,GAAG,CAAC,MAAM,EAAE,YAAY,GAAG,SAAS,CAAa,EAK3D;IAED,SAAS,CAAC,IAAI,EAAE,MAAM,GAAG,YAAY,GAAG,SAAS,CAahD;IAED,KAAK,SAEJ;IAQD;;;OAGG;IACH,OAAO,CAAC,YAAY,EAAE,IAAI,GAAG,SAAS,EAAE,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,WAAW,QAiBxE;IAED;;OAEG;IACG,UAAU,CACd,KAAK,EAAE,SAAS,EAChB,WAAW,EAAE,IAAI,EACjB,WAAW,CAAC,EAAE,eAAe,GAC5B,OAAO,CAAC,eAAe,CAAC,CAY1B;IAED;;;;;;;OAOG;IACH,IAAI,oBAaH;CACF;AAED,wBAAsB,aAAa,CACjC,MAAM,EAAE,eAAe,EACvB,IAAI,EAAE,IAAI,EACV,KAAK,EAAE,KAAK,iBAkBb"}
+{"version":3,"file":"ivm-branch.d.ts","sourceRoot":"","sources":["../../../../../zero-client/src/client/ivm-branch.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAGV,WAAW,EACZ,MAAM,uCAAuC,CAAC;AAC/C,OAAO,KAAK,EAAC,SAAS,EAAC,MAAM,2CAA2C,CAAC;AACzE,OAAO,EAAY,KAAK,KAAK,EAAC,MAAM,sCAAsC,CAAC;AAG3E,OAAO,KAAK,EAAC,IAAI,EAAC,MAAM,iCAAiC,CAAC;AAC1D,OAAO,KAAK,EAAC,eAAe,EAAC,MAAM,+CAA+C,CAAC;AASnF,OAAO,KAAK,EAAC,WAAW,EAAC,MAAM,0CAA0C,CAAC;AAC1E,OAAO,EAAC,YAAY,EAAC,MAAM,uCAAuC,CAAC;AAQnE;;;;;;;;;;;;;;;GAeG;AACH,qBAAa,eAAe;;IAI1B,IAAI,EAAE,IAAI,GAAG,SAAS,CAAC;IAEvB,YACE,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,EACnC,IAAI,CAAC,EAAE,IAAI,EACX,OAAO,GAAE,GAAG,CAAC,MAAM,EAAE,YAAY,GAAG,SAAS,CAAa,EAK3D;IAED,SAAS,CAAC,IAAI,EAAE,MAAM,GAAG,YAAY,GAAG,SAAS,CAahD;IAED,KAAK,SAEJ;IAQD;;;OAGG;IACH,OAAO,CAAC,YAAY,EAAE,IAAI,GAAG,SAAS,EAAE,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,WAAW,QAiBxE;IAED;;OAEG;IACG,UAAU,CACd,KAAK,EAAE,SAAS,EAChB,WAAW,EAAE,IAAI,EACjB,WAAW,CAAC,EAAE,eAAe,GAC5B,OAAO,CAAC,eAAe,CAAC,CAY1B;IAED;;;;;;;OAOG;IACH,IAAI,oBAaH;CACF;AAED,wBAAsB,aAAa,CACjC,MAAM,EAAE,eAAe,EACvB,IAAI,EAAE,IAAI,EACV,KAAK,EAAE,KAAK,iBAkBb"}

package/out/zero-client/src/client/ivm-branch.js

@@ -6,7 +6,7 @@ import { using, withRead } from "../../../replicache/src/with-transactions.js";
 import { must } from "../../../shared/src/must.js";
 import { diffBinarySearch } from "../../../replicache/src/subscriptions.js";
 import { consume } from "../../../zql/src/ivm/stream.js";
-import { makeSourceChangeAdd, makeSourceChangeEdit, makeSourceChangeRemove } from "../../../zql/src/ivm/source.js";
+import { makeSourceChangeEdit, makeSourceChangeRemove } from "../../../zql/src/ivm/source.js";
 import { MemorySource } from "../../../zql/src/ivm/memory-source.js";
 import { sourceNameFromKey } from "./keys.js";
 //#region ../zero-client/src/client/ivm-branch.ts
@@ -119,15 +119,32 @@ function applyDiffs(diffs, branch) {
 			case "del":
 				consume(source.push(makeSourceChangeRemove(diff.oldValue)));
 				break;
-			case "add":
-				consume(source.push(makeSourceChangeAdd(diff.newValue)));
+			case "add": {
+				const rows = takeAddsForSource(diffs, i, name);
+				i += rows.length - 1;
+				source.pushAdds(rows);
 				break;
+			}
 			case "change":
 				consume(source.push(makeSourceChangeEdit(diff.newValue, diff.oldValue)));
 				break;
 		}
 	}
 }
+/**
+* Returns the rows of the run of `add` diffs for the source `name` that starts
+* at `start`. Diffs are ordered by key so a table's rows are contiguous.
+*/
+function takeAddsForSource(diffs, start, name) {
+	const prefix = "e/" + name + "/";
+	const rows = [];
+	for (let i = start; i < diffs.length; i++) {
+		const diff = diffs[i];
+		if (diff.op !== "add" || !diff.key.startsWith(prefix)) break;
+		rows.push(diff.newValue);
+	}
+	return rows;
+}
 //#endregion
 export { IVMSourceBranch };
 

package/out/zero-client/src/client/ivm-branch.js.map

@@ -1 +1 @@
-{"version":3,"file":"ivm-branch.js","names":["#sources","#tables","#throwIfInvalid","#advanceError"],"sources":["../../../../../zero-client/src/client/ivm-branch.ts"],"sourcesContent":["import type {\n  InternalDiff,\n  InternalDiffOperation,\n  NoIndexDiff,\n} from '../../../replicache/src/btree/node.ts';\nimport type {LazyStore} from '../../../replicache/src/dag/lazy-store.ts';\nimport {type Read, type Store} from '../../../replicache/src/dag/store.ts';\nimport {readFromHash} from '../../../replicache/src/db/read.ts';\nimport * as FormatVersion from '../../../replicache/src/format-version-enum.ts';\nimport type {Hash} from '../../../replicache/src/hash.ts';\nimport type {ZeroReadOptions} from '../../../replicache/src/replicache-options.ts';\nimport {diffBinarySearch} from '../../../replicache/src/subscriptions.ts';\nimport type {DiffsMap} from '../../../replicache/src/sync/diff.ts';\nimport {diff} from '../../../replicache/src/sync/diff.ts';\nimport {using, withRead} from '../../../replicache/src/with-transactions.ts';\nimport {assert} from '../../../shared/src/asserts.ts';\nimport {wrapIterable} from '../../../shared/src/iterables.ts';\nimport {must} from '../../../shared/src/must.ts';\nimport type {Row} from '../../../zero-protocol/src/data.ts';\nimport type {TableSchema} from '../../../zero-schema/src/table-schema.ts';\nimport {MemorySource} from '../../../zql/src/ivm/memory-source.ts';\nimport {consume} from '../../../zql/src/ivm/stream.ts';\nimport {ENTITIES_KEY_PREFIX, sourceNameFromKey} from './keys.ts';\n\nimport {\n  makeSourceChangeAdd,\n  makeSourceChangeEdit,\n  makeSourceChangeRemove,\n} from '../../../zql/src/ivm/source.ts';\n/**\n * Replicache needs to rebase mutations onto different\n * commits of it's b-tree. These mutations can have reads\n * in them and those reads must be run against the IVM sources.\n *\n * To ensure the reads get the correct state, the IVM\n * sources need to reflect the state of the commit\n * being rebased onto. `IVMSourceBranch` allows us to:\n * 1. fork the IVM sources\n * 2. patch them up to match the desired head\n * 3. run the reads against the forked sources\n *\n * (2) is expected to be a cheap operation as there should only\n * ever be a few outstanding diffs to apply given Zero is meant\n * to be run in a connected state.\n */\nexport class IVMSourceBranch {\n  readonly #sources: Map<string, MemorySource | undefined>;\n  readonly #tables: Record<string, TableSchema>;\n  #advanceError: unknown;\n  hash: Hash | undefined;\n\n  constructor(\n    tables: Record<string, TableSchema>,\n    hash?: Hash,\n    sources: Map<string, MemorySource | undefined> = new Map(),\n  ) {\n    this.#tables = tables;\n    this.#sources = sources;\n    this.hash = hash;\n  }\n\n  getSource(name: string): MemorySource | undefined {\n    this.#throwIfInvalid();\n\n    if (this.#sources.has(name)) {\n      return this.#sources.get(name);\n    }\n\n    const schema = this.#tables[name];\n    const source = schema\n      ? new MemorySource(name, schema.columns, schema.primaryKey)\n      : undefined;\n    this.#sources.set(name, source);\n    return source;\n  }\n\n  clear() {\n    this.#sources.clear();\n  }\n\n  #throwIfInvalid() {\n    if (this.#advanceError) {\n      throw this.#advanceError;\n    }\n  }\n\n  /**\n   * Mutates the current branch, advancing it to the new head\n   * by applying the given diffs.\n   */\n  advance(expectedHead: Hash | undefined, newHead: Hash, diffs: NoIndexDiff) {\n    this.#throwIfInvalid();\n\n    assert(\n      this.hash === expectedHead,\n      () =>\n        `Expected head must match the main head. Got: ${this.hash}, expected: ${expectedHead}`,\n    );\n\n    try {\n      applyDiffs(diffs, this);\n      this.hash = newHead;\n    } catch (e) {\n      this.#advanceError = e;\n      this.clear();\n      throw e;\n    }\n  }\n\n  /**\n   * Fork the branch and patch it up to match the desired head.\n   */\n  async forkToHead(\n    store: LazyStore,\n    desiredHead: Hash,\n    readOptions?: ZeroReadOptions,\n  ): Promise<IVMSourceBranch> {\n    this.#throwIfInvalid();\n\n    const fork = this.fork();\n\n    if (fork.hash === desiredHead) {\n      return fork;\n    }\n\n    await patchBranch(desiredHead, store, fork, readOptions);\n    fork.hash = desiredHead;\n    return fork;\n  }\n\n  /**\n   * Creates a new IVMSourceBranch that is a copy of the current one.\n   * This is a cheap operation since the b-trees are shared until a write is performed\n   * and then only the modified nodes are copied.\n   *\n   * IVM branches are forked when we need to rebase mutations.\n   * The mutations modify the fork rather than original branch.\n   */\n  fork() {\n    this.#throwIfInvalid();\n\n    return new IVMSourceBranch(\n      this.#tables,\n      this.hash,\n      new Map(\n        wrapIterable(this.#sources.entries()).map(([name, source]) => [\n          name,\n          source?.fork(),\n        ]),\n      ),\n    );\n  }\n}\n\nexport async function initFromStore(\n  branch: IVMSourceBranch,\n  hash: Hash,\n  store: Store,\n) {\n  const diffs: InternalDiffOperation[] = [];\n  await withRead(store, async dagRead => {\n    const read = await readFromHash(hash, dagRead, FormatVersion.Latest);\n    for await (const entry of read.map.scan(ENTITIES_KEY_PREFIX, true)) {\n      if (!entry[0].startsWith(ENTITIES_KEY_PREFIX)) {\n        break;\n      }\n      diffs.push({\n        op: 'add',\n        key: entry[0],\n        newValue: entry[1],\n      });\n    }\n  });\n\n  branch.advance(undefined, hash, diffs);\n}\n\nasync function patchBranch(\n  desiredHead: Hash,\n  store: LazyStore,\n  fork: IVMSourceBranch,\n  readOptions: ZeroReadOptions | undefined,\n) {\n  const diffs = await computeDiffs(\n    must(fork.hash),\n    desiredHead,\n    store,\n    readOptions,\n  );\n  if (!diffs) {\n    return;\n  }\n  applyDiffs(diffs, fork);\n}\n\nasync function computeDiffs(\n  startHash: Hash,\n  endHash: Hash,\n  store: LazyStore,\n  readOptions: ZeroReadOptions | undefined,\n): Promise<InternalDiff | undefined> {\n  const readFn = (dagRead: Read) =>\n    diff(\n      startHash,\n      endHash,\n      dagRead,\n      {\n        shouldComputeDiffs: () => true,\n        shouldComputeDiffsForIndex(_name) {\n          return false;\n        },\n      },\n      FormatVersion.Latest,\n    );\n\n  let diffs: DiffsMap;\n  if (readOptions?.openLazySourceRead) {\n    diffs = await using(store.read(readOptions.openLazySourceRead), readFn);\n  } else if (readOptions?.openLazyRead) {\n    diffs = await readFn(readOptions.openLazyRead);\n  } else {\n    diffs = await withRead(store, readFn);\n  }\n\n  return diffs.get('');\n}\n\nfunction applyDiffs(diffs: NoIndexDiff, branch: IVMSourceBranch) {\n  for (\n    let i = diffBinarySearch(diffs, ENTITIES_KEY_PREFIX, diff => diff.key);\n    i < diffs.length;\n    i++\n  ) {\n    const diff = diffs[i];\n    const {key} = diff;\n    if (!key.startsWith(ENTITIES_KEY_PREFIX)) {\n      break;\n    }\n    const name = sourceNameFromKey(key);\n    const source = must(branch.getSource(name));\n    switch (diff.op) {\n      case 'del':\n        consume(source.push(makeSourceChangeRemove(diff.oldValue as Row)));\n        break;\n      case 'add':\n        consume(source.push(makeSourceChangeAdd(diff.newValue as Row)));\n        break;\n      case 'change':\n        consume(\n          source.push(\n            makeSourceChangeEdit(diff.newValue as Row, diff.oldValue as Row),\n          ),\n        );\n        break;\n    }\n  }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;AA6CA,IAAa,kBAAb,MAAa,gBAAgB;CAC3B;CACA;CACA;CACA;CAEA,YACE,QACA,MACA,0BAAiD,IAAI,IAAI,GACzD;EACA,KAAKC,UAAU;EACf,KAAKD,WAAW;EAChB,KAAK,OAAO;CACd;CAEA,UAAU,MAAwC;EAChD,KAAKE,gBAAgB;EAErB,IAAI,KAAKF,SAAS,IAAI,IAAI,GACxB,OAAO,KAAKA,SAAS,IAAI,IAAI;EAG/B,MAAM,SAAS,KAAKC,QAAQ;EAC5B,MAAM,SAAS,SACX,IAAI,aAAa,MAAM,OAAO,SAAS,OAAO,UAAU,IACxD,KAAA;EACJ,KAAKD,SAAS,IAAI,MAAM,MAAM;EAC9B,OAAO;CACT;CAEA,QAAQ;EACN,KAAKA,SAAS,MAAM;CACtB;CAEA,kBAAkB;EAChB,IAAI,KAAKG,eACP,MAAM,KAAKA;CAEf;;;;;CAMA,QAAQ,cAAgC,SAAe,OAAoB;EACzE,KAAKD,gBAAgB;EAErB,OACE,KAAK,SAAS,oBAEZ,gDAAgD,KAAK,KAAK,cAAc,cAC5E;EAEA,IAAI;GACF,WAAW,OAAO,IAAI;GACtB,KAAK,OAAO;EACd,SAAS,GAAG;GACV,KAAKC,gBAAgB;GACrB,KAAK,MAAM;GACX,MAAM;EACR;CACF;;;;CAKA,MAAM,WACJ,OACA,aACA,aAC0B;EAC1B,KAAKD,gBAAgB;EAErB,MAAM,OAAO,KAAK,KAAK;EAEvB,IAAI,KAAK,SAAS,aAChB,OAAO;EAGT,MAAM,YAAY,aAAa,OAAO,MAAM,WAAW;EACvD,KAAK,OAAO;EACZ,OAAO;CACT;;;;;;;;;CAUA,OAAO;EACL,KAAKA,gBAAgB;EAErB,OAAO,IAAI,gBACT,KAAKD,SACL,KAAK,MACL,IAAI,IACF,aAAa,KAAKD,SAAS,QAAQ,CAAC,EAAE,KAAK,CAAC,MAAM,YAAY,CAC5D,MACA,QAAQ,KAAK,CACf,CAAC,CACH,CACF;CACF;AACF;AAyBA,eAAe,YACb,aACA,OACA,MACA,aACA;CACA,MAAM,QAAQ,MAAM,aAClB,KAAK,KAAK,IAAI,GACd,aACA,OACA,WACF;CACA,IAAI,CAAC,OACH;CAEF,WAAW,OAAO,IAAI;AACxB;AAEA,eAAe,aACb,WACA,SACA,OACA,aACmC;CACnC,MAAM,UAAU,YACd,KACE,WACA,SACA,SACA;EACE,0BAA0B;EAC1B,2BAA2B,OAAO;GAChC,OAAO;EACT;CACF,GACA,CACF;CAEF,IAAI;CACJ,IAAI,aAAa,oBACf,QAAQ,MAAM,MAAM,MAAM,KAAK,YAAY,kBAAkB,GAAG,MAAM;MACjE,IAAI,aAAa,cACtB,QAAQ,MAAM,OAAO,YAAY,YAAY;MAE7C,QAAQ,MAAM,SAAS,OAAO,MAAM;CAGtC,OAAO,MAAM,IAAI,EAAE;AACrB;AAEA,SAAS,WAAW,OAAoB,QAAyB;CAC/D,KACE,IAAI,IAAI,iBAAiB,OAAA,OAA4B,SAAQ,KAAK,GAAG,GACrE,IAAI,MAAM,QACV,KACA;EACA,MAAM,OAAO,MAAM;EACnB,MAAM,EAAC,QAAO;EACd,IAAI,CAAC,IAAI,WAAA,IAA8B,GACrC;EAEF,MAAM,OAAO,kBAAkB,GAAG;EAClC,MAAM,SAAS,KAAK,OAAO,UAAU,IAAI,CAAC;EAC1C,QAAQ,KAAK,IAAb;GACE,KAAK;IACH,QAAQ,OAAO,KAAK,uBAAuB,KAAK,QAAe,CAAC,CAAC;IACjE;GACF,KAAK;IACH,QAAQ,OAAO,KAAK,oBAAoB,KAAK,QAAe,CAAC,CAAC;IAC9D;GACF,KAAK;IACH,QACE,OAAO,KACL,qBAAqB,KAAK,UAAiB,KAAK,QAAe,CACjE,CACF;IACA;EACJ;CACF;AACF"}
+{"version":3,"file":"ivm-branch.js","names":["#sources","#tables","#throwIfInvalid","#advanceError"],"sources":["../../../../../zero-client/src/client/ivm-branch.ts"],"sourcesContent":["import type {\n  InternalDiff,\n  InternalDiffOperation,\n  NoIndexDiff,\n} from '../../../replicache/src/btree/node.ts';\nimport type {LazyStore} from '../../../replicache/src/dag/lazy-store.ts';\nimport {type Read, type Store} from '../../../replicache/src/dag/store.ts';\nimport {readFromHash} from '../../../replicache/src/db/read.ts';\nimport * as FormatVersion from '../../../replicache/src/format-version-enum.ts';\nimport type {Hash} from '../../../replicache/src/hash.ts';\nimport type {ZeroReadOptions} from '../../../replicache/src/replicache-options.ts';\nimport {diffBinarySearch} from '../../../replicache/src/subscriptions.ts';\nimport type {DiffsMap} from '../../../replicache/src/sync/diff.ts';\nimport {diff} from '../../../replicache/src/sync/diff.ts';\nimport {using, withRead} from '../../../replicache/src/with-transactions.ts';\nimport {assert} from '../../../shared/src/asserts.ts';\nimport {wrapIterable} from '../../../shared/src/iterables.ts';\nimport {must} from '../../../shared/src/must.ts';\nimport type {Row} from '../../../zero-protocol/src/data.ts';\nimport type {TableSchema} from '../../../zero-schema/src/table-schema.ts';\nimport {MemorySource} from '../../../zql/src/ivm/memory-source.ts';\nimport {consume} from '../../../zql/src/ivm/stream.ts';\nimport {ENTITIES_KEY_PREFIX, sourceNameFromKey} from './keys.ts';\n\nimport {\n  makeSourceChangeEdit,\n  makeSourceChangeRemove,\n} from '../../../zql/src/ivm/source.ts';\n/**\n * Replicache needs to rebase mutations onto different\n * commits of it's b-tree. These mutations can have reads\n * in them and those reads must be run against the IVM sources.\n *\n * To ensure the reads get the correct state, the IVM\n * sources need to reflect the state of the commit\n * being rebased onto. `IVMSourceBranch` allows us to:\n * 1. fork the IVM sources\n * 2. patch them up to match the desired head\n * 3. run the reads against the forked sources\n *\n * (2) is expected to be a cheap operation as there should only\n * ever be a few outstanding diffs to apply given Zero is meant\n * to be run in a connected state.\n */\nexport class IVMSourceBranch {\n  readonly #sources: Map<string, MemorySource | undefined>;\n  readonly #tables: Record<string, TableSchema>;\n  #advanceError: unknown;\n  hash: Hash | undefined;\n\n  constructor(\n    tables: Record<string, TableSchema>,\n    hash?: Hash,\n    sources: Map<string, MemorySource | undefined> = new Map(),\n  ) {\n    this.#tables = tables;\n    this.#sources = sources;\n    this.hash = hash;\n  }\n\n  getSource(name: string): MemorySource | undefined {\n    this.#throwIfInvalid();\n\n    if (this.#sources.has(name)) {\n      return this.#sources.get(name);\n    }\n\n    const schema = this.#tables[name];\n    const source = schema\n      ? new MemorySource(name, schema.columns, schema.primaryKey)\n      : undefined;\n    this.#sources.set(name, source);\n    return source;\n  }\n\n  clear() {\n    this.#sources.clear();\n  }\n\n  #throwIfInvalid() {\n    if (this.#advanceError) {\n      throw this.#advanceError;\n    }\n  }\n\n  /**\n   * Mutates the current branch, advancing it to the new head\n   * by applying the given diffs.\n   */\n  advance(expectedHead: Hash | undefined, newHead: Hash, diffs: NoIndexDiff) {\n    this.#throwIfInvalid();\n\n    assert(\n      this.hash === expectedHead,\n      () =>\n        `Expected head must match the main head. Got: ${this.hash}, expected: ${expectedHead}`,\n    );\n\n    try {\n      applyDiffs(diffs, this);\n      this.hash = newHead;\n    } catch (e) {\n      this.#advanceError = e;\n      this.clear();\n      throw e;\n    }\n  }\n\n  /**\n   * Fork the branch and patch it up to match the desired head.\n   */\n  async forkToHead(\n    store: LazyStore,\n    desiredHead: Hash,\n    readOptions?: ZeroReadOptions,\n  ): Promise<IVMSourceBranch> {\n    this.#throwIfInvalid();\n\n    const fork = this.fork();\n\n    if (fork.hash === desiredHead) {\n      return fork;\n    }\n\n    await patchBranch(desiredHead, store, fork, readOptions);\n    fork.hash = desiredHead;\n    return fork;\n  }\n\n  /**\n   * Creates a new IVMSourceBranch that is a copy of the current one.\n   * This is a cheap operation since the b-trees are shared until a write is performed\n   * and then only the modified nodes are copied.\n   *\n   * IVM branches are forked when we need to rebase mutations.\n   * The mutations modify the fork rather than original branch.\n   */\n  fork() {\n    this.#throwIfInvalid();\n\n    return new IVMSourceBranch(\n      this.#tables,\n      this.hash,\n      new Map(\n        wrapIterable(this.#sources.entries()).map(([name, source]) => [\n          name,\n          source?.fork(),\n        ]),\n      ),\n    );\n  }\n}\n\nexport async function initFromStore(\n  branch: IVMSourceBranch,\n  hash: Hash,\n  store: Store,\n) {\n  const diffs: InternalDiffOperation[] = [];\n  await withRead(store, async dagRead => {\n    const read = await readFromHash(hash, dagRead, FormatVersion.Latest);\n    for await (const entry of read.map.scan(ENTITIES_KEY_PREFIX, true)) {\n      if (!entry[0].startsWith(ENTITIES_KEY_PREFIX)) {\n        break;\n      }\n      diffs.push({\n        op: 'add',\n        key: entry[0],\n        newValue: entry[1],\n      });\n    }\n  });\n\n  branch.advance(undefined, hash, diffs);\n}\n\nasync function patchBranch(\n  desiredHead: Hash,\n  store: LazyStore,\n  fork: IVMSourceBranch,\n  readOptions: ZeroReadOptions | undefined,\n) {\n  const diffs = await computeDiffs(\n    must(fork.hash),\n    desiredHead,\n    store,\n    readOptions,\n  );\n  if (!diffs) {\n    return;\n  }\n  applyDiffs(diffs, fork);\n}\n\nasync function computeDiffs(\n  startHash: Hash,\n  endHash: Hash,\n  store: LazyStore,\n  readOptions: ZeroReadOptions | undefined,\n): Promise<InternalDiff | undefined> {\n  const readFn = (dagRead: Read) =>\n    diff(\n      startHash,\n      endHash,\n      dagRead,\n      {\n        shouldComputeDiffs: () => true,\n        shouldComputeDiffsForIndex(_name) {\n          return false;\n        },\n      },\n      FormatVersion.Latest,\n    );\n\n  let diffs: DiffsMap;\n  if (readOptions?.openLazySourceRead) {\n    diffs = await using(store.read(readOptions.openLazySourceRead), readFn);\n  } else if (readOptions?.openLazyRead) {\n    diffs = await readFn(readOptions.openLazyRead);\n  } else {\n    diffs = await withRead(store, readFn);\n  }\n\n  return diffs.get('');\n}\n\nfunction applyDiffs(diffs: NoIndexDiff, branch: IVMSourceBranch) {\n  for (\n    let i = diffBinarySearch(diffs, ENTITIES_KEY_PREFIX, diff => diff.key);\n    i < diffs.length;\n    i++\n  ) {\n    const diff = diffs[i];\n    const {key} = diff;\n    if (!key.startsWith(ENTITIES_KEY_PREFIX)) {\n      break;\n    }\n    const name = sourceNameFromKey(key);\n    const source = must(branch.getSource(name));\n    switch (diff.op) {\n      case 'del':\n        consume(source.push(makeSourceChangeRemove(diff.oldValue as Row)));\n        break;\n      case 'add': {\n        const rows = takeAddsForSource(diffs, i, name);\n        i += rows.length - 1;\n        source.pushAdds(rows);\n        break;\n      }\n      case 'change':\n        consume(\n          source.push(\n            makeSourceChangeEdit(diff.newValue as Row, diff.oldValue as Row),\n          ),\n        );\n        break;\n    }\n  }\n}\n\n/**\n * Returns the rows of the run of `add` diffs for the source `name` that starts\n * at `start`. Diffs are ordered by key so a table's rows are contiguous.\n */\nfunction takeAddsForSource(\n  diffs: NoIndexDiff,\n  start: number,\n  name: string,\n): Row[] {\n  const prefix = ENTITIES_KEY_PREFIX + name + '/';\n  const rows: Row[] = [];\n  for (let i = start; i < diffs.length; i++) {\n    const diff = diffs[i];\n    if (diff.op !== 'add' || !diff.key.startsWith(prefix)) {\n      break;\n    }\n    rows.push(diff.newValue as Row);\n  }\n  return rows;\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;AA4CA,IAAa,kBAAb,MAAa,gBAAgB;CAC3B;CACA;CACA;CACA;CAEA,YACE,QACA,MACA,0BAAiD,IAAI,IAAI,GACzD;EACA,KAAKC,UAAU;EACf,KAAKD,WAAW;EAChB,KAAK,OAAO;CACd;CAEA,UAAU,MAAwC;EAChD,KAAKE,gBAAgB;EAErB,IAAI,KAAKF,SAAS,IAAI,IAAI,GACxB,OAAO,KAAKA,SAAS,IAAI,IAAI;EAG/B,MAAM,SAAS,KAAKC,QAAQ;EAC5B,MAAM,SAAS,SACX,IAAI,aAAa,MAAM,OAAO,SAAS,OAAO,UAAU,IACxD,KAAA;EACJ,KAAKD,SAAS,IAAI,MAAM,MAAM;EAC9B,OAAO;CACT;CAEA,QAAQ;EACN,KAAKA,SAAS,MAAM;CACtB;CAEA,kBAAkB;EAChB,IAAI,KAAKG,eACP,MAAM,KAAKA;CAEf;;;;;CAMA,QAAQ,cAAgC,SAAe,OAAoB;EACzE,KAAKD,gBAAgB;EAErB,OACE,KAAK,SAAS,oBAEZ,gDAAgD,KAAK,KAAK,cAAc,cAC5E;EAEA,IAAI;GACF,WAAW,OAAO,IAAI;GACtB,KAAK,OAAO;EACd,SAAS,GAAG;GACV,KAAKC,gBAAgB;GACrB,KAAK,MAAM;GACX,MAAM;EACR;CACF;;;;CAKA,MAAM,WACJ,OACA,aACA,aAC0B;EAC1B,KAAKD,gBAAgB;EAErB,MAAM,OAAO,KAAK,KAAK;EAEvB,IAAI,KAAK,SAAS,aAChB,OAAO;EAGT,MAAM,YAAY,aAAa,OAAO,MAAM,WAAW;EACvD,KAAK,OAAO;EACZ,OAAO;CACT;;;;;;;;;CAUA,OAAO;EACL,KAAKA,gBAAgB;EAErB,OAAO,IAAI,gBACT,KAAKD,SACL,KAAK,MACL,IAAI,IACF,aAAa,KAAKD,SAAS,QAAQ,CAAC,EAAE,KAAK,CAAC,MAAM,YAAY,CAC5D,MACA,QAAQ,KAAK,CACf,CAAC,CACH,CACF;CACF;AACF;AAyBA,eAAe,YACb,aACA,OACA,MACA,aACA;CACA,MAAM,QAAQ,MAAM,aAClB,KAAK,KAAK,IAAI,GACd,aACA,OACA,WACF;CACA,IAAI,CAAC,OACH;CAEF,WAAW,OAAO,IAAI;AACxB;AAEA,eAAe,aACb,WACA,SACA,OACA,aACmC;CACnC,MAAM,UAAU,YACd,KACE,WACA,SACA,SACA;EACE,0BAA0B;EAC1B,2BAA2B,OAAO;GAChC,OAAO;EACT;CACF,GACA,CACF;CAEF,IAAI;CACJ,IAAI,aAAa,oBACf,QAAQ,MAAM,MAAM,MAAM,KAAK,YAAY,kBAAkB,GAAG,MAAM;MACjE,IAAI,aAAa,cACtB,QAAQ,MAAM,OAAO,YAAY,YAAY;MAE7C,QAAQ,MAAM,SAAS,OAAO,MAAM;CAGtC,OAAO,MAAM,IAAI,EAAE;AACrB;AAEA,SAAS,WAAW,OAAoB,QAAyB;CAC/D,KACE,IAAI,IAAI,iBAAiB,OAAA,OAA4B,SAAQ,KAAK,GAAG,GACrE,IAAI,MAAM,QACV,KACA;EACA,MAAM,OAAO,MAAM;EACnB,MAAM,EAAC,QAAO;EACd,IAAI,CAAC,IAAI,WAAA,IAA8B,GACrC;EAEF,MAAM,OAAO,kBAAkB,GAAG;EAClC,MAAM,SAAS,KAAK,OAAO,UAAU,IAAI,CAAC;EAC1C,QAAQ,KAAK,IAAb;GACE,KAAK;IACH,QAAQ,OAAO,KAAK,uBAAuB,KAAK,QAAe,CAAC,CAAC;IACjE;GACF,KAAK,OAAO;IACV,MAAM,OAAO,kBAAkB,OAAO,GAAG,IAAI;IAC7C,KAAK,KAAK,SAAS;IACnB,OAAO,SAAS,IAAI;IACpB;GACF;GACA,KAAK;IACH,QACE,OAAO,KACL,qBAAqB,KAAK,UAAiB,KAAK,QAAe,CACjE,CACF;IACA;EACJ;CACF;AACF;;;;;AAMA,SAAS,kBACP,OACA,OACA,MACO;CACP,MAAM,SAAA,OAA+B,OAAO;CAC5C,MAAM,OAAc,CAAC;CACrB,KAAK,IAAI,IAAI,OAAO,IAAI,MAAM,QAAQ,KAAK;EACzC,MAAM,OAAO,MAAM;EACnB,IAAI,KAAK,OAAO,SAAS,CAAC,KAAK,IAAI,WAAW,MAAM,GAClD;EAEF,KAAK,KAAK,KAAK,QAAe;CAChC;CACA,OAAO;AACT"}

package/out/zero-client/src/client/mutator-proxy.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"mutator-proxy.d.ts","sourceRoot":"","sources":["../../../../../zero-client/src/client/mutator-proxy.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,UAAU,EAAC,MAAM,kBAAkB,CAAC;AAEjD,OAAO,KAAK,EAAC,iBAAiB,EAAC,MAAM,6BAA6B,CAAC;AAInE,OAAO,KAAK,EACV,iBAAiB,EAElB,MAAM,yBAAyB,CAAC;AAEjC,OAAO,KAAK,EACV,aAAa,EAGd,MAAM,aAAa,CAAC;AACrB,OAAO,EAAc,KAAK,SAAS,EAAC,MAAM,YAAY,CAAC;AACvD,OAAO,KAAK,EAAC,eAAe,EAAC,MAAM,uBAAuB,CAAC;AAuB3D,qBAAa,YAAY;;IAMvB,YACE,EAAE,EAAE,UAAU,EACd,iBAAiB,EAAE,iBAAiB,EACpC,eAAe,EAAE,eAAe,EAUjC;IAED,IAAI,sBAAsB,IAAI,SAAS,GAAG,SAAS,CAElD;IA0CD,iBAAiB,CACf,CAAC,SAAS,CAAC,GAAG,IAAI,EAAE,EAAE,GAAG,CAAC,iBAAiB,CAAC,KAAK;QAC/C,MAAM,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC;QACzB,MAAM,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC;KAC1B,EACD,IAAI,EAAE,MAAM,EAAE,CAAC,EAAE,CAAC,GAAG,CAAC,GAAG,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC,KAAK,aAAa,CA4E/D;CAgCF"}
+{"version":3,"file":"mutator-proxy.d.ts","sourceRoot":"","sources":["../../../../../zero-client/src/client/mutator-proxy.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,UAAU,EAAC,MAAM,kBAAkB,CAAC;AAGjD,OAAO,KAAK,EAAC,iBAAiB,EAAC,MAAM,6BAA6B,CAAC;AAInE,OAAO,KAAK,EACV,iBAAiB,EAElB,MAAM,yBAAyB,CAAC;AAEjC,OAAO,KAAK,EACV,aAAa,EAGd,MAAM,aAAa,CAAC;AACrB,OAAO,EAAc,KAAK,SAAS,EAAC,MAAM,YAAY,CAAC;AACvD,OAAO,KAAK,EAAC,eAAe,EAAC,MAAM,uBAAuB,CAAC;AAuB3D,qBAAa,YAAY;;IAMvB,YACE,EAAE,EAAE,UAAU,EACd,iBAAiB,EAAE,iBAAiB,EACpC,eAAe,EAAE,eAAe,EAUjC;IAED,IAAI,sBAAsB,IAAI,SAAS,GAAG,SAAS,CAElD;IA2CD,iBAAiB,CACf,CAAC,SAAS,CAAC,GAAG,IAAI,EAAE,EAAE,GAAG,CAAC,iBAAiB,CAAC,KAAK;QAC/C,MAAM,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC;QACzB,MAAM,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC;KAC1B,EACD,IAAI,EAAE,MAAM,EAAE,CAAC,EAAE,CAAC,GAAG,CAAC,GAAG,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC,KAAK,aAAa,CAuF/D;CAgCF"}

package/out/zero-client/src/client/mutator-proxy.js

@@ -1,6 +1,7 @@
 import { unreachable } from "../../../shared/src/asserts.js";
+import { getStorageFailure } from "../../../replicache/src/storage-failure.js";
 import { wrapWithApplicationError } from "../../../zero-protocol/src/application-error.js";
-import { Closed, Connected, Connecting, Disconnected, Error, NeedsAuth } from "./connection-status-enum.js";
+import { Closed, Connected, Connecting, Disconnected, Error, Initializing, NeedsAuth } from "./connection-status-enum.js";
 import { ClientClosed, Offline } from "./client-error-kind-enum.js";
 import { isZeroError } from "./error.js";
 //#region ../zero-client/src/client/mutator-proxy.ts
@@ -50,6 +51,7 @@ var MutatorProxy = class {
 				};
 				this.#mutationTracker.rejectAllOutstandingMutations(state.reason);
 				break;
+			case Initializing:
 			case Connected:
 			case Connecting:
 			case NeedsAuth:
@@ -80,7 +82,8 @@ var MutatorProxy = class {
 					return zeroErrorPromise;
 				}
 				const applicationError = wrapWithApplicationError(error);
-				this.#lc.error?.(`Mutator "${name}" app error on ${origin}`, applicationError);
+				if (getStorageFailure(error) === void 0) this.#lc.error?.(`Mutator "${name}" app error on ${origin}`, applicationError);
+				else this.#lc.warn?.(`Mutator "${name}" storage failure on ${origin}`, applicationError);
 				const applicationErrorPromise = this.#makeApplicationErrorResultDetails(applicationError);
 				cachedMutationPromises[origin] = applicationErrorPromise;
 				return applicationErrorPromise;

package/out/zero-client/src/client/mutator-proxy.js.map

@@ -1 +1 @@
-{"version":3,"file":"mutator-proxy.js","names":["#lc","#connectionManager","#mutationTracker","#onConnectionStateChange","#mutationRejection","#makeZeroErrorResultDetails","#makeApplicationErrorResultDetails","#normalizeResultPromise"],"sources":["../../../../../zero-client/src/client/mutator-proxy.ts"],"sourcesContent":["import type {LogContext} from '@rocicorp/logger';\nimport {unreachable} from '../../../shared/src/asserts.ts';\nimport type {ReadonlyJSONValue} from '../../../shared/src/json.ts';\nimport type {ApplicationError} from '../../../zero-protocol/src/application-error.ts';\nimport {wrapWithApplicationError} from '../../../zero-protocol/src/application-error.ts';\nimport {ClientErrorKind} from './client-error-kind.ts';\nimport type {\n  ConnectionManager,\n  ConnectionManagerState,\n} from './connection-manager.ts';\nimport {ConnectionStatus} from './connection-status.ts';\nimport type {\n  MutatorResult,\n  MutatorResultErrorDetails,\n  MutatorResultSuccessDetails,\n} from './custom.ts';\nimport {isZeroError, type ZeroError} from './error.ts';\nimport type {MutationTracker} from './mutation-tracker.ts';\n\nconst successResultDetails = {\n  type: 'success',\n} as const satisfies MutatorResultSuccessDetails;\nconst successResult = () => successResultDetails;\n\nfunction getStateDescription(error: ZeroError): string {\n  switch (error.kind) {\n    case ClientErrorKind.Offline:\n      return 'offline';\n    case ClientErrorKind.ClientClosed:\n      return 'closed';\n    default:\n      return 'in error state';\n  }\n}\n\ntype CachedMutationRejection = {\n  readonly error: ZeroError;\n  readonly promise: Promise<MutatorResultErrorDetails>;\n};\n\nexport class MutatorProxy {\n  readonly #lc: LogContext;\n  readonly #connectionManager: ConnectionManager;\n  readonly #mutationTracker: MutationTracker;\n  #mutationRejection: CachedMutationRejection | undefined;\n\n  constructor(\n    lc: LogContext,\n    connectionManager: ConnectionManager,\n    mutationTracker: MutationTracker,\n  ) {\n    this.#lc = lc;\n    this.#connectionManager = connectionManager;\n    this.#mutationTracker = mutationTracker;\n\n    this.#connectionManager.subscribe(state =>\n      this.#onConnectionStateChange(state),\n    );\n    this.#onConnectionStateChange(connectionManager.state);\n  }\n\n  get mutationRejectionError(): ZeroError | undefined {\n    return this.#mutationRejection?.error;\n  }\n\n  /**\n   * Called when the connection state changes.\n   *\n   * If the connection state is disconnected, error, or closed, the\n   * mutation rejection error is set and all outstanding `.server` promises in\n   * the mutation tracker are rejected with the error.\n   */\n  #onConnectionStateChange(state: ConnectionManagerState) {\n    // we short circuit the rejection if the error is due to a missing cacheURL\n    // this allows local writes to continue\n    if (\n      state.name === ConnectionStatus.Disconnected &&\n      state.reason.kind === ClientErrorKind.NoSocketOrigin\n    ) {\n      this.#mutationRejection = undefined;\n      return;\n    }\n\n    switch (state.name) {\n      case ConnectionStatus.Disconnected:\n      case ConnectionStatus.Error:\n      case ConnectionStatus.Closed:\n        this.#mutationRejection = {\n          error: state.reason,\n          promise: Promise.resolve(\n            this.#makeZeroErrorResultDetails(state.reason),\n          ),\n        };\n        this.#mutationTracker.rejectAllOutstandingMutations(state.reason);\n        break;\n      case ConnectionStatus.Connected:\n      case ConnectionStatus.Connecting:\n      case ConnectionStatus.NeedsAuth:\n        this.#mutationRejection = undefined;\n        return;\n      default:\n        unreachable(state);\n    }\n  }\n\n  wrapCustomMutator<\n    F extends (...args: [] | [ReadonlyJSONValue]) => {\n      client: Promise<unknown>;\n      server: Promise<unknown>;\n    },\n  >(name: string, f: F): (...args: Parameters<F>) => MutatorResult {\n    return (...args) => {\n      if (this.#mutationRejection) {\n        const error = this.#mutationRejection.error;\n        this.#lc.warn?.(\n          `Mutation \"${name}\" rejected because Zero is ${getStateDescription(error)}. Details: ${error.message}. See also: https://zero.rocicorp.dev/docs/connection.`,\n        );\n        return {\n          client: this.#mutationRejection.promise,\n          server: this.#mutationRejection.promise,\n        } as const satisfies MutatorResult;\n      }\n\n      let result: {\n        client: Promise<unknown>;\n        server: Promise<unknown>;\n      };\n\n      const cachedMutationPromises: Partial<\n        Record<'client' | 'server', Promise<MutatorResultErrorDetails>>\n      > = {};\n\n      const wrapErrorFor =\n        (origin: 'client' | 'server') =>\n        (error: unknown): Promise<MutatorResultErrorDetails> => {\n          const cachedPromise = cachedMutationPromises[origin];\n          if (cachedPromise) {\n            return cachedPromise;\n          }\n\n          if (isZeroError(error)) {\n            this.#lc.error?.(`Mutator \"${name}\" error on ${origin}`, error);\n\n            const zeroErrorPromise = this.#makeZeroErrorResultDetails(error);\n            cachedMutationPromises[origin] = zeroErrorPromise;\n            return zeroErrorPromise;\n          }\n\n          const applicationError = wrapWithApplicationError(error);\n          this.#lc.error?.(\n            `Mutator \"${name}\" app error on ${origin}`,\n            applicationError,\n          );\n\n          const applicationErrorPromise =\n            this.#makeApplicationErrorResultDetails(applicationError);\n          cachedMutationPromises[origin] = applicationErrorPromise;\n          return applicationErrorPromise;\n        };\n\n      try {\n        result = f(...args);\n      } catch (error) {\n        const clientPromise = wrapErrorFor('client')(error);\n        const serverPromise = wrapErrorFor('server')(error);\n\n        return {\n          client: clientPromise,\n          server: serverPromise,\n        } as const satisfies MutatorResult;\n      }\n\n      const client = this.#normalizeResultPromise(\n        result.client,\n        wrapErrorFor('client'),\n      );\n      const server = this.#normalizeResultPromise(\n        result.server,\n        wrapErrorFor('server'),\n      );\n\n      return {\n        client,\n        server,\n      };\n    };\n  }\n\n  #normalizeResultPromise(\n    promise: Promise<unknown>,\n    wrapError: (error: unknown) => Promise<MutatorResultErrorDetails>,\n  ) {\n    return promise.then<MutatorResultSuccessDetails, MutatorResultErrorDetails>(\n      successResult,\n      wrapError,\n    );\n  }\n\n  #makeZeroErrorResultDetails(zeroError: ZeroError) {\n    return Promise.resolve({\n      type: 'error',\n      error: {\n        type: 'zero',\n        message: zeroError.message,\n      },\n    } as const satisfies MutatorResultErrorDetails);\n  }\n\n  #makeApplicationErrorResultDetails(applicationError: ApplicationError) {\n    return Promise.resolve({\n      type: 'error',\n      error: {\n        type: 'app',\n        message: applicationError.message,\n        details: applicationError.details,\n      },\n    } as const satisfies MutatorResultErrorDetails);\n  }\n}\n"],"mappings":";;;;;;AAmBA,IAAM,uBAAuB,EAC3B,MAAM,UACR;AACA,IAAM,sBAAsB;AAE5B,SAAS,oBAAoB,OAA0B;CACrD,QAAQ,MAAM,MAAd;EACE,KAAK,SACH,OAAO;EACT,KAAK,cACH,OAAO;EACT,SACE,OAAO;CACX;AACF;AAOA,IAAa,eAAb,MAA0B;CACxB;CACA;CACA;CACA;CAEA,YACE,IACA,mBACA,iBACA;EACA,KAAKA,MAAM;EACX,KAAKC,qBAAqB;EAC1B,KAAKC,mBAAmB;EAExB,KAAKD,mBAAmB,WAAU,UAChC,KAAKE,yBAAyB,KAAK,CACrC;EACA,KAAKA,yBAAyB,kBAAkB,KAAK;CACvD;CAEA,IAAI,yBAAgD;EAClD,OAAO,KAAKC,oBAAoB;CAClC;;;;;;;;CASA,yBAAyB,OAA+B;EAGtD,IACE,MAAM,SAAS,kBACf,MAAM,OAAO,SAAS,kBACtB;GACA,KAAKA,qBAAqB,KAAA;GAC1B;EACF;EAEA,QAAQ,MAAM,MAAd;GACE,KAAK;GACL,KAAK;GACL,KAAK;IACH,KAAKA,qBAAqB;KACxB,OAAO,MAAM;KACb,SAAS,QAAQ,QACf,KAAKC,4BAA4B,MAAM,MAAM,CAC/C;IACF;IACA,KAAKH,iBAAiB,8BAA8B,MAAM,MAAM;IAChE;GACF,KAAK;GACL,KAAK;GACL,KAAK;IACH,KAAKE,qBAAqB,KAAA;IAC1B;GACF,SACE,YAAY,KAAK;EACrB;CACF;CAEA,kBAKE,MAAc,GAAiD;EAC/D,QAAQ,GAAG,SAAS;GAClB,IAAI,KAAKA,oBAAoB;IAC3B,MAAM,QAAQ,KAAKA,mBAAmB;IACtC,KAAKJ,IAAI,OACP,aAAa,KAAK,6BAA6B,oBAAoB,KAAK,EAAE,aAAa,MAAM,QAAQ,uDACvG;IACA,OAAO;KACL,QAAQ,KAAKI,mBAAmB;KAChC,QAAQ,KAAKA,mBAAmB;IAClC;GACF;GAEA,IAAI;GAKJ,MAAM,yBAEF,CAAC;GAEL,MAAM,gBACH,YACA,UAAuD;IACtD,MAAM,gBAAgB,uBAAuB;IAC7C,IAAI,eACF,OAAO;IAGT,IAAI,YAAY,KAAK,GAAG;KACtB,KAAKJ,IAAI,QAAQ,YAAY,KAAK,aAAa,UAAU,KAAK;KAE9D,MAAM,mBAAmB,KAAKK,4BAA4B,KAAK;KAC/D,uBAAuB,UAAU;KACjC,OAAO;IACT;IAEA,MAAM,mBAAmB,yBAAyB,KAAK;IACvD,KAAKL,IAAI,QACP,YAAY,KAAK,iBAAiB,UAClC,gBACF;IAEA,MAAM,0BACJ,KAAKM,mCAAmC,gBAAgB;IAC1D,uBAAuB,UAAU;IACjC,OAAO;GACT;GAEF,IAAI;IACF,SAAS,EAAE,GAAG,IAAI;GACpB,SAAS,OAAO;IAId,OAAO;KACL,QAJoB,aAAa,QAAQ,EAAE,KAInC;KACR,QAJoB,aAAa,QAAQ,EAAE,KAInC;IACV;GACF;GAWA,OAAO;IACL,QAVa,KAAKC,wBAClB,OAAO,QACP,aAAa,QAAQ,CAQrB;IACA,QAPa,KAAKA,wBAClB,OAAO,QACP,aAAa,QAAQ,CAKrB;GACF;EACF;CACF;CAEA,wBACE,SACA,WACA;EACA,OAAO,QAAQ,KACb,eACA,SACF;CACF;CAEA,4BAA4B,WAAsB;EAChD,OAAO,QAAQ,QAAQ;GACrB,MAAM;GACN,OAAO;IACL,MAAM;IACN,SAAS,UAAU;GACrB;EACF,CAA8C;CAChD;CAEA,mCAAmC,kBAAoC;EACrE,OAAO,QAAQ,QAAQ;GACrB,MAAM;GACN,OAAO;IACL,MAAM;IACN,SAAS,iBAAiB;IAC1B,SAAS,iBAAiB;GAC5B;EACF,CAA8C;CAChD;AACF"}
+{"version":3,"file":"mutator-proxy.js","names":["#lc","#connectionManager","#mutationTracker","#onConnectionStateChange","#mutationRejection","#makeZeroErrorResultDetails","#makeApplicationErrorResultDetails","#normalizeResultPromise"],"sources":["../../../../../zero-client/src/client/mutator-proxy.ts"],"sourcesContent":["import type {LogContext} from '@rocicorp/logger';\nimport {getStorageFailure} from '../../../replicache/src/storage-failure.ts';\nimport {unreachable} from '../../../shared/src/asserts.ts';\nimport type {ReadonlyJSONValue} from '../../../shared/src/json.ts';\nimport type {ApplicationError} from '../../../zero-protocol/src/application-error.ts';\nimport {wrapWithApplicationError} from '../../../zero-protocol/src/application-error.ts';\nimport {ClientErrorKind} from './client-error-kind.ts';\nimport type {\n  ConnectionManager,\n  ConnectionManagerState,\n} from './connection-manager.ts';\nimport {ConnectionStatus} from './connection-status.ts';\nimport type {\n  MutatorResult,\n  MutatorResultErrorDetails,\n  MutatorResultSuccessDetails,\n} from './custom.ts';\nimport {isZeroError, type ZeroError} from './error.ts';\nimport type {MutationTracker} from './mutation-tracker.ts';\n\nconst successResultDetails = {\n  type: 'success',\n} as const satisfies MutatorResultSuccessDetails;\nconst successResult = () => successResultDetails;\n\nfunction getStateDescription(error: ZeroError): string {\n  switch (error.kind) {\n    case ClientErrorKind.Offline:\n      return 'offline';\n    case ClientErrorKind.ClientClosed:\n      return 'closed';\n    default:\n      return 'in error state';\n  }\n}\n\ntype CachedMutationRejection = {\n  readonly error: ZeroError;\n  readonly promise: Promise<MutatorResultErrorDetails>;\n};\n\nexport class MutatorProxy {\n  readonly #lc: LogContext;\n  readonly #connectionManager: ConnectionManager;\n  readonly #mutationTracker: MutationTracker;\n  #mutationRejection: CachedMutationRejection | undefined;\n\n  constructor(\n    lc: LogContext,\n    connectionManager: ConnectionManager,\n    mutationTracker: MutationTracker,\n  ) {\n    this.#lc = lc;\n    this.#connectionManager = connectionManager;\n    this.#mutationTracker = mutationTracker;\n\n    this.#connectionManager.subscribe(state =>\n      this.#onConnectionStateChange(state),\n    );\n    this.#onConnectionStateChange(connectionManager.state);\n  }\n\n  get mutationRejectionError(): ZeroError | undefined {\n    return this.#mutationRejection?.error;\n  }\n\n  /**\n   * Called when the connection state changes.\n   *\n   * If the connection state is disconnected, error, or closed, the\n   * mutation rejection error is set and all outstanding `.server` promises in\n   * the mutation tracker are rejected with the error.\n   */\n  #onConnectionStateChange(state: ConnectionManagerState) {\n    // we short circuit the rejection if the error is due to a missing cacheURL\n    // this allows local writes to continue\n    if (\n      state.name === ConnectionStatus.Disconnected &&\n      state.reason.kind === ClientErrorKind.NoSocketOrigin\n    ) {\n      this.#mutationRejection = undefined;\n      return;\n    }\n\n    switch (state.name) {\n      case ConnectionStatus.Disconnected:\n      case ConnectionStatus.Error:\n      case ConnectionStatus.Closed:\n        this.#mutationRejection = {\n          error: state.reason,\n          promise: Promise.resolve(\n            this.#makeZeroErrorResultDetails(state.reason),\n          ),\n        };\n        this.#mutationTracker.rejectAllOutstandingMutations(state.reason);\n        break;\n      case ConnectionStatus.Initializing:\n      case ConnectionStatus.Connected:\n      case ConnectionStatus.Connecting:\n      case ConnectionStatus.NeedsAuth:\n        this.#mutationRejection = undefined;\n        return;\n      default:\n        unreachable(state);\n    }\n  }\n\n  wrapCustomMutator<\n    F extends (...args: [] | [ReadonlyJSONValue]) => {\n      client: Promise<unknown>;\n      server: Promise<unknown>;\n    },\n  >(name: string, f: F): (...args: Parameters<F>) => MutatorResult {\n    return (...args) => {\n      if (this.#mutationRejection) {\n        const error = this.#mutationRejection.error;\n        this.#lc.warn?.(\n          `Mutation \"${name}\" rejected because Zero is ${getStateDescription(error)}. Details: ${error.message}. See also: https://zero.rocicorp.dev/docs/connection.`,\n        );\n        return {\n          client: this.#mutationRejection.promise,\n          server: this.#mutationRejection.promise,\n        } as const satisfies MutatorResult;\n      }\n\n      let result: {\n        client: Promise<unknown>;\n        server: Promise<unknown>;\n      };\n\n      const cachedMutationPromises: Partial<\n        Record<'client' | 'server', Promise<MutatorResultErrorDetails>>\n      > = {};\n\n      const wrapErrorFor =\n        (origin: 'client' | 'server') =>\n        (error: unknown): Promise<MutatorResultErrorDetails> => {\n          const cachedPromise = cachedMutationPromises[origin];\n          if (cachedPromise) {\n            return cachedPromise;\n          }\n\n          if (isZeroError(error)) {\n            this.#lc.error?.(`Mutator \"${name}\" error on ${origin}`, error);\n\n            const zeroErrorPromise = this.#makeZeroErrorResultDetails(error);\n            cachedMutationPromises[origin] = zeroErrorPromise;\n            return zeroErrorPromise;\n          }\n\n          const applicationError = wrapWithApplicationError(error);\n          if (getStorageFailure(error) === undefined) {\n            this.#lc.error?.(\n              `Mutator \"${name}\" app error on ${origin}`,\n              applicationError,\n            );\n          } else {\n            // The local store's storage failed under the mutation. That is\n            // the device's condition, reported once through\n            // `onStorageFailure`, not the app's mutator throwing and not a\n            // developer's to fix.\n            this.#lc.warn?.(\n              `Mutator \"${name}\" storage failure on ${origin}`,\n              applicationError,\n            );\n          }\n\n          const applicationErrorPromise =\n            this.#makeApplicationErrorResultDetails(applicationError);\n          cachedMutationPromises[origin] = applicationErrorPromise;\n          return applicationErrorPromise;\n        };\n\n      try {\n        result = f(...args);\n      } catch (error) {\n        const clientPromise = wrapErrorFor('client')(error);\n        const serverPromise = wrapErrorFor('server')(error);\n\n        return {\n          client: clientPromise,\n          server: serverPromise,\n        } as const satisfies MutatorResult;\n      }\n\n      const client = this.#normalizeResultPromise(\n        result.client,\n        wrapErrorFor('client'),\n      );\n      const server = this.#normalizeResultPromise(\n        result.server,\n        wrapErrorFor('server'),\n      );\n\n      return {\n        client,\n        server,\n      };\n    };\n  }\n\n  #normalizeResultPromise(\n    promise: Promise<unknown>,\n    wrapError: (error: unknown) => Promise<MutatorResultErrorDetails>,\n  ) {\n    return promise.then<MutatorResultSuccessDetails, MutatorResultErrorDetails>(\n      successResult,\n      wrapError,\n    );\n  }\n\n  #makeZeroErrorResultDetails(zeroError: ZeroError) {\n    return Promise.resolve({\n      type: 'error',\n      error: {\n        type: 'zero',\n        message: zeroError.message,\n      },\n    } as const satisfies MutatorResultErrorDetails);\n  }\n\n  #makeApplicationErrorResultDetails(applicationError: ApplicationError) {\n    return Promise.resolve({\n      type: 'error',\n      error: {\n        type: 'app',\n        message: applicationError.message,\n        details: applicationError.details,\n      },\n    } as const satisfies MutatorResultErrorDetails);\n  }\n}\n"],"mappings":";;;;;;;AAoBA,IAAM,uBAAuB,EAC3B,MAAM,UACR;AACA,IAAM,sBAAsB;AAE5B,SAAS,oBAAoB,OAA0B;CACrD,QAAQ,MAAM,MAAd;EACE,KAAK,SACH,OAAO;EACT,KAAK,cACH,OAAO;EACT,SACE,OAAO;CACX;AACF;AAOA,IAAa,eAAb,MAA0B;CACxB;CACA;CACA;CACA;CAEA,YACE,IACA,mBACA,iBACA;EACA,KAAKA,MAAM;EACX,KAAKC,qBAAqB;EAC1B,KAAKC,mBAAmB;EAExB,KAAKD,mBAAmB,WAAU,UAChC,KAAKE,yBAAyB,KAAK,CACrC;EACA,KAAKA,yBAAyB,kBAAkB,KAAK;CACvD;CAEA,IAAI,yBAAgD;EAClD,OAAO,KAAKC,oBAAoB;CAClC;;;;;;;;CASA,yBAAyB,OAA+B;EAGtD,IACE,MAAM,SAAS,kBACf,MAAM,OAAO,SAAS,kBACtB;GACA,KAAKA,qBAAqB,KAAA;GAC1B;EACF;EAEA,QAAQ,MAAM,MAAd;GACE,KAAK;GACL,KAAK;GACL,KAAK;IACH,KAAKA,qBAAqB;KACxB,OAAO,MAAM;KACb,SAAS,QAAQ,QACf,KAAKC,4BAA4B,MAAM,MAAM,CAC/C;IACF;IACA,KAAKH,iBAAiB,8BAA8B,MAAM,MAAM;IAChE;GACF,KAAK;GACL,KAAK;GACL,KAAK;GACL,KAAK;IACH,KAAKE,qBAAqB,KAAA;IAC1B;GACF,SACE,YAAY,KAAK;EACrB;CACF;CAEA,kBAKE,MAAc,GAAiD;EAC/D,QAAQ,GAAG,SAAS;GAClB,IAAI,KAAKA,oBAAoB;IAC3B,MAAM,QAAQ,KAAKA,mBAAmB;IACtC,KAAKJ,IAAI,OACP,aAAa,KAAK,6BAA6B,oBAAoB,KAAK,EAAE,aAAa,MAAM,QAAQ,uDACvG;IACA,OAAO;KACL,QAAQ,KAAKI,mBAAmB;KAChC,QAAQ,KAAKA,mBAAmB;IAClC;GACF;GAEA,IAAI;GAKJ,MAAM,yBAEF,CAAC;GAEL,MAAM,gBACH,YACA,UAAuD;IACtD,MAAM,gBAAgB,uBAAuB;IAC7C,IAAI,eACF,OAAO;IAGT,IAAI,YAAY,KAAK,GAAG;KACtB,KAAKJ,IAAI,QAAQ,YAAY,KAAK,aAAa,UAAU,KAAK;KAE9D,MAAM,mBAAmB,KAAKK,4BAA4B,KAAK;KAC/D,uBAAuB,UAAU;KACjC,OAAO;IACT;IAEA,MAAM,mBAAmB,yBAAyB,KAAK;IACvD,IAAI,kBAAkB,KAAK,MAAM,KAAA,GAC/B,KAAKL,IAAI,QACP,YAAY,KAAK,iBAAiB,UAClC,gBACF;SAMA,KAAKA,IAAI,OACP,YAAY,KAAK,uBAAuB,UACxC,gBACF;IAGF,MAAM,0BACJ,KAAKM,mCAAmC,gBAAgB;IAC1D,uBAAuB,UAAU;IACjC,OAAO;GACT;GAEF,IAAI;IACF,SAAS,EAAE,GAAG,IAAI;GACpB,SAAS,OAAO;IAId,OAAO;KACL,QAJoB,aAAa,QAAQ,EAAE,KAInC;KACR,QAJoB,aAAa,QAAQ,EAAE,KAInC;IACV;GACF;GAWA,OAAO;IACL,QAVa,KAAKC,wBAClB,OAAO,QACP,aAAa,QAAQ,CAQrB;IACA,QAPa,KAAKA,wBAClB,OAAO,QACP,aAAa,QAAQ,CAKrB;GACF;EACF;CACF;CAEA,wBACE,SACA,WACA;EACA,OAAO,QAAQ,KACb,eACA,SACF;CACF;CAEA,4BAA4B,WAAsB;EAChD,OAAO,QAAQ,QAAQ;GACrB,MAAM;GACN,OAAO;IACL,MAAM;IACN,SAAS,UAAU;GACrB;EACF,CAA8C;CAChD;CAEA,mCAAmC,kBAAoC;EACrE,OAAO,QAAQ,QAAQ;GACrB,MAAM;GACN,OAAO;IACL,MAAM;IACN,SAAS,iBAAiB;IAC1B,SAAS,iBAAiB;GAC5B;EACF,CAA8C;CAChD;AACF"}

package/out/zero-client/src/client/options.d.ts

@@ -1,5 +1,6 @@
 import type { LogLevel, LogSink } from '@rocicorp/logger';
 import type { StoreProvider } from '../../../replicache/src/kv/store.ts';
+import type { StorageFailureError } from '../../../replicache/src/storage-failure.ts';
 import * as v from '../../../shared/src/valita.ts';
 import type { BaseDefaultContext, BaseDefaultSchema, DefaultContext, DefaultSchema } from '../../../zero-types/src/default-types.ts';
 import type { AnyMutatorRegistry } from '../../../zql/src/mutate/mutator-registry.ts';
@@ -213,6 +214,9 @@ export type ZeroOptions<S extends BaseDefaultSchema = DefaultSchema, MD extends
      * - the local persistent synchronization state has been garbage collected.
      *   This can happen if the client has no pending mutations and has not been
      *   used for a while (e.g. the client's tab has been hidden for a long time).
+     * - the local persistent synchronization state was found to be corrupt.
+     *   Replicache tries to drop the local database so that a reload starts
+     *   fresh. The callback is called even if that fails.
      * - zero-cache fails to find the server side synchronization state for
      *   this client.
      * - zero-cache rejects this client's persisted synchronization state,
@@ -228,6 +232,35 @@ export type ZeroOptions<S extends BaseDefaultSchema = DefaultSchema, MD extends
      * Provide your own function to prevent this functionality.
      */
     onClientStateNotFound?: (() => void) | undefined;
+    /**
+     * `onStorageFailure` is called once, the first time the local persistent
+     * store reports that its storage has failed rather than its data, with the
+     * {@link StorageFailureError} it threw: the device is out of space
+     * (`full`), the database cannot be opened (`cannot-open`, including an
+     * IndexedDB that fails to open), or a read or write to it failed
+     * (`io-error`).
+     *
+     * A failure while this `Zero` instance is opening runs it on memory for the
+     * session, as with `kvStore: 'mem'`: nothing is written to disk. A failure
+     * after that stops persisting locally: queries and mutations keep running
+     * against what the in-memory dag holds, and mutations keep pushing to
+     * zero-cache, but nothing is written to disk until a new instance is
+     * created; a read that needs a chunk not yet loaded
+     * from the store (or since evicted from the in-memory cache) still fails
+     * the way any store read does, and is reported here too, whichever caller
+     * made it. An invalid ref count seen while the store is
+     * failing with `cannot-open` or `io-error` is not treated as corruption, so
+     * {@link onClientStateNotFound} is not called for it: a store that cannot
+     * complete its reads and writes produces such readings without the data
+     * being corrupt, and dropping the database would rebuild onto the same
+     * failing storage. A `full` disk keeps the drop, since deleting the database
+     * is also what frees the space.
+     *
+     * The default behavior is to log the failure and nothing else. Provide a
+     * function to show the user what to do — free up space, or restart the
+     * app once the storage is available again.
+     */
+    onStorageFailure?: ((failure: StorageFailureError) => void) | undefined;
     /**
      * The number of milliseconds to wait before disconnecting a Zero
      * instance whose tab has become hidden.

package/out/zero-client/src/client/options.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"options.d.ts","sourceRoot":"","sources":["../../../../../zero-client/src/client/options.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,QAAQ,EAAE,OAAO,EAAC,MAAM,kBAAkB,CAAC;AACxD,OAAO,KAAK,EAAC,aAAa,EAAC,MAAM,qCAAqC,CAAC;AACvE,OAAO,KAAK,CAAC,MAAM,+BAA+B,CAAC;AACnD,OAAO,KAAK,EACV,kBAAkB,EAClB,iBAAiB,EACjB,cAAc,EACd,aAAa,EACd,MAAM,0CAA0C,CAAC;AAClD,OAAO,KAAK,EAAC,kBAAkB,EAAC,MAAM,6CAA6C,CAAC;AACpF,OAAO,KAAK,EAAC,iBAAiB,EAAC,MAAM,aAAa,CAAC;AACnD,OAAO,EAAC,sBAAsB,EAAC,MAAM,gCAAgC,CAAC;AAEtE;;GAEG;AACH,MAAM,MAAM,WAAW,CACrB,CAAC,SAAS,iBAAiB,GAAG,aAAa,EAC3C,EAAE,SAAS,iBAAiB,GAAG,SAAS,GAAG,SAAS,EACpD,CAAC,SAAS,kBAAkB,GAAG,cAAc,IAC3C;IACF;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;IAErC;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;IAEnC;;;;;;;;;;;;;;;;;OAiBG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;IAEjC;;;;;;;OAOG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;IAEnC;;;;;OAKG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAEhC;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,EAAE,QAAQ,GAAG,SAAS,CAAC;IAEhC;;;;;;;;;;OAUG;IACH,OAAO,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAE9B;;;OAGG;IACH,MAAM,EAAE,CAAC,CAAC;IAEV;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAuCG;IACH,QAAQ,CAAC,EAAE,EAAE,SAAS,iBAAiB,GAAG,EAAE,GAAG,kBAAkB,GAAG,SAAS,CAAC;IAE9E;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAE/B;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,SAAS,CAAC;IAEnD;;;;;OAKG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAEnC;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAE9B;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,SAAS,CAAC;IAElD;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,cAAc,CAAC,EAAE,CAAC,MAAM,MAAM,GAAG,SAAS,CAAC,GAAG,SAAS,CAAC;IAExD;;;;;;;;;;;;OAYG;IACH,cAAc,CAAC,EAAE,CAAC,CAAC,MAAM,EAAE,OAAO,KAAK,IAAI,CAAC,GAAG,SAAS,CAAC;IAEzD;;;;;;;;;;OAUG;IACH,cAAc,CAAC,EAAE,CAAC,CAAC,MAAM,EAAE,kBAAkB,KAAK,IAAI,CAAC,GAAG,SAAS,CAAC;IAEpE;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,qBAAqB,CAAC,EAAE,CAAC,MAAM,IAAI,CAAC,GAAG,SAAS,CAAC;IAEjD;;;;;;;OAOG;IACH,wBAAwB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAE9C;;;;;OAKG;IACH,mBAAmB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAEzC;;;;;;;;OAQG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAEnC;;;;;;;;;;;;OAYG;IACH,OAAO,CAAC,EAAE,KAAK,GAAG,KAAK,GAAG,aAAa,GAAG,SAAS,CAAC;IAEpD;;;;;;;;;OASG;IACH,eAAe,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAErC;;;;;;OAMG;IACH,wBAAwB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAE9C;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,gBAAgB,CAAC,EAAE,CAAC,CAAC,gBAAgB,EAAE,MAAM,IAAI,KAAK,IAAI,CAAC,GAAG,SAAS,CAAC;IAExE;;;;;;;OAOG;IACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAEtC;;;;;OAKG;IACH,qBAAqB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAE3C;;OAEG;IACH,OAAO,CAAC,EAAE,CAAC,GAAG,SAAS,CAAC;CACzB,GAAG,CAAC,OAAO,SAAS,cAAc,GAC/B,EAAE,GACF;IACE,OAAO,EAAE,CAAC,CAAC;CACZ,CAAC,CAAC;AAEP;;GAEG;AACH,MAAM,MAAM,mBAAmB,CAC7B,CAAC,SAAS,iBAAiB,EAC3B,EAAE,SAAS,iBAAiB,GAAG,SAAS,EACxC,OAAO,SAAS,kBAAkB,IAChC,WAAW,CAAC,CAAC,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;AAEhC,KAAK,sBAAsB,GAAG;IAC5B,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF,MAAM,MAAM,kBAAkB,GAC1B,CAAC;IAAC,IAAI,EAAE,sBAAsB,CAAC,cAAc,CAAA;CAAC,GAAG,sBAAsB,CAAC,GACxE,CAAC;IACC,IAAI,EAAE,sBAAsB,CAAC,mBAAmB,CAAC;CAClD,GAAG,sBAAsB,CAAC,GAC3B,CAAC;IACC,IAAI,EAAE,sBAAsB,CAAC,yBAAyB,CAAC;CACxD,GAAG,sBAAsB,CAAC,CAAC;AAEhC,eAAO,MAAM,4BAA4B,EAAE,CAAC,CAAC,IAAI,CAAC,kBAAkB,CAAC,MAAM,CAAC,CAKzE,CAAC"}
+{"version":3,"file":"options.d.ts","sourceRoot":"","sources":["../../../../../zero-client/src/client/options.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,QAAQ,EAAE,OAAO,EAAC,MAAM,kBAAkB,CAAC;AACxD,OAAO,KAAK,EAAC,aAAa,EAAC,MAAM,qCAAqC,CAAC;AACvE,OAAO,KAAK,EAAC,mBAAmB,EAAC,MAAM,4CAA4C,CAAC;AACpF,OAAO,KAAK,CAAC,MAAM,+BAA+B,CAAC;AACnD,OAAO,KAAK,EACV,kBAAkB,EAClB,iBAAiB,EACjB,cAAc,EACd,aAAa,EACd,MAAM,0CAA0C,CAAC;AAClD,OAAO,KAAK,EAAC,kBAAkB,EAAC,MAAM,6CAA6C,CAAC;AACpF,OAAO,KAAK,EAAC,iBAAiB,EAAC,MAAM,aAAa,CAAC;AACnD,OAAO,EAAC,sBAAsB,EAAC,MAAM,gCAAgC,CAAC;AAEtE;;GAEG;AACH,MAAM,MAAM,WAAW,CACrB,CAAC,SAAS,iBAAiB,GAAG,aAAa,EAC3C,EAAE,SAAS,iBAAiB,GAAG,SAAS,GAAG,SAAS,EACpD,CAAC,SAAS,kBAAkB,GAAG,cAAc,IAC3C;IACF;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;IAErC;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;IAEnC;;;;;;;;;;;;;;;;;OAiBG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;IAEjC;;;;;;;OAOG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;IAEnC;;;;;OAKG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAEhC;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,EAAE,QAAQ,GAAG,SAAS,CAAC;IAEhC;;;;;;;;;;OAUG;IACH,OAAO,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAE9B;;;OAGG;IACH,MAAM,EAAE,CAAC,CAAC;IAEV;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAuCG;IACH,QAAQ,CAAC,EAAE,EAAE,SAAS,iBAAiB,GAAG,EAAE,GAAG,kBAAkB,GAAG,SAAS,CAAC;IAE9E;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAE/B;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,SAAS,CAAC;IAEnD;;;;;OAKG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAEnC;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAE9B;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,SAAS,CAAC;IAElD;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,cAAc,CAAC,EAAE,CAAC,MAAM,MAAM,GAAG,SAAS,CAAC,GAAG,SAAS,CAAC;IAExD;;;;;;;;;;;;OAYG;IACH,cAAc,CAAC,EAAE,CAAC,CAAC,MAAM,EAAE,OAAO,KAAK,IAAI,CAAC,GAAG,SAAS,CAAC;IAEzD;;;;;;;;;;OAUG;IACH,cAAc,CAAC,EAAE,CAAC,CAAC,MAAM,EAAE,kBAAkB,KAAK,IAAI,CAAC,GAAG,SAAS,CAAC;IAEpE;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,qBAAqB,CAAC,EAAE,CAAC,MAAM,IAAI,CAAC,GAAG,SAAS,CAAC;IAEjD;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACH,gBAAgB,CAAC,EAAE,CAAC,CAAC,OAAO,EAAE,mBAAmB,KAAK,IAAI,CAAC,GAAG,SAAS,CAAC;IAExE;;;;;;;OAOG;IACH,wBAAwB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAE9C;;;;;OAKG;IACH,mBAAmB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAEzC;;;;;;;;OAQG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAEnC;;;;;;;;;;;;OAYG;IACH,OAAO,CAAC,EAAE,KAAK,GAAG,KAAK,GAAG,aAAa,GAAG,SAAS,CAAC;IAEpD;;;;;;;;;OASG;IACH,eAAe,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAErC;;;;;;OAMG;IACH,wBAAwB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAE9C;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,gBAAgB,CAAC,EAAE,CAAC,CAAC,gBAAgB,EAAE,MAAM,IAAI,KAAK,IAAI,CAAC,GAAG,SAAS,CAAC;IAExE;;;;;;;OAOG;IACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAEtC;;;;;OAKG;IACH,qBAAqB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAE3C;;OAEG;IACH,OAAO,CAAC,EAAE,CAAC,GAAG,SAAS,CAAC;CACzB,GAAG,CAAC,OAAO,SAAS,cAAc,GAC/B,EAAE,GACF;IACE,OAAO,EAAE,CAAC,CAAC;CACZ,CAAC,CAAC;AAEP;;GAEG;AACH,MAAM,MAAM,mBAAmB,CAC7B,CAAC,SAAS,iBAAiB,EAC3B,EAAE,SAAS,iBAAiB,GAAG,SAAS,EACxC,OAAO,SAAS,kBAAkB,IAChC,WAAW,CAAC,CAAC,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;AAEhC,KAAK,sBAAsB,GAAG;IAC5B,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF,MAAM,MAAM,kBAAkB,GAC1B,CAAC;IAAC,IAAI,EAAE,sBAAsB,CAAC,cAAc,CAAA;CAAC,GAAG,sBAAsB,CAAC,GACxE,CAAC;IACC,IAAI,EAAE,sBAAsB,CAAC,mBAAmB,CAAC;CAClD,GAAG,sBAAsB,CAAC,GAC3B,CAAC;IACC,IAAI,EAAE,sBAAsB,CAAC,yBAAyB,CAAC;CACxD,GAAG,sBAAsB,CAAC,CAAC;AAEhC,eAAO,MAAM,4BAA4B,EAAE,CAAC,CAAC,IAAI,CAAC,kBAAkB,CAAC,MAAM,CAAC,CAKzE,CAAC"}