rouzer 5.2.0 → 5.2.1

package/README.md

@@ -237,6 +237,12 @@ for await (const event of await client.events()) {
 }
 ```
 
+If a client aborts the request signal or stops iteration early by breaking from
+`for await` or calling the iterator's `return()`, Rouzer cancels the response
+body and calls the server source iterator's `return()`. Sources that wait for
+future events should make those waits abort-aware when they need cleanup to run
+while an awaited operation is still pending.
+
 ## Documentation
 
 - [Concepts, API selection, v5 client input notes, and migration notes](docs/context.md)

package/dist/ndjson.d.ts

@@ -2,6 +2,11 @@ import { type ClientResponsePlugin, type ResponsePluginMarker, type RouterRespon
 declare const codecId = "rouzer/ndjson";
 /** Values accepted by Rouzer's NDJSON response encoder. */
 export type NdjsonSource<T = unknown> = Iterable<T> | AsyncIterable<T>;
+/** Options for Rouzer's NDJSON response encoder. */
+export type NdjsonEncodeOptions = {
+    /** Signal whose abort cancels the source iterator and closes the stream. */
+    signal?: AbortSignal;
+};
 /**
  * Create a compile-time marker for newline-delimited JSON response items.
  *
@@ -32,9 +37,11 @@ export declare const routerPlugin: RouterResponsePlugin;
  *
  * @remarks Each yielded value is serialized with `JSON.stringify` and followed
  * by `\n`. Values that cannot be represented as a JSON text, such as
- * `undefined`, cause the stream to error when read.
+ * `undefined`, cause the stream to error when read. When `options.signal`
+ * aborts, the source iterator's `return()` method is called and the stream is
+ * closed.
  */
-export declare function encodeNdjson(source: NdjsonSource): ReadableStream<Uint8Array>;
+export declare function encodeNdjson(source: NdjsonSource, options?: NdjsonEncodeOptions): ReadableStream<Uint8Array>;
 /**
  * Decode a newline-delimited JSON byte stream.
  *
@@ -50,5 +57,5 @@ export declare function decodeNdjson<T = unknown>(stream: ReadableStream<Uint8Ar
  * `content-type: application/x-ndjson; charset=utf-8` unless the caller supplies
  * a content type in `init.headers`.
  */
-export declare function ndjsonResponse<T>(source: NdjsonSource<T>, init?: ResponseInit): Response;
+export declare function ndjsonResponse<T>(source: NdjsonSource<T>, init?: ResponseInit & NdjsonEncodeOptions): Response;
 export {};

package/dist/ndjson.js

@@ -36,8 +36,10 @@ export const clientPlugin = {
  */
 export const routerPlugin = {
     id: codecId,
-    encode(value) {
-        return ndjsonResponse(value);
+    encode(value, { request }) {
+        return ndjsonResponse(value, {
+            signal: request.signal,
+        });
     },
 };
 /**
@@ -45,15 +47,58 @@ export const routerPlugin = {
  *
  * @remarks Each yielded value is serialized with `JSON.stringify` and followed
  * by `\n`. Values that cannot be represented as a JSON text, such as
- * `undefined`, cause the stream to error when read.
+ * `undefined`, cause the stream to error when read. When `options.signal`
+ * aborts, the source iterator's `return()` method is called and the stream is
+ * closed.
  */
-export function encodeNdjson(source) {
+export function encodeNdjson(source, options = {}) {
     const iterator = getAsyncIterator(source);
     const encoder = new TextEncoder();
+    const { signal } = options;
+    let cancelled = false;
+    let cleanup;
+    let abortHandler;
+    function removeAbortHandler() {
+        if (signal && abortHandler) {
+            signal.removeEventListener('abort', abortHandler);
+            abortHandler = undefined;
+        }
+    }
+    function cancelIterator(reason) {
+        cancelled = true;
+        removeAbortHandler();
+        cleanup ??= Promise.resolve(iterator.return?.(reason)).then(() => { });
+        return cleanup;
+    }
     return new ReadableStream({
+        start(controller) {
+            if (!signal) {
+                return;
+            }
+            abortHandler = () => {
+                void cancelIterator(signal.reason).catch(() => { });
+                try {
+                    controller.close();
+                }
+                catch { }
+            };
+            if (signal.aborted) {
+                abortHandler();
+                return;
+            }
+            signal.addEventListener('abort', abortHandler, { once: true });
+        },
         async pull(controller) {
+            if (cancelled) {
+                controller.close();
+                return;
+            }
             const { done, value } = await iterator.next();
+            if (cancelled) {
+                return;
+            }
             if (done) {
+                removeAbortHandler();
                 controller.close();
                 return;
             }
@@ -64,7 +109,7 @@ export function encodeNdjson(source) {
             controller.enqueue(encoder.encode(`${line}\n`));
         },
         async cancel(reason) {
-            await iterator.return?.(reason);
+            await cancelIterator(reason);
         },
     });
 }
@@ -118,12 +163,13 @@ export async function* decodeNdjson(stream) {
  * a content type in `init.headers`.
  */
 export function ndjsonResponse(source, init = {}) {
+    const { signal, ...responseInit } = init;
     const headers = new Headers(init.headers);
     if (!headers.has('content-type')) {
         headers.set('content-type', 'application/x-ndjson; charset=utf-8');
     }
-    return new Response(encodeNdjson(source), {
-        ...init,
+    return new Response(encodeNdjson(source, { signal }), {
+        ...responseInit,
         headers,
     });
 }

package/docs/context.md

@@ -424,6 +424,12 @@ Rouzer's decoder accepts `\n` and `\r\n`, handles UTF-8 chunk boundaries, and
 throws a `SyntaxError` with a line number for malformed JSON. If a consumer stops
 reading early, the response body is cancelled.
 
+If a client aborts the request signal or stops iteration early by breaking from
+`for await` or calling the iterator's `return()`, Rouzer cancels the response
+body and calls the server source iterator's `return()`. Sources that wait for
+future events should make those waits abort-aware when they need cleanup to run
+while an awaited operation is still pending.
+
 Rouzer does not convert handler or generator failures into extra NDJSON items. If
 an async generator throws after the response starts, the response stream errors
 and the client's `for await` loop throws. Model application-level stream errors

package/examples/ndjson-stream.ts

@@ -2,17 +2,34 @@ import type { HattipHandler } from '@hattip/core'
 import { createClient, createRouter } from 'rouzer'
 import * as http from 'rouzer/http'
 import * as ndjson from 'rouzer/ndjson'
+import { z } from 'zod'
 
 type Event = {
   id: number
   message: string
 }
 
+const EventFilter = z.object({
+  names: z.array(z.string()),
+  where: z.array(
+    z.object({
+      path: z.string(),
+      equals: z.string(),
+    })
+  ),
+})
+
 export const events = http.get('events', {
   response: ndjson.$type<Event>(),
 })
 
-export const routes = { events }
+// NDJSON responses work for POST routes with ordinary JSON body schemas too.
+export const stream = http.post('events/stream', {
+  body: EventFilter,
+  response: ndjson.$type<Event>(),
+})
+
+export const routes = { events, stream }
 
 /**
  * Tiny Hattip adapter used only to keep this example self-contained. Real apps
@@ -46,6 +63,17 @@ async function collect<T>(source: AsyncIterable<T>) {
   return values
 }
 
+async function readFirst<T>(source: AsyncIterable<T>) {
+  const iterator = source[Symbol.asyncIterator]()
+  try {
+    return (await iterator.next()).value
+  } finally {
+    // Closing the client iterator cancels the response body. For Rouzer NDJSON
+    // routes, that cancellation reaches the server source iterator's return().
+    await iterator.return?.()
+  }
+}
+
 export async function runNdjsonStreamExample() {
   const handler = createRouter({
     basePath: 'api/',
@@ -55,6 +83,14 @@ export async function runNdjsonStreamExample() {
       yield { id: 1, message: 'ready' }
       yield { id: 2, message: 'done' }
     },
+    async *stream({ body }) {
+      // The POST body was parsed and validated before the stream starts.
+      yield {
+        id: 1,
+        message: `${body.names[0]} for ${body.where[0]?.equals}`,
+      }
+      yield { id: 2, message: 'done' }
+    },
   })
 
   const client = createClient({
@@ -64,5 +100,16 @@ export async function runNdjsonStreamExample() {
     fetch: createLocalFetch(handler),
   })
 
-  return collect(await client.events())
+  const allEvents = await collect(await client.events())
+
+  // This call sends a JSON body, receives an AsyncIterable, and then stops after
+  // one event. Request signals can also be used to cancel long-lived streams.
+  const firstMatchingEvent = await readFirst(
+    await client.stream({
+      names: ['session.message'],
+      where: [{ path: 'id', equals: 'ses_123' }],
+    })
+  )
+
+  return { allEvents, firstMatchingEvent }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "rouzer",
-  "version": "5.2.0",
+  "version": "5.2.1",
   "packageManager": "pnpm@11.5.1",
   "type": "module",
   "exports": {
@@ -41,7 +41,7 @@
   },
   "dependencies": {
     "@hattip/core": "^0.0.49",
-    "@remix-run/route-pattern": "^0.21.1",
+    "@remix-run/route-pattern": "^0.22.1",
     "alien-middleware": "^0.11.6"
   },
   "prettier": "@alloc/prettier-config",