Files
moltbot/src/utils/fetch-timeout.ts
Kevin Lin f351961173 fix: log fetch timeout aborts (#73692)
* fix: log fetch timeout aborts

* fix: redact relative timeout urls
2026-04-28 11:36:10 -07:00

146 lines
3.8 KiB
TypeScript

import { createSubsystemLogger } from "../logging/subsystem.js";
const log = createSubsystemLogger("fetch-timeout");
const LOG_URL_MAX_CHARS = 500;
const URL_SECRET_SUFFIX_PATTERN = /[?#]/;
type TimeoutAbortSignalParams = {
timeoutMs?: number;
signal?: AbortSignal;
operation?: string;
url?: string;
};
/**
* Relay abort without forwarding the Event argument as the abort reason.
* Using .bind() avoids closure scope capture (memory leak prevention).
*/
function relayAbort(this: AbortController) {
this.abort();
}
/** Returns a bound abort relay for use as an event listener. */
export function bindAbortRelay(controller: AbortController): () => void {
return relayAbort.bind(controller);
}
function sanitizeTimeoutLogUrl(rawUrl: string | undefined): string | undefined {
const trimmed = rawUrl?.trim();
if (!trimmed) {
return undefined;
}
try {
const parsed = new URL(trimmed);
parsed.username = "";
parsed.password = "";
parsed.search = "";
parsed.hash = "";
const value = parsed.toString();
return value.length > LOG_URL_MAX_CHARS ? `${value.slice(0, LOG_URL_MAX_CHARS)}...` : value;
} catch {
const withoutQueryOrHash = trimmed.split(URL_SECRET_SUFFIX_PATTERN, 1)[0] ?? "";
const cleaned = withoutQueryOrHash
.replace(/[\r\n\u2028\u2029]+/g, " ")
.replace(/\p{Cc}+/gu, " ")
.replace(/\s+/g, " ")
.trim();
if (!cleaned) {
return undefined;
}
return cleaned.length > LOG_URL_MAX_CHARS
? `${cleaned.slice(0, LOG_URL_MAX_CHARS)}...`
: cleaned;
}
}
function abortDueToTimeout(
controller: AbortController,
timeoutMs: number,
startedAtMs: number,
operation?: string,
url?: string,
) {
if (controller.signal.aborted) {
return;
}
const sanitizedUrl = sanitizeTimeoutLogUrl(url);
log.warn("fetch timeout reached; aborting operation", {
timeoutMs,
elapsedMs: Math.max(0, Date.now() - startedAtMs),
...(operation ? { operation } : {}),
...(sanitizedUrl ? { url: sanitizedUrl } : {}),
});
controller.abort();
}
export function buildTimeoutAbortSignal(params: TimeoutAbortSignalParams): {
signal?: AbortSignal;
cleanup: () => void;
} {
const { timeoutMs, signal } = params;
if (!timeoutMs && !signal) {
return { signal: undefined, cleanup: () => {} };
}
if (!timeoutMs) {
return { signal, cleanup: () => {} };
}
const controller = new AbortController();
const normalizedTimeoutMs = Math.max(1, Math.floor(timeoutMs));
const timeoutId = setTimeout(
abortDueToTimeout,
normalizedTimeoutMs,
controller,
normalizedTimeoutMs,
Date.now(),
params.operation,
params.url,
);
const onAbort = bindAbortRelay(controller);
if (signal) {
if (signal.aborted) {
controller.abort();
} else {
signal.addEventListener("abort", onAbort, { once: true });
}
}
return {
signal: controller.signal,
cleanup: () => {
clearTimeout(timeoutId);
if (signal) {
signal.removeEventListener("abort", onAbort);
}
},
};
}
/**
* Fetch wrapper that adds timeout support via AbortController.
*
* @param url - The URL to fetch
* @param init - RequestInit options (headers, method, body, etc.)
* @param timeoutMs - Timeout in milliseconds
* @param fetchFn - The fetch implementation to use (defaults to global fetch)
* @returns The fetch Response
* @throws AbortError if the request times out
*/
export async function fetchWithTimeout(
url: string,
init: RequestInit,
timeoutMs: number,
fetchFn: typeof fetch = fetch,
): Promise<Response> {
const { signal, cleanup } = buildTimeoutAbortSignal({
timeoutMs: Math.max(1, timeoutMs),
operation: "fetchWithTimeout",
url,
});
try {
return await fetchFn(url, { ...init, signal });
} finally {
cleanup();
}
}