okengine 0.21.0 → 0.22.0

package/src/client/live.ts

@@ -4,7 +4,16 @@
 
 import type { ClientFetch, ClientOptions, ClientRouteMap, FlowContract } from "./types.ts";
 import type { LiveHandlers, LiveUnsubscribe } from "./types.ts";
-import { readSse, sseError } from "./sse.ts";
+import { iterateSseFrames, sseError } from "./sse.ts";
+import {
+  applyAuthHeader,
+  applyHeaderBag,
+  interpolatePath,
+  methodAndPath,
+  resolveHeaders,
+  toQuery,
+  walkContracts,
+} from "./wire.ts";
 
 /** One HTTP exposure of a live signal. */
 export interface LiveExposure {
@@ -31,24 +40,16 @@ export function flattenLiveRoutes($routes: ClientRouteMap | undefined): {
 } {
   const bySignal: Record<string, LiveExposure[]> = {};
   const byFlow: Record<string, LiveExposure> = {};
-  if (!$routes) return { bySignal, byFlow };
-  for (const [unit, flows] of Object.entries($routes)) {
-    if (!flows || typeof flows !== "object") continue;
-    for (const [flow, contract] of Object.entries(flows)) {
-      if (!contract || typeof contract !== "object") continue;
-      const live = liveName(contract);
-      const method = "method" in contract ? contract.method : undefined;
-      const path = "path" in contract ? contract.path : undefined;
-      if (typeof live !== "string" || typeof method !== "string" || typeof path !== "string") {
-        continue;
-      }
-      const matchKey = matchKeyOf(contract);
-      const id = `${unit}.${flow}`;
-      const exposure: LiveExposure = { flow: id, method, path, matchKey };
-      (bySignal[live] ??= []).push(exposure);
-      byFlow[id] = exposure;
-    }
-  }
+  walkContracts($routes, (unit, flow, contract) => {
+    const live = liveName(contract);
+    const route = methodAndPath(contract);
+    if (typeof live !== "string" || !route) return;
+    const matchKey = matchKeyOf(contract);
+    const id = `${unit}.${flow}`;
+    const exposure: LiveExposure = { flow: id, method: route.method, path: route.path, matchKey };
+    (bySignal[live] ??= []).push(exposure);
+    byFlow[id] = exposure;
+  });
   return { bySignal, byFlow };
 }
 
@@ -87,11 +88,7 @@ export function pickLiveExposure(
 ): LiveExposure {
   if (via) {
     const hit = exposures.find((e) => e.flow === via);
-    if (!hit) {
-      throw new Error(
-        `Unknown live via "${via}". Known: ${exposures.map((e) => e.flow).join(", ")}`,
-      );
-    }
+    if (!hit) throw new Error(`Unknown live via "${via}"`);
     return hit;
   }
   const keys =
@@ -100,19 +97,12 @@ export function pickLiveExposure(
       : [];
   const candidates = exposures.filter((e) => e.matchKey.every((k) => keys.includes(k)));
   if (candidates.length === 0) {
-    throw new Error(
-      `No live exposure matches input keys [${keys.join(", ")}]. Flows: ${exposures.map((e) => e.flow).join(", ")}`,
-    );
-  }
-  let max = -1;
-  for (const e of candidates) {
-    if (e.matchKey.length > max) max = e.matchKey.length;
+    throw new Error(`No live exposure matches input keys [${keys.join(", ")}]`);
   }
+  const max = Math.max(...candidates.map((e) => e.matchKey.length));
   const top = candidates.filter((e) => e.matchKey.length === max);
   if (top.length !== 1) {
-    throw new Error(
-      `Multiple live exposures match: ${top.map((e) => e.flow).join(", ")}. Pass via: "unit.flow".`,
-    );
+    throw new Error(`Multiple live exposures match. Pass via: "unit.flow".`);
   }
   return top[0]!;
 }
@@ -173,6 +163,11 @@ async function pump(
   let delayMs = LIVE_RESUBSCRIBE_INITIAL_MS;
   let attempt = 0;
   let lastSeenId: string | undefined;
+  /** Report `err`. Returns whether the loop should resubscribe. */
+  const note = (err: unknown): boolean => {
+    handlers.onError?.(err);
+    return auto;
+  };
   for (;;) {
     if (signal.aborted) return;
     if (attempt > 0 && auto) {
@@ -182,45 +177,26 @@ async function pump(
     }
     attempt += 1;
     try {
-      const res = await openSse(base, exposure, input, opts, signal, lastSeenId);
+      let res = await openSse(base, exposure, input, opts, signal, lastSeenId);
       if (signal.aborted) return;
       if (res.status === 401 && opts.auth?.refresh) {
         await opts.auth.refresh();
-        const retry = await openSse(base, exposure, input, opts, signal, lastSeenId);
-        if (signal.aborted) return;
-        lastSeenId = await consumeSse(retry, handlers, signal, lastSeenId);
+        res = await openSse(base, exposure, input, opts, signal, lastSeenId);
         if (signal.aborted) return;
-        const closed = new Error("live connection closed");
-        if (auto) {
-          handlers.onError?.(closed);
-          continue;
-        }
-        handlers.onError?.(closed);
-        return;
       }
       if (res.status === 410) {
-        const err = await liveResumeGapError(res);
         lastSeenId = undefined;
-        handlers.onError?.(err);
-        if (!auto) return;
-        continue;
+        const text = await res.text().catch(() => "");
+        if (note(sseError(410, text))) continue;
+        return;
       }
       lastSeenId = await consumeSse(res, handlers, signal, lastSeenId);
       if (signal.aborted) return;
-      const closed = new Error("live connection closed");
-      if (auto) {
-        handlers.onError?.(closed);
-        continue;
-      }
-      handlers.onError?.(closed);
+      if (note(new Error("live connection closed"))) continue;
       return;
     } catch (err) {
       if (signal.aborted) return;
-      if (auto) {
-        handlers.onError?.(err);
-        continue;
-      }
-      handlers.onError?.(err);
+      if (note(err)) continue;
       return;
     }
   }
@@ -233,23 +209,13 @@ async function consumeSse(
   lastSeenId: string | undefined,
 ): Promise<string | undefined> {
   let cursor = lastSeenId;
-  await readSse(
-    res,
-    (event, id) => {
-      handlers.onEvent(event);
-      if (id !== undefined && id.length > 0) cursor = id;
-    },
-    signal,
-    handlers.onOpen,
-  );
+  for await (const frame of iterateSseFrames(res, signal, handlers.onOpen)) {
+    handlers.onEvent(frame.event);
+    if (frame.id !== undefined && frame.id.length > 0) cursor = frame.id;
+  }
   return cursor;
 }
 
-async function liveResumeGapError(res: Response): Promise<Error> {
-  const text = await res.text().catch(() => "");
-  return sseError(410, text);
-}
-
 /**
  * Abortable delay. Resolves immediately when `signal` is already aborted.
  *
@@ -280,19 +246,8 @@ async function openSse(
 ): Promise<Response> {
   const { url, method } = restGet(base, exposure.path, input);
   const headers = new Headers({ accept: "text/event-stream" });
-  const extra = typeof opts.headers === "function" ? await opts.headers() : opts.headers;
-  if (Array.isArray(extra)) {
-    for (const [k, v] of extra) headers.set(k, v);
-  } else if (extra) {
-    for (const [k, v] of Object.entries(extra)) headers.set(k, v);
-  }
-  const token =
-    opts.auth && "getToken" in opts.auth && typeof opts.auth.getToken === "function"
-      ? await opts.auth.getToken()
-      : undefined;
-  if (token && !headers.has("authorization")) {
-    headers.set("authorization", `Bearer ${token}`);
-  }
+  applyHeaderBag(headers, await resolveHeaders(opts));
+  await applyAuthHeader(headers, opts);
   if (lastSeenId) headers.set("last-event-id", lastSeenId);
   const fetchFn: ClientFetch = opts.fetch ?? globalThis.fetch.bind(globalThis);
   return fetchFn(url, {
@@ -304,18 +259,6 @@ async function openSse(
 }
 
 function restGet(base: string, path: string, input: unknown): { url: string; method: string } {
-  const params =
-    input !== null && typeof input === "object" ? (input as Record<string, unknown>) : {};
-  let pathOut = path;
-  const query: string[] = [];
-  for (const [k, v] of Object.entries(params)) {
-    const token = `:${k}`;
-    if (pathOut.includes(token)) {
-      pathOut = pathOut.replaceAll(token, encodeURIComponent(String(v)));
-    } else if (v !== undefined) {
-      query.push(`${encodeURIComponent(k)}=${encodeURIComponent(String(v))}`);
-    }
-  }
-  const qs = query.length ? `?${query.join("&")}` : "";
-  return { url: `${base}${pathOut}${qs}`, method: "GET" };
+  const { path: pathOut, rest } = interpolatePath(path, input);
+  return { url: `${base}${pathOut}${toQuery(rest)}`, method: "GET" };
 }

package/src/client/sse.ts

@@ -4,33 +4,30 @@
  * @module
  */
 
-/** Callback for one parsed SSE data frame. */
-export type SseFrameHandler = (event: unknown, id: string | undefined) => void;
+/** One parsed SSE data frame. */
+export interface ParsedSseFrame {
+  readonly event: unknown;
+  readonly id: string | undefined;
+}
 
 /**
- * Read an SSE response body until `[DONE]`, abort, or EOF.
+ * Shared frame pump. `[DONE]` and abort end the iterator without throwing.
  *
- * @param res - Fetch response (`text/event-stream`)
- * @param onEvent - Frame handler
+ * @param res - Fetch response
  * @param signal - Abort signal
  * @param onOpen - Called after content-type validation
  */
-export async function readSse(
+export async function* iterateSseFrames(
   res: Response,
-  onEvent: SseFrameHandler,
   signal: AbortSignal,
   onOpen?: () => void,
-): Promise<void> {
+): AsyncGenerator<ParsedSseFrame> {
   if (signal.aborted) return;
   const ct = res.headers.get("content-type") ?? "";
-  if (!res.ok || !res.body) {
+  if (!res.ok || !res.body || !ct.includes("text/event-stream")) {
     const text = await res.text().catch(() => "");
     throw sseError(res.status, text);
   }
-  if (!ct.includes("text/event-stream")) {
-    const text = await res.text().catch(() => "");
-    throw sseError(res.status, text || `Expected text/event-stream, got ${ct || "none"}`);
-  }
   onOpen?.();
   const reader = res.body.getReader();
   const dec = new TextDecoder();
@@ -39,14 +36,15 @@ export async function readSse(
     for (;;) {
       if (signal.aborted) return;
       const { done, value } = await reader.read();
-      if (done) break;
+      if (done) return;
       buf += dec.decode(value, { stream: true });
       let sep = buf.indexOf("\n\n");
       while (sep >= 0) {
         const raw = buf.slice(0, sep);
         buf = buf.slice(sep + 2);
-        const stop = dispatchFrame(raw, onEvent, signal);
-        if (stop || signal.aborted) return;
+        const frame = parseFrame(raw);
+        if (frame === "done" || signal.aborted) return;
+        if (frame) yield frame;
         sep = buf.indexOf("\n\n");
       }
     }
@@ -56,65 +54,21 @@ export async function readSse(
 }
 
 /**
- * Yield SSE JSON frames as an async iterable until `[DONE]`.
+ * Parse one SSE block. `"done"` stops the pump; `null` skips empty blocks.
  *
- * @param res - Fetch response
- * @param signal - Abort signal
+ * @param raw - Text between blank lines
  */
-export async function* iterateSse(res: Response, signal: AbortSignal): AsyncGenerator<unknown> {
-  const queue: unknown[] = [];
-  let wake: (() => void) | undefined;
-  let done = false;
-  let err: unknown;
-
-  const pump = readSse(
-    res,
-    (event) => {
-      queue.push(event);
-      wake?.();
-    },
-    signal,
-  )
-    .then(() => {
-      done = true;
-      wake?.();
-    })
-    .catch((e) => {
-      err = e;
-      done = true;
-      wake?.();
-    });
-
-  try {
-    for (;;) {
-      while (queue.length > 0) {
-        yield queue.shift();
-      }
-      if (done) break;
-      await new Promise<void>((r) => {
-        wake = r;
-      });
-      wake = undefined;
-    }
-    if (err) throw err;
-  } finally {
-    await pump.catch(() => {});
-  }
-}
-
-function dispatchFrame(raw: string, onEvent: SseFrameHandler, signal: AbortSignal): boolean {
+function parseFrame(raw: string): ParsedSseFrame | "done" | null {
   const dataLines: string[] = [];
   let id: string | undefined;
   for (const line of raw.split("\n")) {
     if (line.startsWith("id:")) id = line.slice(3).replace(/^ /, "");
     if (line.startsWith("data:")) dataLines.push(line.slice(5).replace(/^ /, ""));
   }
-  if (dataLines.length === 0) return false;
+  if (dataLines.length === 0) return null;
   const data = dataLines.join("\n");
-  if (data === "[DONE]") return true;
-  if (signal.aborted) return true;
-  onEvent(JSON.parse(data) as unknown, id);
-  return false;
+  if (data === "[DONE]") return "done";
+  return { event: JSON.parse(data) as unknown, id };
 }
 
 /** Build an Error with optional HTTP status. */

package/src/client/stream.ts

@@ -4,8 +4,17 @@
  * @module
  */
 
-import { iterateSse, sseError } from "./sse.ts";
-import type { ClientFetch, ClientHeaders, ClientOptions, ClientRouteMap } from "./types.ts";
+import { iterateSseFrames, sseError } from "./sse.ts";
+import type { ClientFetch, ClientOptions, ClientRouteMap } from "./types.ts";
+import {
+  applyAuthHeader,
+  applyHeaderBag,
+  interpolatePath,
+  methodAndPath,
+  resolveHeaders,
+  toQuery,
+  walkContracts,
+} from "./wire.ts";
 
 /** Flow id → REST route for stream-only (non-live) SSE. */
 export type StreamByFlow = Readonly<
@@ -19,20 +28,12 @@ export type StreamByFlow = Readonly<
  */
 export function flattenStreamRoutes($routes: ClientRouteMap | undefined): StreamByFlow {
   const out: Record<string, { readonly method: string; readonly path: string }> = {};
-  if (!$routes) return out;
-  for (const [unit, flows] of Object.entries($routes)) {
-    if (!flows || typeof flows !== "object") continue;
-    for (const [flow, contract] of Object.entries(flows)) {
-      if (!contract || typeof contract !== "object") continue;
-      if (!("stream" in contract) || contract.stream !== true) continue;
-      if ("live" in contract && typeof contract.live === "string") continue;
-      const method = "method" in contract ? contract.method : undefined;
-      const path = "path" in contract ? contract.path : undefined;
-      if (typeof method === "string" && typeof path === "string") {
-        out[`${unit}.${flow}`] = { method, path };
-      }
-    }
-  }
+  walkContracts($routes, (unit, flow, contract) => {
+    if (!("stream" in contract) || contract.stream !== true) return;
+    if ("live" in contract && typeof contract.live === "string") return;
+    const route = methodAndPath(contract);
+    if (route) out[`${unit}.${flow}`] = route;
+  });
   return out;
 }
 
@@ -51,36 +52,21 @@ export async function* openStream(
   opts: ClientOptions,
 ): AsyncGenerator<unknown> {
   const fetchFn: ClientFetch = opts.fetch ?? globalThis.fetch.bind(globalThis);
+  const signal = opts.signal ?? new AbortController().signal;
   let refreshed = false;
   for (;;) {
-    const ctrl = new AbortController();
-    const parent = opts.signal;
-    if (parent) {
-      if (parent.aborted) {
-        ctrl.abort();
-      } else {
-        parent.addEventListener("abort", () => ctrl.abort(), { once: true });
-      }
-    }
     const { url, method, body } = streamRequest(base, route.method, route.path, input);
     const headers = new Headers({ accept: "text/event-stream" });
-    const extra = typeof opts.headers === "function" ? await opts.headers() : opts.headers;
-    applyHeaders(headers, extra);
+    applyHeaderBag(headers, await resolveHeaders(opts));
     if (body !== undefined && !headers.has("content-type")) {
       headers.set("content-type", "application/json");
     }
-    const token =
-      opts.auth && "getToken" in opts.auth && typeof opts.auth.getToken === "function"
-        ? await opts.auth.getToken()
-        : undefined;
-    if (token && !headers.has("authorization")) {
-      headers.set("authorization", `Bearer ${token}`);
-    }
+    await applyAuthHeader(headers, opts);
     const res = await fetchFn(url, {
       method,
       headers,
       body,
-      signal: ctrl.signal,
+      signal,
       ...(opts.credentials !== undefined ? { credentials: opts.credentials } : {}),
     });
     if (
@@ -98,7 +84,7 @@ export async function* openStream(
       const text = await res.text().catch(() => "");
       throw sseError(res.status, text);
     }
-    yield* iterateSse(res, ctrl.signal);
+    for await (const frame of iterateSseFrames(res, signal)) yield frame.event;
     return;
   }
 }
@@ -109,39 +95,11 @@ function streamRequest(
   path: string,
   input: unknown,
 ): { url: string; method: string; body: string | undefined } {
-  const params =
-    input !== null && typeof input === "object" ? (input as Record<string, unknown>) : {};
-  let pathOut = path;
-  const rest: Record<string, unknown> = {};
-  for (const [k, v] of Object.entries(params)) {
-    const token = `:${k}`;
-    if (pathOut.includes(token)) {
-      pathOut = pathOut.replaceAll(token, encodeURIComponent(String(v)));
-    } else {
-      rest[k] = v;
-    }
-  }
+  const { path: pathOut, rest } = interpolatePath(path, input);
   const upper = method.toUpperCase();
-  let body: string | undefined;
   if (upper === "GET" || upper === "HEAD") {
-    const query: string[] = [];
-    for (const [k, v] of Object.entries(rest)) {
-      if (v !== undefined) {
-        query.push(`${encodeURIComponent(k)}=${encodeURIComponent(String(v))}`);
-      }
-    }
-    const qs = query.length ? `?${query.join("&")}` : "";
-    return { url: `${base}${pathOut}${qs}`, method: upper, body: undefined };
+    return { url: `${base}${pathOut}${toQuery(rest)}`, method: upper, body: undefined };
   }
-  body = JSON.stringify(Object.keys(rest).length > 0 ? rest : (input ?? {}));
+  const body = JSON.stringify(Object.keys(rest).length > 0 ? rest : (input ?? {}));
   return { url: `${base}${pathOut}`, method: upper, body };
 }
-
-function applyHeaders(headers: Headers, extra: ClientHeaders | undefined): void {
-  if (!extra) return;
-  if (Array.isArray(extra)) {
-    for (const [k, v] of extra) headers.set(k, v);
-  } else {
-    for (const [k, v] of Object.entries(extra)) headers.set(k, v);
-  }
-}