@statewalker/webrun-rpc 0.5.0 → 0.5.1

package/dist/async-dispose.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Makes `target` disposable with `await using`: installs `dispose` as its
+ * `[Symbol.asyncDispose]`, where the runtime defines the symbol. Hand-written
+ * iterators lose what a native generator gets from `AsyncIteratorPrototype`;
+ * this gives it back. A no-op where the symbol is missing. Kept off the
+ * declared types, which would require consumers to compile with the
+ * `esnext.disposable` lib.
+ */
+export declare function asyncDisposable<T extends object>(target: T, dispose: () => Promise<unknown>): T;
+//# sourceMappingURL=async-dispose.d.ts.map

package/dist/async-dispose.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"async-dispose.d.ts","sourceRoot":"","sources":["../src/async-dispose.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AACH,wBAAgB,eAAe,CAAC,CAAC,SAAS,MAAM,EAAE,MAAM,EAAE,CAAC,EAAE,OAAO,EAAE,MAAM,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,CAa/F"}

package/dist/connect-serve.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"connect-serve.d.ts","sourceRoot":"","sources":["../src/connect-serve.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAU,KAAK,EAAE,MAAM,6BAA6B,CAAC;AAM1E,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAEzD,OAAO,KAAK,EAAE,SAAS,EAAE,OAAO,EAAE,MAAM,iBAAiB,CAAC;AAU1D,uEAAuE;AACvE,MAAM,MAAM,MAAM,GAAG,CAAC,IAAI,EAAE,aAAa,EAAE,IAAI,CAAC,EAAE,OAAO,KAAK,OAAO,GAAG,SAAS,CAAC;AAElF;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,MAAM,cAAc,GAAG,CAAC,MAAM,CAAC,EAAE,MAAM,KAAK,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;AAE7E,MAAM,WAAW,UAAU;IACzB;;;;;;;;;;OAUG;IACH,GAAG,EAAE,cAAc,CAAC;IACpB;;;yEAGqE;IACrE,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,OAAO,EAAE,OAAO,CAAC,UAAU,CA0BvC,CAAC;AAEF;;;;;;;;;;GAUG;AACH,eAAO,MAAM,KAAK,EAAE,KAAK,CAAC,UAAU,CAqDnC,CAAC;AAEF,MAAM,WAAW,eAAe;IAC9B,mFAAmF;IACnF,KAAK,EAAE,SAAS,CAAC;IACjB;;;;OAIG;IACH,IAAI,CAAC,EAAE,WAAW,GAAG,WAAW,CAAC;IACjC,oEAAoE;IACpE,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;;;OAIG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED;;;;;GAKG;AACH,wBAAgB,QAAQ,CAAC,IAAI,EAAE,aAAa,EAAE,OAAO,EAAE,eAAe,GAAG,cAAc,CAEtF;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,SAAS,CAAC,OAAO,EAAE,cAAc,GAAG,cAAc,CAEjE"}
+{"version":3,"file":"connect-serve.d.ts","sourceRoot":"","sources":["../src/connect-serve.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAU,KAAK,EAAE,MAAM,6BAA6B,CAAC;AAM1E,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAEzD,OAAO,KAAK,EAAE,SAAS,EAAE,OAAO,EAAE,MAAM,iBAAiB,CAAC;AAW1D,uEAAuE;AACvE,MAAM,MAAM,MAAM,GAAG,CAAC,IAAI,EAAE,aAAa,EAAE,IAAI,CAAC,EAAE,OAAO,KAAK,OAAO,GAAG,SAAS,CAAC;AAElF;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,MAAM,cAAc,GAAG,CAAC,MAAM,CAAC,EAAE,MAAM,KAAK,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;AAE7E,MAAM,WAAW,UAAU;IACzB;;;;;;;;;;OAUG;IACH,GAAG,EAAE,cAAc,CAAC;IACpB;;;yEAGqE;IACrE,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,OAAO,EAAE,OAAO,CAAC,UAAU,CAyCvC,CAAC;AAEF;;;;;;;;;;GAUG;AACH,eAAO,MAAM,KAAK,EAAE,KAAK,CAAC,UAAU,CAqDnC,CAAC;AAEF,MAAM,WAAW,eAAe;IAC9B,mFAAmF;IACnF,KAAK,EAAE,SAAS,CAAC;IACjB;;;;OAIG;IACH,IAAI,CAAC,EAAE,WAAW,GAAG,WAAW,CAAC;IACjC,oEAAoE;IACpE,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;;;OAIG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED;;;;;GAKG;AACH,wBAAgB,QAAQ,CAAC,IAAI,EAAE,aAAa,EAAE,OAAO,EAAE,eAAe,GAAG,cAAc,CAEtF;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,SAAS,CAAC,OAAO,EAAE,cAAc,GAAG,cAAc,CAEjE"}

package/dist/duplex-over-port.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"duplex-over-port.d.ts","sourceRoot":"","sources":["../src/duplex-over-port.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,KAAK,MAAM,EAOZ,MAAM,6BAA6B,CAAC;AAIrC,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAGzD;;;;;;;GAOG;AACH,eAAO,MAAM,YAAY,4BAA4B,CAAC;AActD,MAAM,WAAW,qBAAqB;IACpC;;;;OAIG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB;;;;;;OAMG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,6CAA6C;IAC7C,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE,KAAK,IAAI,CAAC;CACpC;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,cAAc,CAAC,IAAI,EAAE,aAAa,EAAE,OAAO,GAAE,qBAA0B,GAAG,MAAM,CAE/F;AAED;;;GAGG;AACH,wBAAgB,mBAAmB,CACjC,IAAI,EAAE,aAAa,EACnB,OAAO,EAAE,MAAM,EACf,OAAO,GAAE,qBAA0B,GAClC,MAAM,IAAI,CA8BZ"}
+{"version":3,"file":"duplex-over-port.d.ts","sourceRoot":"","sources":["../src/duplex-over-port.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,KAAK,MAAM,EAOZ,MAAM,6BAA6B,CAAC;AAIrC,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAIzD;;;;;;;GAOG;AACH,eAAO,MAAM,YAAY,4BAA4B,CAAC;AActD,MAAM,WAAW,qBAAqB;IACpC;;;;OAIG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB;;;;;;OAMG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,6CAA6C;IAC7C,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE,KAAK,IAAI,CAAC;CACpC;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,cAAc,CAAC,IAAI,EAAE,aAAa,EAAE,OAAO,GAAE,qBAA0B,GAAG,MAAM,CAE/F;AAED;;;GAGG;AACH,wBAAgB,mBAAmB,CACjC,IAAI,EAAE,aAAa,EACnB,OAAO,EAAE,MAAM,EACf,OAAO,GAAE,qBAA0B,GAClC,MAAM,IAAI,CA8BZ"}

package/dist/index.js

@@ -468,6 +468,73 @@ async function* callBidi(port, input, { options = {}, ...params } = {}) {
 	if (outerError !== void 0) throw outerError;
 }
 //#endregion
+//#region src/async-dispose.ts
+/**
+* Makes `target` disposable with `await using`: installs `dispose` as its
+* `[Symbol.asyncDispose]`, where the runtime defines the symbol. Hand-written
+* iterators lose what a native generator gets from `AsyncIteratorPrototype`;
+* this gives it back. A no-op where the symbol is missing. Kept off the
+* declared types, which would require consumers to compile with the
+* `esnext.disposable` lib.
+*/
+function asyncDisposable(target, dispose) {
+	const asyncDispose = Symbol.asyncDispose;
+	if (asyncDispose && !(asyncDispose in target)) Object.defineProperty(target, asyncDispose, {
+		value: async () => {
+			await dispose();
+		},
+		configurable: true,
+		writable: true
+	});
+	return target;
+}
+//#endregion
+//#region src/return-at-once.ts
+/**
+* `gen`, except that `return()` and `throw()` take effect at once.
+*
+* On an async generator both are queued behind a `next()` that is still
+* pending: a consumer that gives up on a stream while it waits for the peer's
+* next chunk — an aborted fetch whose response head has not come, say — cannot
+* end it until that chunk arrives, which for a peer that never answers is
+* never. The stream's `finally` (which closes its port and tells the peer)
+* then never runs, and on a multiplexer the port is kept for good.
+*
+* So `abandon` runs first, synchronously: it must make the pending `next()`
+* settle (abort the stream), which then resolves done, after which the
+* generator's own `return()` / `throw()` proceeds as usual. On a generator
+* suspended at a `yield` it is the same ending, a step earlier. `abandon` runs once, whichever comes first.
+*/
+function returningAtOnce(gen, abandon) {
+	let abandoned = false;
+	const giveUp = (reason) => {
+		if (abandoned) return;
+		abandoned = true;
+		abandon(reason);
+	};
+	const wrapped = {
+		next: (...args) => gen.next(...args).catch((error) => {
+			if (abandoned) return {
+				done: true,
+				value: void 0
+			};
+			throw error;
+		}),
+		return(value) {
+			giveUp();
+			return gen.return(value);
+		},
+		throw(error) {
+			giveUp(error);
+			return gen.throw(error);
+		},
+		[Symbol.asyncIterator]() {
+			return wrapped;
+		}
+	};
+	return asyncDisposable(wrapped, () => wrapped.return(void 0));
+}
+//#endregion
 //#region src/duplex-over-port.ts
 /**
 * The `type` of the out-of-band notice a side posts when it abandons a stream.
@@ -565,7 +632,7 @@ function runCallerSide(port, input, options) {
 	const inbound = receiveChunks(port, CHANNEL_OUT, controller, clock.touch);
 	const pump = sendChunks(port, CHANNEL_IN, input, options, controller.signal, clock.touch);
 	pump.catch(() => {});
-	return (async function* () {
+	return returningAtOnce((async function* () {
 		try {
 			yield* inbound.stream;
 		} finally {
@@ -579,7 +646,9 @@ function runCallerSide(port, input, options) {
 				await port.close?.();
 			} catch {}
 		}
-	})();
+	})(), () => {
+		if (!controller.signal.aborted) controller.abort(/* @__PURE__ */ new Error("webrun-rpc: the caller abandoned the stream"));
+	});
 }
 /**
 * Listens for the peer's abort notice, and can post our own. The notice is a
@@ -981,9 +1050,22 @@ const connect = async ({ mux: factory, timeout }) => {
 		maxMessageSize: mux.maxMessageSize,
 		timeout
 	};
-	const call = (input) => (async function* () {
-		yield* duplexOverPort(await mux.openPort(STREAM_META), streamOptions)(input);
-	})();
+	const call = (input) => {
+		let stream;
+		let abandoned = false;
+		return returningAtOnce((async function* () {
+			const port = await mux.openPort(STREAM_META);
+			if (abandoned) {
+				await port.close?.();
+				return;
+			}
+			stream = duplexOverPort(port, streamOptions)(input);
+			yield* stream;
+		})(), () => {
+			abandoned = true;
+			stream?.return(void 0).catch(() => {});
+		});
+	};
 	return {
 		call,
 		async close() {

package/dist/return-at-once.d.ts

@@ -0,0 +1,17 @@
+/**
+ * `gen`, except that `return()` and `throw()` take effect at once.
+ *
+ * On an async generator both are queued behind a `next()` that is still
+ * pending: a consumer that gives up on a stream while it waits for the peer's
+ * next chunk — an aborted fetch whose response head has not come, say — cannot
+ * end it until that chunk arrives, which for a peer that never answers is
+ * never. The stream's `finally` (which closes its port and tells the peer)
+ * then never runs, and on a multiplexer the port is kept for good.
+ *
+ * So `abandon` runs first, synchronously: it must make the pending `next()`
+ * settle (abort the stream), which then resolves done, after which the
+ * generator's own `return()` / `throw()` proceeds as usual. On a generator
+ * suspended at a `yield` it is the same ending, a step earlier. `abandon` runs once, whichever comes first.
+ */
+export declare function returningAtOnce<T>(gen: AsyncGenerator<T>, abandon: (reason?: unknown) => void): AsyncGenerator<T>;
+//# sourceMappingURL=return-at-once.d.ts.map

