@rocicorp/zero 1.11.0-canary.0 → 1.11.0-canary.10

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

@@ -4,14 +4,13 @@ import { AbortError } from "../../../shared/src/abort-error.js";
 import { sleep, sleepWithAbort } from "../../../shared/src/sleep.js";
 import { parse } from "../../../shared/src/valita.js";
 import "../../../replicache/src/deleted-clients.js";
-import { localNavigator } from "../../../shared/src/navigator.js";
 import { getKVStoreProvider } from "../../../replicache/src/get-kv-store-provider.js";
 import { IDBDatabasesStore } from "../../../replicache/src/persist/idb-databases-store.js";
 import { dropDatabase } from "../../../replicache/src/persist/collect-idb-databases.js";
 import { must } from "../../../shared/src/must.js";
 import { clientToServer } from "../../../zero-schema/src/name-mapper.js";
 import { h64 } from "../../../shared/src/hash.js";
-import { getErrorMessage } from "../../../shared/src/error.js";
+import { getErrorCauses, getErrorMessage } from "../../../shared/src/error.js";
 import { ClientNotFound, InvalidMessage } from "../../../zero-protocol/src/error-kind-enum.js";
 import { ProtocolError } from "../../../zero-protocol/src/error.js";
 import "../../../zero-protocol/src/client-schema.js";
@@ -20,10 +19,11 @@ import { isMutatorRegistry, iterateMutators } from "../../../zql/src/mutate/muta
 import { createRunnableBuilder } from "../../../zql/src/query/create-builder.js";
 import "../../../zql/src/query/query.js";
 import { addContextToQuery } from "../../../zql/src/query/query-registry.js";
-import { Closed, Connected, Connecting, Disconnected, Error as Error$1, NeedsAuth } from "./connection-status-enum.js";
+import { Closed, Connected, Connecting, Disconnected, Error as Error$1, Initializing, NeedsAuth } from "./connection-status-enum.js";
 import { getDocumentVisibilityWatcher } from "../../../shared/src/document-visible.js";
 import { ReplicacheImpl } from "../../../replicache/src/replicache-impl.js";
 import "../../../replicache/src/impl.js";
+import { localNavigator } from "../../../shared/src/navigator.js";
 import { promiseRace } from "../../../shared/src/promise-race.js";
 import { emptyFunction } from "../../../shared/src/sentinels.js";
 import { Subscribable } from "../../../shared/src/subscribable.js";
@@ -38,7 +38,7 @@ import { isClientMetric } from "../../../zql/src/query/metrics-delegate.js";
 import { nanoid } from "../util/nanoid.js";
 import { ActiveClientsManager } from "./active-clients-manager.js";
 import { AbruptClose, CleanClose, ClientClosed, ConnectTimeout, Hidden, Internal, InvalidMessage as InvalidMessage$1, NoSocketOrigin, PingTimeout, PullTimeout, UnexpectedBaseCookie } from "./client-error-kind-enum.js";
-import { ClientError, NO_STATUS_TRANSITION, getBackoffParams, getErrorConnectionTransition, isAuthError, isClientError, isServerError, isZeroError } from "./error.js";
+import { ClientError, NO_STATUS_TRANSITION, getBackoffParams, getErrorConnectionTransition, isClientError, isServerError, isZeroError } from "./error.js";
 import { ConnectionManager, throwIfConnectionError } from "./connection-manager.js";
 import { ConnectionImpl } from "./connection.js";
 import { IVMSourceBranch } from "./ivm-branch.js";
@@ -90,6 +90,11 @@ var DEFAULT_DISCONNECT_TIMEOUT_MS = 60 * 1e3;
 * consider it timed out.
 */
 var CONNECT_TIMEOUT_MS = 1e4;
