@dxos/edge-client 0.13.0 → 0.14.0

package/dist/lib/chunk-edge-http-client.mjs

@@ -10,7 +10,7 @@ import * as Schema from "effect/Schema";
 import * as EffectEx from "@dxos/effect/EffectEx";
 import { invariant } from "@dxos/invariant";
 import { log } from "@dxos/log";
-import { EDGE_CLIENT_TAG_HEADER, EdgeAuthChallengeError, EdgeCallFailedError, EdgeCredentialsHeaderCodec, InboxListResponseSchema, InboxSendResponseSchema } from "@dxos/protocols";
+import { EDGE_CLIENT_TAG_HEADER, EDGE_CLIENT_TOO_OLD, EDGE_CLIENT_VERSION_HEADER, EDGE_CLIENT_VERSION_PROTOCOL_PREFIX, EdgeAuthChallengeError, EdgeCallFailedError, EdgeClientTooOldError, EdgeCredentialsHeaderCodec, InboxListResponseSchema, InboxSendResponseSchema } from "@dxos/protocols";
 import { createUrl } from "@dxos/util";
 import { sleep } from "@dxos/async";
 import { TRACE_SPAN_ATTRIBUTE } from "@dxos/context";
@@ -20,6 +20,27 @@ import { PresentationSchema } from "@dxos/protocols/buf/dxos/halo/credentials_pb
 import * as Duration from "effect/Duration";
 import * as Schedule from "effect/Schedule";
 import { BaseError } from "@dxos/errors";
