@rocicorp/zero 1.11.0-canary.1 → 1.11.0-canary.3

package/out/zero-cache/src/services/view-syncer/view-syncer.js

@@ -90,7 +90,21 @@ var ViewSyncerService = class {
 	#stopped = resolver();
 	#initialized = resolver();
 	#cvr;
-	#pipelinesSynced = false;
+	/**
+	* Indicates whether the query pipelines have completed initial catch-up and
+	* hydration with the CVR snapshot, and are ready for steady-state operation.
+	*
+	* - When `false`: The syncer is in its initial catch-up phase. The replica
+	*   advances without diffs until it reaches `cvr.version.stateVersion`,
+	*   after which `#maybeHydratePipelines` hydrates queries.
+	* - When `true`: Pipelines are fully populated and in steady-state; replica
+	*   changes advance incrementally via `#advancePipelines`, and client query
+	*   updates are processed via `#syncQueryPipelineSet`.
+	*
+	* Resets to `false` if `#advancePipelines` returns a `ResetPipelinesSignal`
+	* and pipelines must be reset and rehydrated.
+	*/
+	#pipelinesHydrated = false;
 	#servedVersion = null;
 	#e2eServingLagTracker = new E2EServingLagTracker();
 	#expiredQueriesTimer = 0;
@@ -213,26 +227,18 @@ var ViewSyncerService = class {
 						lc.info?.(`resetting CVR: ${message}`);
 						throw new ClientNotFoundError(message);
 					}
-					if (this.#pipelinesSynced) {
+					if (this.#pipelinesHydrated) {
 						const result = await this.#advancePipelines(lc, cvr);
 						if (result === "success") return;
 						lc.info?.(`resetting pipelines: ${result.message}`);
 						this.#pipelineResets.add(1, { reason: result.reason });
 						this.#pipelines.reset(clientSchema);
-						this.#pipelinesSynced = false;
+						this.#pipelinesHydrated = false;
 						this.connContextManager.setSharedRetransformReady(false);
 					}
-					const version = this.#pipelines.advanceWithoutDiff();
-					const cvrVer = versionString(cvr.version);
-					if (version < cvr.version.stateVersion) {
-						lc.debug?.(`replica@${version} is behind cvr@${cvrVer}`);
-						return;
-					}
-					lc.info?.(`init pipelines@${version} (cvr@${cvrVer})`);
-					const driftedQueryIDs = await this.#hydrateUnchangedQueries(lc, cvr);
-					await this.#syncQueryPipelineSet(lc, cvr, "missing", void 0, driftedQueryIDs);
-					this.#pipelinesSynced = true;
-					this.connContextManager.setSharedRetransformReady(true);
+					const backgroundConnCtx = this.connContextManager.getBackgroundConnectionContext();
+					if (backgroundConnCtx) await this.#maybeHydratePipelines(lc, cvr, backgroundConnCtx);
+					else lc.info?.("No validated background connection; deferring pipeline init");
 				});
 			}
 			if (this.#drainCoordinator.shouldDrain()) this.#drainCoordinator.drainNextIn(this.#totalHydrationTimeMs());
@@ -246,11 +252,52 @@ var ViewSyncerService = class {
 			this.#stopped.resolve();
 		}
 	}