+/**
+* Setting up active-client tracking blocks the first connect attempt. Above
+* this, say so.
+*/
+var SLOW_ACTIVE_CLIENTS_THRESHOLD_MS = 50;
 var CHECK_CONNECTIVITY_ON_ERROR_FREQUENCY = 6;
 var DEFAULT_QUERY_CHANGE_THROTTLE_MS = 10;
 function convertOnUpdateNeededReason(reason) {
@@ -117,7 +122,7 @@ var serverAheadReloadReason = `Server reported that client is ahead of server. T
 function onClientStateNotFoundServerReason(serverErrMsg) {
 	return `Server could not find state needed to synchronize this client. ${serverErrMsg}`;
 }
-var ON_CLIENT_STATE_NOT_FOUND_REASON_CLIENT = "The local persistent state needed to synchronize this client has been garbage collected.";
+var ON_CLIENT_STATE_NOT_FOUND_REASON_CLIENT = "The local persistent state needed to synchronize this client has been garbage collected or was found to be corrupt.";
 var CLOSE_CODE_NORMAL = 1e3;
 var Zero = class Zero {
 	version = version;
@@ -281,7 +286,7 @@ var Zero = class Zero {
 		})).toString(36);
 		const storageScopedUserID = userID ?? "__anonymous__";
 		const replicacheOptions = {
-			schemaVersion: `52.${hash}`,
+			schemaVersion: `53.${hash}`,
 			logLevel: logOptions.logLevel,
 			logSinks: [logOptions.logSink],
 			mutators: replicacheMutators,
@@ -296,12 +301,13 @@ var Zero = class Zero {
 			licenseKey: "zero-client-static-key",
 			kvStore
 		};
+		this.#visibilityWatcher = getDocumentVisibilityWatcher(getBrowserGlobal("document"), hiddenTabDisconnectDelay, this.#closeAbortController.signal);
 		this.#zeroContext = new ZeroContext(lc, this.#ivmMain, (ast, ttl, gotCallback) => {
 			if (enableLegacyQueries) return this.#queryManager.addLegacy(ast, ttl, gotCallback);
 			return emptyFunction;
 		}, (ast, customQueryID, ttl, gotCallback) => this.#queryManager.addCustom(ast, customQueryID, ttl, gotCallback), (ast, ttl) => {
 			if (enableLegacyQueries) this.#queryManager.updateLegacy(ast, ttl);
-		}, (customQueryID, ttl) => this.#queryManager.updateCustom(customQueryID, ttl), () => this.#queryManager.flushBatch(), batchViewUpdates, this.#addMetric, assertValidRunOptions);
+		}, (customQueryID, ttl) => this.#queryManager.updateCustom(customQueryID, ttl), () => this.#queryManager.flushBatch(), batchViewUpdates, this.#addMetric, assertValidRunOptions, this.#visibilityWatcher);
 		this.query = createRunnableBuilder(this.#zeroContext, schema);
 		const rep = new ReplicacheImpl(replicacheOptions, {
 			enableClientGroupForking: false,
@@ -321,7 +327,7 @@ var Zero = class Zero {
 		this.#activeClientsManager = makeActiveClientsManager(rep.clientGroupID, this.clientID, this.#closeAbortController.signal, (clientID, clientGroupID) => this.#deleteClientsManager.onClientsDeleted([{
 			clientGroupID,
 			clientID
-		}]));
+		}]), this.#lc);
 		const onUpdateNeededCallback = (reason) => {
 			if (onUpdateNeeded) onUpdateNeeded(reason);
 			else reloadWithReason(this.#lc, this.#reload, reason.type, updateNeededReloadReasonMessage(reason));
@@ -372,15 +378,15 @@ var Zero = class Zero {
 		});
 		this.#metrics.tags.push(`version:${this.version}`);
 		this.#pokeHandler = new PokeHandler(async (poke) => {
+			const socket = this.#socket;
 			await this.#rep.poke(poke);
-			this.#queryManager.markGotQueriesAuthoritative();
+			if (socket !== void 0 && this.#socket === socket) this.#queryManager.markGotQueriesAuthoritative();
 		}, (e) => this.#onPokeError(e), rep.clientID, schema, this.#lc, this.#mutationTracker);
-		this.#visibilityWatcher = getDocumentVisibilityWatcher(getBrowserGlobal("document"), hiddenTabDisconnectDelay, this.#closeAbortController.signal);
 		this.#runLoop();
 		this.#expose();
 	}
 	#enableRefresh() {
-		return this.#forceEnableRefresh || !this.#connectionManager.is("connected") && !this.#connectionManager.is("connecting");
+		return this.#forceEnableRefresh || !this.#connectionManager.is("connected") && !this.#connectionManager.is("connecting") && !this.#connectionManager.is("initializing");
 	}
 	#expose() {
 		const g = globalThis;
@@ -431,8 +437,11 @@ var Zero = class Zero {
 	* This function is useful when you want to populate the cache ahead of time,
 	* for example after login, to avoid a flash of loading screen on the next page.
 	*
-	* Returns an object with two properties:
-	* - `complete`: a Promise that resolves when the data is loaded
+	* Returns an object with three properties:
+	* - `complete`: a Promise that resolves when the server has confirmed the
+	*   data on this connection
+	* - `cached`: a Promise that resolves as soon as the store holds a
+	*   server-confirmed result, from this connection or a previous one
 	* - `cleanup`: a function that can be called to cancel the preload
 	*
 	* @example
@@ -449,7 +458,9 @@ var Zero = class Zero {
 	* Executes a query once and returns the results.
 	*
 	* By default, runs immediately with whatever data is available locally.
-	* Use `{type: 'complete'}` to wait for fresh results from the server.
+	* Use `{type: 'complete'}` to wait for fresh results from the server, or
+	* `{type: 'cached'}` to accept a result the server confirmed on a previous
+	* connection when the store holds one.
 	*
 	* @param query - The query to execute
 	* @param runOptions - Options controlling query execution
@@ -494,6 +505,16 @@ var Zero = class Zero {
 		return this.#rep.idbName;
 	}
 	/**
+	* The KV store backing this instance of Zero. Its `kind` is the storage
+	* currently in use: `'idb'`, `'mem'`, `'op-sqlite'`, `'expo-sqlite'`, or
+	* whatever a custom store reports. An IndexedDB store that fails to open
+	* falls back to memory, so `kind` can change from `'idb'` to `'mem'` after
+	* the first read or write.
+	*/
+	get kvStore() {
+		return this.#rep.kvStore;
+	}
+	/**
 	* The schema version of the data understood by this application.
 	* See [[ZeroOptions.schemaVersion]].
 	*/
@@ -913,11 +934,11 @@ var Zero = class Zero {
 		const clientGroupID = await this.clientGroupID;
 		this.#addConnectEvent(lc, attempt, "initializing active clients");
 		const activeClientsManager = await this.#activeClientsManager;
-		if (signal.aborted) throw signal.reason;
+		if (signal.aborted) throw attempt.abortReason ?? signal.reason;
 		const [ws, initConnectionQueries, deletedClients] = await createSocket(this.#rep, this.#queryManager, this.#deleteClientsManager, socketOrigin, connectCookie, this.clientID, clientGroupID, this.#clientSchema, this.userID, fromReplicacheAuthToken(this.#rep.auth), this.#lastMutationIDReceived, wsid, this.#options.logLevel === "debug", lc, this.#options.mutateURL, this.#options.mutateHeaders, this.#options.queryURL ?? this.#options.getQueriesURL, this.#options.queryHeaders, additionalConnectParams, activeClientsManager, this.#options.maxHeaderLength, (event) => this.#addConnectEvent(lc, attempt, event));
 		if (signal.aborted) {
 			ws.close();
-			throw signal.reason;
+			throw attempt.abortReason ?? signal.reason;
 		}
 		if (this.closed) {
 			ws.close();
@@ -933,17 +954,52 @@ var Zero = class Zero {
 		this.#socketResolver.resolve(ws);
 		this.#addConnectEvent(lc, attempt, "waiting for the server acknowledgement");
 		lc.debug?.("Waiting for connection to be acknowledged");
+		attempt.clearTimeout?.();
+		attempt.clearTimeout = this.#armConnectTimeout(lc, attempt, "ack");
 		await attempt.connected.promise;
-		if (signal.aborted) throw signal.reason;
+		if (signal.aborted) throw attempt.abortReason ?? signal.reason;
 		this.#mutationTracker.onConnected(this.#lastMutationIDReceived);
 		this.#rep.push().catch(() => {});
 	}
+	/**
+	* Starts the deadline for one phase of a connection attempt, and returns a
+	* function that cancels it.
+	*
+	* The two phases are measured separately because they fail for unrelated
+	* reasons. `setup` covers local work — reading the cookie, the client group
+	* ID and the active clients from IDB, then preparing and opening the socket
+	* — whose duration says nothing about whether the server is reachable.
+	* `ack` covers the wait for the server's response. Running them on one
+	* budget meant a slow cold boot spent the server's time before the socket
+	* existed, and reported a healthy server as unreachable.
+	*/
+	#armConnectTimeout(lc, attempt, phase) {
+		const { signal } = attempt.controller;
+		if (signal.aborted) return () => {};
+		const timeoutID = setTimeout(() => {
+			lc.debug?.("Connection attempt timed out");
+			this.#disconnect(lc, new ClientError({
+				kind: ConnectTimeout,
+				message: (phase === "setup" ? `Connection setup timed out after ${CONNECT_TIMEOUT_MS / 1e3} seconds. ` : `Server did not acknowledge the connection within ${CONNECT_TIMEOUT_MS / 1e3} seconds. `) + `Connect events: ${JSON.stringify(attempt.events)}`
+			}));
+		}, CONNECT_TIMEOUT_MS);
+		const clear = () => {
+			clearTimeout(timeoutID);
+			signal.removeEventListener("abort", clear);
+		};
+		signal.addEventListener("abort", clear, { once: true });
+		return clear;
+	}
 	#addConnectEvent(lc, attempt, event) {
 		attempt.events.push([/* @__PURE__ */ new Date(), event]);
 		lc.debug?.("Connect event", event);
 	}
 	#disconnect(lc, reason, closeCode) {
-		this.#currentConnectAttempt?.controller.abort(reason);
+		const attempt = this.#currentConnectAttempt;
+		if (attempt) {
+			attempt.abortReason = reason;
+			attempt.controller.abort(reason);
+		}
 		if (shouldReportConnectError(reason)) {
 			this.#connectErrorCount++;
 			this.#metrics.lastConnectError.set(getLastConnectErrorValue(reason));
@@ -970,6 +1026,7 @@ var Zero = class Zero {
 			case Closed:
 				lc.debug?.("disconnect() called while closed");
 				return;
+			case Initializing:
 			case Disconnected:
 			case Connecting:
 			case NeedsAuth:
@@ -1113,6 +1170,26 @@ var Zero = class Zero {
 		};
 		const { auth } = this.#options;
 		this.#setAuth(auth);
+		const { signal: closeSignal } = this.#closeAbortController;
+		const closed = resolver();
+		const onClose = () => closed.resolve();
+		closeSignal.addEventListener("abort", onClose, { once: true });
+		try {
+			if ((await promiseRace({
+				initialized: Promise.all([
+					this.#rep.cookie,
+					this.clientGroupID,
+					this.#activeClientsManager
+				]),
+				closed: closed.promise
+			})).key === "closed") {
+				this.#lc.debug?.("Closed while initializing, not connecting");
+				return;
+			}
+		} catch {} finally {
+			closeSignal.removeEventListener("abort", onClose);
+		}
+		this.#connectionManager.initialized();
 		let backoffMs;
 		let additionalConnectParams;
 		while (this.#connectionManager.shouldContinueRunLoop()) {
@@ -1146,16 +1223,10 @@ var Zero = class Zero {
 						};
 						this.#currentConnectAttempt = attempt;
 						this.#addConnectEvent(lc, attempt, "starting the connection");
+						attempt.clearTimeout = this.#armConnectTimeout(lc, attempt, "setup");
 						const canceled = resolver();
-						const abortHandler = () => canceled.reject(attempt.controller.signal.reason);
+						const abortHandler = () => canceled.reject(attempt.abortReason ?? attempt.controller.signal.reason);
 						attempt.controller.signal.addEventListener("abort", abortHandler, { once: true });
-						const timeoutID = setTimeout(() => {
-							lc.debug?.("Connection attempt timed out");
-							this.#disconnect(lc, new ClientError({
-								kind: ConnectTimeout,
-								message: `Connection attempt timed out after ${CONNECT_TIMEOUT_MS / 1e3} seconds. Connect events: ${JSON.stringify(attempt.events)}`
-							}));
-						}, CONNECT_TIMEOUT_MS);
 						try {
 							try {
 								await Promise.race([this.#connectAttempt(lc, additionalConnectParams, attempt), canceled.promise]);
@@ -1172,7 +1243,7 @@ var Zero = class Zero {
 							ready.resolve();
 							additionalConnectParams = void 0;
 						} finally {
-							clearTimeout(timeoutID);
+							attempt.clearTimeout?.();
 							attempt.controller.signal.removeEventListener("abort", abortHandler);
 							if (this.#currentConnectAttempt === attempt) this.#currentConnectAttempt = void 0;
 						}
@@ -1225,27 +1296,38 @@ var Zero = class Zero {
 						})).key === "connectRequest") this.#connectionManager.resumeFromConnectRequest();
 						break;
 					case Error$1:
-						lc.info?.(`Run loop paused in error state. Call zero.connection.connect() to resume.`, currentState.reason);
+						lc.info?.(`Run loop paused in error state. Call zero.connection.connect() to resume.`, currentState.reason, ...getErrorCauses(currentState.reason));
 						if ((await promiseRace({
 							connectRequest: this.#connectionManager.waitForConnectRequest(),
 							stateChange: this.#connectionManager.waitForStateChange()
 						})).key === "connectRequest") this.#connectionManager.resumeFromConnectRequest();
 						break;
 					case Closed: break;
+					case Initializing: unreachable();
 					default: unreachable(currentState);
 				}
 			} catch (ex) {
 				const isClientClosedError = isClientError(ex) && ex.kind === "ClientClosed";
+				const transition = getErrorConnectionTransition(ex);
 				if (!this.#connectionManager.is("connected") && !isClientClosedError) {
-					const level = isAuthError(ex) ? "warn" : "error";
+					let level;
+					switch (transition.status) {
+						case Error$1:
+							level = "error";
+							break;
+						case Disconnected:
+						case Closed:
+							level = "info";
+							break;
+						default: level = "warn";
+					}
 					const kind = isServerError(ex) ? ex.kind : "Unknown Error";
-					lc[level]?.("Failed to connect", ex, kind, {
+					lc[level]?.("Failed to connect", ex, ...getErrorCauses(ex), kind, {
 						lmid: this.#lastMutationIDReceived,
 						baseCookie: this.#connectCookie
 					});
 				}
 				lc.debug?.("Got an exception in the run loop", "state:", this.#connectionManager.state, "exception:", ex);
-				const transition = getErrorConnectionTransition(ex);
 				let sleepMs = void 0;
 				switch (transition.status) {
 					case NO_STATUS_TRANSITION: {
@@ -1504,7 +1586,7 @@ async function createSocket(rep, queryManager, deleteClientsManager, socketOrigi
 	];
 }
 async function createConnectionURL(socketOrigin, clientID, clientGroupID, userID, baseCookie, lmid, wsid, rep, debugPerf, additionalConnectParams, lc) {
-	const url = new URL(appendPath(socketOrigin, `/sync/v52/connect`));
+	const url = new URL(appendPath(socketOrigin, `/sync/v53/connect`));
 	const { searchParams } = url;
 	searchParams.set("clientID", clientID);
 	searchParams.set("clientGroupID", clientGroupID);
@@ -1549,8 +1631,14 @@ function addWebSocketIDToLogContext(wsid, lc) {
 	return lc.withContext("wsid", wsid);
 }
 function assertValidRunOptions(_options) {}
-async function makeActiveClientsManager(clientGroupID, clientID, signal, onDelete) {
-	const manager = await ActiveClientsManager.create(await clientGroupID, clientID, signal);
+async function makeActiveClientsManager(clientGroupID, clientID, signal, onDelete, lc) {
+	const groupID = await clientGroupID;
+	const start = performance.now();
+	const manager = await ActiveClientsManager.create(groupID, clientID, signal);
+	const elapsed = performance.now() - start;
+	const locks = getBrowserGlobal("navigator")?.locks ? "native" : "fallback";
+	if (elapsed > SLOW_ACTIVE_CLIENTS_THRESHOLD_MS) lc.warn?.(`Initializing active clients took ${Math.round(elapsed)}ms`, { locks });
+	else lc.debug?.("Initialized active clients in", Math.round(elapsed), "ms", { locks });
 	manager.onDelete = onDelete;
 	return manager;
 }