arthron 2.0.1 → 2.1.0

package/dist/index.cjs

@@ -183,6 +183,7 @@ async function validate(schema, body) {
 //#endregion
 //#region src/response/stream-parser.ts
 const DEFAULT_LIMIT = 8388608;
+const DECODE_CHUNK_BYTES = 16384;
 /**
 * Yield the body line by line, reassembling lines split across chunks. Only
 * the newly arrived text is scanned, so a long line costs linear time; a line
@@ -199,28 +200,37 @@ async function* lines(response, maxLineLength) {
 	const breaks = /\r\n|\r|\n/g;
 	let pending = "";
 	let afterCR = false;
+	const scan = function* (decoded) {
+		let text = decoded;
+		if (afterCR && text.startsWith("\n")) {
+			text = text.slice(1);
+			afterCR = false;
+		}
+		if (text) afterCR = text.endsWith("\r");
+		let start = 0;
+		breaks.lastIndex = 0;
+		for (let m = breaks.exec(text); m; m = breaks.exec(text)) {
+			yield checked(pending + text.slice(start, m.index));
+			pending = "";
+			start = breaks.lastIndex;
+		}
+		pending = checked(pending + text.slice(start));
+	};
 	try {
 		while (true) {
 			const { value, done } = await reader.read();
-			let text = decoder.decode(value, { stream: !done });
-			if (afterCR && text.startsWith("\n")) {
-				text = text.slice(1);
-				afterCR = false;
+			if (value) for (let offset = 0; offset < value.byteLength; offset += DECODE_CHUNK_BYTES) {
+				const part = value.subarray(offset, offset + DECODE_CHUNK_BYTES);
+				yield* scan(decoder.decode(part, { stream: true }));
 			}
-			if (text) afterCR = text.endsWith("\r");
-			let start = 0;
-			breaks.lastIndex = 0;
-			for (let m = breaks.exec(text); m; m = breaks.exec(text)) {
-				yield checked(pending + text.slice(start, m.index));
-				pending = "";
-				start = breaks.lastIndex;
+			if (done) {
+				yield* scan(decoder.decode());
+				break;
 			}
-			pending = checked(pending + text.slice(start));
-			if (done) break;
 		}
 		if (pending) yield pending;
 	} finally {
-		await reader.cancel().catch(() => {});
+		reader.cancel().catch(() => {});
 		reader.releaseLock();
 	}
 }
@@ -481,9 +491,9 @@ function assertSendable(url, method) {
 	try {
 		new Request(url, { method });
 	} catch (cause) {
-		require_create_error.redactErrorUrl(cause, url);
+		const safeCause = require_create_error.redactErrorUrl(cause, url);
 		const reason = require_create_error.redactUrlIn(cause instanceof Error ? cause.message : String(cause), url);
-		throw new TypeError(`arthron: cannot send ${method} ${require_create_error.redactUrl(url)} (${reason}) — use an absolute URL or a baseURL with a scheme (https://…), and a valid HTTP method`, { cause });
+		throw new TypeError(`arthron: cannot send ${method} ${require_create_error.redactUrl(url)} (${reason}) — use an absolute URL or a baseURL with a scheme (https://…), and a valid HTTP method`, { cause: safeCause });
 	}
 }
 /**

package/dist/index.mjs

@@ -1,4 +1,4 @@
-import { C as withoutSecrets, S as resolveUrl, _ as leavesBase, a as responseError, b as redactUrl, c as isReadableStream, d as tagOf, f as ArthronError, h as httpOrigin, i as redactErrorUrl, l as runtimeStreamsRequestBody, m as fillPath, n as isCancellation, p as isArthronError, r as networkError, t as cancellationError, u as serializeBody, x as redactUrlIn, y as originSet } from "./shared.mjs";
+import { C as redactUrlIn, S as redactUrl, T as withoutSecrets, _ as httpOrigin, a as redactErrorUrl, d as runtimeStreamsRequestBody, f as serializeBody, g as fillPath, h as isArthronError, i as networkError, m as ArthronError, n as isCancellation, o as responseError, p as tagOf, t as cancellationError, u as isReadableStream, w as resolveUrl, x as originSet, y as leavesBase } from "./shared.mjs";
 //#region src/request/headers.ts
 const isPlainRecord = (headers) => !Array.isArray(headers) && Object.prototype.toString.call(headers) !== "[object Headers]";
 /**
@@ -182,6 +182,7 @@ async function validate(schema, body) {
 //#endregion
 //#region src/response/stream-parser.ts
 const DEFAULT_LIMIT = 8388608;
+const DECODE_CHUNK_BYTES = 16384;
 /**
 * Yield the body line by line, reassembling lines split across chunks. Only
 * the newly arrived text is scanned, so a long line costs linear time; a line
@@ -198,28 +199,37 @@ async function* lines(response, maxLineLength) {
 	const breaks = /\r\n|\r|\n/g;
 	let pending = "";
 	let afterCR = false;
+	const scan = function* (decoded) {
+		let text = decoded;
+		if (afterCR && text.startsWith("\n")) {
+			text = text.slice(1);
+			afterCR = false;
+		}
+		if (text) afterCR = text.endsWith("\r");
+		let start = 0;
+		breaks.lastIndex = 0;
+		for (let m = breaks.exec(text); m; m = breaks.exec(text)) {
+			yield checked(pending + text.slice(start, m.index));
+			pending = "";
+			start = breaks.lastIndex;
+		}
+		pending = checked(pending + text.slice(start));
+	};
 	try {
 		while (true) {
 			const { value, done } = await reader.read();
-			let text = decoder.decode(value, { stream: !done });
-			if (afterCR && text.startsWith("\n")) {
-				text = text.slice(1);
-				afterCR = false;
+			if (value) for (let offset = 0; offset < value.byteLength; offset += DECODE_CHUNK_BYTES) {
+				const part = value.subarray(offset, offset + DECODE_CHUNK_BYTES);
+				yield* scan(decoder.decode(part, { stream: true }));
 			}
-			if (text) afterCR = text.endsWith("\r");
-			let start = 0;
-			breaks.lastIndex = 0;
-			for (let m = breaks.exec(text); m; m = breaks.exec(text)) {
-				yield checked(pending + text.slice(start, m.index));
-				pending = "";
-				start = breaks.lastIndex;
+			if (done) {
+				yield* scan(decoder.decode());
+				break;
 			}
-			pending = checked(pending + text.slice(start));
-			if (done) break;
 		}
 		if (pending) yield pending;
 	} finally {
-		await reader.cancel().catch(() => {});
+		reader.cancel().catch(() => {});
 		reader.releaseLock();
 	}
 }
@@ -480,9 +490,9 @@ function assertSendable(url, method) {
 	try {
 		new Request(url, { method });
 	} catch (cause) {
-		redactErrorUrl(cause, url);
+		const safeCause = redactErrorUrl(cause, url);
 		const reason = redactUrlIn(cause instanceof Error ? cause.message : String(cause), url);
-		throw new TypeError(`arthron: cannot send ${method} ${redactUrl(url)} (${reason}) — use an absolute URL or a baseURL with a scheme (https://…), and a valid HTTP method`, { cause });
+		throw new TypeError(`arthron: cannot send ${method} ${redactUrl(url)} (${reason}) — use an absolute URL or a baseURL with a scheme (https://…), and a valid HTTP method`, { cause: safeCause });
 	}
 }
 /**

package/dist/plugins.cjs

@@ -100,18 +100,24 @@ function bearerAuth(options) {
 }
 //#endregion
 //#region src/plugins/logging/logging.ts
+/** What an error line shows without a status: the error's name (`TimeoutError`, `TypeError`), else `-`. */
+function nameOf(error) {
+	const name = error?.name;
+	return typeof name === "string" && name !== "" ? name : "-";
+}
 function consoleSink(logger) {
 	return (e) => {
 		if (e.phase === "start") logger.log(`[arthron] → ${e.method} ${e.url}`);
 		else if (e.phase === "success") logger.log(`[arthron] ← ${e.method} ${e.url} ${e.status} ${e.duration}ms`);
-		else logger.error(`[arthron] ✕ ${e.method} ${e.url} ${e.status ?? "-"} ${e.duration}ms`);
+		else logger.error(`[arthron] ✕ ${e.method} ${e.url} ${e.status ?? nameOf(e.error)} ${e.duration}ms`);
 	};
 }
 /**
 * One event when a request starts, one when it settles, with status and
 * elapsed time. Wraps the whole call, so retries are included in the time.
 * Default output is a console line per event; pass `onEvent` to get the
-* structured event instead. Cancellations are not reported.
+* structured event instead. Cancellations are not reported, timeouts only
+* with `timeouts: true`.
 */
 function logging(options = {}) {
 	if (options.now !== void 0) throw new TypeError("arthron: logging's now option left the public options in 2.0 — mock performance.now in tests (vi.spyOn(performance, \"now\"))");
@@ -119,7 +125,8 @@ function logging(options = {}) {
 }
 /** `logging()` with the clock injected — for this package's tests; `arthron/plugins` does not export it. */
 function loggingWithClock(options, now) {
-	const { enabled = true, logger = console, onEvent } = options;
+	const { enabled = true, logger = console, onEvent, timeouts = false } = options;
+	const reported = (error, signal) => !require_create_error.isCancellation(error, signal) || timeouts && require_create_error.isTimeout(error);
 	const emit = onEvent ?? consoleSink(logger);
 	return {
 		pluginName: "logging",
@@ -138,7 +145,7 @@ function loggingWithClock(options, now) {
 			try {
 				res = await next(ctx);
 			} catch (error) {
-				if (!require_create_error.isCancellation(error, ctx.init.signal)) {
+				if (reported(error, ctx.init.signal)) {
 					const status = require_create_error.isArthronError(error) ? error.status : void 0;
 					emit({
 						phase: "error",
@@ -293,8 +300,10 @@ const MAX_TIMER_MS = 2 ** 31 - 1;
 /**
 * Wrap `body` so the deadline keeps running until it is fully read, and so an
 * abort while reading surfaces as a stream error instead of a silent stall.
+* The idle deadline runs only while a read waits on the source: the time the
+* caller takes between reads is not the server going quiet.
 */
-function guardBody(body, signal, finish, onChunk) {
+function guardBody(body, signal, finish, idle) {
 	const reader = body.getReader();
 	let onAbort = () => {};
 	const release = () => {
@@ -305,12 +314,15 @@ function guardBody(body, signal, finish, onChunk) {
 		start(controller) {
 			onAbort = () => {
 				controller.error(signal.reason);
+				release();
 				reader.cancel(signal.reason).catch(() => {});
 			};
-			signal.addEventListener("abort", onAbort, { once: true });
+			if (signal.aborted) onAbort();
+			else signal.addEventListener("abort", onAbort, { once: true });
 		},
 		async pull(controller) {
 			let chunk;
+			idle.start();
 			try {
 				chunk = await reader.read();
 			} catch (error) {
@@ -322,7 +334,7 @@ function guardBody(body, signal, finish, onChunk) {
 				controller.close();
 				return;
 			}
-			onChunk();
+			idle.stop();
 			controller.enqueue(chunk.value);
 		},
 		cancel(reason) {
@@ -396,16 +408,19 @@ function timeout(first, removed) {
 			const signal = outer ? AbortSignal.any([outer, controller.signal]) : controller.signal;
 			const total = deadline === Number.POSITIVE_INFINITY ? void 0 : deadlineTimer(controller, deadline, `arthron: request timed out after ${deadline}ms`);
 			let quiet;
-			const stillAlive = () => {
-				if (idleMs === void 0) return;
-				clearTimeout(quiet);
-				quiet = deadlineTimer(controller, idleMs, `arthron: no data for ${idleMs}ms`);
+			const idleTimer = {
+				start: () => {
+					if (idleMs === void 0) return;
+					clearTimeout(quiet);
+					quiet = deadlineTimer(controller, idleMs, `arthron: no data for ${idleMs}ms`);
+				},
+				stop: () => clearTimeout(quiet)
 			};
 			const finish = () => {
 				clearTimeout(total);
-				clearTimeout(quiet);
+				idleTimer.stop();
 			};
-			stillAlive();
+			idleTimer.start();
 			let res;
 			try {
 				res = await next({
@@ -423,8 +438,8 @@ function timeout(first, removed) {
 				finish();
 				return res;
 			}
-			stillAlive();
-			return require_create_error.rebuildResponse(res, guardBody(res.body, signal, finish, stillAlive));
+			idleTimer.stop();
+			return require_create_error.rebuildResponse(res, guardBody(res.body, signal, finish, idleTimer));
 		}
 	};
 }
@@ -449,7 +464,7 @@ function encodeFormData(form) {
 	const b = boundary();
 	const parts = [];
 	for (const [name, value] of form) {
-		let head = `--${b}\r\nContent-Disposition: form-data; name="${escapeName(name)}"`;
+		let head = `--${b}\r\nContent-Disposition: form-data; name="${escapeName(normalizeBreaks(name))}"`;
 		if (typeof value === "string") {
 			parts.push(encoder.encode(`${head}\r\n\r\n`));
 			parts.push(encoder.encode(normalizeBreaks(value)));
@@ -711,15 +726,20 @@ function xhrFetch(onProgress) {
 		xhr.onload = () => {
 			if (!reported) report(0, 0);
 			if (xhr.status === 0) return settle(() => reject(/* @__PURE__ */ new TypeError("Network request failed")));
-			const headers = parseResponseHeaders(xhr.getAllResponseHeaders());
-			const body = NULL_BODY_STATUSES.has(xhr.status) ? null : xhr.response;
-			const res = new Response(body, {
-				status: xhr.status,
-				statusText: xhr.statusText,
-				headers
-			});
-			const page = globalThis.location?.href;
-			settle(() => resolve(require_create_error.withFields(res, responseFields(url, xhr.responseURL, page))));
+			let res;
+			try {
+				const headers = parseResponseHeaders(xhr.getAllResponseHeaders());
+				const body = NULL_BODY_STATUSES.has(xhr.status) ? null : xhr.response;
+				const page = globalThis.location?.href;
+				res = require_create_error.withFields(require_create_error.createResponse(body, {
+					status: xhr.status,
+					statusText: xhr.statusText,
+					headers
+				}), responseFields(url, xhr.responseURL, page));
+			} catch (error) {
+				return settle(() => reject(error));
+			}
+			settle(() => resolve(res));
 		};
 		xhr.onerror = xhr.ontimeout = () => settle(() => reject(/* @__PURE__ */ new TypeError("Network request failed")));
 		xhr.open(init.method ?? "GET", url);

package/dist/plugins.d.cts

@@ -71,6 +71,14 @@ type LoggingOptions = {
   logger?: Pick<Console, "log" | "error">;
   /** Receive structured events instead of the default console lines. */
   onEvent?: (event: LogEvent) => void;
+  /**
+   * Default `false`. `true` reports a call that timed out before its response
+   * arrived — a `TimeoutError`, from `timeout()` or `AbortSignal.timeout()` —
+   * as an error event, `status` undefined. A timeout while the body is read
+   * rejects that read instead: the call has already logged its success.
+   * Other cancellations are never reported.
+   */
+  timeouts?: boolean;
 };
 //#endregion
 //#region src/plugins/logging/logging.d.ts
@@ -78,7 +86,8 @@ type LoggingOptions = {
  * One event when a request starts, one when it settles, with status and
  * elapsed time. Wraps the whole call, so retries are included in the time.
  * Default output is a console line per event; pass `onEvent` to get the
- * structured event instead. Cancellations are not reported.
+ * structured event instead. Cancellations are not reported, timeouts only
+ * with `timeouts: true`.
  */
 export declare function logging(options?: LoggingOptions): Plugin;
 //#endregion

package/dist/plugins.d.mts

@@ -71,6 +71,14 @@ type LoggingOptions = {
   logger?: Pick<Console, "log" | "error">;
   /** Receive structured events instead of the default console lines. */
   onEvent?: (event: LogEvent) => void;
+  /**
+   * Default `false`. `true` reports a call that timed out before its response
+   * arrived — a `TimeoutError`, from `timeout()` or `AbortSignal.timeout()` —
+   * as an error event, `status` undefined. A timeout while the body is read
+   * rejects that read instead: the call has already logged its success.
+   * Other cancellations are never reported.
+   */
+  timeouts?: boolean;
 };
 //#endregion
 //#region src/plugins/logging/logging.d.ts
@@ -78,7 +86,8 @@ type LoggingOptions = {
  * One event when a request starts, one when it settles, with status and
  * elapsed time. Wraps the whole call, so retries are included in the time.
  * Default output is a console line per event; pass `onEvent` to get the
- * structured event instead. Cancellations are not reported.
+ * structured event instead. Cancellations are not reported, timeouts only
+ * with `timeouts: true`.
  */
 export declare function logging(options?: LoggingOptions): Plugin;
 //#endregion

package/dist/plugins.mjs

@@ -1,4 +1,4 @@
-import { b as redactUrl, c as isReadableStream, d as tagOf, g as httpOrigins, n as isCancellation, o as rebuildResponse, p as isArthronError, s as withFields, v as originOf } from "./shared.mjs";
+import { S as redactUrl, b as originOf, c as rebuildResponse, h as isArthronError, l as withFields, n as isCancellation, p as tagOf, r as isTimeout, s as createResponse, u as isReadableStream, v as httpOrigins } from "./shared.mjs";
 //#region src/plugins/bearer-auth/bearer-auth.ts
 /** 1.x option, its replacement, and how to pass it. */
 const REPLACED$1 = [
@@ -99,18 +99,24 @@ function bearerAuth(options) {
 }
 //#endregion
 //#region src/plugins/logging/logging.ts
+/** What an error line shows without a status: the error's name (`TimeoutError`, `TypeError`), else `-`. */
+function nameOf(error) {
+	const name = error?.name;
+	return typeof name === "string" && name !== "" ? name : "-";
+}
 function consoleSink(logger) {
 	return (e) => {
 		if (e.phase === "start") logger.log(`[arthron] → ${e.method} ${e.url}`);
 		else if (e.phase === "success") logger.log(`[arthron] ← ${e.method} ${e.url} ${e.status} ${e.duration}ms`);
-		else logger.error(`[arthron] ✕ ${e.method} ${e.url} ${e.status ?? "-"} ${e.duration}ms`);
+		else logger.error(`[arthron] ✕ ${e.method} ${e.url} ${e.status ?? nameOf(e.error)} ${e.duration}ms`);
 	};
 }
 /**
 * One event when a request starts, one when it settles, with status and
 * elapsed time. Wraps the whole call, so retries are included in the time.
 * Default output is a console line per event; pass `onEvent` to get the
-* structured event instead. Cancellations are not reported.
+* structured event instead. Cancellations are not reported, timeouts only
+* with `timeouts: true`.
 */
 function logging(options = {}) {
 	if (options.now !== void 0) throw new TypeError("arthron: logging's now option left the public options in 2.0 — mock performance.now in tests (vi.spyOn(performance, \"now\"))");
@@ -118,7 +124,8 @@ function logging(options = {}) {
 }
 /** `logging()` with the clock injected — for this package's tests; `arthron/plugins` does not export it. */
 function loggingWithClock(options, now) {
-	const { enabled = true, logger = console, onEvent } = options;
+	const { enabled = true, logger = console, onEvent, timeouts = false } = options;
+	const reported = (error, signal) => !isCancellation(error, signal) || timeouts && isTimeout(error);
 	const emit = onEvent ?? consoleSink(logger);
 	return {
 		pluginName: "logging",
@@ -137,7 +144,7 @@ function loggingWithClock(options, now) {
 			try {
 				res = await next(ctx);
 			} catch (error) {
-				if (!isCancellation(error, ctx.init.signal)) {
+				if (reported(error, ctx.init.signal)) {
 					const status = isArthronError(error) ? error.status : void 0;
 					emit({
 						phase: "error",
@@ -292,8 +299,10 @@ const MAX_TIMER_MS = 2 ** 31 - 1;
 /**
 * Wrap `body` so the deadline keeps running until it is fully read, and so an
 * abort while reading surfaces as a stream error instead of a silent stall.
+* The idle deadline runs only while a read waits on the source: the time the
+* caller takes between reads is not the server going quiet.
 */
-function guardBody(body, signal, finish, onChunk) {
+function guardBody(body, signal, finish, idle) {
 	const reader = body.getReader();
 	let onAbort = () => {};
 	const release = () => {
@@ -304,12 +313,15 @@ function guardBody(body, signal, finish, onChunk) {
 		start(controller) {
 			onAbort = () => {
 				controller.error(signal.reason);
+				release();
 				reader.cancel(signal.reason).catch(() => {});
 			};
-			signal.addEventListener("abort", onAbort, { once: true });
+			if (signal.aborted) onAbort();
+			else signal.addEventListener("abort", onAbort, { once: true });
 		},
 		async pull(controller) {
 			let chunk;
+			idle.start();
 			try {
 				chunk = await reader.read();
 			} catch (error) {
@@ -321,7 +333,7 @@ function guardBody(body, signal, finish, onChunk) {
 				controller.close();
 				return;
 			}
-			onChunk();
+			idle.stop();
 			controller.enqueue(chunk.value);
 		},
 		cancel(reason) {
@@ -395,16 +407,19 @@ function timeout(first, removed) {
 			const signal = outer ? AbortSignal.any([outer, controller.signal]) : controller.signal;
 			const total = deadline === Number.POSITIVE_INFINITY ? void 0 : deadlineTimer(controller, deadline, `arthron: request timed out after ${deadline}ms`);
 			let quiet;
-			const stillAlive = () => {
-				if (idleMs === void 0) return;
-				clearTimeout(quiet);
-				quiet = deadlineTimer(controller, idleMs, `arthron: no data for ${idleMs}ms`);
+			const idleTimer = {
+				start: () => {
+					if (idleMs === void 0) return;
+					clearTimeout(quiet);
+					quiet = deadlineTimer(controller, idleMs, `arthron: no data for ${idleMs}ms`);
+				},
+				stop: () => clearTimeout(quiet)
 			};
 			const finish = () => {
 				clearTimeout(total);
-				clearTimeout(quiet);
+				idleTimer.stop();
 			};
-			stillAlive();
+			idleTimer.start();
 			let res;
 			try {
 				res = await next({
@@ -422,8 +437,8 @@ function timeout(first, removed) {
 				finish();
 				return res;
 			}
-			stillAlive();
-			return rebuildResponse(res, guardBody(res.body, signal, finish, stillAlive));
+			idleTimer.stop();
+			return rebuildResponse(res, guardBody(res.body, signal, finish, idleTimer));
 		}
 	};
 }
@@ -448,7 +463,7 @@ function encodeFormData(form) {
 	const b = boundary();
 	const parts = [];
 	for (const [name, value] of form) {
-		let head = `--${b}\r\nContent-Disposition: form-data; name="${escapeName(name)}"`;
+		let head = `--${b}\r\nContent-Disposition: form-data; name="${escapeName(normalizeBreaks(name))}"`;
 		if (typeof value === "string") {
 			parts.push(encoder.encode(`${head}\r\n\r\n`));
 			parts.push(encoder.encode(normalizeBreaks(value)));
@@ -710,15 +725,20 @@ function xhrFetch(onProgress) {
 		xhr.onload = () => {
 			if (!reported) report(0, 0);
 			if (xhr.status === 0) return settle(() => reject(/* @__PURE__ */ new TypeError("Network request failed")));
-			const headers = parseResponseHeaders(xhr.getAllResponseHeaders());
-			const body = NULL_BODY_STATUSES.has(xhr.status) ? null : xhr.response;
-			const res = new Response(body, {
-				status: xhr.status,
-				statusText: xhr.statusText,
-				headers
-			});
-			const page = globalThis.location?.href;
-			settle(() => resolve(withFields(res, responseFields(url, xhr.responseURL, page))));
+			let res;
+			try {
+				const headers = parseResponseHeaders(xhr.getAllResponseHeaders());
+				const body = NULL_BODY_STATUSES.has(xhr.status) ? null : xhr.response;
+				const page = globalThis.location?.href;
+				res = withFields(createResponse(body, {
+					status: xhr.status,
+					statusText: xhr.statusText,
+					headers
+				}), responseFields(url, xhr.responseURL, page));
+			} catch (error) {
+				return settle(() => reject(error));
+			}
+			settle(() => resolve(res));
 		};
 		xhr.onerror = xhr.ontimeout = () => settle(() => reject(/* @__PURE__ */ new TypeError("Network request failed")));
 		xhr.open(init.method ?? "GET", url);