Make ptywright wait revisions span listener registration

Recheck the session revision after once("update") so a PTY
update between snapshot and sleep cannot be missed. Drop the
silent CSI fallback, write encoded bytes through one helper,
and run ptywright tests in CI.

Author: rgarcia

.github/workflows/ci.yml

@@ -88,6 +88,8 @@ jobs:
         run: npx tsc -b
       - name: Build ptywright (native binding)
         run: npm run build --workspace @onkernel/ptywright
+      - name: Ptywright tests
+        run: npm test --workspace @onkernel/ptywright
       - name: CLI unit tests
         env:
           PTYWRIGHT_REQUIRED: "1"

packages/ptywright/native/src/addon.cc

@@ -196,7 +196,6 @@ Napi::Value EncodeSpecialKey(const Napi::CallbackInfo &info) {
 		&len);
 	if (result != 0) {
 		ThrowGhosttyError(env, "ptywright_ghostty_terminal_encode_special_key", result);
-		ptywright_ghostty_free_bytes(bytes);
 		return env.Undefined();
 	}
 	if (bytes == nullptr || len == 0) {

packages/ptywright/package.json

@@ -18,7 +18,7 @@
     "build:native": "node ./scripts/build-ghostty.mjs && node-gyp rebuild --directory native",
     "clean": "tsc -b --clean",
     "clean:native": "node-gyp clean --directory native",
-    "test": "node --test dist/test/*.test.js"
+    "test": "tsx --test src/test/*.test.ts"
   },
   "gypfile": false,
   "dependencies": {

packages/ptywright/src/session.ts

@@ -65,7 +65,7 @@ export class PtySession {
 			this.transcript += data;
 			const { replyBytes } = this.terminal.feed(data);
 			if (replyBytes && replyBytes.length > 0) {
-				this.pty.write(Buffer.from(replyBytes).toString("utf8"));
+				this.writeBytes(replyBytes);
 			}
 			this.noteUpdate();
 		});
@@ -94,8 +94,7 @@ export class PtySession {
 
 	pressKey(key: SpecialKey): void {
 		this.ensureOpen();
-		const bytes = this.terminal.encodeSpecialKey(key);
-		this.pty.write(Buffer.from(bytes).toString("latin1"));
+		this.writeBytes(this.terminal.encodeSpecialKey(key));
 	}
 
 	resize(cols: number, rows: number): void {
@@ -151,10 +150,7 @@ export class PtySession {
 				if (this.exitedAt) {
 					throw this.buildWaitError(description, snapshot, new Error("process exited before condition was satisfied"));
 				}
-				if (this.revision !== seen) {
-					continue;
-				}
-				await waitForUpdate(this.events, controller.signal);
+				await waitForUpdate(this.events, controller.signal, undefined, () => this.revision !== seen);
 			}
 		} catch (error) {
 			if (controller.signal.aborted) {
@@ -189,10 +185,7 @@ export class PtySession {
 				if (this.exitedAt) {
 					return snapshot;
 				}
-				if (this.revision !== seen) {
-					continue;
-				}
-				await waitForUpdate(this.events, controller.signal, stableForMs);
+				await waitForUpdate(this.events, controller.signal, stableForMs, () => this.revision !== seen);
 			}
 		} catch (error) {
 			if (controller.signal.aborted) {
@@ -213,13 +206,7 @@ export class PtySession {
 		try {
 			while (!this.exitedAt) {
 				const seen = this.revision;
-				if (this.exitedAt) {
-					break;
-				}
-				if (this.revision !== seen) {
-					continue;
-				}
-				await waitForUpdate(this.events, controller.signal);
+				await waitForUpdate(this.events, controller.signal, undefined, () => this.revision !== seen || Boolean(this.exitedAt));
 			}
 			return this.status();
 		} catch (error) {
@@ -284,6 +271,13 @@ export class PtySession {
 		this.events.emit("update");
 	}
 
+	private writeBytes(bytes: Uint8Array): void {
+		if (bytes.length === 0) {
+			return;
+		}
+		this.pty.write(Buffer.from(bytes).toString("utf8"));
+	}
+
 	private ensureOpen(): void {
 		if (this.closed) {
 			throw new Error("session already closed");
@@ -356,7 +350,12 @@ function createWaitController(options?: WaitOptions): { signal: AbortSignal; cle
 	};
 }
 
-async function waitForUpdate(events: EventEmitter, signal: AbortSignal, timeoutMs?: number): Promise<void> {
+async function waitForUpdate(
+	events: EventEmitter,
+	signal: AbortSignal,
+	timeoutMs?: number,
+	alreadyChanged?: () => boolean,
+): Promise<void> {
 	if (signal.aborted) {
 		throw abortReason(signal);
 	}
@@ -381,6 +380,11 @@ async function waitForUpdate(events: EventEmitter, signal: AbortSignal, timeoutM
 
 		events.once("update", onUpdate);
 		signal.addEventListener("abort", onAbort, { once: true });
+		if (alreadyChanged?.()) {
+			cleanup();
+			resolve();
+			return;
+		}
 		if (timeoutMs !== undefined) {
 			timer = setTimeout(() => {
 				cleanup();

packages/ptywright/src/terminal.ts

@@ -1,20 +1,4 @@
-import {
-	KeyArrowDown,
-	KeyArrowLeft,
-	KeyArrowRight,
-	KeyArrowUp,
-	KeyBacktab,
-	KeyDelete,
-	KeyEnd,
-	KeyEscape,
-	KeyHome,
-	KeyInsert,
-	KeyPageDown,
-	KeyPageUp,
-	SPECIAL_KEY_KIND,
-	type SpecialKey,
-	type SpecialKeyName,
-} from "./keys";
+import { SPECIAL_KEY_KIND, type SpecialKey } from "./keys";
 import { loadNativeBinding, type NativeSnapshot, type NativeTerminalHandle } from "./native-loader";
 
 export interface CreateTerminalOptions {
@@ -88,11 +72,7 @@ export class TerminalSurface {
 		if (key.kind !== SPECIAL_KEY_KIND) {
 			throw new Error("encodeSpecialKey expects a SpecialKey");
 		}
-		const encoded = this.native.encodeSpecialKey(key.name);
-		if (encoded && encoded.length > 0) {
-			return encoded;
-		}
-		return Buffer.from(legacySpecialKey(key.name), "latin1");
+		return this.native.encodeSpecialKey(key.name) ?? new Uint8Array();
 	}
 
 	dispose(): void {
@@ -128,35 +108,6 @@ function normalizeSnapshot(snapshot: NativeSnapshot): TerminalSnapshot {
 	};
 }
 
-function legacySpecialKey(name: SpecialKeyName): string {
-	switch (name) {
-		case "arrow_up":
-			return KeyArrowUp;
-		case "arrow_down":
-			return KeyArrowDown;
-		case "arrow_left":
-			return KeyArrowLeft;
-		case "arrow_right":
-			return KeyArrowRight;
-		case "home":
-			return KeyHome;
-		case "end":
-			return KeyEnd;
-		case "page_up":
-			return KeyPageUp;
-		case "page_down":
-			return KeyPageDown;
-		case "insert":
-			return KeyInsert;
-		case "delete":
-			return KeyDelete;
-		case "escape":
-			return KeyEscape;
-		case "backtab":
-			return KeyBacktab;
-	}
-}
-
 function splitLines(text: string): string[] {
 	if (!text) {
 		return [];