+//#endregion
+//#region src/client-version.ts
+/**
+* This SDK's version, which EDGE checks against the oldest it serves. It releases in lockstep with the rest of the
+* SDK, and Vite tree-shakes the import to this one field.
+*/
+var CLIENT_SDK_VERSION = "0.14.0";
+/** Headers advertising {@link CLIENT_SDK_VERSION} on a request of the EDGE connect flow (`/auth` and its fallback). */
+var clientVersionHeaders = () => ({ [EDGE_CLIENT_VERSION_HEADER]: CLIENT_SDK_VERSION });
+/** The same advertisement for the WebSocket upgrade, where a browser can set no header but the subprotocol list. */
+var clientVersionProtocol = () => `${EDGE_CLIENT_VERSION_PROTOCOL_PREFIX}${CLIENT_SDK_VERSION}`;
+/**
+* Throws {@link EdgeClientTooOldError} when `response` is EDGE's failure envelope refusing this SDK. Matched on the
+* envelope's `data.type`, as any WebSocket endpoint answers a plain GET with a bare 426 "Upgrade Required".
+*/
+var assertClientSupported = async (response) => {
+	if (response.ok || !response.headers.get("Content-Type")?.startsWith("application/json")) return;
+	const body = await response.clone().json().catch(() => void 0);
+	if (body?.success === false && body.data?.type === EDGE_CLIENT_TOO_OLD) throw new EdgeClientTooOldError(body, response.status);
+};
+//#endregion
 //#region src/auth-challenge.ts
 var __dxlog_file$3 = "/__w/dxos/dxos/packages/core/mesh/edge-client/src/auth-challenge.ts";
 /**
@@ -124,7 +145,7 @@ var readAuthChallenge = async (response) => {
 		log.verbose("auth challenge response was not JSON", { error }, {
 			"~LogMeta": "~LogMeta",
 			F: __dxlog_file$3,
-			L: 145,
+			L: 147,
 			S: void 0
 		});
 		return;
@@ -138,17 +159,19 @@ var readAuthChallenge = async (response) => {
 * console and records a routine auth failure server-side on each client boot.
 *
 * Returns undefined if the endpoint is unreachable or answers in neither known shape; callers fall
-* back to the 401 path, which still works against every server.
+* back to the 401 path, which still works against every server. Throws {@link EdgeClientTooOldError} when EDGE refuses
+* this SDK, which no fallback can get past.
 */
 var fetchAuthChallengeInfo = async (baseHttpUrl) => {
 	try {
-		const response = await fetch(new URL("/auth", baseHttpUrl));
+		const response = await fetch(new URL("/auth", baseHttpUrl), { headers: clientVersionHeaders() });
+		await assertClientSupported(response);
 		const challenge = await readAuthChallenge(response);
 		if (!challenge) {
 			log.verbose("no challenge in /auth response", { status: response.status }, {
 				"~LogMeta": "~LogMeta",
 				F: __dxlog_file$3,
-				L: 175,
+				L: 179,
 				S: void 0
 			});
 			return;
@@ -163,10 +186,11 @@ var fetchAuthChallengeInfo = async (baseHttpUrl) => {
 			expiresInMs
 		};
 	} catch (error) {
+		if (error instanceof EdgeClientTooOldError) throw error;
 		log.verbose("failed to fetch auth challenge", { error }, {
 			"~LogMeta": "~LogMeta",
 			F: __dxlog_file$3,
-			L: 189,
+			L: 196,
 			S: void 0
 		});
 		return;
@@ -206,7 +230,7 @@ var handleAuthChallenge = async (failedResponse, identity) => {
 	invariant(challenge !== void 0, "No auth challenge in response.", {
 		"~LogMeta": "~LogMeta",
 		F: __dxlog_file$3,
-		L: 244,
+		L: 251,
 		S: void 0,
 		A: ["challenge !== undefined", "'No auth challenge in response.'"]
 	});
@@ -295,7 +319,7 @@ var BaseHttpClient = class {
 		log("created", { url: this._baseUrl }, {
 			"~LogMeta": "~LogMeta",
 			F: __dxlog_file$1,
-			L: 90,
+			L: 97,
 			S: this
 		});
 	}
@@ -335,7 +359,7 @@ var BaseHttpClient = class {
 		}, {
 			"~LogMeta": "~LogMeta",
 			F: __dxlog_file$1,
-			L: 137,
+			L: 144,
 			S: this
 		});
 		const traceHeaders = getTraceHeaders(ctx);
@@ -353,7 +377,7 @@ var BaseHttpClient = class {
 				}, {
 					"~LogMeta": "~LogMeta",
 					F: __dxlog_file$1,
-					L: 155,
+					L: 162,
 					S: this
 				});
 				const response = await fetch(url, request);
@@ -373,17 +397,18 @@ var BaseHttpClient = class {
 				invariant(!body?.success, "Expected body to not be a failure response or undefined.", {
 					"~LogMeta": "~LogMeta",
 					F: __dxlog_file$1,
-					L: 192,
+					L: 199,
 					S: this,
 					A: ["!body?.success", "'Expected body to not be a failure response or undefined.'"]
 				});
 				if (body?.data?.type === "auth_challenge" && typeof body?.data?.challenge === "string") processingError = new EdgeAuthChallengeError(body.data.challenge, body.data);
+				else if (body?.success === false && body.data?.type === EDGE_CLIENT_TOO_OLD) processingError = new EdgeClientTooOldError(body, response.status);
 				else if (body?.success === false) processingError = EdgeCallFailedError.fromUnsuccessfulResponse(response, body);
 				else {
 					invariant(!response.ok, "Expected response to not be ok.", {
 						"~LogMeta": "~LogMeta",
 						F: __dxlog_file$1,
-						L: 199,
+						L: 208,
 						S: this,
 						A: ["!response.ok", "'Expected response to not be ok.'"]
 					});
@@ -398,7 +423,7 @@ var BaseHttpClient = class {
 			}, {
 				"~LogMeta": "~LogMeta",
 				F: __dxlog_file$1,
-				L: 210,
+				L: 219,
 				S: this
 			});
 			else throw processingError;
@@ -422,7 +447,7 @@ var BaseHttpClient = class {
 		}, {
 			"~LogMeta": "~LogMeta",
 			F: __dxlog_file$1,
-			L: 229,
+			L: 238,
 			S: this
 		});
 		const traceHeaders = getTraceHeaders(ctx);
@@ -457,7 +482,7 @@ var BaseHttpClient = class {
 			}, {
 				"~LogMeta": "~LogMeta",
 				F: __dxlog_file$1,
-				L: 277,
+				L: 286,
 				S: this
 			});
 			else throw processingError;
@@ -478,10 +503,11 @@ var BaseHttpClient = class {
 	_prefetchAuthHeader() {
 		if (this._authPrefetch) return this._authPrefetch;
 		const prefetch = this._prefetchAuthHeaderOnce().catch((err) => {
+			if (err instanceof EdgeClientTooOldError) throw err;
 			log.verbose("auth prefetch failed; proceeding unauthenticated", { err }, {
 				"~LogMeta": "~LogMeta",
 				F: __dxlog_file$1,
-				L: 302,
+				L: 315,
 				S: this
 			});
 		}).finally(() => {
@@ -496,7 +522,7 @@ var BaseHttpClient = class {
 			log.verbose("auth prefetch skipped: no identity set", void 0, {
 				"~LogMeta": "~LogMeta",
 				F: __dxlog_file$1,
-				L: 319,
+				L: 332,
 				S: this
 			});
 			return;
@@ -529,7 +555,7 @@ var BaseHttpClient = class {
 			log.warn("unauthorized response received before identity was set", void 0, {
 				"~LogMeta": "~LogMeta",
 				F: __dxlog_file$1,
-				L: 358,
+				L: 371,
 				S: this
 			});
 			throw await EdgeCallFailedError.fromHttpFailure(response);
@@ -560,7 +586,7 @@ var createRequest = ({ method, body, json = true }, authHeader, traceHeaders, cl
 	if (typeof requestBody === "string" && requestBody.length > WARNING_BODY_SIZE) log.warn("Request with large body", { bodySize: requestBody.length }, {
 		"~LogMeta": "~LogMeta",
 		F: __dxlog_file$1,
-		L: 400,
+		L: 413,
 		S: void 0
 	});
 	if (authHeader) headers["Authorization"] = authHeader;
@@ -1060,10 +1086,7 @@ var EdgeHttpClient = class extends BaseHttpClient {
 		const body = method === "GET" || method === "HEAD" ? void 0 : await request.arrayBuffer();
 		let handledAuth = false;
 		while (true) {
-			if (!this._authHeader) {
-				const authResponse = await fetch(new URL("/auth", this.baseUrl));
-				if (authResponse.status === 401) this._authHeader = await this._handleUnauthorized(authResponse);
-			}
+			if (!this._authHeader) await this._prefetchAuthHeader();
 			const headers = new Headers(request.headers);
 			if (this._authHeader) headers.set("Authorization", this._authHeader);
 			if (this._clientTag) headers.set(EDGE_CLIENT_TAG_HEADER, this._clientTag);
@@ -1155,6 +1178,6 @@ var EdgeHttpClient = class extends BaseHttpClient {
 };
 var getFileMimeType = (filename) => [".js", ".mjs"].some((ext) => filename.endsWith(ext)) ? "application/javascript+module" : filename.endsWith(".wasm") ? "application/wasm" : "application/octet-stream";
 //#endregion
-export { parseChallengeHeader as _, HttpConfig as a, withRetry as c, EdgeConnectionClosedError as d, EdgeIdentityChangedError as f, handleAuthChallenge as g, fetchAuthChallengeInfo as h, getEdgeUrlWithProtocol as i, withRetryConfig as l, fetchAuthChallenge as m, EdgeHttpClientService as n, encodeAuthHeader as o, authenticateViaChallengeEndpoint as p, BaseHttpClient as r, withLogging as s, EdgeHttpClient as t, EdgeClientError as u, presentCredentialsForChallenge as v, readAuthChallenge as y };
+export { clientVersionProtocol as S, parseChallengeHeader as _, HttpConfig as a, assertClientSupported as b, withRetry as c, EdgeConnectionClosedError as d, EdgeIdentityChangedError as f, handleAuthChallenge as g, fetchAuthChallengeInfo as h, getEdgeUrlWithProtocol as i, withRetryConfig as l, fetchAuthChallenge as m, EdgeHttpClientService as n, encodeAuthHeader as o, authenticateViaChallengeEndpoint as p, BaseHttpClient as r, withLogging as s, EdgeHttpClient as t, EdgeClientError as u, presentCredentialsForChallenge as v, clientVersionHeaders as x, readAuthChallenge as y };
 
 //# sourceMappingURL=chunk-edge-http-client.mjs.map