+	/**
+	* Ensures that query pipelines are hydrated and ready for steady-state
+	* operation.
+	*
+	* Preconditions:
+	* 1. Must be called from within the `#lock`.
+	* 2. The caller must provide an active, validated `ConnectionContext` for
+	*    evaluating custom query transforms and permissions.
+	*
+	* Readiness prerequisites:
+	* - The underlying `QueryPipelineDriver` must be initialized with the schema
+	*   (i.e. `this.#pipelines.initialized()` is true).
+	* - The SQLite replica must have caught up to at least the CVR's
+	*   `stateVersion` (`version >= cvr.version.stateVersion`).
+	*
+	* If either prerequisite is not met, this method returns early as a no-op,
+	* waiting for the replica to catch up or the driver to initialize.
+	*
+	* Once ready:
+	* - Hydrates unchanged queries from the CVR snapshot without full row diffing.
+	* - Syncs missing, errored, or drifted queries via `#syncQueryPipelineSet`.
+	* - Sets `#pipelinesHydrated = true` and enables shared retransformations.
+	*/
+	async #maybeHydratePipelines(lc, cvr, connCtx) {
+		if (!this.#pipelines.initialized()) return;
+		const version = this.#pipelines.advanceWithoutDiff();
+		const cvrVer = versionString(cvr.version);
+		if (version < cvr.version.stateVersion) {
+			lc.debug?.(`replica@${version} is behind cvr@${cvrVer}`);
+			return;
+		}
+		lc.info?.(`init pipelines@${version} (cvr@${cvrVer})`);
+		const driftedQueryIDs = await this.#hydrateUnchangedQueries(lc, cvr, connCtx);
+		await this.#syncQueryPipelineSet(lc, cvr, "missing", connCtx, driftedQueryIDs);
+		this.#pipelinesHydrated = true;
+		this.connContextManager.setSharedRetransformReady(true);
+	}
 	#removeExpiredQueries = async (lc, cvr) => {
 		if (hasExpiredQueries(cvr)) {
 			lc = lc.withContext("method", "#removeExpiredQueries");
 			lc.debug?.("Queries have expired");
-			if (this.#pipelinesSynced) await this.#syncQueryPipelineSet(lc, cvr, "missing", void 0);
+			if (this.#pipelinesHydrated) {
+				const connCtx = this.connContextManager.getBackgroundConnectionContext();
+				if (connCtx) await this.#syncQueryPipelineSet(lc, cvr, "missing", connCtx);
+				else lc.info?.("No validated background connection to remove expired queries; deferring");
+			}
 		}
 		this.#scheduleExpireEviction(lc, cvr);
 	};
@@ -466,7 +513,7 @@ var ViewSyncerService = class {
 			}
 			lc.debug?.("Auth changed, re-validating and re-transforming queries");
 			const connCtx = this.connContextManager.mustGetConnectionContext(selector);
-			if (!this.#pipelinesSynced) {
+			if (!this.#pipelinesHydrated) {
 				if (!await this.#validateConnection(connCtx)) return;
 			}
 			return await this.#handleConfigUpdate(lc, clientID, {}, cvr, "all", void 0, connCtx);
@@ -528,7 +575,8 @@ var ViewSyncerService = class {
 				await pokers.end(newCVR.version);
 			});
 		}
