@rocicorp/zero 1.10.0-canary.2 → 1.10.0-canary.20

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

@@ -11,7 +11,7 @@ import { dropDatabase } from "../../../replicache/src/persist/collect-idb-databa
 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";
@@ -31,6 +31,7 @@ import { encodeSecProtocols } from "../../../zero-protocol/src/connect.js";
 import { CRUD, Custom } from "../../../zero-protocol/src/mutation-type-enum.js";
 import { mapCRUD } from "../../../zero-protocol/src/mutation.js";
 import { nullableVersionSchema } from "../../../zero-protocol/src/version.js";
+import "../../../zero-protocol/src/poke.js";
 import { downstreamSchema } from "../../../zero-protocol/src/down.js";
 import "../../../zero-protocol/src/protocol-version.js";
 import { isClientMetric } from "../../../zql/src/query/metrics-delegate.js";
@@ -89,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) {
@@ -280,7 +286,7 @@ var Zero = class Zero {
 		})).toString(36);
 		const storageScopedUserID = userID ?? "__anonymous__";
 		const replicacheOptions = {
-			schemaVersion: `51.${hash}`,
+			schemaVersion: `52.${hash}`,
 			logLevel: logOptions.logLevel,
 			logSinks: [logOptions.logSink],
 			mutators: replicacheMutators,
@@ -301,6 +307,7 @@ var Zero = class Zero {
 		}, (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);
+		this.#zeroContext.deferPipelines();
 		this.query = createRunnableBuilder(this.#zeroContext, schema);
 		const rep = new ReplicacheImpl(replicacheOptions, {
 			enableClientGroupForking: false,
@@ -320,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));
@@ -641,13 +648,36 @@ var Zero = class Zero {
 	}
 	#onMessage = (e) => {
 		const lc = this.#lc;
-		lc.debug?.("received message", e.data);
+		const { data } = e;
+		lc.debug?.("received message", data instanceof ArrayBuffer ? {
+			type: "binary",
+			byteLength: data.byteLength
+		} : data);
 		if (this.closed) {
 			lc.debug?.("ignoring message because already closed");
 			return;
 		}
 		let downMessage;
-		const { data } = e;
+		if (data instanceof ArrayBuffer) {
+			this.#messageCount++;
+			const message = new Uint8Array(data);
+			if (message[0] !== 0) {
+				this.#disconnect(lc, new ClientError({
+					kind: InvalidMessage$1,
+					message: `Unknown binary message type: ${String(message[0])}`
+				}));
+				return;
+			}
+			this.#handlePokeChunk(message.subarray(1));
+			return;
+		}
+		if (typeof data !== "string") {
+			this.#disconnect(lc, new ClientError({
+				kind: InvalidMessage$1,
+				message: "Invalid binary message received from server"
+			}));
+			return;
+		}
 		try {
 			downMessage = parse(JSON.parse(data), downstreamSchema, "passthrough");
 		} catch (e) {
@@ -889,11 +919,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();
@@ -909,17 +939,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));
@@ -993,9 +1058,15 @@ var Zero = class Zero {
 		const lastMutationIDChangeForSelf = this.#pokeHandler.handlePokePart(pokeMessage[1]);
 		if (lastMutationIDChangeForSelf !== void 0) this.#lastMutationIDReceived = lastMutationIDChangeForSelf;
 	}
+	#handlePokeChunk(chunk) {
+		this.#abortPingTimeout();
+		this.#pokeHandler.handlePokeChunk(chunk);
+	}
 	#handlePokeEnd(_lc, pokeMessage) {
 		this.#abortPingTimeout();
-		this.#pokeHandler.handlePokeEnd(pokeMessage[1]);
+		const result = this.#pokeHandler.handlePokeEnd(pokeMessage[1]);
+		if (result?.hasRows) resetBackoff();
+		if (result?.lastMutationIDChangeForSelf !== void 0) this.#lastMutationIDReceived = result.lastMutationIDChangeForSelf;
 	}
 	#onPokeError(error) {
 		const lc = this.#lc;
@@ -1116,16 +1187,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]);
@@ -1142,7 +1207,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;
 						}
@@ -1195,7 +1260,7 @@ 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()
@@ -1209,7 +1274,7 @@ var Zero = class Zero {
 				if (!this.#connectionManager.is("connected") && !isClientClosedError) {
 					const level = isAuthError(ex) ? "warn" : "error";
 					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
 					});
@@ -1465,14 +1530,16 @@ async function createSocket(rep, queryManager, deleteClientsManager, socketOrigi
 		queriesPatch = void 0;
 	} else deletedClients = void 0;
 	onEvent?.("creating the WebSocket");
+	const socket = new WS(url.toString(), secProtocol);
+	socket.binaryType = "arraybuffer";
 	return [
-		new WS(url.toString(), secProtocol),
+		socket,
 		queriesPatch,
 		skipEmptyDeletedClients(deletedClients)
 	];
 }
 async function createConnectionURL(socketOrigin, clientID, clientGroupID, userID, baseCookie, lmid, wsid, rep, debugPerf, additionalConnectParams, lc) {
-	const url = new URL(appendPath(socketOrigin, `/sync/v51/connect`));
+	const url = new URL(appendPath(socketOrigin, `/sync/v52/connect`));
 	const { searchParams } = url;
 	searchParams.set("clientID", clientID);
 	searchParams.set("clientGroupID", clientGroupID);
@@ -1517,8 +1584,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;
 }