@heojeongbo/wirestage 0.1.0 → 0.2.0

package/src/features/sse/model/types.ts

@@ -31,9 +31,15 @@ export interface SseConnection {
 	readonly sent: number;
 	/** Write an event. A string is sent as `data`. Resolves once written. */
 	send(event: SseEvent | string): Promise<void>;
-	/** Close cleanly; EventSource will reconnect after its retry delay. */
+	/**
+	 * Close cleanly; EventSource will reconnect after its retry delay.
+	 * Resolves once the end is on the timeline.
+	 */
 	end(): Promise<void>;
-	/** Reset the connection, as a network drop would. */
+	/**
+	 * Reset the connection, as a network drop would. Resolves once the cut is
+	 * on the timeline.
+	 */
 	cut(): Promise<void>;
 	readonly closed: Promise<SseEnd>;
 }

package/src/features/websocket/lib/proxy.ts

@@ -49,6 +49,9 @@ export async function createProxy(
 				label: `message on ${socket.url.pathname}`,
 			});
 			const closed = createDeferred<WsCloseInfo>();
+			// Who closed, when neither end did: the test, or the stub — the
+			// stage closes the socket of a rule that throws.
+			let closedBy: "test" | "stub" | undefined;
 			log("lifecycle", "none", "page", { event: "open", url: socket.url.href });
 			const forward = (
 				direction: "in" | "out",
@@ -57,7 +60,16 @@ export async function createProxy(
 			) => {
 				const passing = toMessage(direction, raw, context.clock.now());
 				messages.push(passing);
-				if (options.drop?.(passing)) {
+				let dropped: boolean | undefined;
+				try {
+					dropped = options.drop?.(passing);
+				} catch (error) {
+					// The stage fails a rule that throws and closes both ends: the
+					// closes they report are the stub's, not the page's or server's.
+					closedBy ??= "stub";
+					throw error;
+				}
+				if (dropped) {
 					log("fault", direction, "stub", { reason: "dropped" }, raw);
 					return;
 				}
@@ -77,7 +89,6 @@ export async function createProxy(
 			// end to pass the close on, and the end that started it to complete
 			// it — the page's socket hangs in CLOSING until its end is closed.
 			// Once: each of those closes is reported back through a handler.
-			let closedBy: "test" | undefined;
 			const relay =
 				(from: "page" | "network") =>
 				(code: number | undefined, reason: string | undefined) => {
@@ -97,7 +108,8 @@ export async function createProxy(
 				};
 			page.onClose(relay("page"));
 			server.onClose(relay("network"));
-			// Over from the moment the test closes it, before either end hears.
+			// Over from the moment the test closes it or the rule fails, before
+			// either end hears.
 			const over = () => closed.settled || closedBy !== undefined;
 			connections.push({
 				url: socket.url.href,

package/src/features/websocket/model/types.ts

@@ -90,7 +90,11 @@ export interface WsMock {
 export interface WsProxyOptions {
 	/** Proxy this many connections, then leave the rest to the next rule. */
 	readonly times?: number;
-	/** Drop a message instead of forwarding it. Dropped messages are recorded as faults. */
+	/**
+	 * Drop a message instead of forwarding it. Dropped messages are recorded
+	 * as faults. If it throws, the stage closes both ends, the page's with
+	 * 1011, and records a `rule-error` fault.
+	 */
 	readonly drop?: (message: WsMessage) => boolean;
 }
 

package/src/index.ts

@@ -102,9 +102,11 @@ export type { UrlMatcher } from "./shared/lib/match/index.js";
 export { compileUrlMatcher } from "./shared/lib/match/index.js";
 export type {
 	AttachOptions,
+	MarkOptions,
 	ReportOptions,
 	Stage,
 	StageCore,
+	StageCursor,
 	StageOptions,
 	StageReport,
 } from "./widgets/stage/index.js";

package/src/shared/api/playwright/ports.ts

@@ -30,6 +30,8 @@ export interface ResponsePort {
 	status(): number;
 	headers(): HeaderMap;
 	body(): Promise<Buffer>;
+	/** Who sent it; null for a response a route made up. */
+	serverAddr(): Promise<{ ipAddress: string; port: number } | null>;
 }
 
 export interface RequestPort {
@@ -44,8 +46,11 @@ export interface RequestPort {
 	allHeaders(): Promise<HeaderMap>;
 	postDataBuffer(): Buffer | null;
 	resourceType(): string;
-	/** Throws for requests a service worker makes; callers must guard it. */
-	frame(): { page(): PagePort };
+	/**
+	 * The frame that sent it, the same object for every request of that
+	 * frame. Throws for requests a service worker makes; callers must guard it.
+	 */
+	frame(): { url(): string; page(): PagePort };
 	response(): Promise<ResponsePort | null>;
 	failure(): { errorText: string } | null;
 }

package/src/shared/api/stream-server/stream-server.ts

@@ -37,7 +37,9 @@ export interface StreamServer {
 	/**
 	 * Register a handler and return the URL to redirect one request to.
 	 * `secure` is whether the page's request was https: Playwright only lets
-	 * `route.continue` change the URL within the same scheme.
+	 * `route.continue` change the URL within the same scheme. Every response
+	 * closes its connection (`connection: close`); a handler leaves that
+	 * header alone.
 	 */
 	open(
 		handler: NodeHandler,
@@ -107,6 +109,11 @@ export function createStreamServer(
 	};
 
 	const onRequest = (request: IncomingMessage, response: ServerResponse) => {
+		// One response per connection. A browser re-sends a request that dies
+		// before its first byte on a connection it reused — a stream cut at
+		// once — and its session is gone by then: the page would get a 404
+		// where the test cut the stream.
+		response.setHeader("connection", "close");
 		allowCors(request, response);
 		if (request.method === "OPTIONS") {
 			response.writeHead(204);
@@ -143,8 +150,9 @@ export function createStreamServer(
 					return;
 				}
 				options.log?.error("stream handler failed", { session: id }, error);
-				if (!response.headersSent) response.writeHead(500);
-				response.end();
+				// After the head, a clean end would pass for the whole response.
+				if (response.headersSent) response.destroy();
+				else response.writeHead(500).end();
 			});
 	};
 

package/src/widgets/stage/index.ts

@@ -1,9 +1,11 @@
 export { createStage } from "./lib/create-stage.js";
 export type {
 	AttachOptions,
+	MarkOptions,
 	ReportOptions,
 	Stage,
 	StageCore,
+	StageCursor,
 	StageOptions,
 	StageReport,
 } from "./model/stage.js";

package/src/widgets/stage/lib/create-stage.ts

@@ -41,6 +41,7 @@ const RESERVED = new Set<string>([
 	"frames",
 	"drain",
 	"mark",
+	"cursor",
 	"since",
 	"between",
 	"waitFor",
@@ -93,6 +94,8 @@ export function createStage<const Plugins extends readonly AnyWirePlugin[]>(
 		streams: streamServer,
 		pageId,
 		correlation: createSequence("x"),
+		clock,
+		timeoutMs: options.pageTimeoutMs ?? 2_000,
 	});
 	const sockets = createSocketRouter({
 		timeline,
@@ -121,6 +124,7 @@ export function createStage<const Plugins extends readonly AnyWirePlugin[]>(
 		timeline,
 		clock,
 		sync,
+		pageId,
 		wait: {
 			timeout: options.wait?.timeout ?? 5_000,
 			interval: options.wait?.interval ?? 25,