-		if (this.#pipelinesSynced) await this.#syncQueryPipelineSet(lc, this.#cvr, customQueryTransformMode, connCtx);
+		if (!this.#pipelinesHydrated) await this.#maybeHydratePipelines(lc, this.#cvr, connCtx);
+		else await this.#syncQueryPipelineSet(lc, this.#cvr, customQueryTransformMode, connCtx);
 		return this.#cvr;
 	}
 	/**
@@ -651,7 +699,7 @@ var ViewSyncerService = class {
 	*
 	* This must be called from within the #lock.
 	*/
-	async #hydrateUnchangedQueries(lc, cvr) {
+	async #hydrateUnchangedQueries(lc, cvr, connCtx) {
 		assert(this.#pipelines.initialized(), "pipelines must be initialized");
 		const dbVersion = this.#pipelines.currentVersion();
 		const cvrVersion = cvr.version;
@@ -676,17 +724,16 @@ var ViewSyncerService = class {
 		let customHashMismatchCount = 0;
 		let otherHashMismatchCount = 0;
 		if (customQueries.size > 0 && !this.#customQueryTransformer) lc.warn?.("Custom/named queries were requested but no `ZERO_QUERY_URL` is configured for Zero Cache.");
-		const backgroundContext = this.connContextManager.mustGetBackgroundConnectionContext();
 		const customQueryTransformer = this.#customQueryTransformer;
 		if (customQueryTransformer && customQueries.size > 0) {
-			const transformedCustomQueries = await this.#runPriorityOp(lc, "#hydrateUnchangedQueries transforming custom queries", () => customQueryTransformer.transform(backgroundContext, customQueries.values()));
-			if (transformedCustomQueries.kind === "success" && !transformedCustomQueries.cached) this.connContextManager.validateConnection(backgroundContext, backgroundContext.revision, transformedCustomQueries.validation);
+			const transformedCustomQueries = await this.#runPriorityOp(lc, "#hydrateUnchangedQueries transforming custom queries", () => customQueryTransformer.transform(connCtx, customQueries.values()));
+			if (transformedCustomQueries.kind === "success" && !transformedCustomQueries.cached) this.connContextManager.validateConnection(connCtx, connCtx.revision, transformedCustomQueries.validation);
 			if (Array.isArray(transformedCustomQueries.result)) for (const q of transformedCustomQueries.result) if ("error" in q) customErrorCount++;
 			else if (q.transformationHash !== customQueries.get(q.id)?.transformationHash) customHashMismatchCount++;
 			else transformedQueries.push(q);
 		}
 		for (const q of otherQueries) {
-			const transformed = transformAndHashQuery(lc, q.id, q.ast, must(this.#pipelines.currentPermissions()).permissions ?? { tables: {} }, backgroundContext.auth?.type === "jwt" ? backgroundContext.auth : void 0, q.type === "internal");
+			const transformed = transformAndHashQuery(lc, q.id, q.ast, must(this.#pipelines.currentPermissions()).permissions ?? { tables: {} }, connCtx.auth?.type === "jwt" ? connCtx.auth : void 0, q.type === "internal");
 			if (transformed.transformationHash === q.transformationHash) transformedQueries.push(transformed);
 			else otherHashMismatchCount++;
 		}
@@ -832,7 +879,6 @@ var ViewSyncerService = class {
 			const customQueries = /* @__PURE__ */ new Map();
 			const otherQueries = [];
 			const transformedQueries = [];
-			const resolvedConnCtx = connCtx ?? this.connContextManager.mustGetBackgroundConnectionContext();
 			for (const [id, query] of cvrQueryEntires) if (query.type === "custom") {
 				assert(id === query.id, "custom query id mismatch");
 				customQueries.set(id, query);
@@ -842,7 +888,7 @@ var ViewSyncerService = class {
 			});
 			for (const { id, query: origQuery } of otherQueries) {
 				assert(id === origQuery.id, "query id mismatch");
-				const transformed = transformAndHashQuery(lc, origQuery.id, origQuery.ast, must(this.#pipelines.currentPermissions()).permissions ?? { tables: {} }, resolvedConnCtx.auth?.type === "jwt" ? resolvedConnCtx.auth : void 0, origQuery.type === "internal");
+				const transformed = transformAndHashQuery(lc, origQuery.id, origQuery.ast, must(this.#pipelines.currentPermissions()).permissions ?? { tables: {} }, connCtx.auth?.type === "jwt" ? connCtx.auth : void 0, origQuery.type === "internal");
 				transformedQueries.push({
 					id,
 					origQuery,
@@ -857,10 +903,10 @@ var ViewSyncerService = class {
 				const transformStart = performance.now();
 				let transformedCustomQueries;
 				try {
-					transformedCustomQueries = await this.#runPriorityOp(lc, "#syncQueryPipelineSet transforming custom queries", () => customQueryTransformer.transform(resolvedConnCtx, customQueriesToTransform));
+					transformedCustomQueries = await this.#runPriorityOp(lc, "#syncQueryPipelineSet transforming custom queries", () => customQueryTransformer.transform(connCtx, customQueriesToTransform));
 					if (transformedCustomQueries.kind === "failed") throw new ProtocolErrorWithLevel(transformedCustomQueries.result, "warn");
 					else {
-						if (!transformedCustomQueries.cached) this.connContextManager.validateConnection(resolvedConnCtx, resolvedConnCtx.revision, transformedCustomQueries.validation);
+						if (!transformedCustomQueries.cached) this.connContextManager.validateConnection(connCtx, connCtx.revision, transformedCustomQueries.validation);
 						this.#queryTransformations.add(1, { result: "success" });
 					}
 				} catch (e) {
@@ -1156,7 +1202,9 @@ var ViewSyncerService = class {
 	*
 	* Must be called from within the #lock.
 	*
-	* Returns false if the advancement failed due to a schema change.
+	* Returns 'success' if changes were successfully processed and poked,
+	* or a `ResetPipelinesSignal` if advancement aborted (e.g. schema change,
+	* timeout) and pipelines need to be reset and rehydrated.
 	*/
 	#advancePipelines(lc, cvr) {
 		return startAsyncSpan(tracer, "vs.#advancePipelines", async (span) => {