package/dist/return-at-once.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"return-at-once.d.ts","sourceRoot":"","sources":["../src/return-at-once.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,eAAe,CAAC,CAAC,EAC/B,GAAG,EAAE,cAAc,CAAC,CAAC,CAAC,EACtB,OAAO,EAAE,CAAC,MAAM,CAAC,EAAE,OAAO,KAAK,IAAI,GAClC,cAAc,CAAC,CAAC,CAAC,CA8BnB"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@statewalker/webrun-rpc",
-  "version": "0.5.0",
+  "version": "0.5.1",
   "private": false,
   "type": "module",
   "description": "Ports and RPC over them: a port multiplexer, and typed request/response and streaming primitives over any MessageTarget.",
@@ -30,7 +30,7 @@
     "src"
   ],
   "dependencies": {
-    "@statewalker/webrun-streams": "^0.2.2"
+    "@statewalker/webrun-streams": "^0.2.3"
   },
   "devDependencies": {
     "@biomejs/biome": "^2.5.15",
@@ -39,7 +39,7 @@
     "rolldown": "^1.2.12",
     "typescript": "^7.0.2",
     "vitest": "^5.0.3",
-    "@statewalker/webrun-streams-conformance": "^0.3.2"
+    "@statewalker/webrun-streams-conformance": "^0.3.3"
   },
   "sideEffects": false,
   "publishConfig": {

package/src/async-dispose.ts

@@ -0,0 +1,22 @@
+/**
+ * Makes `target` disposable with `await using`: installs `dispose` as its
+ * `[Symbol.asyncDispose]`, where the runtime defines the symbol. Hand-written
+ * iterators lose what a native generator gets from `AsyncIteratorPrototype`;
+ * this gives it back. A no-op where the symbol is missing. Kept off the
+ * declared types, which would require consumers to compile with the
+ * `esnext.disposable` lib.
+ */
+export function asyncDisposable<T extends object>(target: T, dispose: () => Promise<unknown>): T {
+  // Read here, not at module level: a top-level read is code a bundler keeps.
+  const asyncDispose = (Symbol as { asyncDispose?: symbol }).asyncDispose;
+  if (asyncDispose && !(asyncDispose in target)) {
+    Object.defineProperty(target, asyncDispose, {
+      value: async () => {
+        await dispose();
+      },
+      configurable: true,
+      writable: true,
+    });
+  }
+  return target;
+}

package/src/close-signal.ts

@@ -22,7 +22,7 @@
  */
 import type { MessageTarget } from "./message-target.js";
 
-const closeSignals = new WeakMap<MessageTarget, AbortSignal>();
+const closeSignals = /* @__PURE__ */ new WeakMap<MessageTarget, AbortSignal>();
 
 /**
  * Internal: register a port's close signal. Called once by `bindBytesToPort`.

package/src/connect-serve.ts

@@ -7,6 +7,7 @@ import {
 import type { MessageTarget } from "./message-target.js";
 import { multiplexPort } from "./multiplex-port.js";
 import type { PortCodec, PortMux } from "./port-types.js";
+import { returningAtOnce } from "./return-at-once.js";
 
 /**
  * Announced with every port this pair opens. Layer 1 never reads `meta` — it is
@@ -74,19 +75,34 @@ export const connect: Connect<PortParams> = async ({ mux: factory, timeout }) =>
   const mux = await factory();
   const streamOptions: DuplexOverPortOptions = { maxMessageSize: mux.maxMessageSize, timeout };
 
-  const call: Duplex = (input) =>
+  const call: Duplex = (input) => {
+    let stream: AsyncGenerator<Uint8Array> | undefined;
+    let abandoned = false;
     // The port is opened on the consumer's first pull, not when `call` is
     // invoked. A caller that builds a stream and then drops it without
     // iterating therefore costs the peer nothing — under eager opening it
     // would burn a port (and over libp2p, a whole stream) for a call that
     // never arrives.
-    (async function* () {
+    const outer = (async function* () {
       const port = await mux.openPort(STREAM_META);
+      if (abandoned) {
+        // Given up while the port was being opened.
+        await port.close?.();
+        return;
+      }
+      stream = duplexOverPort(port, streamOptions)(input);
       // `yield*` and not a hand-rolled pump: delegation already forwards
       // `return()` and `throw()` into `duplexOverPort`'s generator, which is
       // exactly the cancellation path `Duplex` specifies.
-      yield* duplexOverPort(port, streamOptions)(input);
+      yield* stream;
     })();
+    // Delegation forwards them only once the pending `next()` settles, though:
+    // giving up while the peer has not answered must reach the stream now.
+    return returningAtOnce(outer, () => {
+      abandoned = true;
+      void stream?.return(undefined).catch(() => {});
+    });
+  };
 
   return {
     call,

package/src/duplex-over-port.ts

@@ -12,6 +12,7 @@ import { callPort, NO_TIMEOUT } from "./call-port.js";
 import { getPortCloseSignal } from "./close-signal.js";
 import { listenPort } from "./listen-port.js";
 import type { MessageTarget } from "./message-target.js";
+import { returningAtOnce } from "./return-at-once.js";
 import { throughAbort } from "./through-abort.js";
 
 /**
@@ -177,7 +178,7 @@ function runCallerSide(
     // the consumer's contract is the inbound half.
   });
 
-  return (async function* () {
+  const stream = (async function* () {
     try {
       yield* inbound.stream;
     } finally {
@@ -200,6 +201,13 @@ function runCallerSide(
       }
     }
   })();
+  // A caller that gives up while it waits for the peer's next chunk ends the
+  // stream now: the abort settles that wait, and the `finally` above runs.
+  return returningAtOnce(stream, () => {
+    if (!controller.signal.aborted) {
+      controller.abort(new Error("webrun-rpc: the caller abandoned the stream"));
+    }
+  });
 }
 
 /**

package/src/return-at-once.ts

@@ -0,0 +1,51 @@
+import { asyncDisposable } from "./async-dispose.js";
+
+/**
+ * `gen`, except that `return()` and `throw()` take effect at once.
+ *
+ * On an async generator both are queued behind a `next()` that is still
+ * pending: a consumer that gives up on a stream while it waits for the peer's
+ * next chunk — an aborted fetch whose response head has not come, say — cannot
+ * end it until that chunk arrives, which for a peer that never answers is
+ * never. The stream's `finally` (which closes its port and tells the peer)
+ * then never runs, and on a multiplexer the port is kept for good.
+ *
+ * So `abandon` runs first, synchronously: it must make the pending `next()`
+ * settle (abort the stream), which then resolves done, after which the
+ * generator's own `return()` / `throw()` proceeds as usual. On a generator
+ * suspended at a `yield` it is the same ending, a step earlier. `abandon` runs once, whichever comes first.
+ */
+export function returningAtOnce<T>(
+  gen: AsyncGenerator<T>,
+  abandon: (reason?: unknown) => void,
+): AsyncGenerator<T> {
+  let abandoned = false;
+  const giveUp = (reason?: unknown) => {
+    if (abandoned) return;
+    abandoned = true;
+    abandon(reason);
+  };
+  const wrapped: AsyncGenerator<T> = {
+    // A `next()` that was pending when the consumer gave up ends as the
+    // stream does — done — rather than rejecting with the abort it caused: a
+    // consumer that raced it against a timer may hold no handler for it.
+    next: (...args: [] | [unknown]) =>
+      gen.next(...args).catch((error: unknown) => {
+        if (abandoned) return { done: true, value: undefined } as IteratorResult<T>;
+        throw error;
+      }),
+    return(value) {
+      giveUp();
+      return gen.return(value);
+    },
+    throw(error) {
+      giveUp(error);
+      return gen.throw(error);
+    },
+    [Symbol.asyncIterator]() {
+      return wrapped;
+    },
+  };
+  // `await using` ends the stream as leaving a `for await` early does.
+  return asyncDisposable(wrapped, () => wrapped.return(undefined));
+}