Compare commits

...
Author SHA1 Message Date
Mohamed Boudra bd1b491dcb fix(app): keep layout sized to the window after rotation
A style update racing a window resize could recommit old root constraints. Rebuild the style update from the current root on each commit attempt.
2026-10-31 12:59:15 +01:00
Mohamed Boudra fd65985e9d fix(android): resize header fades after rotation (#8349)
Clear Android SVG descendant geometry caches when the canvas resizes. Cover growth and shrinkage with a native pixel-rendering regression.
2026-10-31 14:45:13 +07:00
Mohamed Boudra 254166e7c1 feat(terminal): add native selection handles (#8348)
* feat(terminal): add native selection handles

* fix(terminal): preserve selection at row boundaries

* fix(terminal): preserve selection boundary when handles cross
2026-10-31 14:23:10 +07:00
paseo-bot[bot] 9c5b47421a test(server): exclude filesystem startup from config responsiveness (#8296)
* test(server): diagnose recurring config responsiveness failure

* test(server): compare profiled and plain config reads on Windows

* test(server): correlate config profiles with long callbacks

* test(server): probe config timing under CPU contention

* test(server): exclude filesystem pool startup from config budget

* test(terminal): finish output before comparing replay captures

A marker can arrive before its trailing newline. Comparing captures taken on either side of that output compares different terminal states. Split that output deliberately and wait for its parsed completion before capturing the expected replay.

---------

Co-authored-by: paseo-bot[bot] <266920839+paseo-bot[bot]@users.noreply.github.com>
2026-10-31 06:49:47 +00:00
paseo-bot[bot]andMohamed Boudra 3b51b8ab2e Recover terminal worker records after Windows reader contention (#8155)
* test(terminal): let cleanup fixture exit on request

* test(terminal): capture the Windows record rewrite failure

* test(terminal): repeat Windows cleanup exit diagnostics

* fix(server): reopening a Codex agent no longer reads and holds its full history (#8132)

* fix(server): read Codex history only when Paseo replays it

Reopening a Codex agent whose timeline Paseo still held read the full
thread on connect and kept it on the session until the next replay, which
never came, so every reopened agent held a second copy of its transcript.
thread/resume also returned every turn, and only the sandbox policy was
used from it.

Resume now sends excludeTurns (older Codex ignores the unknown field) and
the history read moves into streamHistory, whose caller owns the result.
A resumed session still needs the earlier turns for rewind targets and the
sub-agent routes that keep an earlier child's interactions on its original
card, so the first turn, goal or rewind indexes the thread and drops the
timeline it read.

* test(server): run reopened Codex agent tests without the Codex CLI installed

* test(terminal): isolate record reader contention on exit

* feat(usage): show when each limit resets, and make usage rows easier to read (#8162)

The reset countdown floored to one unit, so a weekly window read "resets 2d"
from 2d 23h down to 2d 0h and looked stuck for a day; the session window had
the same problem with hours. Countdowns now use two units ("2d 23h", "4h 59m"),
and every row also shows the clock time it resets ("7:20 AM", "Sat 8:00 AM",
"Oct 31, 3:00 PM"), so users can plan work around a reset without hovering.

Rows now put the window name and percent on one line, the bar under it, and the
reset on its own full-width line, so the exact time fits at phone width in
longer languages. The pinned-row background is gone; the pin glyph, drawn in
the foreground colour when pinned, is the only pinned signal. Bars are 6px.

* Make Claude session entrypoint relabeling optional (#8164)

* fix(claude): make session entrypoint relabeling opt-in

Keep inherited SDK and parent identities cleared. Honor the explicit session-open entrypoint contribution so users can opt into the label through a plugin instead of every session receiving it unconditionally.

* test(hub): use standard budget for restart and worktree recovery

The Windows CI scenario timed out at its custom 20-second limit while the other Hub cases took 4–10 seconds each. This scenario starts two daemons and creates, archives and restores a worktree. Use the existing 30-second suite budget without changing any assertions.

* Deliver a steer message that arrives while the previous turn is still starting (#6192)

* Deliver a steer message that arrives while the previous turn is still starting

A steer send that reached an agent before its previous turn had a turn id
found no turn to steer and replaced the starting turn, so the earlier
message never reached the provider. Steering now waits for the starting
turn to be accepted (or fail) and steers the turn it became.

Fixes #6186

* Wake a waiting steer only once the starting turn has an id or its run has ended

A failed start used to wake the waiting steer before its run was cleared,
leaving the later send to replace a run that had already failed.

* Clear a failed start's run even when reporting the failure throws

A steer waiting on that start is released only when the run is cleared.

* Test that a failed start keeps a waiting steer until its run is cleared

* fix(server): steer Codex turns while native identification is pending

Wait for the accepted foreground turn to receive its native ID before steering it. Returning unavailable in this window replaced the turn even after the manager had waited for startup.

---------

Co-authored-by: paseo-bot[bot] <266920839+paseo-bot[bot]@users.noreply.github.com>

* fix(terminal): recover worker records after reader contention

Retain the latest record until a transient sharing failure clears. Deliver exits while publication is pending, await publication before confirming creation, and cancel retries before retirement.

---------

Co-authored-by: paseo-bot[bot] <266920839+paseo-bot[bot]@users.noreply.github.com>
Co-authored-by: Mohamed Boudra <boudra.moha@gmail.com>
2026-10-31 06:31:08 +00:00
paseo-bot[bot]andEgg3901 9b3f1bfffd Start custom Codex providers with reserved names (#6954)
* fix(codex): start custom providers with reserved names

Codex rejects custom provider keys such as ollama before a turn starts.
Namespace the generated keys without changing user-facing provider ids.
Keep older sessions discoverable and select the new key explicitly when
resuming them, so the startup fix does not strand existing conversations.

Closes #6874

Co-authored-by: Egg3901 <rainfordmason@gmail.com>

* fix(codex): keep native sessions out of custom provider imports

* fix(providers): align custom provider example with generated config

Correct the documented internal provider key and simplify import filtering while preserving native and legacy session selection.

* fix(codex): exclude native GCP sessions from custom imports

* test(codex): seed sessions through the portable launcher

---------

Co-authored-by: paseo-bot[bot] <266920839+paseo-bot[bot]@users.noreply.github.com>
Co-authored-by: Egg3901 <rainfordmason@gmail.com>
2026-10-31 05:02:14 +00:00
paseo-ai[bot] 5ea639d9b2 fix: update lockfile signatures and Nix hash [skip ci] 2026-10-31 04:01:29 +00:00
Mohamed Boudra 9c926ed126 fix(terminal): preserve 10,000 rows with direct ANSI replay (#8282)
Restore configured terminal history on reconnect, retaining 10,000 rows plus the screen. Serialize the worker-owned xterm buffer directly to ANSI and forward negotiated bounded replay chunks while preserving ANSI-era clients and per-viewer live ordering.

Preserve captured geometry through replay, bound pressure recovery to 500 rows, and keep the omitted visible-history default at 200. Remove the full cell-grid copy and obsolete JSON rendering.

All 21 CI checks pass. Real browser, native Debug emulator/simulator and Linux Electron coverage and platform limits are documented in the PR. The Android Debug invalid native delegate dispatch also reproduces on upstream main; its cause and any change in frequency remain unproven.

Credit Manav Dhindsa (DrakenKor), #6139 and #6148, and Lennart Schoch, #6743, for prior ANSI replay and retention work informing this change.

Closes #6137.
Closes #6147.
2026-10-31 10:51:45 +07:00
Mohamed Boudra 7b03f0ad21 fix(ci): migrate to the latest macOS runners (#8335)
* fix(ci): replace retiring macOS 14 runners

Use the supported macOS 15 ARM64 image before the November 2 retirement. Keep the Intel release runner and existing test/build/release commands unchanged.

* fix(ci): use the latest macOS runner images
2026-10-31 10:05:16 +07:00
Mohamed Boudra 0a549945b5 fix(terminal): keep native text aligned with terminal cells (#8336)
Shape rows in native Canvas and CoreText, then place clusters on xterm columns so fallback font advances cannot separate text from its cursor. Wait for measured dimensions before attachment and repaint overhanging ink with affected rows.

Use Android platform ICU to avoid bundling approximately 14 MB of data; retain and document the Android 10 conjunct limitation.
2026-10-31 09:45:57 +07:00
Mohamed Boudra 0be49c0620 feat(transport): keep large messages intact across relay connections (#8302)
Negotiate shared binary chunk framing below application messages and routing, with bounded logical assembly and paced writes that respect encrypted relay limits. Preserve legacy admission, reconnect state, sibling route isolation, and native single-frame upload behavior.
2026-10-31 09:26:24 +07:00
paseo-bot[bot] 186c132151 test(server): isolate the reconciliation responsiveness budget (#8317)
* test(server): isolate the reconciliation responsiveness budget

Measure the cold reconciliation in compiled plain Node so unrelated runner callbacks cannot consume its 20ms budget. Retain real filesystem admission and every archival assertion, with unrelated CPU work in the parent as a regression check.

* test(server): initialize probe filesystem support before measurement

---------

Co-authored-by: paseo-bot[bot] <266920839+paseo-bot[bot]@users.noreply.github.com>
2026-10-31 00:33:29 +00:00
180 changed files with 11773 additions and 4856 deletions
+2 -2
View File
@@ -281,10 +281,10 @@ jobs:
# otherwise has no server-test coverage. Scoped to the observer/watcher suites to
# bound runtime.
server-tests-macos:
name: server-tests (macos-14, file observation)
name: server-tests (macos-latest, file observation)
needs: changes
if: ${{ !cancelled() && (needs.changes.outputs.full != 'false' || needs.changes.outputs.server != 'false') }}
runs-on: macos-14
runs-on: macos-latest
steps:
- uses: actions/checkout@v4
+2 -2
View File
@@ -100,10 +100,10 @@ jobs:
fail-fast: false
matrix:
include:
- runner: macos-14
- runner: macos-latest
electron_arch: arm64
node_heap_mb: 4096
- runner: macos-15-intel
- runner: macos-26-intel
electron_arch: x64
node_heap_mb: 8192
permissions:
+1 -1
View File
@@ -101,7 +101,7 @@ jobs:
run: nix build .#desktop -o result-desktop
build-desktop-darwin:
runs-on: macos-14
runs-on: macos-latest
steps:
- uses: actions/checkout@v4
+1
View File
@@ -52,6 +52,7 @@ At the start of non-trivial work, list `docs/` and skim anything relevant to the
| [docs/connected-hosts.md](docs/connected-hosts.md) | Daemon-owned host registrations, routed SDK scopes, identity and authority boundaries |
| [docs/permissions.md](docs/permissions.md) | Semantic daemon permissions, principals, credentials, pairing invitations, and Hub authority |
| [docs/terminal-performance.md](docs/terminal-performance.md) | Terminal latency pipeline, coalescing/backpressure invariants, benchmark + perf spec usage |
| [docs/terminal-rendering.md](docs/terminal-rendering.md) | Native terminal view: xterm owns the grid, cluster placement, emoji widths, mixed-direction limits, render regression |
| [docs/agent-stream-performance.md](docs/agent-stream-performance.md) | Assistant text pipeline — coalescing window, paced reveal, why arrival lumps are smoothed at render |
| [docs/markdown-renderer.md](docs/markdown-renderer.md) | Shared Markdown engine, native selection, links, images and library constraints |
| [docs/native-text-selection.md](docs/native-text-selection.md) | Native diagram grouping, selection boundaries and leading inline image limitations |
+12
View File
@@ -61,6 +61,18 @@ Gradle auto-fetches the platform/build-tools it needs once licenses are accepted
## Local build + install
The `react-native-svg@15.15.4` patch prevents header fades retaining their old painted size after
rotation. Rebuild native Android after changing it; Metro reloads cannot update this code. Keep the
resize hunks until upstream invalidates descendant geometry on canvas resize. Its instrumentation
regression renders real gradient pixels across growing and shrinking layouts, including a nested
group. From `packages/app/android`, run it on your selected emulator:
```bash
ANDROID_SERIAL=emulator-5562 ./gradlew :react-native-svg:connectedDebugAndroidTest \
-Pandroid.testInstrumentationRunnerArguments.class=com.horcrux.svg.SvgResizeTest \
--no-daemon --max-workers=2 -Dorg.gradle.parallel=false
```
The locked `expo-modules-core@57.0.23` needs the patch installed by `npm install`.
It backports
[Expo's Activity-result launcher fix](https://github.com/expo/expo/pull/49634): changing
+3 -3
View File
@@ -232,7 +232,7 @@ For pay-as-you-go, use `ANTHROPIC_API_KEY` with a standard Model Studio key (`sk
Codex talks to OpenAI's Responses API by default. Custom providers that extend `"codex"` can point Codex at any OpenAI-compatible endpoint (OpenRouter, LiteLLM, vLLM, llama.cpp server, an internal gateway, etc.) by setting `OPENAI_BASE_URL` and `OPENAI_API_KEY` in the provider `env`.
Paseo passes those variables through to the Codex app-server process **and** maps them into Codex's thread config under `model_provider` / `model_providers`, because Codex reads provider routing from config rather than from `OPENAI_BASE_URL` alone.
Paseo passes those variables through to the Codex app-server process **and** maps them into Codex's thread config under `model_provider` / `model_providers`, because Codex reads provider routing from config rather than from `OPENAI_BASE_URL` alone. The generated Codex provider key is `paseo:<provider-id>`, so a Paseo provider such as `ollama` does not override a Codex built-in. Existing custom sessions created with a non-built-in provider key remain available in Import session. Native Codex conversations using a built-in key stay separate from a custom provider of the same name.
### Setup
@@ -260,9 +260,9 @@ Paseo passes those variables through to the Codex app-server process **and** map
Under the hood, for each custom Codex provider Paseo injects this into Codex's config:
```toml
model_provider = "my-codex"
model_provider = "paseo:my-codex"
[model_providers.my-codex]
[model_providers."paseo:my-codex"]
name = "My Codex"
base_url = "https://custom-relay.example.com/v1"
wire_api = "responses"
+41
View File
@@ -52,6 +52,47 @@ On capable daemons, connecting creates no timeline or event demand. Client subsc
release it on unsubscribe, and restore it after reconnect. Raw message observers inspect traffic
without requesting streams. Application caches and which agents are visible remain caller-owned.
## Terminal ANSI replay
Terminal replay intentionally drops JSON-era apps, an exception to the general cross-version policy:
use app v0.1.81 or newer. Earlier apps omit `restore` and reject ANSI Restore (`0x05`), so they show
only subsequent live output, without the existing screen or history.
`terminal_chunked_replay` is SDK-owned delivery behavior. The daemon sends new binary opcodes only to a source
advertising the capability. The SDK keeps the established subscribe request against older
ANSI hosts and normalizes their single Restore frame into begin/data/end. `observeTerminal` defaults
to an explicit full snapshot: omitting restore on an ANSI-era host selects its discarded JSON path.
Explicit caller restore modes and history counts pass through unchanged. JSON snapshot
wire declarations remain accepted, but JSON snapshot frames have no rendering runtime.
Terminals require `terminal-restore-modes`; older hosts show an update message without attaching.
## Binary chunking
`binary_chunking_v1` in hello and optional `server_info.features.binaryChunkingV1`
negotiate connection-scoped framing. Application serializers and routed envelopes use
the same boundary. Small messages and handshakes keep their existing representation.
Older peers retain existing frame limits.
The reserved binary opcode `0x31` is followed by version `1`, original kind
(`0` text, `1` binary), and START/END flag bits `0`/`1`. Remaining bytes are an
unchanged slice. There is no total length or chunk count; a future receiver can
consume slices incrementally. Today the receiver buffers up to the existing
100 MiB logical limit and decodes UTF-8 only after END. Transfers cannot interleave.
Disconnect clears partial state and negotiation.
The lower transport supplies its plaintext frame budget, including encryption
overhead. The sender waits for drain between chunks while ordinary messages keep
the existing delivery path. Slow-client protections count messages queued behind
an active transfer as well as bytes already in the socket.
The framing module never selects an encryption construction.
Native uploads retain the platform's existing queue limits. React Native's
WebSocket does not report its queued bytes, so the client cannot wait for native
drain. Android's installed OkHttp transport closes when a send would put more
than 16 MiB in its queue. The native transport disables outbound chunking, including
on routed channels, and retains its existing single-frame admission errors.
Inbound chunking remains enabled; daemon-to-native responses use the daemon's paced writes.
## Owned observations
`owned_subscriptions` and `server_info.features.ownedSubscriptions` negotiate the source-owned
+10 -6
View File
@@ -6,9 +6,9 @@ How terminal output stays low-latency, what the invariants are, and how to measu
```
pty (node-pty, forked worker process)
→ headless xterm parse (worker, snapshot fidelity)
→ TerminalOutputCoalescer (worker, ≤1 IPC message per 5ms per terminal)
→ process.send IPC → daemon main process
→ headless xterm parse (worker, ANSI replay fidelity)
→ TerminalOutputCoalescer (worker, ≤1 socket frame per 5ms per terminal)
→ framed local socket → daemon main process
→ TerminalOutputCoalescer (per client stream, terminal-session-controller.ts)
→ binary ws frame (2-byte header + raw bytes)
→ client decode (daemon-client.ts) → stream router → emulator runtime
@@ -19,11 +19,15 @@ Terminal frames share the daemon main event loop with all agent traffic. The `ev
## Invariants (the easy-to-break ones)
- **Replay is incremental across the daemon and SDK.** Capable clients request their configured history, bounded by [worker retention](terminal-worker.md#process-model). Older apps retain their own 200-row request. Explicit SDK history demand is unchanged against older ANSI hosts, which apply their existing 500-row ceiling. Begin resets once, chunks keep a streaming UTF-8 decoder/parser, and each renderer suppresses generated replies while parsing replay. Never concatenate capable replay chunks to feed the renderer.
- **Replay serialization reads xterm directly.** The [worker](terminal-worker.md#process-model) uses its existing buffer; text capture translates only the requested rows, and readiness scans row strings. Do not rebuild a full cell-object grid. Serialization still allocates a whole ANSI string and UTF-8 bytes before bounded delivery; chunking does not bound those allocations.
- **Coalescers are leading+trailing throttles.** The first chunk after an idle window flushes immediately (synchronously); only sustained bursts wait for the trailing timer. Reverting to trailing-only adds a full window (~5ms) to every keystroke echo.
- **Output coalescing happens in the worker, before IPC.** One `process.send` per pty chunk was a main-loop flood under build output. Non-output messages (snapshot/snapshotReady/titleChange/exit) must flush the coalescer first so ordering is preserved.
- **Output coalescing happens in the worker, before IPC.** One socket frame per pty chunk was a main-loop flood under build output. Non-output messages (snapshotReady/titleChange/exit) must flush the coalescer first so ordering is preserved.
- **Replay delivery is isolated per viewer.** Live worker output never waits for app delivery. Each daemon stream owns its bounded live tail and revision deduplication; a slow or failed replay cannot pause another viewer of the same terminal.
- **Replay geometry belongs to the parser queue.** Native measurements and web fits must leave the captured dimensions intact through every chunk's commit. Apply the latest measured size after replay, before live bytes; clear, replacement and disposal must release that geometry ownership. A layout effect must not resize the renderer directly during replay.
- **Coalesced output carries the LAST chunk's revision.** Snapshot replay dedup (`replayTerminalOutputAfterSnapshot`) skips buffered output with `revision <= replayRevision`; a merged batch with a lower revision would be wrongly skipped (lost output).
- **The input-mode tracker runs once per process boundary, not per hop.** The worker owns the authoritative tracker; the daemon caches the replay preamble from `getTerminalState` responses and `snapshotReady` messages. Do not reintroduce a per-chunk `feed()` on the daemon main loop.
- **Snapshot catch-up is backpressure-gated.** A stream falls back to a full snapshot only when `outputBytesSinceSnapshot > MAX_TERMINAL_OUTPUT_FRAME_BYTES` (256KB) **and** the client transport reports `bufferedAmount > MAX_CLIENT_BUFFERED_BYTES` (4MB). A client that keeps draining streams continuously, no matter how much output is produced. Before this gate existed, every 256KB of build output dropped a frame and forced a full JSON cell-grid snapshot (~200k objects across IPC) — the historical source of spiky lag and GC hitches.
- **The input-mode tracker runs once per process boundary, not per hop.** The worker commits its authoritative tracker with xterm parsing before publishing the corresponding revision; the daemon caches current modes from ordered worker events and adoption. A replay response carries capture-time modes for its viewer; it must not overwrite the shared cache after newer live output. Apply that viewer's preamble before its buffered live bytes. Do not reintroduce a per-chunk `feed()` on the daemon main loop.
- **Snapshot catch-up is backpressure-gated.** After more than 256 KiB of output, a stream catches up only when its transport reports more than 4 MiB queued, or exposes no backpressure reading. A draining client streams continuously. Pressure recovery sends at most 500 recent history rows plus the screen, preserving smaller explicit demands including zero; even a live-only subscription needs this resynchronization. It does not change the subscription's configured demand: later attach/reconnect restores still request the full configured history. The recent window avoids repeatedly serializing all retained history for a slow viewer.
- **Plugin daemon sessions report IPC queue bytes.** Their virtual socket increments `bufferedAmount` before `process.send` and decrements it only in the send callback. Text and binary frames share that ordered queue, so the normal snapshot catch-up and physical high-water gates remain valid for server-side plugin SDK traffic.
- **Client output writes are not serialized per frame.** The emulator runtime drains contiguous plain writes straight into xterm (which buffers internally). Only barrier ops (`clear`, `snapshot`, `suppressInput` writes) wait — behind a zero-length sentinel write — so resets can't interleave with in-flight output.
- **Find preserves the inspected xterm viewport, including at the live bottom.** Keep its output anchor inside the existing batched write path. Serializing output to preserve a search result would add terminal latency.
+65
View File
@@ -0,0 +1,65 @@
# Terminal rendering
Web and Electron draw terminals with xterm.js. iOS and Android keep an `@xterm/headless` buffer in JS and draw it with the `PaseoTerminal` native view in `packages/app/modules/paseo-terminal`: CoreText on iOS, `Canvas.drawTextRun` on Android. `src/terminal/native-renderer/terminal-frame.ts` turns the visible buffer into frames, and both native views take the same props.
## xterm owns the grid
xterm decides which column every cell occupies. The native views never let text advance move a cell. Each row is shaped once, one run per font face, so Hangul jamo, ligatures, combining marks, conjuncts and fallback fonts see their neighbours. Each shaped cluster is then drawn at its first cell's column, centred in the columns it owns, and scaled down when its glyphs are wider. Cursor, selection, hit-testing and copy all use xterm's columns, so they stay correct whatever the font does.
A cluster is the run of cells the shaper merged, and it is drawn once from the shaped row. Drawing part of a cluster on its own reshapes it: a half-form conjunct such as `स्ते` comes apart into `स्` with a visible virama. So colour and selection never split a cluster. A cluster whose cells differ in colour is drawn once per colour, clipped to that colour's columns.
Android also groups cells with `android.icu.text.BreakIterator`, because Minikin's advances and cursor boundaries alone split some conjuncts. Grapheme rules follow the OS ICU version. Android 10 (API 29) splits `स्ते` after the virama and renders it incorrectly. The tested corpus passed on API 33, 34 and 35; API 30–32 have not been tested. We accept that version-dependent limitation to avoid bundling approximately 14 MB of ICU4J data. CoreText keeps this conjunct together on iOS. This renderer does not guarantee identical shaping across OS versions.
`TerminalRowLayoutTest.kt` is the Android regression test. It draws the rows of `grapheme-rows.json` and compares each with its grapheme clusters drawn one at a time, and with a wrong clustering that must not match. `terminal-frame.test.ts` checks that those rows are what xterm produces and that the clusters are UAX #29 grapheme clusters. Run it with `./gradlew :paseo-terminal:connectedDebugAndroidTest` from `packages/app/android`, with `ANDROID_SERIAL` set.
The view reports ready only after it has measured its grid size. The pane attaches with that size, so the daemon replays the terminal at the client's size. Before this, the replay arrived at the PTY's old size, the resize came after it, and the shell's redraw landed on the wrong rows.
Emoji widths come from the headless buffer, which uses xterm's default Unicode 6 table. `👍` gets one column, and `👋🏽` and `🇰🇷` get two cells drawn as one cluster. Web loads the Unicode 11 addon, so the same output can wrap differently on web and native.
## Ink outside the row
Marks stacked above or below a letter, Arabic letter tails and some fallback glyphs ink into the rows next to theirs. Neither view clips a row to its own bounds, because a row clip also cuts marks and Arabic dots. Rows draw top to bottom, so a later row's cell backgrounds cover the ink that reaches into it.
Android redraws every row on each frame, so overhanging ink cannot go stale. Its row `RenderNode`s are created with `setClipToBounds(false)`. The default would clip only unselected rows, because selected rows are drawn straight onto the view's canvas.
iOS repaints only the rows that changed. Each `TerminalRowLayout` records how far its glyphs ink above and below the row. A changed row invalidates its old and new ink extent, and `draw(_:)` redraws every row whose ink extent meets the dirty rect. Invalidating only the row's own rect left an erased row's marks in the row next to it, erased a neighbour's marks when a row was rewritten, and showed or hid overhang depending on which rows changed together.
## Mixed-direction text
Rows draw left to right in logical order on both platforms. Terminal bidi escape modes are not implemented. On iOS the row needs both the `kCTWritingDirection` override and an LTR paragraph base direction. Without the base direction, bidi rule L1 moves trailing spaces ahead of a row that starts with Arabic or Hebrew, and the whole row shifts.
Arabic still gets the contextual form its logical neighbours select, but in left-to-right order, so letters join on the wrong side. Correct visual Arabic needs implicit bidi per row: reorder RTL runs for display and map cursor, selection and hit-testing through the visual-to-logical index. That changes which column a character appears in, so it has to be decided as product behaviour first. Shaping alone cannot fix it.
## Render regression
The scripts live in `packages/app/e2e/mobile/terminal-rendering`. Run them from `packages/app` on the daemon's host, starting from an idle, focused terminal with an empty prompt.
`render.mjs` prints a mixed-script fixture, screenshots it with agent-device, and checks the geometry with `check.mjs`. The check rebuilds the expected buffer with `@xterm/headless` and measures the grid from a ruler row. It checks that:
- every grapheme cluster has ink inside its own columns, and blank cells stay blank;
- on the accent rows, every cell is drawn in its own colour, including cells inside one cluster;
- the cursor is drawn after the text;
- every row is exposed as `terminal-row-<n>`;
- selecting one cell of a conjunct highlights only that cell.
On iOS the screenshot is taken at 3 pixels per point (`PASEO_TERMINAL_RENDERING_PIXEL_DENSITY`), because the simulator's default is one pixel per point and a glyph is then about 12 pixels. Focus the terminal before a run: with the simulator's hardware keyboard connected the key bar shows without a focused input, and `type` fails. In a debug build, the dev client's floating gear button covers the right end of the first row, so ruler cells there fail.
```bash
PLATFORM=android ANDROID_SERIAL=emulator-5554 node e2e/mobile/terminal-rendering/render.mjs
PLATFORM=ios IOS_DEVICE="iPhone 17" node e2e/mobile/terminal-rendering/render.mjs
```
Geometry passes when a cell holds the wrong glyph. `identity.mjs` judges each cluster of a `render.mjs` run against pango's rendering of the same characters in the device's fonts. The reference is cut at the edges of the cluster's columns, placed as the renderer places it, because glyphs such as Devanagari letters ink past their advance and the device cuts them there too. A shape passes when its coverage correlates with its own reference at 0.6 or more, and no other cluster of the corpus matches it better. Box and block characters are judged against their Unicode definition. Shades are judged by even density over a 4×4 grid, because the device and pango fall back to different shade fonts. Clusters that pango draws without ink are reported as unjudged instead: flags on both platforms and Apple Color Emoji. The `rect` and `swap` controls fill every cluster with white, or judge each one against another cluster. Both must fail every cluster, which shows the oracle refuses ink that is present but wrong. An Arabic letter is compared with all four of its positional forms, so the oracle shows the right letter is drawn, not that it has the right form. Ink that a neighbouring row draws into a cluster's cells counts as that cluster's ink. On iOS the tail of `م` in the Arabic row reaches one pixel into the `न` below it, so `न` fails although both rows are drawn correctly.
```bash
FONTCONFIG_FILE=fonts.conf node e2e/mobile/terminal-rendering/identity.mjs <run dir> [none|rect|swap]
```
`fonts.conf` points fontconfig at the device's font files and lists, for `monospace`, the terminal font followed by the device's fallbacks for Hangul, Arabic, Devanagari, CJK, emoji and symbols:
- **Android:** pull the fonts from `/system/fonts` with `adb pull`. The terminal font is Droid Sans Mono.
- **iOS:** copy the simulator runtime's fonts from `RuntimeRoot/System/Library/Fonts`. The terminal font is Menlo. PingFang stores its outlines in Apple's `hvgl` table, which FreeType cannot draw, so the CJK references come from Apple SD Gothic Neo instead. `語` then scores below the threshold although the device draws it correctly.
`overhang.mjs` prints rows whose marks reach the rows next to them. In one update it writes into two rows that hold a neighbour's marks and erases two rows whose marks reach a blank row. The marks must be drawn before the update, stay drawn in the written rows, and leave no ink behind the erased rows. Run it like `render.mjs`.
`reattach.mjs` checks the restore size. It changes the PTY size by opening the keyboard (`RESIZE=keyboard`) or folding an Android foldable (`RESIZE=fold`), relaunches the app, and compares the client's rows with `paseo terminal capture`. A trial where no terminal rows appear, for example after a launch crash, counts as never attached and fails the run.
+15 -1
View File
@@ -15,6 +15,8 @@ supervisor (paseo.pid) ──► daemon worker ──► launcher ──► term
- The worker exits on its own when it has no controller and no terminals, on `shutdown`, on SIGTERM (killing its terminals), and when its record disappears (a deleted `$PASEO_HOME`: nobody can ever reach it again).
- Its stderr goes to `$PASEO_HOME/terminal-worker.log`. No pipe to the daemon survives the daemon.
The worker retains a fixed 10,000 history rows plus the screen in its existing xterm. Replay uses `@xterm/addon-serialize` 0.14 against headless xterm 6; no second cell grid or lifetime byte log is retained. The serializer boundary owns cursor position, visibility and explicit program-selected presentation; the addon alone does not preserve all three. An unset program style leaves each client’s configured cursor defaults intact. Standard modes come from the serializer; the existing input-mode tracker retains protocol modes such as Kitty and Win32 input. Commit that tracker with parsed output so replay bytes and metadata describe the same cut.
Which triggers keep terminals and which close them is owned by the stop reason (`keepTerminals`) that flows from the request through the supervisor to `stop()`. The kill side always ends in the reaper (`terminal-worker-reaper.ts`), the only path that signals terminal processes outside a connected daemon.
## Record, socket and secret
@@ -40,10 +42,22 @@ The worker writes `$PASEO_HOME/terminal-worker/<pid>.json` (owner-only) with its
Never more than two workers run. A new worker launches only when none is current, none is incompatible and fewer than two run. The count comes from the records, so an unreachable or unidentified worker counts, and so does one a cleanup could not confirm gone. When two run, the daemon starts with no current worker, and the first terminal created after one of them exits launches it.
**The frozen envelope never changes across versions:** the frame format (4-byte length + `v8.serialize`), `hello`/`helloAck`, the `listTerminals` info fields and `shutdown`. That is what lets any daemon close any worker: a kill stop sends `shutdown` to a newer worker it cannot otherwise drive. When you bump the version, keep a previous-version adapter so the draining worker can still be driven, and drop the adapter for the version before that.
**The frozen envelope never changes across versions:** the frame format (4-byte length + `v8.serialize`), `hello`/`helloAck`, the `listTerminals` info fields and `shutdown`. That is what lets any daemon close any worker: a kill stop sends `shutdown` to a newer worker it cannot otherwise drive. Protocol 5 hard cuts unreleased protocols 1 through 4, including the acknowledgement-based replay contract: those workers are obsolete and close. For future versions, keep a previous-version adapter so the draining worker can still be driven, and drop the adapter for the version before that.
Tests stand up other versions with `PASEO_TERMINAL_WORKER_PROTOCOL_OVERRIDE`, read by the worker. It is test-only.
## Display replay
The worker keeps the headless xterm model and generates ANSI. A replay request emits begin metadata (dimensions, retained history, revision and input modes), at most 64 KiB per data chunk, and end. Live output keeps flowing independently during replay. Capture is synchronous with PTY callbacks; flush the output coalescer before the cut so a later batch never includes bytes already in replay. Retained-history metadata counts the worker history before the request limit.
ConPTY renders a console rather than forwarding every program escape sequence unchanged. A program write callback does not establish that its hidden cursor move or input modes reached the worker. Test exact ANSI fidelity at the serializer boundary; PTY integration compares the initial replay plus committed observed output at the capture cut, including startup modes.
The worker paces replay writes on its local socket; the daemon synchronously queues each event into the application's bounded transport. App network delivery does not extend the worker's request deadline. There is no per-chunk acknowledgement or second replay delivery queue in the daemon. The physical application transport owns its 64 MiB high-water close, so a backed-up app cannot hold worker capture open. Each daemon viewer still holds at most 4 MiB of live output during capture, then drops revisions already present in the worker replay. Capture failure and tail overflow affect only that viewer; PTYs and healthy viewers keep running.
Live traffic that fills the shared worker socket beyond 4 MiB disconnects the stalled controller. Reconnection adopts the surviving sessions and requests fresh replay for existing streams. Readiness does not require a revision: adoption announces readiness without one, while the replay capture supplies the revision used for deduplication.
The SDK advertises `terminal_chunked_replay` only because it decodes begin/data/end. Capable clients receive these events directly; the daemon collects one Restore frame only for older ANSI clients. The SDK normalizes an older host's single Restore into the same lifecycle. Capture stays a worker request; bootstrap readiness uses `hasOutput`, not a transported grid.
## Running from its own copy
A worker outlives the installation that started it. An npm or desktop update replaces that installation's files, and the next terminal the old worker creates would load node-pty's `spawn-helper` and the zsh integration from paths that no longer exist. So a built daemon does not launch the worker from its install:
+1 -1
View File
@@ -1 +1 @@
sha256-8NOrrCAxraQ74lP3Vy59MRhloBfzStTc4rW+ltc42Fg=
sha256-zFjdXeRpqrjEZk44ZCvEOTnVVGX0ASfDPktYNiWZpsw=
+8
View File
@@ -14740,6 +14740,12 @@
"node": ">=10.0.0"
}
},
"node_modules/@xterm/addon-serialize": {
"version": "0.14.0",
"resolved": "https://registry.npmjs.org/@xterm/addon-serialize/-/addon-serialize-0.14.0.tgz",
"integrity": "sha512-uteyTU1EkrQa2Ux6P/uFl2fzmXI46jy5uoQMKEOM0fKTyiW7cSn0WrFenHm5vO5uEXX/GpwW/FgILvv3r0WbkA==",
"license": "MIT"
},
"node_modules/@xterm/headless": {
"version": "6.0.0",
"resolved": "https://registry.npmjs.org/@xterm/headless/-/headless-6.0.0.tgz",
@@ -37703,6 +37709,7 @@
"@types/ws": "^8.18.1",
"@vitest/browser": "^4.1.7",
"@vitest/browser-playwright": "^4.1.7",
"@xterm/addon-serialize": "0.14.0",
"@xterm/headless": "^6.1.0-beta.213",
"babel-preset-expo": "~57.0.16",
"dotenv": "^17.2.3",
@@ -40682,6 +40689,7 @@
"@modelcontextprotocol/sdk": "1.29.0",
"@opencode-ai/sdk": "1.14.46",
"@opencode/client": "2.0.10",
"@xterm/addon-serialize": "0.14.0",
"@xterm/headless": "^6.0.0",
"ai": "5.0.78",
"ajv": "^8.20.0",
@@ -18,7 +18,7 @@ function visibleMainPane(page: Page) {
}
function composerChangesPill(page: Page) {
return page.getByTestId("composer-diff-stat-pill");
return page.getByRole("button", { name: "Open Changes tab", exact: true });
}
async function revealComposerChangesInExplorer(page: Page) {
@@ -498,6 +498,7 @@ test.describe("send review feedback", () => {
test("only open tabs in this workspace appear in compact and wide recipient menus", async ({
page,
}) => {
test.setTimeout(120000);
const workspace = await seedChangedAgent("review-feedback-multiple-");
const other = await seedChangedAgent("review-feedback-other-");
try {
@@ -1,8 +1,9 @@
import { randomUUID } from "node:crypto";
import { mkdtemp, writeFile } from "node:fs/promises";
import { mkdtemp, writeFile, rm } from "node:fs/promises";
import { existsSync } from "node:fs";
import { tmpdir } from "node:os";
import path from "node:path";
import { expect, test } from "../support/fixtures";
import { expect, test, daemonTest as cleanupTest } from "../support/fixtures";
import { startIsolatedHostDaemon } from "../support/helpers/isolated-host-daemon";
import {
openDaemonOverview,
@@ -13,6 +14,10 @@ import {
readWorkerPid,
openLongLivedTerminal,
listTerminalIds,
suspendDaemonProcess,
resumeDaemonProcess,
daemonProcessCanWrite,
readTerminalProcessIds,
} from "../support/helpers/daemon-lifecycle";
test("settings restart waits for a replacement worker while retaining the supervisor", async ({
@@ -119,3 +124,51 @@ async function createHomeWithSlowProvider(versionDelayMs: number): Promise<strin
);
return paseoHome;
}
// Cleanup has no renderer demand: drive the same isolated daemon owner directly.
// A stopped worker deterministically outlives the old helper's five-second
// supervisor-only kill and logs into its deleted home when resumed.
cleanupTest(
"isolated cleanup prevents a stopped worker from recreating its deleted home",
async () => {
cleanupTest.skip(process.platform === "win32", "POSIX stopped-process failure injection");
const daemon = await startIsolatedHostDaemon(randomUUID());
const workerPid = await readWorkerPid(daemon);
try {
suspendDaemonProcess(workerPid);
await daemon.close();
resumeDaemonProcess(workerPid);
await expect.poll(() => daemonProcessCanWrite(workerPid)).toBe(false);
expect(existsSync(daemon.paseoHome)).toBe(false);
} finally {
resumeDaemonProcess(workerPid);
await daemon.close();
await rm(daemon.paseoHome, { recursive: true, force: true });
}
},
);
cleanupTest(
"isolated cleanup force-stops a frozen supervisor and its detached terminal writers",
async () => {
cleanupTest.skip(process.platform === "win32", "POSIX stopped-process failure injection");
const daemon = await startIsolatedHostDaemon(randomUUID());
const supervisorPid = daemon.getPid()!;
const workerPid = await readWorkerPid(daemon);
try {
await openLongLivedTerminal(daemon);
const terminalProcesses = await readTerminalProcessIds(daemon);
expect(terminalProcesses.length).toBeGreaterThanOrEqual(2);
suspendDaemonProcess(supervisorPid);
await daemon.close();
const writerStates = await Promise.all(
[supervisorPid, workerPid, ...terminalProcesses].map(daemonProcessCanWrite),
);
expect(writerStates).toEqual(Array(terminalProcesses.length + 2).fill(false));
expect(existsSync(daemon.paseoHome)).toBe(false);
} finally {
resumeDaemonProcess(supervisorPid);
await daemon.close();
}
},
);
@@ -1,3 +1,4 @@
import { chooseModel, startWithoutRememberedModel } from "../support/helpers/model-memory";
import {
composerLocator,
enterComposerFullscreen,
@@ -97,6 +98,7 @@ test.describe("New workspace composer draft", () => {
const project = await seedWorkspace({ repoPrefix: "new-workspace-submitted-draft-" });
try {
await startWithoutRememberedModel(page);
await gotoAppShell(page);
await waitForSidebarHydration(page);
await openNewWorkspaceComposer(page, {
@@ -104,6 +106,7 @@ test.describe("New workspace composer draft", () => {
projectDisplayName: project.projectDisplayName,
});
await chooseModel(page, "mock", "Ten second stream");
const composer = page.getByRole("textbox", { name: "Message agent..." });
const createButton = page.getByTestId("workspace-create-submit");
await expect(composer).toBeEditable({ timeout: 30_000 });
@@ -1,5 +1,10 @@
import type { Page } from "@playwright/test";
import { expect, test } from "../support/fixtures";
import {
expectTerminalCursor,
getTerminalBufferText,
waitForTerminalContent,
} from "../support/helpers/terminal-perf";
import { TerminalE2EHarness } from "../support/helpers/terminal-dsl";
interface AttachOverlayProbeWindow extends Window {
@@ -59,4 +64,65 @@ test.describe("retained terminal tab streams", () => {
expect(await terminalAttachOverlayWasSeen(page)).toBe(false);
});
for (const { count, retainedMarker } of [
{ count: 3000, retainedMarker: "history-0001界🙂" },
{ count: 12050, retainedMarker: "history-3000界🙂" },
]) {
test(`reattach restores retained styled Unicode history from ${count} lines`, async ({
page,
}) => {
await page.addInitScript(() => {
const key = "@paseo:app-settings";
const settings = JSON.parse(localStorage.getItem(key) ?? "{}");
localStorage.setItem(key, JSON.stringify({ ...settings, terminalScrollbackLines: 10000 }));
});
const terminal = await harness.createTerminal({
name: `history-${count}`,
command: "/bin/sh",
args: [
"-lc",
`i=1; while [ $i -le ${count} ]; do printf '\\033[31mhistory-%04d界🙂 payload-abcdefghijklmnopqrstuvwxyz0123456789\\033[0m\\n' $i; i=$((i+1)); done; sleep 120`,
],
});
const last = `history-${String(count).padStart(4, "0")}界🙂`;
await harness.openTerminal(page, { terminalId: terminal.id });
await waitForTerminalContent(page, (text) => text.includes(last), 10000);
expect(await getTerminalBufferText(page)).toContain(retainedMarker);
await page.reload();
await waitForTerminalContent(page, (text) => text.includes(last), 10000);
const restored = await getTerminalBufferText(page);
expect(restored).toContain(retainedMarker);
expect(restored.match(/history-\d{4,5}/g)?.length).toBeGreaterThanOrEqual(
Math.min(count, 10000),
);
if (count > 10000) expect(restored).not.toContain("history-0001界🙂");
});
}
for (const input of [
{ name: "client blinking bar", presentation: "", shape: "bar" as const, blinking: true },
{
name: "program blinking underline",
presentation: "\x1b[3 q",
shape: "underline" as const,
blinking: true,
},
]) {
test(`reattach preserves the ${input.name} cursor`, async ({ page }) => {
const terminal = await harness.createTerminal({
name: "cursor-presentation",
command: process.execPath,
args: [
"-e",
`process.stdout.write(${JSON.stringify(input.presentation + "CURSOR-READY\r\n")});setInterval(()=>{},1000)`,
],
});
await harness.openTerminal(page, { terminalId: terminal.id });
await waitForTerminalContent(page, (text) => text.includes("CURSOR-READY"), 10000);
await expectTerminalCursor(page, input);
await page.reload();
await waitForTerminalContent(page, (text) => text.includes("CURSOR-READY"), 10000);
await expectTerminalCursor(page, input);
});
}
});
@@ -0,0 +1,311 @@
import assert from "node:assert/strict";
import { writeFileSync } from "node:fs";
import xterm from "@xterm/headless";
import { PNG } from "pngjs";
import { ACCENT, fixtureLines, fixtureOutput, RULER_CELLS, SELECT_LINE } from "./fixture.mjs";
/** A pixel is ink when one channel differs from the terminal background by more than this. */
const INK_THRESHOLD = 70;
/** Ink pixels a printed grapheme cluster needs inside its own columns. */
const MIN_CLUSTER_INK = 3;
/** How far a pixel may sit from the background-to-color blend line and still count as that color. */
const BLEND_TOLERANCE = 40;
/** Pixels of another cell's color tolerated in a cell, for antialiasing at the cell edge. */
const MAX_FOREIGN_INK = 2;
const graphemes = new Intl.Segmenter("und", { granularity: "grapheme" });
/**
* Checks a screenshot of the fixture against the cells xterm assigns: every printed grapheme
* cluster has ink inside its own columns, blank cells stay blank, and the cursor sits right after
* the text. A cluster that spans cells, such as a Devanagari conjunct, is shaped as one unit, so
* it is judged across all its columns. On rows that use the fixture's accent color, every cell
* must be drawn in its own color, including cells that share a shaped cluster.
*
* These are geometry and color checks: they cannot tell a correct glyph from a wrong one.
*
* `rows` maps a terminal row index to its rect in screenshot pixels.
*/
export async function checkTerminalScreenshot({ png, size, rows }) {
const terminal = await fixtureTerminal(size);
assert.ok(rows.get(0), "The ruler row is not exposed as terminal-row-0");
const grid = measureGrid(png, rows.get(0));
const { failures, slots } = checkRows({ png, terminal, rows, grid });
terminal.dispose();
return { grid, failures, slots };
}
/** Where the harness selects: the first cell of the conjunct that starts the `select` line. */
export async function selectionTarget({ size }) {
const terminal = await fixtureTerminal(size);
const row = lineNames(terminal.buffer.active, terminal.buffer.active.cursorY + 1).indexOf(
SELECT_LINE,
);
terminal.dispose();
return { row, col: 0, clusterColumns: 2 };
}
/**
* Checks a screenshot taken with only the first cell of the `select` conjunct selected: that cell
* has the selection background and the conjunct's second, unselected cell keeps its accent color.
*/
export function checkPartialSelection({ png, rows, grid, target }) {
const rect = rows.get(target.row);
if (!rect) return [{ row: target.row, kind: "missing-row" }];
const cell = (col) => ({
left: grid.left + col * grid.cellWidth + 1,
right: grid.left + (col + 1) * grid.cellWidth - 1,
top: rect.y,
bottom: rect.y + rect.height,
});
const selected = cell(target.col);
const unselected = cell(target.col + 1);
const selectionBackground = pixelAt(png, selected.left + 1, selected.top + 1);
const unselectedBackground = pixelAt(png, unselected.left + 1, unselected.top + 1);
if (
!differs(selectionBackground, grid.background) ||
differs(unselectedBackground, grid.background)
) {
return [{ row: target.row, col: target.col, kind: "selection-not-set-up" }];
}
const failures = [];
const ownInk = countColor(png, unselected, grid.background, ACCENT);
if (ownInk < MIN_CLUSTER_INK) {
failures.push({ row: target.row, col: target.col + 1, kind: "unselected-cell-lost-color" });
}
return failures;
}
async function fixtureTerminal(size) {
const terminal = new xterm.Terminal({
cols: size.columns,
rows: size.rows,
allowProposedApi: true,
});
await new Promise((done) =>
terminal.write(fixtureOutput(size.columns).replaceAll("\n", "\r\n"), done),
);
return terminal;
}
export function writeOverlay(png, slots, path) {
const out = new PNG({ width: png.width, height: png.height });
png.data.copy(out.data);
for (const slot of slots) {
const color = slot.ok ? [0, 200, 0] : [255, 0, 0];
const { left, right, top, bottom } = slot.box;
for (let x = Math.ceil(left); x < right; x += 1) {
for (const y of [Math.ceil(top), Math.floor(bottom) - 1]) {
const offset = (out.width * y + x) * 4;
out.data.set(color, offset);
}
}
if (!slot.ok) {
for (let y = Math.ceil(top); y < bottom; y += 1) {
for (const x of [Math.ceil(left), Math.floor(right) - 1]) {
out.data.set(color, (out.width * y + x) * 4);
}
}
}
}
writeFileSync(path, PNG.sync.write(out));
}
function inkAt(png, x, y, background) {
const offset = (png.width * Math.round(y) + Math.round(x)) * 4;
return (
Math.abs(png.data[offset] - background[0]) > INK_THRESHOLD ||
Math.abs(png.data[offset + 1] - background[1]) > INK_THRESHOLD ||
Math.abs(png.data[offset + 2] - background[2]) > INK_THRESHOLD
);
}
/** Pixels in `box` that differ from `background` in some channel by more than the ink threshold. */
export function countInk(png, box, background) {
let count = 0;
for (let y = Math.ceil(box.top); y < Math.floor(box.bottom); y += 1) {
for (let x = Math.ceil(box.left); x < Math.floor(box.right); x += 1) {
if (inkAt(png, x, y, background)) count += 1;
}
}
return count;
}
function differs(a, b) {
return a.some((channel, index) => Math.abs(channel - b[index]) > INK_THRESHOLD);
}
/** Distance from `pixel` to the nearest blend of `background` toward `color`. */
function blendDistance(pixel, background, color) {
const direction = color.map((channel, index) => channel - background[index]);
const length = direction.reduce((sum, value) => sum + value * value, 0);
const offset = pixel.map((channel, index) => channel - background[index]);
const along = offset.reduce((sum, value, index) => sum + value * direction[index], 0);
const alpha = length === 0 ? 0 : Math.min(1, Math.max(0, along / length));
return Math.hypot(...offset.map((value, index) => value - alpha * direction[index]));
}
/** Ink pixels in `box` that are a blend of the background toward `color`. */
function countColor(png, box, background, color, other) {
let count = 0;
for (let y = Math.ceil(box.top); y < Math.floor(box.bottom); y += 1) {
for (let x = Math.ceil(box.left); x < Math.floor(box.right); x += 1) {
if (!inkAt(png, x, y, background)) continue;
const pixel = pixelAt(png, x, y);
const distance = blendDistance(pixel, background, color);
if (distance > BLEND_TOLERANCE) continue;
if (other && blendDistance(pixel, background, other) <= distance) continue;
count += 1;
}
}
return count;
}
function pixelAt(png, x, y) {
const offset = (png.width * Math.round(y) + Math.round(x)) * 4;
return [png.data[offset], png.data[offset + 1], png.data[offset + 2]];
}
/** Reads the grid origin and cell width from a ruler row of `RULER_CELLS` full blocks. */
export function measureGrid(png, rulerRect) {
const y = rulerRect.y + rulerRect.height / 2;
const background = pixelAt(png, rulerRect.x + rulerRect.width - 2, y);
let left = -1;
let right = -1;
for (let x = Math.ceil(rulerRect.x); x < rulerRect.x + rulerRect.width; x += 1) {
if (!inkAt(png, x, y, background)) continue;
if (left < 0) left = x;
right = x + 1;
}
assert.ok(left >= 0, "The ruler row has no ink");
const foreground = pixelAt(png, Math.round((left + right) / 2), y);
return { left, cellWidth: (right - left) / RULER_CELLS, background, foreground };
}
function lineNames(buffer, count) {
const names = fixtureLines(0).map((line) => line.name);
const result = [];
let index = -1;
for (let row = 0; row < count; row += 1) {
if (!buffer.getLine(row).isWrapped) index += 1;
result.push(names[index] ?? `line-${index}`);
}
return result;
}
/** The row's printed cells, consecutive cells of one grapheme cluster grouped together. */
function rowClusters(line, columns, cell) {
const cells = [];
let text = "";
for (let col = 0; col < columns; col += 1) {
line.getCell(col, cell);
const width = cell.getWidth();
if (width === 0) continue;
const chars = cell.getChars() || " ";
cells.push({
col,
width,
chars,
offset: text.length,
painted: cell.isInverse() || !cell.isBgDefault(),
accent: cell.isFgRGB() && cell.getFgColor() === rgbValue(ACCENT),
});
text += chars;
}
const clusterEnds = [...graphemes.segment(text)].map(
(segment) => segment.index + segment.segment.length,
);
const clusters = [];
let end = 0;
for (const entry of cells) {
while (entry.offset >= clusterEnds[end]) end += 1;
const last = clusters.at(-1);
if (last && last.end === end) last.cells.push(entry);
else clusters.push({ end, cells: [entry] });
}
return clusters.map((cluster) => cluster.cells);
}
function rgbValue([red, green, blue]) {
return (red << 16) | (green << 8) | blue;
}
/** Each cell of a cluster that uses the accent color holds ink of its own color only. */
function checkClusterColors({ png, cluster, rect, grid }) {
const kinds = [];
for (const entry of cluster) {
const box = {
left: grid.left + entry.col * grid.cellWidth + 1,
right: grid.left + (entry.col + entry.width) * grid.cellWidth - 1,
top: rect.y,
bottom: rect.y + rect.height,
};
const [color, other] = entry.accent ? [ACCENT, grid.foreground] : [grid.foreground, ACCENT];
const own = countColor(png, box, grid.background, color, other);
const foreign = countColor(png, box, grid.background, other, color);
if (own < MIN_CLUSTER_INK || foreign > MAX_FOREIGN_INK) {
kinds.push({ col: entry.col, kind: entry.accent ? "accent-color-lost" : "color-leaked" });
}
}
return kinds;
}
function checkRows({ png, terminal, rows, grid }) {
const buffer = terminal.buffer.active;
const lastRow = buffer.cursorY;
const names = lineNames(buffer, lastRow + 1);
const failures = [];
const slots = [];
const cell = buffer.getNullCell();
for (let row = 0; row <= lastRow; row += 1) {
const rect = rows.get(row);
if (!rect) {
failures.push({ row, line: names[row], kind: "missing-row" });
continue;
}
const clusters = rowClusters(buffer.getLine(row), terminal.cols, cell);
// Color is judged on whole rows that use the accent, so a color leaking into a neighbouring
// default-colored cell fails too.
const checksColor = clusters.some((cluster) => cluster.some((entry) => entry.accent));
for (const cluster of clusters) {
const first = cluster[0];
const columns = cluster.reduce((sum, entry) => sum + entry.width, 0);
const left = grid.left + first.col * grid.cellWidth;
const right = left + columns * grid.cellWidth;
const box = { left: left + 1, right: right - 1, top: rect.y, bottom: rect.y + rect.height };
const chars = cluster.map((entry) => entry.chars).join("");
const isCursor = row === lastRow && first.col === buffer.cursorX;
let kind = null;
if (isCursor) {
const covered = countInk(png, box, grid.background);
const area = (box.right - box.left) * (box.bottom - box.top);
if (covered < area * 0.25) kind = "cursor-not-drawn";
} else if (chars.trim() !== "") {
if (countInk(png, box, grid.background) < MIN_CLUSTER_INK) kind = "missing-ink";
} else if (!cluster.some((entry) => entry.painted)) {
const quarter = (right - left) / 4;
const center = { ...box, left: left + quarter, right: right - quarter };
if (countInk(png, center, grid.background) > 0) kind = "ink-in-blank";
}
const colorFailures =
kind === null && checksColor && chars.trim() !== ""
? checkClusterColors({ png, cluster, rect, grid })
: [];
slots.push({
row,
line: names[row],
col: first.col,
width: columns,
chars,
isCursor,
box,
ok: kind === null && colorFailures.length === 0,
});
if (kind) failures.push({ row, line: names[row], col: first.col, char: chars, kind });
for (const failure of colorFailures) {
failures.push({ row, line: names[row], char: chars, ...failure });
}
}
}
return { failures, slots };
}
@@ -0,0 +1,59 @@
// Terminal output covering the scripts and styles the native renderer must place on the grid.
// Each entry is one line of output; `ruler` is drawn with full blocks so the harness can read
// the grid origin and cell width from pixels, independent of the renderer under test.
const ESC = "\u001b";
const sgr = (codes, text) => `${ESC}[${codes}m${text}${ESC}[0m`;
export const RULER_CELLS = 20;
/** A foreground no theme uses, so its pixels can be told apart from default text. */
export const ACCENT = [255, 64, 160];
const accent = (text) => sgr(`38;2;${ACCENT.join(";")}`, text);
/**
* The `select` line starts with a conjunct whose first cell the harness selects on its own. Its
* second cell uses the accent, which no theme's selection foreground matches.
*/
export const SELECT_LINE = "select";
export function fixtureLines(columns) {
const wrapSyllables = Math.ceil(columns / 2) + 6;
return [
{ name: "ruler", text: "█".repeat(RULER_CELLS) },
{ name: "ascii", text: "ASCII abcdefghij 0123456789 end" },
{ name: "hangul-mixed", text: "한글 문장 Hello end" },
{ name: "hangul-color-boundary", text: `안녕하세요${sgr(31, "NEXT")} end` },
{ name: "hangul-bold-boundary", text: `${sgr(1, "안녕하세요")}NEXT end` },
{ name: "hangul-decomposed", text: "한글 end" },
{ name: "cjk", text: "日本語テキスト 中文字符 end" },
{ name: "combining", text: "é ä ñ x̣̂ end" },
{ name: "arabic", text: "مرحبا لا 123 abc end" },
{ name: "devanagari", text: "नमस्ते क्षत्रिय end" },
{ name: "emoji", text: "👍 ❤️ 👋🏽 👩‍💻 🇰🇷 end" },
// One shaped cluster over two cells, colored per cell: the color must follow the cell.
{ name: "split-color", text: `क्${accent("ष")} ${accent("क्")}ष ल${accent("ا")} end` },
{ name: SELECT_LINE, text: `क्${accent("ष")} end` },
{ name: "box", text: "╭──┬──╮ │ab│cd│ ╰──┴──╯ ▀▄▌▐░▒▓ end" },
{
name: "styles",
text: [
sgr(1, "bold"),
sgr(3, "italic"),
sgr(4, "under"),
sgr(7, "inverse"),
sgr(42, "bg"),
sgr(9, "strike"),
"end",
].join(" "),
},
{ name: "hangul-wrap", text: "가".repeat(wrapSyllables) },
// The last line has no newline: the shell sleeps with the cursor right after it.
{ name: "cursor", text: "> 안녕하세요" },
];
}
/** The bytes `cat` writes; the tty turns each newline into CR LF. */
export function fixtureOutput(columns) {
return fixtureLines(columns)
.map((line) => line.text)
.join("\n");
}
@@ -0,0 +1,423 @@
import { execFileSync } from "node:child_process";
import { mkdirSync, mkdtempSync, readFileSync, rmSync, writeFileSync } from "node:fs";
import { tmpdir } from "node:os";
import { resolve } from "node:path";
import { PNG } from "pngjs";
import { checkTerminalScreenshot } from "./check.mjs";
// Checks that every printed cluster of a `render.mjs` run is the right glyph. `check.mjs` proves
// where ink lands and what color it has; this compares each cluster's ink with pango's (HarfBuzz)
// rendering of the same characters in the device's own fonts, so a wrong glyph, tofu, a solid
// block, a split conjunct or a cluster from elsewhere fails.
//
// FONTCONFIG_FILE=<fonts.conf> node e2e/mobile/terminal-rendering/identity.mjs <run dir> [control]
//
// The fonts.conf lists the device's font files and prefers, for `monospace`, the terminal font
// followed by the device's fallbacks; `docs/terminal-rendering.md` says how to build one. Needs
// `pango-view` on the PATH.
//
// control:
// none judge the screenshot (default); exits 1 when a cluster fails.
// rect first fill every judged cluster's box with white; exits 1 unless every cluster fails.
// swap judge each cluster against a different cluster of the corpus; exits 1 unless every
// cluster fails.
// The two controls prove the oracle refuses ink that is present but wrong.
/** Coverage grid side used to compare shapes. */
const GRID = 16;
/** A pixel at or above this ink strength (0..1) is part of a glyph's bounding box. */
const INK = 0.25;
/** Lowest shape correlation a cluster may have with its own reference. */
const THRESHOLD = 0.6;
/** How much better another cluster may match before the cluster's own match stops counting. */
const MARGIN = 0.02;
/** Lines whose cells carry decorations or a custom-drawn ruler; they stay geometry-only. */
const SKIPPED_LINES = new Set(["ruler", "styles"]);
const ZWJ = "‍";
/**
* The renderer draws box and block characters to fill the cell, so they are judged against their
* Unicode definition. Shades come from the font, whose fallback differs between the device and
* pango, so a shade is judged by how evenly and densely it inks its own bounding box. Fonts dither
* differently: ░ ▒ ▓ measure 0.16, 0.31, 0.75 in Droid Sans Mono and 0.19, 0.50, 0.81 in Menlo. The
* bands split between those, and do not overlap, so one shade never passes as another.
*/
const CELL_GLYPHS = {
"─": { arms: "LR" },
"│": { arms: "UD" },
"┬": { arms: "LRD" },
"┴": { arms: "LRU" },
"╭": { arms: "DR" },
"╮": { arms: "DL" },
"╰": { arms: "UR" },
"╯": { arms: "UL" },
"▀": { fill: "top" },
"▄": { fill: "bottom" },
"▌": { fill: "left" },
"▐": { fill: "right" },
"░": { shade: [0.08, 0.25] },
"▒": { shade: [0.25, 0.625] },
"▓": { shade: [0.625, 0.9] },
};
/** A shade must ink each region of this grid over its bounding box within its band. */
const SHADE_GRID = 4;
/** Regions of the cell, as fractions [left, top, right, bottom], that a line to each edge crosses. */
const ARM_REGIONS = {
U: [0.3, 0, 0.7, 0.2],
D: [0.3, 0.8, 0.7, 1],
L: [0, 0.3, 0.2, 0.7],
R: [0.8, 0.3, 1, 0.7],
};
/** [filled, empty] halves of each half block. */
const HALVES = {
top: [
[0, 0, 1, 0.5],
[0, 0.5, 1, 1],
],
bottom: [
[0, 0.5, 1, 1],
[0, 0, 1, 0.5],
],
left: [
[0, 0, 0.5, 1],
[0.5, 0, 1, 1],
],
right: [
[0.5, 0, 1, 1],
[0, 0, 0.5, 1],
],
};
const [dirArg, control = "none"] = process.argv.slice(2);
if (!dirArg || !["none", "rect", "swap"].includes(control)) {
throw new Error("Usage: identity.mjs <run dir> [none|rect|swap]");
}
const dir = resolve(dirArg);
const report = JSON.parse(readFileSync(resolve(dir, "report.json"), "utf8"));
const png = PNG.sync.read(readFileSync(resolve(dir, "terminal.png")));
const rows = new Map(report.rows.map((row) => [row.index, row.rect]));
const { grid, slots } = await checkTerminalScreenshot({ png, size: report.size, rows });
const printed = slots.filter(
(slot) => !SKIPPED_LINES.has(slot.line) && !slot.isCursor && slot.chars.trim() !== "",
);
/** The columns xterm gives each printed cluster. */
const columnsOf = new Map(printed.map((slot) => [slot.chars, slot.width]));
if (control === "rect") {
for (const { box } of printed) {
for (let y = Math.ceil(box.top); y < Math.floor(box.bottom); y += 1) {
for (let x = Math.ceil(box.left); x < Math.floor(box.right); x += 1) {
png.data.set([255, 255, 255, 255], (png.width * y + x) * 4);
}
}
}
}
/** Ink strength 0..1 of each pixel in a box: the largest channel distance from the background. */
function screenshotInk(box) {
const left = Math.ceil(box.left);
const top = Math.ceil(box.top);
const width = Math.floor(box.right) - left;
const height = Math.floor(box.bottom) - top;
const ink = new Float32Array(width * height);
for (let y = 0; y < height; y += 1) {
for (let x = 0; x < width; x += 1) {
const offset = (png.width * (top + y) + left + x) * 4;
let distance = 0;
for (let channel = 0; channel < 3; channel += 1) {
distance = Math.max(
distance,
Math.abs(png.data[offset + channel] - grid.background[channel]),
);
}
ink[y * width + x] = distance / 255;
}
}
return { ink, width, height };
}
/** Ink of the slot's whole cells, scaled so the foreground color is 1. */
function cellInk(slot) {
const left = Math.round(grid.left + slot.col * grid.cellWidth);
const right = Math.round(grid.left + (slot.col + slot.width) * grid.cellWidth);
const cells = screenshotInk({ left, right, top: slot.box.top, bottom: slot.box.bottom });
const full =
Math.max(...[0, 1, 2].map((c) => Math.abs(grid.foreground[c] - grid.background[c]))) / 255;
for (let i = 0; i < cells.ink.length; i += 1) cells.ink[i] = Math.min(1, cells.ink[i] / full);
return cells;
}
const scratch = mkdtempSync(resolve(tmpdir(), "terminal-identity-"));
/** pango-view sizes its image to the text's advance plus this margin on each side. */
const REFERENCE_MARGIN = 48;
function pangoInk(text) {
const out = resolve(scratch, "reference.png");
execFileSync("pango-view", [
"--no-display",
"--dpi=72",
"--font=monospace 96px",
`--text=${text}`,
"--background=black",
"--foreground=white",
`--margin=${REFERENCE_MARGIN}`,
"-o",
out,
]);
const image = PNG.sync.read(readFileSync(out));
const ink = new Float32Array(image.width * image.height);
for (let i = 0; i < ink.length; i += 1) {
const o = i * 4;
ink[i] = Math.max(image.data[o], image.data[o + 1], image.data[o + 2]) / 255;
}
return {
ink,
width: image.width,
height: image.height,
advance: image.width - 2 * REFERENCE_MARGIN,
};
}
/** The terminal font's cell advance at the reference size. */
const referenceCell = pangoInk("M").advance;
/**
* The text as the renderer places it in `columns` cells: centred, scaled down when its advance is
* wider, and cut at the cells' edges. Glyphs whose ink overhangs their advance, such as Devanagari
* headlines, are cut on the device too.
*/
function referenceInk(text, columns) {
const image = pangoInk(text);
const box = Math.max(image.advance, columns * referenceCell);
const left = Math.round(REFERENCE_MARGIN + (image.advance - box) / 2);
const right = Math.round(REFERENCE_MARGIN + (image.advance + box) / 2);
for (let y = 0; y < image.height; y += 1) {
for (let x = 0; x < image.width; x += 1) {
if (x < left || x >= right) image.ink[y * image.width + x] = 0;
}
}
return image;
}
function regionInk({ ink, width, height }, [x0, y0, x1, y1]) {
let [sum, max, count] = [0, 0, 0];
for (let y = Math.floor(y0 * height); y < Math.ceil(y1 * height); y += 1) {
for (let x = Math.floor(x0 * width); x < Math.ceil(x1 * width); x += 1) {
const value = ink[y * width + x] ?? 0;
sum += value;
max = Math.max(max, value);
count += 1;
}
}
return { mean: sum / count, max };
}
function inkBox({ ink, width, height }) {
let [minX, minY, maxX, maxY] = [width, height, -1, -1];
for (let y = 0; y < height; y += 1) {
for (let x = 0; x < width; x += 1) {
if (ink[y * width + x] < INK) continue;
minX = Math.min(minX, x);
maxX = Math.max(maxX, x);
minY = Math.min(minY, y);
maxY = Math.max(maxY, y);
}
}
return maxX < 0 ? null : { x: minX, y: minY, width: maxX - minX + 1, height: maxY - minY + 1 };
}
/** Whether an unbroken line crosses the region to the cell edge: a row for L/R, a column for U/D. */
function lineCrosses({ ink, width, height }, arm) {
const [x0, y0, x1, y1] = ARM_REGIONS[arm];
const [left, top, right, bottom] = [
Math.floor(x0 * width),
Math.floor(y0 * height),
Math.ceil(x1 * width),
Math.ceil(y1 * height),
];
const horizontal = arm === "L" || arm === "R";
const [outerFrom, outerTo, innerFrom, innerTo] = horizontal
? [top, bottom, left, right]
: [left, right, top, bottom];
for (let outer = outerFrom; outer < outerTo; outer += 1) {
let unbroken = true;
for (let inner = innerFrom; inner < innerTo && unbroken; inner += 1) {
const [x, y] = horizontal ? [inner, outer] : [outer, inner];
unbroken = (ink[y * width + x] ?? 0) >= 0.5;
}
if (unbroken) return true;
}
return false;
}
/** 1 when the cell matches the character's definition, 0 otherwise. */
function cellGlyphScore(slot, spec) {
const ink = cellInk(slot);
if (spec.arms) {
const matches = Object.keys(ARM_REGIONS).every((arm) =>
spec.arms.includes(arm) ? lineCrosses(ink, arm) : regionInk(ink, ARM_REGIONS[arm]).max < 0.3,
);
return matches ? 1 : 0;
}
if (spec.fill) {
const [filled, empty] = HALVES[spec.fill].map((region) => regionInk(ink, region).mean);
return filled >= 0.8 && empty <= 0.2 ? 1 : 0;
}
const box = inkBox(ink);
if (!box || box.width < 0.7 * ink.width || box.height < 0.5 * ink.height) return 0;
const [x0, y0] = [box.x / ink.width, box.y / ink.height];
const [x1, y1] = [(box.x + box.width) / ink.width, (box.y + box.height) / ink.height];
const [w, h] = [(x1 - x0) / SHADE_GRID, (y1 - y0) / SHADE_GRID];
const regions = Array.from({ length: SHADE_GRID * SHADE_GRID }, (_, index) => {
const [gx, gy] = [index % SHADE_GRID, Math.floor(index / SHADE_GRID)];
return [x0 + gx * w, y0 + gy * h, x0 + (gx + 1) * w, y0 + (gy + 1) * h];
});
const means = regions.map((region) => regionInk(ink, region).mean);
return means.every((mean) => mean >= spec.shade[0] && mean < spec.shade[1]) ? 1 : 0;
}
/** Coverage of the ink's bounding box, centered in a square that keeps its aspect, at GRID². */
function coverage(image) {
const box = inkBox(image);
if (!box) return null;
const side = Math.max(box.width, box.height);
const originX = box.x - (side - box.width) / 2;
const originY = box.y - (side - box.height) / 2;
const vector = new Float32Array(GRID * GRID);
const step = side / GRID;
const samples = 4;
for (let gy = 0; gy < GRID; gy += 1) {
for (let gx = 0; gx < GRID; gx += 1) {
let sum = 0;
for (let sample = 0; sample < samples * samples; sample += 1) {
const x = Math.floor(originX + (gx + ((sample % samples) + 0.5) / samples) * step);
const y = Math.floor(
originY + (gy + (Math.floor(sample / samples) + 0.5) / samples) * step,
);
sum +=
x >= 0 && y >= 0 && x < image.width && y < image.height
? image.ink[y * image.width + x]
: 0;
}
vector[gy * GRID + gx] = sum / (samples * samples);
}
}
return vector;
}
/** Pearson correlation of two coverage vectors; -1 when either has no ink or no contrast. */
function correlation(a, b) {
if (!a || !b) return -1;
const n = a.length;
let [ma, mb] = [0, 0];
for (let i = 0; i < n; i += 1) {
ma += a[i];
mb += b[i];
}
ma /= n;
mb /= n;
let [num, da, db] = [0, 0, 0];
for (let i = 0; i < n; i += 1) {
num += (a[i] - ma) * (b[i] - mb);
da += (a[i] - ma) ** 2;
db += (b[i] - mb) ** 2;
}
return da === 0 || db === 0 ? -1 : num / Math.sqrt(da * db);
}
const references = new Map();
/**
* The cluster alone and with a zero-width joiner before, after and on both sides, so any Arabic
* positional form of the right letter matches.
*/
function referenceVectors(chars) {
if (!references.has(chars)) {
const forms = [chars, ZWJ + chars, chars + ZWJ, ZWJ + chars + ZWJ];
references.set(
chars,
forms.map((text) => coverage(referenceInk(text, columnsOf.get(chars)))),
);
}
return references.get(chars);
}
function shapeScore(vector, chars) {
return Math.max(...referenceVectors(chars).map((reference) => correlation(vector, reference)));
}
/**
* pango draws no ink for Apple Color Emoji, and draws flags on neither device. Those clusters have
* no reference and are reported instead of judged.
*/
const hasReference = (chars) =>
CELL_GLYPHS[chars] ||
(!/^\p{Regional_Indicator}{2}$/u.test(chars) && referenceVectors(chars).some(Boolean));
const judged = printed.filter((slot) => hasReference(slot.chars));
const unjudged = printed
.filter((slot) => !hasReference(slot.chars))
.map((slot) => ({
line: slot.line,
col: slot.col,
chars: slot.chars,
reason: "no reference ink",
}));
const distinct = [...new Set(judged.map((slot) => slot.chars))];
const shapes = distinct.filter((chars) => !CELL_GLYPHS[chars]);
/** The cluster a slot is judged against: its own, or under `swap` a different one. */
function expectedChars(slot, index) {
if (control !== "swap") return slot.chars;
const own = distinct.indexOf(slot.chars);
const other = distinct[(own + 1 + (index % (distinct.length - 1))) % distinct.length];
return other === slot.chars ? distinct[(own + 1) % distinct.length] : other;
}
function judge(slot, index) {
const expected = expectedChars(slot, index);
const result = { line: slot.line, row: slot.row, col: slot.col, chars: slot.chars, expected };
const spec = CELL_GLYPHS[expected];
if (spec) {
result.score = cellGlyphScore(slot, spec);
return result;
}
// The shape must also resemble its own cluster at least as much as any other cluster in the
// corpus, within MARGIN, so a near-lookalike such as g judged as 8 fails.
const vector = coverage(screenshotInk(slot.box));
const score = shapeScore(vector, expected);
let nearest = { chars: expected, score };
for (const other of shapes) {
if (other === expected) continue;
const otherScore = shapeScore(vector, other);
if (otherScore > nearest.score) nearest = { chars: other, score: otherScore };
}
const distinctive = nearest.chars === expected || nearest.score - score <= MARGIN;
result.score = distinctive ? score : Math.min(score, 0);
result.nearest = nearest;
return result;
}
const results = judged.map(judge);
rmSync(scratch, { recursive: true, force: true });
const passed = results.filter((result) => result.score >= THRESHOLD);
const failed = results.filter((result) => result.score < THRESHOLD);
const outDir = resolve(dir, "identity");
mkdirSync(outDir, { recursive: true });
writeFileSync(
resolve(outDir, `${control}.json`),
`${JSON.stringify({ control, threshold: THRESHOLD, unjudged, results }, null, 2)}\n`,
);
const format = (result) =>
`${result.line}@${result.col}(${result.chars}${result.expected === result.chars ? "" : `→${result.expected}`})=${result.score.toFixed(2)}${result.nearest && result.nearest.chars !== result.expected ? ` nearest ${result.nearest.chars}` : ""}`;
console.log(
`${report.label} ${control}: ${results.length} clusters judged, ${passed.length} pass, ${failed.length} fail, ${unjudged.length} unjudged (${outDir})`,
);
if (control === "none") {
for (const result of failed) console.log(` fail ${format(result)}`);
process.exitCode = failed.length === 0 ? 0 : 1;
} else {
for (const result of passed) console.log(` accepted ${format(result)}`);
process.exitCode = passed.length === 0 ? 0 : 1;
}
@@ -0,0 +1,236 @@
import assert from "node:assert/strict";
import { execFileSync } from "node:child_process";
import { mkdirSync, readFileSync, writeFileSync } from "node:fs";
import { homedir, tmpdir } from "node:os";
import { resolve } from "node:path";
import { setTimeout } from "node:timers/promises";
import { PNG } from "pngjs";
import { countInk, measureGrid } from "./check.mjs";
import { RULER_CELLS } from "./fixture.mjs";
// Checks ink that leaves its row: stacked marks above and below a row reach into the rows next to
// it. The script prints such rows, then in one update writes into two rows that hold another row's
// overhang and erases two rows whose overhang reaches a blank row. The overhang must be drawn
// before the update, stay drawn in the written rows, and leave no ink behind the erased rows.
//
// Preconditions are the same as `render.mjs`: the app runs the build being verified against a
// daemon on the same host as this script, and shows an idle, focused terminal with an empty prompt.
//
// PLATFORM=android ANDROID_SERIAL=emulator-5554 node e2e/mobile/terminal-rendering/overhang.mjs
// PLATFORM=ios IOS_DEVICE="iPhone 17" node e2e/mobile/terminal-rendering/overhang.mjs
const platform = process.env.PLATFORM ?? "android";
const appId = process.env.PASEO_TERMINAL_RENDERING_APP_ID ?? "sh.paseo.debug";
const label = process.env.PASEO_TERMINAL_RENDERING_LABEL ?? "overhang";
const session = process.env.AGENT_DEVICE_SESSION ?? `terminal-rendering-${platform}`;
const artifacts = resolve(
process.env.PASEO_TERMINAL_RENDERING_ARTIFACTS ??
resolve(homedir(), ".paseo/artifacts/terminal-rendering", platform),
label,
);
const fixtureDir = process.env.PASEO_TERMINAL_RENDERING_FIXTURE_DIR ?? tmpdir();
const screenshotArgs =
platform === "ios"
? ["--pixel-density", process.env.PASEO_TERMINAL_RENDERING_PIXEL_DENSITY ?? "3"]
: [];
const env = {
...process.env,
AGENT_DEVICE_STATE_DIR:
process.env.AGENT_DEVICE_STATE_DIR ??
resolve(homedir(), ".paseo/artifacts/terminal-rendering/device-state"),
};
mkdirSync(artifacts, { recursive: true });
/** Marks stacked below the row: Arabic dots, rings below `g`, a vowel sign below a consonant. */
const BELOW = "پپپ ييي ججج g̥̥̥̥ कृ";
/** Marks stacked above the row: accents over `e` and `s`, candrabindu, om. */
const ABOVE = "é́́́ ŝ̂̂ कँ ॐ";
/** The marks rows stay left of this column; the update writes at it, outside the checked boxes. */
const CHECKED_COLUMNS = 26;
const WRITE_COLUMN = 30;
/** 0-based rows. Each source row's overhang reaches the row next to it. */
const SOURCES = [
{ row: 2, text: BELOW, overhangRow: 3, update: "write" },
{ row: 6, text: ABOVE, overhangRow: 5, update: "erase" },
{ row: 9, text: BELOW, overhangRow: 10, update: "erase" },
{ row: 13, text: ABOVE, overhangRow: 12, update: "write" },
];
const PARK_ROW = 16;
function ad(...args) {
return execFileSync("agent-device", [...args, "--session", session], {
env,
encoding: "utf8",
timeout: 60_000,
});
}
function deviceArgs() {
if (platform === "android") {
return [
"--platform",
"android",
...(process.env.ANDROID_SERIAL ? ["--serial", process.env.ANDROID_SERIAL] : []),
];
}
return [
"--platform",
"ios",
...(process.env.IOS_DEVICE ? ["--device", process.env.IOS_DEVICE] : []),
];
}
function snapshotNodes() {
return JSON.parse(ad("snapshot", "--json")).data.nodes;
}
function pressControl(id) {
const node = JSON.parse(ad("snapshot", "-i", "--json")).data.nodes.find(
(candidate) => candidate.identifier === id,
);
assert.ok(node?.rect, `No ${id} control on screen`);
const { x, y, width, height } = node.rect;
ad("press", String(Math.round(x + width / 2)), String(Math.round(y + height / 2)));
}
async function pressEnter() {
pressControl("terminal-key-enter");
await setTimeout(2_000);
}
async function runCommand(command) {
ad("type", command, "--delay-ms", "0");
await pressEnter();
}
async function terminalSize() {
await runCommand("clear; stty size");
for (const node of snapshotNodes()) {
const match = /^(\d+) (\d+)$/.exec((node.label ?? "").trim());
if (match && (node.identifier ?? "").startsWith("terminal-row-")) {
return { rows: Number(match[1]), columns: Number(match[2]) };
}
}
throw new Error("No terminal row showed the `stty size` output");
}
function shellQuote(text) {
return `'${text.replaceAll("'", "'\\''")}'`;
}
/** Prints the source rows, waits for Enter, applies the update, and waits for Enter again. */
function fixtureScript() {
const at = (row, col) => `\\033[${row + 1};${col + 1}H`;
const print = (row, text) => `printf '${at(row, 0)}%s' ${shellQuote(text)}`;
const update = SOURCES.map((source) =>
source.update === "write"
? `${at(source.overhangRow, WRITE_COLUMN)}x`
: `${at(source.row, 0)}\\033[2K`,
).join("");
return [
"stty -echo",
"printf '\\033[2J\\033[3J'",
print(0, "█".repeat(RULER_CELLS)),
...SOURCES.map((source) => print(source.row, source.text)),
`printf '${at(PARK_ROW, 0)}'`,
"read -r _",
`printf '${update}${at(PARK_ROW, 0)}'`,
"read -r _",
"stty echo",
"",
].join("\n");
}
function screenshot(name) {
const path = resolve(artifacts, name);
ad("screenshot", path, ...screenshotArgs);
return PNG.sync.read(readFileSync(path));
}
/** Pixels in `box` where the two screenshots differ by more than the ink threshold. */
function changedPixels(before, after, box) {
const difference = new PNG({ width: before.width, height: before.height });
for (let index = 0; index < before.data.length; index += 1) {
difference.data[index] = Math.abs(before.data[index] - after.data[index]);
}
return countInk(difference, box, [0, 0, 0]);
}
ad("open", appId, ...deviceArgs());
const controls = JSON.parse(ad("snapshot", "-i", "--json")).data.nodes;
const hasControl = (id) => controls.some((node) => node.identifier === id);
assert.ok(hasControl("terminal-keyboard-toggle"), "Open a terminal first");
if (!hasControl("terminal-key-enter")) pressControl("terminal-keyboard-toggle");
const size = await terminalSize();
assert.ok(
size.rows > PARK_ROW && size.columns > WRITE_COLUMN,
`Terminal too small: ${JSON.stringify(size)}`,
);
const scriptPath = resolve(fixtureDir, "paseo-terminal-overhang.sh");
writeFileSync(scriptPath, fixtureScript());
await runCommand(`sh ${scriptPath}`);
const nodes = snapshotNodes();
const before = screenshot("before.png");
await pressEnter();
const after = screenshot("after.png");
await pressEnter();
// Snapshot rects are in points on iOS and pixels on Android; the checks work in screenshot pixels.
const scale = before.width / Math.max(...nodes.map((node) => node.rect?.width ?? 0));
const ruler = nodes.find((node) => node.identifier === "terminal-row-0")?.rect;
assert.ok(ruler, "The ruler row is not exposed as terminal-row-0");
const rulerRect = {
x: ruler.x * scale,
y: ruler.y * scale,
width: ruler.width * scale,
height: ruler.height * scale,
};
const grid = measureGrid(before, rulerRect);
const rowBox = (row) => ({
left: grid.left,
right: grid.left + CHECKED_COLUMNS * grid.cellWidth,
top: rulerRect.y + row * rulerRect.height,
bottom: rulerRect.y + (row + 1) * rulerRect.height,
});
/** Measures one source row's overhang before and after the update. */
function measure(source) {
const box = rowBox(source.overhangRow);
const overhangBefore = countInk(before, box, grid.background);
if (source.update === "write") {
const changedAfterWrite = changedPixels(before, after, box);
const failures = [
...(overhangBefore === 0 ? ["overhang-not-drawn"] : []),
...(changedAfterWrite > 0 ? ["overhang-lost-after-write"] : []),
];
return { ...source, overhangBefore, changedAfterWrite, failures };
}
const inkAfterErase = countInk(after, box, grid.background);
const sourceInkAfterErase = countInk(after, rowBox(source.row), grid.background);
const failures = [
...(overhangBefore === 0 ? ["overhang-not-drawn"] : []),
...(inkAfterErase > 0 ? ["overhang-left-after-erase"] : []),
...(sourceInkAfterErase > 0 ? ["source-left-after-erase"] : []),
];
return { ...source, overhangBefore, inkAfterErase, sourceInkAfterErase, failures };
}
const results = SOURCES.map(measure);
const report = { platform, label, size, grid, rulerRect, results };
writeFileSync(resolve(artifacts, "report.json"), `${JSON.stringify(report, null, 2)}\n`);
const failures = results.flatMap((result) =>
result.failures.map((failure) => `row ${result.overhangRow}: ${failure}`),
);
console.log(`${label}: ${failures.length} failures (${artifacts})`);
for (const result of results) {
console.log(
` row ${result.row} -> ${result.overhangRow} (${result.update}): overhang ${result.overhangBefore}` +
(result.update === "write"
? `, changed after write ${result.changedAfterWrite}`
: `, left after erase ${result.inkAfterErase}, source left ${result.sourceInkAfterErase}`),
);
}
for (const failure of failures) console.log(` ${failure}`);
process.exitCode = failures.length === 0 ? 0 : 1;
@@ -0,0 +1,149 @@
import { homedir } from "node:os";
import { execFileSync } from "node:child_process";
import { mkdirSync, writeFileSync } from "node:fs";
import { resolve } from "node:path";
import { setTimeout } from "node:timers/promises";
// Reattaches to a terminal whose PTY has a different size than the app will measure, and checks
// that the client rows equal the daemon's rows. RESIZE=keyboard opens the keyboard, and the
// relaunched app starts with it closed. RESIZE=fold folds an Android foldable emulator and
// relaunches the app unfolded. Either way the shell redraws its prompt on attach.
//
// Preconditions: the app shows terminal TERMINAL_ID, idle at an empty shell prompt, against the
// daemon at PASEO_HOST.
//
// PLATFORM=android TERMINAL_ID=511fd9f0 PASEO_HOST=localhost:6870 \
// node e2e/mobile/terminal-rendering/reattach.mjs
//
// The client used to be sized after the replay arrived, so the shell's redraw landed on the
// wrong rows in most trials. TRIALS sets how many reattaches to check.
const platform = process.env.PLATFORM ?? "android";
const appId = process.env.PASEO_TERMINAL_RENDERING_APP_ID ?? "sh.paseo.debug";
const appUrl = process.env.PASEO_TERMINAL_RENDERING_APP_URL;
const terminalId = process.env.TERMINAL_ID;
const host = process.env.PASEO_HOST;
const trials = Number(process.env.TRIALS ?? 5);
const resize = process.env.RESIZE ?? "keyboard";
const label = process.env.PASEO_TERMINAL_RENDERING_LABEL ?? "reattach";
const session = process.env.AGENT_DEVICE_SESSION ?? `terminal-rendering-${platform}`;
const artifacts = resolve(
process.env.PASEO_TERMINAL_RENDERING_ARTIFACTS ??
resolve(homedir(), ".paseo/artifacts/terminal-rendering", platform),
label,
);
const env = {
...process.env,
AGENT_DEVICE_STATE_DIR:
process.env.AGENT_DEVICE_STATE_DIR ??
resolve(homedir(), ".paseo/artifacts/terminal-rendering/device-state"),
};
if (!terminalId || !host) throw new Error("Set TERMINAL_ID and PASEO_HOST");
mkdirSync(artifacts, { recursive: true });
function ad(...args) {
return execFileSync("agent-device", [...args, "--session", session], {
env,
encoding: "utf8",
timeout: 120_000,
});
}
function paseo(...args) {
return execFileSync("npm", ["run", "-s", "cli", "--", ...args, "--host", host], {
cwd: resolve(import.meta.dirname, "../../../../.."),
encoding: "utf8",
});
}
function pressControl(id) {
const node = JSON.parse(ad("snapshot", "-i", "--json")).data.nodes.find(
(candidate) => candidate.identifier === id,
);
if (!node?.rect) throw new Error(`No ${id} control on screen`);
const { x, y, width, height } = node.rect;
ad("press", String(Math.round(x + width / 2)), String(Math.round(y + height / 2)));
}
async function resizePty() {
if (resize === "keyboard") {
pressControl("terminal-keyboard-toggle");
await setTimeout(2_000);
return;
}
const adb = (...args) =>
execFileSync("adb", [
...(process.env.ANDROID_SERIAL ? ["-s", process.env.ANDROID_SERIAL] : []),
...args,
]);
adb("emu", "fold");
await setTimeout(5_000);
adb("shell", "am", "force-stop", appId);
adb("emu", "unfold");
await setTimeout(3_000);
}
function clientRows() {
const nodes = JSON.parse(ad("snapshot", "--json")).data.nodes;
const byIndex = new Map(nodes.map((node) => [node.index, node]));
const rows = [];
for (const node of nodes) {
const match = /^terminal-row-(\d+)$/.exec(node.identifier ?? "");
if (!match) continue;
// agent-device leaves the label on the parent when the row inherits it.
const text = node.label ?? (node.inheritsLabel ? byIndex.get(node.parentIndex)?.label : "");
rows[Number(match[1])] = (text ?? "").trim();
}
return rows;
}
/**
* Waits for the relaunched app to show terminal rows, then for the shell's redraw to land.
* Returns null when no row appears, for example when the app crashed on launch.
*/
async function attachedClientRows() {
for (let attempt = 0; attempt < 30; attempt += 1) {
await setTimeout(2_000);
if (clientRows().some((text) => text !== "")) {
await setTimeout(3_000);
return clientRows();
}
}
return null;
}
function mismatches(client, server) {
const rows = [];
for (let row = 0; row < Math.max(client.length, server.length); row += 1) {
const expected = (server[row] ?? "").trim();
const actual = client[row] ?? "";
if (expected !== actual) rows.push({ row, server: expected, client: actual });
}
return rows;
}
const results = [];
for (let trial = 1; trial <= trials; trial += 1) {
paseo("terminal", "send-keys", terminalId, "clear", "Enter");
await setTimeout(1_500);
await resizePty();
ad("open", appId, ...(appUrl ? [appUrl] : []), "--relaunch");
const client = await attachedClientRows();
ad("screenshot", resolve(artifacts, `trial-${trial}.png`));
if (!client) {
results.push({ trial, attached: false });
console.log(`${label} trial ${trial}: no terminal rows appeared`);
continue;
}
const server = paseo("terminal", "capture", terminalId).split("\n");
const rows = mismatches(client, server);
results.push({ trial, attached: true, mismatchedRows: rows });
console.log(`${label} trial ${trial}: ${rows.length} mismatched rows`);
}
writeFileSync(resolve(artifacts, "report.json"), `${JSON.stringify(results, null, 2)}\n`);
const attached = results.filter((result) => result.attached);
const failed = attached.filter((result) => result.mismatchedRows.length > 0).length;
console.log(
`${label}: ${failed} of ${attached.length} reattaches differ from the daemon, ${trials - attached.length} never attached (${artifacts})`,
);
process.exitCode = failed === 0 && attached.length === trials ? 0 : 1;
@@ -0,0 +1,197 @@
import assert from "node:assert/strict";
import { execFileSync } from "node:child_process";
import { mkdirSync, readFileSync, writeFileSync } from "node:fs";
import { homedir, tmpdir } from "node:os";
import { resolve } from "node:path";
import { setTimeout } from "node:timers/promises";
import { PNG } from "pngjs";
import {
checkPartialSelection,
checkTerminalScreenshot,
selectionTarget,
writeOverlay,
} from "./check.mjs";
import { fixtureOutput } from "./fixture.mjs";
// Renders the fixture in a real Paseo terminal and checks the screenshot with `check.mjs`, then
// selects one cell of a conjunct and checks a second screenshot.
//
// Preconditions: the app runs the build being verified against a daemon on the same host as
// this script, and shows an idle, focused terminal with an empty shell prompt.
//
// PLATFORM=android ANDROID_SERIAL=emulator-5554 node e2e/mobile/terminal-rendering/render.mjs
// PLATFORM=ios IOS_DEVICE="iPhone 17" node e2e/mobile/terminal-rendering/render.mjs
const platform = process.env.PLATFORM ?? "android";
const appId = process.env.PASEO_TERMINAL_RENDERING_APP_ID ?? "sh.paseo.debug";
const label = process.env.PASEO_TERMINAL_RENDERING_LABEL ?? "run";
const session = process.env.AGENT_DEVICE_SESSION ?? `terminal-rendering-${platform}`;
const artifacts = resolve(
process.env.PASEO_TERMINAL_RENDERING_ARTIFACTS ??
resolve(homedir(), ".paseo/artifacts/terminal-rendering", platform),
label,
);
const fixtureDir = process.env.PASEO_TERMINAL_RENDERING_FIXTURE_DIR ?? tmpdir();
// iOS simulators screenshot at one pixel per point unless asked; glyph identity needs the
// device's real density. Android screenshots are always in device pixels.
const screenshotArgs =
platform === "ios"
? ["--pixel-density", process.env.PASEO_TERMINAL_RENDERING_PIXEL_DENSITY ?? "3"]
: [];
const env = {
...process.env,
AGENT_DEVICE_STATE_DIR:
process.env.AGENT_DEVICE_STATE_DIR ??
resolve(homedir(), ".paseo/artifacts/terminal-rendering/device-state"),
};
mkdirSync(artifacts, { recursive: true });
function ad(...args) {
return execFileSync("agent-device", [...args, "--session", session], {
env,
encoding: "utf8",
timeout: 60_000,
});
}
function deviceArgs() {
if (platform === "android") {
return [
"--platform",
"android",
...(process.env.ANDROID_SERIAL ? ["--serial", process.env.ANDROID_SERIAL] : []),
];
}
return [
"--platform",
"ios",
...(process.env.IOS_DEVICE ? ["--device", process.env.IOS_DEVICE] : []),
];
}
function snapshotNodes() {
return JSON.parse(ad("snapshot", "--json")).data.nodes;
}
function rowNodes(nodes) {
const rows = new Map();
for (const node of nodes) {
const match = /^terminal-row-(\d+)$/.exec(node.identifier ?? "");
if (match && node.rect) rows.set(Number(match[1]), node);
}
return rows;
}
/**
* Taps a control at its center. On iOS the keyboard toolbar is a full-screen accessibility node
* listed after the key bar, so pressing by selector reports the keys as covered.
*/
function pressControl(id) {
const node = JSON.parse(ad("snapshot", "-i", "--json")).data.nodes.find(
(candidate) => candidate.identifier === id,
);
assert.ok(node?.rect, `No ${id} control on screen`);
const { x, y, width, height } = node.rect;
ad("press", String(Math.round(x + width / 2)), String(Math.round(y + height / 2)));
}
async function runCommand(command) {
ad("type", command, "--delay-ms", "0");
pressControl("terminal-key-enter");
await setTimeout(2_000);
}
async function terminalSize() {
await runCommand("clear; stty size");
for (const node of snapshotNodes()) {
const match = /^(\d+) (\d+)$/.exec((node.label ?? "").trim());
if (match && (node.identifier ?? "").startsWith("terminal-row-")) {
return { rows: Number(match[1]), columns: Number(match[2]) };
}
}
throw new Error("No terminal row showed the `stty size` output");
}
ad("open", appId, ...deviceArgs());
const controls = JSON.parse(ad("snapshot", "-i", "--json")).data.nodes;
const hasControl = (id) => controls.some((node) => node.identifier === id);
assert.ok(hasControl("terminal-keyboard-toggle"), "Open a terminal first");
if (!hasControl("terminal-key-enter")) pressControl("terminal-keyboard-toggle");
const size = await terminalSize();
const fixturePath = resolve(fixtureDir, "paseo-terminal-rendering.txt");
const scriptPath = resolve(fixtureDir, "paseo-terminal-rendering.sh");
writeFileSync(fixturePath, fixtureOutput(size.columns));
writeFileSync(scriptPath, `printf '\\033[2J\\033[3J\\033[H'; cat '${fixturePath}'; sleep 120\n`);
await runCommand(`sh ${scriptPath}`);
const nodes = snapshotNodes();
const screenshotPath = resolve(artifacts, "terminal.png");
ad("screenshot", screenshotPath, ...screenshotArgs);
const png = PNG.sync.read(readFileSync(screenshotPath));
// Snapshot rects are in points on iOS and pixels on Android; the checks work in screenshot pixels.
const scale = png.width / Math.max(...nodes.map((node) => node.rect?.width ?? 0));
const toPixels = ({ x, y, width, height }) => ({
x: x * scale,
y: y * scale,
width: width * scale,
height: height * scale,
});
const rows = rowNodes(nodes);
const rects = new Map([...rows].map(([index, node]) => [index, toPixels(node.rect)]));
const { grid, failures, slots } = await checkTerminalScreenshot({ png, size, rows: rects });
// Long-press selects the conjunct as a word; dragging back from its second cell leaves the first.
const target = await selectionTarget({ size });
const targetRect = rects.get(target.row);
assert.ok(targetRect, "The select line is not on screen");
const y = Math.round((targetRect.y + targetRect.height / 2) / scale);
const cellX = (offset) => Math.round((grid.left + (target.col + offset) * grid.cellWidth) / scale);
ad("longpress", String(cellX(0.5)), String(y), "800");
ad("gesture", "pan", String(cellX(1.75)), String(y), String(cellX(0.5) - cellX(1.75)), "0", "600");
const selectionPath = resolve(artifacts, "selection.png");
ad("screenshot", selectionPath, ...screenshotArgs);
const selectionFailures = checkPartialSelection({
png: PNG.sync.read(readFileSync(selectionPath)),
rows: rects,
grid,
target,
});
for (const failure of selectionFailures) failures.push({ line: "select", ...failure });
// A tap clears the selection; it would otherwise survive into the next run's screenshot.
const lastRect = rects.get(size.rows - 1);
if (lastRect) {
ad("press", String(cellX(4)), String(Math.round((lastRect.y + lastRect.height / 2) / scale)));
}
try {
pressControl("terminal-key-ctrl");
ad("type", "c", "--delay-ms", "0");
} catch (error) {
console.warn(`Could not interrupt the fixture: ${error.message}`);
}
writeOverlay(png, slots, resolve(artifacts, "overlay.png"));
const report = {
platform,
label,
size,
grid,
checkedClusters: slots.length,
failures,
rows: [...rows.keys()].map((index) => ({
index,
label: rows.get(index).label,
rect: rects.get(index),
})),
};
writeFileSync(resolve(artifacts, "report.json"), `${JSON.stringify(report, null, 2)}\n`);
const byLine = Map.groupBy(failures, (failure) => failure.line);
console.log(
`${label}: ${slots.length} clusters checked, ${failures.length} failures (${artifacts})`,
);
for (const [line, list] of byLine) {
console.log(
` ${line}: ${list.map((failure) => `${failure.kind}@${failure.col ?? "-"}${failure.char ? `(${failure.char})` : ""}`).join(" ")}`,
);
}
process.exitCode = failures.length === 0 ? 0 : 1;
@@ -1,5 +1,5 @@
import { execFile, spawn } from "node:child_process";
import { writeFile } from "node:fs/promises";
import { writeFile, readFile, readdir } from "node:fs/promises";
import path from "node:path";
import { promisify } from "node:util";
import { expect, type Page } from "@playwright/test";
@@ -154,3 +154,42 @@ export async function plantUnclosableTerminalProgram(
throw error;
}
}
/** Fault injection and liveness checks for the isolated daemon cleanup journey. */
export function suspendDaemonProcess(pid: number): void {
process.kill(pid, "SIGSTOP");
}
export function resumeDaemonProcess(pid: number): void {
try {
process.kill(pid, "SIGCONT");
} catch (error) {
if ((error as NodeJS.ErrnoException).code !== "ESRCH") throw error;
}
}
export async function daemonProcessCanWrite(pid: number): Promise<boolean> {
try {
const state = await psField(pid, "stat");
return state.length > 0 && !state.startsWith("Z");
} catch (error) {
if ((error as { code?: unknown }).code === 1) return false;
throw error;
}
}
export async function readTerminalProcessIds(daemon: IsolatedHostDaemon): Promise<number[]> {
const directory = path.join(daemon.paseoHome, "terminal-worker");
const records = await Promise.all(
(await readdir(directory))
.filter((name) => name.endsWith(".json"))
.map(async (name) => {
const record = JSON.parse(await readFile(path.join(directory, name), "utf8")) as {
pid: number;
terminals: Array<{ pid: number }>;
};
return [record.pid].concat(record.terminals.map((terminal) => terminal.pid));
}),
);
return records.flat();
}
@@ -1,4 +1,11 @@
import { spawn, execFileSync, type ChildProcess, type SpawnOptions } from "node:child_process";
import { promisify } from "node:util";
import {
spawn,
execFile,
execFileSync,
type ChildProcess,
type SpawnOptions,
} from "node:child_process";
import { mkdtemp, rm, writeFile } from "node:fs/promises";
import net from "node:net";
import { tmpdir } from "node:os";
@@ -6,6 +13,8 @@ import path from "node:path";
import { withDisabledE2ESpeechEnv } from "./speech-env";
import { killProcessTree, spawnTsx } from "./spawn-node";
const execFileAsync = promisify(execFile);
export interface IsolatedHostDaemon {
serverId: string;
port: number;
@@ -152,6 +161,24 @@ export async function startIsolatedHostDaemon(
const serverDir = publishedPackageRoot
? path.join(publishedPackageRoot, "node_modules", "@getpaseo", "server")
: path.resolve(__dirname, "../../../../server");
let child: ChildProcess | null = null;
const stopDaemon = async (): Promise<void> => {
// The CLI owns graceful shutdown, forced cleanup and detached terminal
// reaping. Keep its ESM graph out of Playwright's transforming loader.
await execFileAsync(
process.execPath,
[
path.resolve(__dirname, "../../../../cli/dist/index.js"),
"daemon",
"stop",
"--home",
paseoHome,
"--force",
],
{ timeout: 30_000 },
);
await killProcessTree(child);
};
const spawnDaemon = async (): Promise<ChildProcess> => {
const spawnOptions: SpawnOptions = {
cwd: serverDir,
@@ -169,21 +196,21 @@ export async function startIsolatedHostDaemon(
stdio: ["ignore", "ignore", "pipe"],
detached: false,
};
const child = publishedPackageRoot
const spawned = publishedPackageRoot
? spawn(process.execPath, ["dist/scripts/supervisor-entrypoint.js"], spawnOptions)
: spawnTsx("scripts/supervisor-entrypoint.ts", ["--dev"], spawnOptions);
child = spawned;
let stderr = "";
child.stderr?.on("data", (chunk: Buffer) => {
spawned.stderr?.on("data", (chunk: Buffer) => {
stderr += chunk.toString("utf8");
stderr = stderr.split("\n").slice(-40).join("\n");
});
try {
await waitForServer(port, child);
return child;
await waitForServer(port, spawned);
return spawned;
} catch (error) {
await killProcessTree(child);
throw new Error(
`${error instanceof Error ? error.message : String(error)}\nDaemon stderr:\n${stderr}`,
{ cause: error },
@@ -191,10 +218,10 @@ export async function startIsolatedHostDaemon(
}
};
let child: ChildProcess;
try {
child = await spawnDaemon();
await spawnDaemon();
} catch (error) {
await stopDaemon();
if (!options.preserveHome) {
await rm(paseoHome, { recursive: true, force: true });
}
@@ -209,22 +236,22 @@ export async function startIsolatedHostDaemon(
serverId,
port,
paseoHome,
getPid: () => child.pid,
getPid: () => child?.pid,
restart: async () => {
if (closed) throw new Error(`Cannot restart closed isolated daemon ${serverId}`);
await killProcessTree(child);
child = await spawnDaemon();
await stopDaemon();
await spawnDaemon();
},
close: async () => {
if (closed) return;
closed = true;
await killProcessTree(child);
await stopDaemon();
if (!options.preserveHome) {
await rm(paseoHome, { recursive: true, force: true });
}
if (publishedPackageRoot) {
await rm(publishedPackageRoot, { recursive: true, force: true });
}
closed = true;
},
};
}
@@ -1,4 +1,5 @@
import { expect, type Page } from "@playwright/test";
import type { Terminal } from "@xterm/xterm";
import { buildHostWorkspaceRoute } from "../../../src/utils/host-routes";
import { getServerId } from "./server-id";
@@ -206,3 +207,100 @@ export function computePercentile(samples: number[], p: number): number {
export function round2(value: number): number {
return Math.round(value * 100) / 100;
}
/** Observe actual cursor pixels and blink phases through xterm's public render event. */
export async function expectTerminalCursor(
page: Page,
expected: { shape: "bar" | "underline"; blinking: boolean },
): Promise<void> {
const observed = await page.evaluate(async () => {
const terminal = (window as Window & { __paseoTerminal?: Terminal }).__paseoTerminal;
if (!terminal) throw new Error("Terminal did not mount");
const source = Array.from(document.querySelectorAll(".xterm-screen canvas")).find(
(canvas): canvas is HTMLCanvasElement =>
canvas instanceof HTMLCanvasElement && canvas.getContext("webgl2") !== null,
);
if (!source) throw new Error("Cursor verification requires the actual WebGL renderer");
const copy = document.createElement("canvas");
const context = copy.getContext("2d");
if (!context) throw new Error("Cursor pixel capture is unavailable");
terminal.focus();
await new Promise<void>((resolve) =>
requestAnimationFrame(() => requestAnimationFrame(() => resolve())),
);
if (!terminal.element?.contains(document.activeElement))
throw new Error("Terminal did not focus");
const started = performance.now();
const frames: Array<{ time: number; width: number; height: number }> = [];
const rendered = terminal.onRender(() => {
copy.width = source.width;
copy.height = source.height;
// WebGL's default drawing buffer must be copied before this render returns.
context.drawImage(source, 0, 0);
const cellWidth = source.width / terminal.cols;
const cellHeight = source.height / terminal.rows;
const x = Math.round(terminal.buffer.active.cursorX * cellWidth);
const y = Math.round(terminal.buffer.active.cursorY * cellHeight);
const width = Math.ceil(cellWidth);
const height = Math.ceil(cellHeight);
const background = context.getImageData(x + width + 2, y, 1, 1).data;
const pixels = context.getImageData(x, y, width, height).data;
let minX = width;
let maxX = -1;
let minY = height;
let maxY = -1;
for (let row = 0; row < height; row++) {
for (let col = 0; col < width; col++) {
const offset = (row * width + col) * 4;
if (
![0, 1, 2, 3].some(
(channel) => Math.abs(pixels[offset + channel]! - background[channel]!) > 20,
)
)
continue;
minX = Math.min(minX, col);
maxX = Math.max(maxX, col);
minY = Math.min(minY, row);
maxY = Math.max(maxY, row);
}
}
frames.push({
time: performance.now() - started,
width: maxX < 0 ? 0 : (maxX - minX + 1) / cellWidth,
height: maxY < 0 ? 0 : (maxY - minY + 1) / cellHeight,
});
});
try {
const refresh = setInterval(() => terminal.refresh(0, terminal.rows - 1), 40);
try {
await new Promise((resolve) => setTimeout(resolve, 1800));
} finally {
clearInterval(refresh);
}
} finally {
rendered.dispose();
}
return {
frames,
focused: terminal.element?.contains(document.activeElement),
samples: frames.length,
width: Math.max(...frames.map((frame) => frame.width)),
height: Math.max(...frames.map((frame) => frame.height)),
blinking:
frames.filter(
(frame, index) => index > 0 && (frame.width === 0) !== (frames[index - 1]!.width === 0),
).length >= 2,
};
});
expect(observed.samples).toBeGreaterThan(5);
expect(observed.blinking, JSON.stringify(observed)).toBe(expected.blinking);
if (expected.shape === "bar") {
expect(observed.width).toBeGreaterThan(0);
expect(observed.width).toBeLessThan(0.4);
expect(observed.height).toBeGreaterThan(0.6);
} else {
expect(observed.width).toBeGreaterThan(0.6);
expect(observed.height).toBeGreaterThan(0);
expect(observed.height).toBeLessThan(0.4);
}
}
@@ -0,0 +1,25 @@
apply plugin: 'com.android.library'
group = 'sh.paseo.terminal'
version = '0.1.0'
def expoModulesCorePlugin = new File(project(":expo-modules-core").projectDir.absolutePath, "ExpoModulesCorePlugin.gradle")
apply from: expoModulesCorePlugin
applyKotlinExpoModulesCorePlugin()
useCoreDependencies()
useExpoPublishing()
useDefaultAndroidSdkVersions()
android {
namespace "sh.paseo.terminal"
defaultConfig {
testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
}
}
dependencies {
implementation "androidx.customview:customview:1.1.0"
testImplementation "junit:junit:4.13.2"
androidTestImplementation "androidx.test:runner:1.6.2"
androidTestImplementation "androidx.test.ext:junit:1.2.1"
}
@@ -0,0 +1,38 @@
[
{
"output": "स्ते",
"row": "2,1,2,1,1,1,1,1,1,1,1,1,1,1,1,1;8,4294638330,0,0;स्ते ",
"clusterStarts": [0, 2, 3, 4, 5, 6, 7],
"contrastStarts": [0, 1, 2, 3, 4, 5, 6, 7]
},
{
"output": "क्ष",
"row": "2,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1;8,4294638330,0,0;क्ष ",
"clusterStarts": [0, 2, 3, 4, 5, 6, 7],
"contrastStarts": [0, 1, 2, 3, 4, 5, 6, 7]
},
{
"output": "নক্ষত্র",
"row": "1,1,2,1,1,1,2,1,1,1,1,1,1,1,1,1;8,4294638330,0,0;নক্ষত্র ",
"clusterStarts": [0, 1, 3, 5, 6, 7],
"contrastStarts": [0, 1, 2, 3, 4, 5, 6, 7]
},
{
"output": "क्अ",
"row": "2,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1;8,4294638330,0,0;क्अ ",
"clusterStarts": [0, 1, 2, 3, 4, 5, 6, 7],
"contrastStarts": [0, 2, 3, 4, 5, 6, 7]
},
{
"output": "ক্অ",
"row": "2,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1;8,4294638330,0,0;ক্অ ",
"clusterStarts": [0, 1, 2, 3, 4, 5, 6, 7],
"contrastStarts": [0, 2, 3, 4, 5, 6, 7]
},
{
"output": "अ्क",
"row": "2,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1;8,4294638330,0,0;अ्क ",
"clusterStarts": [0, 1, 2, 3, 4, 5, 6, 7],
"contrastStarts": [0, 2, 3, 4, 5, 6, 7]
}
]
@@ -0,0 +1,140 @@
package sh.paseo.terminal
import android.os.Build
import android.graphics.Bitmap
import android.graphics.Canvas
import android.graphics.Paint
import android.util.Log
import androidx.test.ext.junit.runners.AndroidJUnit4
import androidx.test.platform.app.InstrumentationRegistry
import org.json.JSONArray
import org.json.JSONObject
import org.junit.Assert.assertTrue
import org.junit.Assert.assertEquals
import org.junit.Test
import org.junit.runner.RunWith
private const val COLUMNS = 8
/** Rasters that draw the same clusters match exactly; a wrong clustering differs by 0.12 or more. */
private const val MATCH_TOLERANCE = 0.01f
@RunWith(AndroidJUnit4::class)
class TerminalRowLayoutTest {
private val font = TerminalFont("monospace", 40f, 1f)
private val paints = TerminalPaints()
/**
* Draws each row of `grapheme-rows.json` and compares it with its grapheme clusters drawn one at a
* time, each centred in its own columns. `terminal-frame.test.ts` checks that the rows are what
* xterm produces and that the clusters are UAX #29 grapheme clusters.
*/
@Test
fun drawsEachGraphemeClusterInItsOwnColumns() {
val assets = InstrumentationRegistry.getInstrumentation().context.assets
val rows = JSONArray(assets.open("grapheme-rows.json").bufferedReader().readText())
for (index in 0 until rows.length()) {
val row = rows.getJSONObject(index)
val source = TerminalRowSource.decode(row.getString("row"))
val layout = TerminalRowLayout(source, font, TerminalCustomGlyphs.EMPTY)
// Selection covers row 0 only, so drawing as row 1 draws nothing selected.
val drawn = raster { layout.drawSelected(it, 1, TerminalSelection(TerminalSelectionRecord()), paints) }
val expected = raster { drawClusters(it, source, starts(row, "clusterStarts")) }
val contrast = raster { drawClusters(it, source, starts(row, "contrastStarts")) }
val output = row.getString("output")
val (toExpected, toContrast) = difference(drawn, expected) to difference(drawn, contrast)
Log.i("TerminalRowLayoutTest", "$output expected=$toExpected contrast=$toContrast")
// Android 10's platform ICU splits this conjunct. Keep its observed raster baseline
// explicit rather than claiming this supported OS passes the modern grapheme corpus.
if (Build.VERSION.SDK_INT == 29 && output == "स्ते") {
assertTrue("Android 10 unexpectedly matches modern conjunct clustering", toExpected > MATCH_TOLERANCE)
assertTrue("Android 10 split-conjunct baseline changed", toContrast <= MATCH_TOLERANCE)
continue
}
assertTrue("$output differs from its grapheme clusters by $toExpected", toExpected <= MATCH_TOLERANCE)
assertTrue("$output also matches the wrong clusters", toContrast > MATCH_TOLERANCE)
}
}
@Test
fun selectionCompositesOverCellAndTerminalBackgroundsWithoutChangingForeground() {
val red = 0xffff0000.toInt()
val green = 0xff00aa00.toInt()
val overlay = 0x472684ff
val source = TerminalRowSource.decode("1,1;1,4294901760,4278233600,0;M")
val layout = TerminalRowLayout(source, font, TerminalCustomGlyphs.EMPTY)
paints.selectionBackground = overlay
for (terminalBackground in listOf(0xffffffff.toInt(), 0xff000000.toInt())) {
val actual = raster { canvas ->
canvas.drawColor(terminalBackground)
layout.drawSelected(canvas, 0, TerminalSelection(TerminalSelectionRecord()), paints)
}
val expected = raster { canvas ->
canvas.drawColor(terminalBackground)
canvas.drawColor(green)
canvas.drawColor(overlay)
}
assertEquals(expected.getPixel(0, 0), actual.getPixel(0, 0))
assertTrue("selected glyph retains its red foreground", (0 until font.cellHeightPx).any { y ->
(0 until font.cellWidthPx).any { x -> actual.getPixel(x, y) == red }
})
}
val defaultBackground = TerminalRowLayout(TerminalRowSource.decode("1,1;1,4294901760,0,0;M"), font, TerminalCustomGlyphs.EMPTY)
for (terminalBackground in listOf(0xffffffff.toInt(), 0xff000000.toInt())) {
val actual = raster { canvas ->
canvas.drawColor(terminalBackground)
defaultBackground.drawSelected(canvas, 0, TerminalSelection(TerminalSelectionRecord()), paints)
}
val expected = raster { canvas -> canvas.drawColor(terminalBackground); canvas.drawColor(overlay) }
assertEquals(expected.getPixel(0, 0), actual.getPixel(0, 0))
}
}
private fun starts(row: JSONObject, key: String): List<Int> =
row.getJSONArray(key).let { starts -> List(starts.length()) { starts.getInt(it) } }
private fun raster(draw: (Canvas) -> Unit): Bitmap {
val bitmap = Bitmap.createBitmap(COLUMNS * font.cellWidthPx, font.cellHeightPx, Bitmap.Config.ARGB_8888)
draw(Canvas(bitmap))
return bitmap
}
/** Draws each cluster as its own text, centred in its columns and scaled down when wider. */
private fun drawClusters(canvas: Canvas, source: TerminalRowSource, starts: List<Int>) {
val cellCount = source.cells.size / 2
val paint = Paint(font.paint(0)).apply { color = source.styles[1].toLong().toInt() }
val offsets = IntArray(cellCount + 1)
val cols = IntArray(cellCount + 1)
for (cell in 0 until cellCount) {
offsets[cell + 1] = offsets[cell] + source.cells[cell * 2]
cols[cell + 1] = cols[cell] + source.cells[cell * 2 + 1]
}
for ((index, first) in starts.withIndex()) {
val end = starts.getOrElse(index + 1) { cellCount }
val text = source.text.substring(offsets[first], offsets[end])
if (text.isBlank()) continue
val slot = (cols[end] - cols[first]) * font.cellWidthPx.toFloat()
val advance = paint.measureText(text)
val x = cols[first] * font.cellWidthPx + if (advance > slot + 1f) 0f else (slot - advance) / 2f
canvas.save()
if (advance > slot + 1f) canvas.scale(slot / advance, slot / advance, x, font.cellHeightPx / 2f)
canvas.drawText(text, x, font.baselinePx.toFloat(), paint)
canvas.restore()
}
}
/** Share of inked pixels, in either image, whose coverage differs by more than a quarter. */
private fun difference(a: Bitmap, b: Bitmap): Float {
var inked = 0
var differing = 0
for (y in 0 until a.height) {
for (x in 0 until a.width) {
val (left, right) = (a.getPixel(x, y) ushr 24) to (b.getPixel(x, y) ushr 24)
if (left < 64 && right < 64) continue
inked += 1
if (kotlin.math.abs(left - right) > 64) differing += 1
}
}
return if (inked == 0) 0f else differing.toFloat() / inked
}
}
@@ -0,0 +1 @@
<manifest xmlns:android="http://schemas.android.com/apk/res/android" />
@@ -0,0 +1,24 @@
package sh.paseo.terminal
import expo.modules.kotlin.modules.Module
import expo.modules.kotlin.modules.ModuleDefinition
class PaseoTerminalModule : Module() {
override fun definition() = ModuleDefinition {
Name("PaseoTerminal")
View(PaseoTerminalView::class) {
Events("onCellMetrics")
Prop("frame") { view: PaseoTerminalView, frame: TerminalFrameRecord -> view.setFrame(frame) }
Prop("theme") { view: PaseoTerminalView, theme: TerminalThemeRecord -> view.setTheme(theme) }
Prop("fontFamily") { view: PaseoTerminalView, family: String -> view.setFontFamily(family) }
Prop("fontSize") { view: PaseoTerminalView, size: Double -> view.setFontSize(size) }
Prop("customGlyphs") { view: PaseoTerminalView, glyphs: List<TerminalCustomGlyphRecord> ->
view.setCustomGlyphs(glyphs)
}
OnViewDidUpdateProps { view: PaseoTerminalView -> view.commit() }
}
}
}
@@ -0,0 +1,195 @@
package sh.paseo.terminal
import android.annotation.SuppressLint
import android.content.Context
import android.graphics.Canvas
import android.graphics.Color
import android.graphics.Rect
import android.os.Bundle
import android.view.MotionEvent
import android.widget.TextView
import androidx.core.view.ViewCompat
import androidx.core.view.accessibility.AccessibilityNodeInfoCompat
import androidx.customview.widget.ExploreByTouchHelper
import expo.modules.kotlin.AppContext
import expo.modules.kotlin.viewevent.EventDispatcher
import expo.modules.kotlin.views.ExpoView
private const val MIN_CACHED_ROWS = 256
private const val CURSOR_ALPHA = 0.45f
/**
* Paints terminal frames on the cell grid. Row shaping is cached by row content, so cursor and
* selection changes repaint without reshaping, and unchanged rows replay their display lists.
*/
@SuppressLint("ViewConstructor")
class PaseoTerminalView(context: Context, appContext: AppContext) : ExpoView(context, appContext) {
private val onCellMetrics by EventDispatcher<Map<String, Float>>()
private var fontFamily = "monospace"
private var fontSize = 12.0
private var font: TerminalFont? = null
private var customGlyphs = TerminalCustomGlyphs.EMPTY
private var frame: TerminalFrameRecord? = null
private var frameChanged = false
private var rows: List<TerminalRowLayout> = emptyList()
private var columns = 0
private var cursor: TerminalCursorRecord? = null
private var selection: TerminalSelection? = null
private var backgroundColor = Color.BLACK
private var cursorColor = Color.WHITE
private val paints = TerminalPaints()
private val rowCache = object : LinkedHashMap<String, TerminalRowLayout>(64, 0.75f, true) {
override fun removeEldestEntry(eldest: MutableMap.MutableEntry<String, TerminalRowLayout>): Boolean {
if (size <= maxOf(MIN_CACHED_ROWS, rows.size * 2)) return false
eldest.value.release()
return true
}
}
private val accessibility = RowAccessibility()
init {
setWillNotDraw(false)
ViewCompat.setAccessibilityDelegate(this, accessibility)
}
fun setFrame(value: TerminalFrameRecord) {
frame = value
frameChanged = true
}
fun setTheme(value: TerminalThemeRecord) {
backgroundColor = argb(value.background)
cursorColor = argb(value.cursor)
paints.selectionBackground = argb(value.selectionBackground)
invalidate()
}
fun setFontFamily(value: String) {
fontFamily = value
}
fun setFontSize(value: Double) {
fontSize = value
}
fun setCustomGlyphs(value: List<TerminalCustomGlyphRecord>) {
customGlyphs = TerminalCustomGlyphs(value)
clearRowCache()
frameChanged = true
}
/** Applies a batch of prop updates: font first, then the frame laid out with it. */
fun commit() {
val density = resources.displayMetrics.density
val sizePx = (fontSize * density).toFloat()
val current = font
if (current == null || !current.sameAs(fontFamily, sizePx, density)) {
val next = TerminalFont(fontFamily, sizePx, density)
font = next
clearRowCache()
frameChanged = true
onCellMetrics(
mapOf(
"cellWidth" to next.cellWidthPx / density,
"cellHeight" to next.cellHeightPx / density,
),
)
}
if (frameChanged) {
frameChanged = false
layoutFrame()
}
invalidate()
}
private fun layoutFrame() {
val currentFont = font ?: return
val record = frame ?: return
columns = record.columns
cursor = record.cursor
selection = record.selection?.let(::TerminalSelection)
rows = record.rows.map { encoded ->
rowCache.getOrPut(encoded) {
TerminalRowLayout(TerminalRowSource.decode(encoded), currentFont, customGlyphs)
}
}
accessibility.invalidateRoot()
}
private fun clearRowCache() {
for (layout in rowCache.values) layout.release()
rowCache.clear()
rows = emptyList()
}
override fun onDraw(canvas: Canvas) {
super.onDraw(canvas)
canvas.drawColor(backgroundColor)
val currentFont = font ?: return
val cellWidth = currentFont.cellWidthPx
val cellHeight = currentFont.cellHeightPx
val gridWidth = columns * cellWidth
canvas.save()
canvas.clipRect(0, 0, minOf(width, gridWidth), height)
val activeSelection = selection
for ((index, row) in rows.withIndex()) {
canvas.save()
canvas.translate(0f, (index * cellHeight).toFloat())
if (activeSelection != null && activeSelection.intersectsRow(index)) {
row.drawSelected(canvas, index, activeSelection, paints)
} else {
row.draw(canvas, gridWidth, paints)
}
canvas.restore()
}
cursor?.let { position ->
paints.fill.color = withAlpha(cursorColor, CURSOR_ALPHA)
val left = (position.col * cellWidth).toFloat()
val top = (position.row * cellHeight).toFloat()
canvas.drawRect(left, top, left + cellWidth, top + cellHeight, paints.fill)
}
canvas.restore()
}
override fun dispatchHoverEvent(event: MotionEvent): Boolean =
accessibility.dispatchHoverEvent(event) || super.dispatchHoverEvent(event)
override fun onDetachedFromWindow() {
super.onDetachedFromWindow()
for (layout in rowCache.values) layout.release()
}
private fun withAlpha(color: Int, alpha: Float): Int =
Color.argb((Color.alpha(color) * alpha).toInt(), Color.red(color), Color.green(color), Color.blue(color))
/** Exposes each non-blank row as a virtual text node, `terminal-row-<index>`. */
private inner class RowAccessibility : ExploreByTouchHelper(this@PaseoTerminalView) {
override fun getVirtualViewAt(x: Float, y: Float): Int {
val cellHeight = font?.cellHeightPx ?: return INVALID_ID
val row = (y / cellHeight).toInt()
return if (row in rows.indices && rows[row].describe().isNotEmpty()) row else INVALID_ID
}
override fun getVisibleVirtualViews(virtualViewIds: MutableList<Int>) {
for ((index, row) in rows.withIndex()) {
if (row.describe().isNotEmpty()) virtualViewIds.add(index)
}
}
@Suppress("DEPRECATION")
override fun onPopulateNodeForVirtualView(virtualViewId: Int, node: AccessibilityNodeInfoCompat) {
val cellHeight = font?.cellHeightPx ?: 1
val label = rows.getOrNull(virtualViewId)?.describe().orEmpty()
node.className = TextView::class.java.name
node.text = label
node.contentDescription = label
node.viewIdResourceName = "terminal-row-$virtualViewId"
val top = virtualViewId * cellHeight
node.setBoundsInParent(Rect(0, top, minOf(width, columns * (font?.cellWidthPx ?: 1)), top + cellHeight))
}
override fun onPerformActionForVirtualView(virtualViewId: Int, action: Int, arguments: Bundle?): Boolean = false
}
}
@@ -0,0 +1,76 @@
package sh.paseo.terminal
import android.graphics.Canvas
import android.graphics.Paint
import android.graphics.Path
/**
* Box drawing and block elements painted as cell geometry instead of font glyphs, so frames and
* blocks join across cells regardless of the font's own metrics.
*/
internal class TerminalCustomGlyph(record: TerminalCustomGlyphRecord) {
private val rects: FloatArray = FloatArray(record.rects.size) { record.rects[it].toFloat() }
private val commands: DoubleArray = record.path
private val strokeWidth: Float = record.strokeWidth.toFloat()
private var scaledPath: Path? = null
private var scaledWidth = 0f
private var scaledHeight = 0f
fun draw(canvas: Canvas, x: Float, width: Float, height: Float, density: Float, paint: Paint) {
paint.style = Paint.Style.FILL
var index = 0
while (index + 3 < rects.size) {
canvas.drawRect(
x + rects[index] * width,
rects[index + 1] * height,
x + (rects[index] + rects[index + 2]) * width,
(rects[index + 1] + rects[index + 3]) * height,
paint,
)
index += 4
}
if (commands.isEmpty()) return
val path = pathFor(width, height)
paint.style = Paint.Style.STROKE
paint.strokeWidth = strokeWidth * density
paint.strokeCap = Paint.Cap.BUTT
paint.strokeJoin = Paint.Join.MITER
canvas.save()
canvas.translate(x, 0f)
canvas.drawPath(path, paint)
canvas.restore()
paint.style = Paint.Style.FILL
}
private fun pathFor(width: Float, height: Float): Path {
val cached = scaledPath
if (cached != null && scaledWidth == width && scaledHeight == height) return cached
val path = Path()
var index = 0
while (index < commands.size) {
val x = { offset: Int -> commands[index + offset].toFloat() * width }
val y = { offset: Int -> commands[index + offset].toFloat() * height }
when (commands[index].toInt()) {
0 -> { path.moveTo(x(1), y(2)); index += 3 }
1 -> { path.lineTo(x(1), y(2)); index += 3 }
2 -> { path.quadTo(x(1), y(2), x(3), y(4)); index += 5 }
else -> index = commands.size
}
}
scaledPath = path
scaledWidth = width
scaledHeight = height
return path
}
}
internal class TerminalCustomGlyphs(records: List<TerminalCustomGlyphRecord>) {
private val glyphs: Map<String, TerminalCustomGlyph> =
records.associate { it.char to TerminalCustomGlyph(it) }
operator fun get(text: String): TerminalCustomGlyph? = glyphs[text]
companion object {
val EMPTY = TerminalCustomGlyphs(emptyList())
}
}
@@ -0,0 +1,61 @@
package sh.paseo.terminal
import android.graphics.Paint
import android.graphics.Typeface
import kotlin.math.max
import kotlin.math.roundToInt
private const val MEASURE_TEXT = "mmmmmmmmmm"
/**
* The terminal font at one pixel size: a paint per face (regular, bold, italic, bold italic) and
* the cell those faces are laid out on. Cells are whole device pixels so every column origin is
* exact. Platform fallback fonts cover characters the family lacks.
*/
internal class TerminalFont(val family: String, val sizePx: Float, val density: Float) {
private val faces: Array<Paint> = Array(4) { face ->
Paint(Paint.ANTI_ALIAS_FLAG or Paint.SUBPIXEL_TEXT_FLAG).apply {
typeface = Typeface.create(family, typefaceStyle(face))
textSize = sizePx
}
}
val cellWidthPx: Int
val cellHeightPx: Int
val baselinePx: Int
val underlineOffsetPx: Float
val underlineThicknessPx: Float
val strikeOffsetPx: Float
val strikeThicknessPx: Float
init {
val regular = faces[0]
cellWidthPx = max(1, (regular.measureText(MEASURE_TEXT) / MEASURE_TEXT.length).roundToInt())
val metrics = regular.fontMetricsInt
cellHeightPx = max(1, metrics.descent - metrics.ascent)
baselinePx = -metrics.ascent
underlineOffsetPx = regular.underlinePosition
underlineThicknessPx = max(1f, regular.underlineThickness)
strikeOffsetPx = regular.strikeThruPosition
strikeThicknessPx = max(1f, regular.strikeThruThickness)
}
/** Paint for a style's face; callers only change its color. */
fun paint(flags: Int): Paint = faces[face(flags)]
fun sameAs(family: String, sizePx: Float, density: Float): Boolean =
this.family == family && this.sizePx == sizePx && this.density == density
companion object {
fun face(flags: Int): Int =
(if (flags and TerminalStyleFlags.BOLD != 0) 1 else 0) +
(if (flags and TerminalStyleFlags.ITALIC != 0) 2 else 0)
private fun typefaceStyle(face: Int): Int = when (face) {
1 -> Typeface.BOLD
2 -> Typeface.ITALIC
3 -> Typeface.BOLD_ITALIC
else -> Typeface.NORMAL
}
}
}
@@ -0,0 +1,99 @@
package sh.paseo.terminal
import expo.modules.kotlin.records.Field
import expo.modules.kotlin.records.Record
class TerminalCursorRecord : Record {
@Field val row: Int = 0
@Field val col: Int = 0
}
class TerminalSelectionRecord : Record {
@Field val startRow: Int = 0
@Field val startCol: Int = 0
@Field val endRow: Int = 0
@Field val endCol: Int = 0
}
class TerminalFrameRecord : Record {
@Field val columns: Int = 0
/** Encoded rows, `cells;styles;text`; see `frame-encoding.ts`. */
@Field val rows: List<String> = emptyList()
@Field val cursor: TerminalCursorRecord? = null
@Field val selection: TerminalSelectionRecord? = null
}
class TerminalThemeRecord : Record {
@Field val background: Double = 0.0
@Field val cursor: Double = 0.0
@Field val selectionBackground: Double = 0.0
}
class TerminalCustomGlyphRecord : Record {
@Field val char: String = ""
@Field val rects: DoubleArray = DoubleArray(0)
@Field val path: DoubleArray = DoubleArray(0)
@Field val strokeWidth: Double = 0.0
}
internal object TerminalStyleFlags {
const val BOLD = 1
const val ITALIC = 2
const val UNDERLINE = 4
const val STRIKETHROUGH = 8
}
/** JS sends colors as unsigned ARGB numbers; Android paints signed ARGB ints. */
internal fun argb(value: Double): Int = value.toLong().toInt()
/** One row as the caller described it: cell text, column spans and style spans. */
internal class TerminalRowSource private constructor(
val text: String,
val cells: IntArray,
val styles: DoubleArray,
) {
companion object {
/** Decodes `cells;styles;text`, where both number lists are comma separated. */
fun decode(encoded: String): TerminalRowSource {
val cellsEnd = encoded.indexOf(';')
val stylesEnd = encoded.indexOf(';', cellsEnd + 1)
val cells = parseNumbers(encoded, 0, cellsEnd)
val styles = parseNumbers(encoded, cellsEnd + 1, stylesEnd)
return TerminalRowSource(
encoded.substring(stylesEnd + 1),
IntArray(cells.size) { cells[it].toInt() },
DoubleArray(styles.size) { styles[it].toDouble() },
)
}
private fun parseNumbers(encoded: String, start: Int, end: Int): LongArray {
if (end <= start) return LongArray(0)
var count = 1
for (index in start until end) if (encoded[index] == ',') count += 1
val numbers = LongArray(count)
var slot = 0
for (index in start until end) {
val char = encoded[index]
if (char == ',') slot += 1 else numbers[slot] = numbers[slot] * 10 + (char - '0')
}
return numbers
}
}
}
internal class TerminalSelection(record: TerminalSelectionRecord) {
private val startRow = record.startRow
private val startCol = record.startCol
private val endRow = record.endRow
private val endCol = record.endCol
fun intersectsRow(row: Int): Boolean = row in startRow..endRow
/** A cell is selected when any column it covers is inside the inclusive range. */
fun contains(row: Int, col: Int, span: Int): Boolean {
if (!intersectsRow(row)) return false
val firstCol = if (row == startRow) startCol else 0
val lastCol = if (row == endRow) endCol else Int.MAX_VALUE
return col + span - 1 >= firstCol && col <= lastCol
}
}
@@ -0,0 +1,302 @@
package sh.paseo.terminal
import android.graphics.Canvas
import android.graphics.Paint
import android.graphics.RenderNode
import android.graphics.text.MeasuredText
import android.icu.text.BreakIterator
/** Shaped glyphs may exceed their slot by this many pixels before they are scaled down. */
private const val OVERFLOW_TOLERANCE_PX = 1f
/** Stands in for an open edge when a group is clipped on one side only. */
private const val CLIP_UNBOUNDED_PX = 100_000f
/**
* One row shaped once and placed on the terminal grid.
*
* Each run of cells with the same font face is shaped as a whole, so contextual forms, ligatures,
* marks and fallback fonts see their neighbours. The shaper reports a cluster's advance on its
* first UTF-16 unit and zero on the units it absorbed. A cell whose first unit has zero advance
* therefore belongs to the cluster of the cell before it: a ligature, conjunct, emoji sequence or
* reordered mark that spans columns. A cell that does not start a grapheme cluster also stays with
* the cell before it: a half-form conjunct such as स्त keeps both consonants' advances, and drawing
* either half alone would show an explicit virama. Each resulting group is drawn from the shaped
* run (in context) at its first cell's column, centred in the columns it owns, and scaled down only when
* its glyphs are wider than those columns. Colors never split groups or reshape the row: a group
* whose cells differ in color is drawn once per color, clipped to those cells' columns.
*/
internal class TerminalRowLayout(
val source: TerminalRowSource,
private val font: TerminalFont,
private val customGlyphs: TerminalCustomGlyphs,
) {
private val chars: CharArray = source.text.toCharArray()
private val cellCount = source.cells.size / 2
private val cellCol = IntArray(cellCount)
private val cellSpan = IntArray(cellCount)
private val cellStart = IntArray(cellCount)
private val cellEnd = IntArray(cellCount)
private val cellForeground = IntArray(cellCount)
private val cellBackground = IntArray(cellCount)
private val cellFlags = IntArray(cellCount)
private val cellGlyph = arrayOfNulls<TerminalCustomGlyph>(cellCount)
private val groups = ArrayList<Group>()
private val measured: MeasuredText?
val text: String get() = source.text
private var node: RenderNode? = null
private class Group(
val firstCell: Int,
val lastCell: Int,
val col: Int,
val start: Int,
val end: Int,
val contextStart: Int,
val contextEnd: Int,
val offsetPx: Float,
val scale: Float,
val blank: Boolean,
)
init {
readCells()
measured = measure()
if (measured != null) buildGroups(measured)
}
private fun readCells() {
var offset = 0
var col = 0
var styleIndex = 0
var styleEndCol = 0
for (cell in 0 until cellCount) {
val length = source.cells[cell * 2]
val span = maxOf(1, source.cells[cell * 2 + 1])
while (col >= styleEndCol && styleIndex + 3 < source.styles.size) {
styleEndCol += source.styles[styleIndex].toInt()
styleIndex += 4
}
val style = styleIndex - 4
if (style >= 0) {
cellForeground[cell] = argb(source.styles[style + 1])
cellBackground[cell] = argb(source.styles[style + 2])
cellFlags[cell] = source.styles[style + 3].toInt()
}
cellCol[cell] = col
cellSpan[cell] = span
cellStart[cell] = offset
cellEnd[cell] = minOf(chars.size, offset + length)
cellGlyph[cell] = customGlyphs[source.text.substring(cellStart[cell], cellEnd[cell])]
offset = cellEnd[cell]
col += span
}
}
/** Same face, not custom glyph: cells shaped together. */
private fun shapesWith(cell: Int, other: Int): Boolean =
cellGlyph[cell] == null && cellGlyph[other] == null &&
TerminalFont.face(cellFlags[cell]) == TerminalFont.face(cellFlags[other])
private fun measure(): MeasuredText? {
if (chars.isEmpty()) return null
val builder = MeasuredText.Builder(chars)
var cell = 0
while (cell < cellCount) {
var last = cell
while (last + 1 < cellCount && shapesWith(cell, last + 1)) last += 1
val length = cellEnd[last] - cellStart[cell]
if (length > 0) {
if (cellGlyph[cell] != null) {
builder.appendReplacementRun(font.paint(cellFlags[cell]), length, 0f)
} else {
builder.appendStyleRun(font.paint(cellFlags[cell]), length, false)
}
}
cell = last + 1
}
val trailing = chars.size - (if (cellCount > 0) cellEnd[cellCount - 1] else 0)
if (trailing > 0) builder.appendReplacementRun(font.paint(0), trailing, 0f)
return builder.build()
}
private fun buildGroups(measured: MeasuredText) {
// Keep platform graphemes together even when Minikin reports separate advances/cursors.
// Rules follow the OS ICU version: Android 10 splits Indic conjuncts such as स्ते.
val graphemes = BreakIterator.getCharacterInstance()
graphemes.setText(source.text)
var cell = 0
while (cell < cellCount) {
if (cellGlyph[cell] != null) {
cell += 1
continue
}
var last = cell
while (last + 1 < cellCount && shapesWith(cell, last + 1)) last += 1
val contextStart = cellStart[cell]
val contextEnd = cellEnd[last]
var first = cell
for (next in cell + 1..last) {
val startsCluster =
cellEnd[next] > cellStart[next] &&
measured.getCharWidthAt(cellStart[next]) != 0f &&
graphemes.isBoundary(cellStart[next])
if (startsCluster) {
addGroup(measured, first, next - 1, contextStart, contextEnd)
first = next
}
}
addGroup(measured, first, last, contextStart, contextEnd)
cell = last + 1
}
}
private fun addGroup(measured: MeasuredText, first: Int, last: Int, contextStart: Int, contextEnd: Int) {
val start = cellStart[first]
val end = cellEnd[last]
if (end <= start) return
var columns = 0
for (cell in first..last) columns += cellSpan[cell]
val slot = (columns * font.cellWidthPx).toFloat()
val advance = measured.getWidth(start, end)
val scale = if (advance > slot + OVERFLOW_TOLERANCE_PX) slot / advance else 1f
val offset = if (scale < 1f) 0f else (slot - advance) / 2f
var blank = true
for (index in start until end) {
if (chars[index] != ' ') {
blank = false
break
}
}
groups.add(Group(first, last, cellCol[first], start, end, contextStart, contextEnd, offset, scale, blank))
}
/** Draws the row with its own colors, replaying a recorded display list when possible. */
fun draw(canvas: Canvas, width: Int, paints: TerminalPaints) {
if (!canvas.isHardwareAccelerated) {
drawContent(canvas, -1, null, paints)
return
}
// Marks stacked above or below a letter ink outside the row. The node must not clip them: the
// view redraws every row on each frame, so ink outside the row is never left stale.
val recorded = node ?: RenderNode("terminal-row").also {
it.setClipToBounds(false)
node = it
}
if (!recorded.hasDisplayList() || recorded.width != width) {
recorded.setPosition(0, 0, width, font.cellHeightPx)
val recording = recorded.beginRecording()
try {
drawContent(recording, -1, null, paints)
} finally {
recorded.endRecording()
}
}
canvas.drawRenderNode(recorded)
}
/** Draws backgrounds, the selection overlay, then text with its original colors. */
fun drawSelected(canvas: Canvas, row: Int, selection: TerminalSelection, paints: TerminalPaints) {
drawContent(canvas, row, selection, paints)
}
fun release() {
node?.discardDisplayList()
node = null
}
private fun selected(row: Int, selection: TerminalSelection?, cell: Int): Boolean =
selection?.contains(row, cellCol[cell], cellSpan[cell]) == true
private fun drawContent(canvas: Canvas, row: Int, selection: TerminalSelection?, paints: TerminalPaints) {
val cellWidth = font.cellWidthPx.toFloat()
val cellHeight = font.cellHeightPx.toFloat()
val fill = paints.fill
for (cell in 0 until cellCount) {
val left = cellCol[cell] * cellWidth
val right = (cellCol[cell] + cellSpan[cell]) * cellWidth
val background = cellBackground[cell]
if (background ushr 24 != 0) {
fill.color = background
canvas.drawRect(left, 0f, right, cellHeight, fill)
}
if (selected(row, selection, cell)) {
fill.color = paints.selectionBackground
canvas.drawRect(left, 0f, right, cellHeight, fill)
}
}
val baseline = font.baselinePx.toFloat()
val text = measured
if (text != null) {
for (group in groups) {
if (group.blank) continue
val paint = font.paint(cellFlags[group.firstCell])
var first = group.firstCell
while (first <= group.lastCell) {
val color = cellForeground[first]
var last = first
while (last < group.lastCell && cellForeground[last + 1] == color) last += 1
// Only edges between differently colored cells clip; the group's outer edges may overhang.
val clipped = first > group.firstCell || last < group.lastCell
canvas.save()
if (clipped) {
val left = if (first > group.firstCell) cellCol[first] * cellWidth else -CLIP_UNBOUNDED_PX
val right =
if (last < group.lastCell) (cellCol[last] + cellSpan[last]) * cellWidth else CLIP_UNBOUNDED_PX
canvas.clipRect(left, -CLIP_UNBOUNDED_PX, right, CLIP_UNBOUNDED_PX)
}
paint.color = color
drawGroupText(canvas, text, group, paint, cellWidth, cellHeight, baseline)
canvas.restore()
first = last + 1
}
}
}
for (cell in 0 until cellCount) {
val glyph = cellGlyph[cell]
val flags = cellFlags[cell]
val foreground = cellForeground[cell]
if (glyph != null) {
fill.color = foreground
glyph.draw(canvas, cellCol[cell] * cellWidth, cellSpan[cell] * cellWidth, cellHeight, font.density, fill)
}
if (flags and (TerminalStyleFlags.UNDERLINE or TerminalStyleFlags.STRIKETHROUGH) == 0) continue
fill.color = foreground
val left = cellCol[cell] * cellWidth
val right = left + cellSpan[cell] * cellWidth
if (flags and TerminalStyleFlags.UNDERLINE != 0) {
val top = baseline + font.underlineOffsetPx
canvas.drawRect(left, top, right, top + font.underlineThicknessPx, fill)
}
if (flags and TerminalStyleFlags.STRIKETHROUGH != 0) {
val top = baseline + font.strikeOffsetPx
canvas.drawRect(left, top, right, top + font.strikeThicknessPx, fill)
}
}
}
private fun drawGroupText(
canvas: Canvas,
text: MeasuredText,
group: Group,
paint: Paint,
cellWidth: Float,
cellHeight: Float,
baseline: Float,
) {
val x = group.col * cellWidth + group.offsetPx
if (group.scale < 1f) canvas.scale(group.scale, group.scale, x, cellHeight / 2f)
canvas.drawTextRun(text, group.start, group.end, group.contextStart, group.contextEnd, x, baseline, false, paint)
}
/** The row's text as accessibility reads it. */
fun describe(): String = source.text.trimEnd()
}
/** Paint state shared by every row of one view. */
internal class TerminalPaints {
val fill = Paint(Paint.ANTI_ALIAS_FLAG)
var selectionBackground: Int = 0x472684FF
}
@@ -0,0 +1,59 @@
/**
* Native terminal renderer. The caller owns terminal state (xterm), input and gestures; this view
* shapes and paints one frame of terminal cells on the authoritative cell grid and reports the
* cell size its font produces.
*
* Colors are unsigned 32-bit ARGB numbers (`0xAARRGGBB`). Alpha 0 means "not painted".
*/
export interface PaseoTerminalFrame {
/** Columns the frame paints. Cells beyond it are clipped. */
columns: number;
rows: PaseoTerminalRow[];
cursor: PaseoTerminalCursor | null;
selection: PaseoTerminalSelection | null;
}
/**
* One terminal row. Cells start at column 0 and are consecutive. `text` is every cell's text in
* order, so cell `i` owns the next `cells[2i]` UTF-16 code units of `text` and covers the next
* `cells[2i + 1]` columns. Style spans are consecutive from column 0 and cover all columns.
*/
export interface PaseoTerminalRow {
text: string;
/** Flattened `[utf16Length, columnSpan]` per cell. */
cells: number[];
/** Flattened `[columnCount, foreground, background, flags]` per style span. */
styles: number[];
}
export interface PaseoTerminalCursor {
row: number;
col: number;
}
/** Inclusive cell range in frame rows. A cell is selected when any of its columns is. */
export interface PaseoTerminalSelection {
startRow: number;
startCol: number;
endRow: number;
endCol: number;
}
export interface PaseoTerminalTheme {
background: number;
cursor: number;
selectionBackground: number;
}
export interface PaseoTerminalCellMetrics {
cellWidth: number;
cellHeight: number;
}
export const PASEO_TERMINAL_STYLE_FLAGS = {
bold: 1,
italic: 2,
underline: 4,
strikethrough: 8,
dim: 16,
} as const;
@@ -1,6 +1,6 @@
import { describe, expect, it } from "vitest";
import { resolveTerminalCustomGlyph } from "./terminal-custom-glyph";
import { encodeTerminalCustomGlyphs, resolveTerminalCustomGlyph } from "./custom-glyphs";
describe("native terminal custom glyphs", () => {
it("fills the complete cell for the full block used by the Claude mascot", () => {
@@ -85,4 +85,22 @@ describe("native terminal custom glyphs", () => {
expect(resolveTerminalCustomGlyph(char), `missing custom glyph ${char}`).not.toBeNull();
}
});
it("encodes every glyph for the native renderer in cell fractions", () => {
const encoded = new Map(encodeTerminalCustomGlyphs().map((glyph) => [glyph.char, glyph]));
expect(encoded.get("▛")).toEqual({
char: "▛",
rects: [0, 0, 0.5, 0.5, 0.5, 0, 0.5, 0.5, 0, 0.5, 0.5, 0.5],
path: [],
strokeWidth: 0,
});
expect(encoded.get("╭")).toEqual({
char: "╭",
rects: [],
path: [0, 0.5, 1, 1, 0.5, 0.75, 2, 0.5, 0.5, 0.75, 0.5, 1, 1, 0.5],
strokeWidth: 1,
});
expect(encoded.get("┣")?.strokeWidth).toBe(3);
});
});
@@ -82,12 +82,60 @@ const BLOCK_GLYPHS: Readonly<Record<string, TerminalRectGlyph>> = {
"▟": rects(upperRight(), lowerLeft(), lowerRight()),
};
/**
* One custom glyph as the native view consumes it. Coordinates are fractions of one cell.
* `rects` is flattened `[x, y, width, height]`. `path` is flattened commands:
* `0 x y` moves, `1 x y` draws a line, `2 cx cy x y` draws a quadratic curve. Paths are
* stroked with `strokeWidth` points regardless of cell size.
*/
export interface PaseoTerminalCustomGlyph {
char: string;
rects: number[];
path: number[];
strokeWidth: number;
}
const PATH_COMMAND_CODES: Readonly<Record<string, { code: number; coordinates: number }>> = {
M: { code: 0, coordinates: 2 },
L: { code: 1, coordinates: 2 },
Q: { code: 2, coordinates: 4 },
};
export function resolveTerminalCustomGlyph(char: string): TerminalCustomGlyph | null {
return LIGHT_BOX_GLYPHS[char] ?? HEAVY_BOX_GLYPHS[char] ?? BLOCK_GLYPHS[char] ?? null;
}
export function isTerminalCustomGlyph(char: string): boolean {
return resolveTerminalCustomGlyph(char) !== null;
export function encodeTerminalCustomGlyphs(): PaseoTerminalCustomGlyph[] {
const table = { ...LIGHT_BOX_GLYPHS, ...HEAVY_BOX_GLYPHS, ...BLOCK_GLYPHS };
return Object.entries(table).map(([char, glyph]) =>
glyph.kind === "rects"
? {
char,
rects: glyph.rects.flatMap((value) => [value.x, value.y, value.width, value.height]),
path: [],
strokeWidth: 0,
}
: { char, rects: [], path: encodePath(glyph.path), strokeWidth: glyph.strokeWidth },
);
}
function encodePath(pathData: string): number[] {
const tokens = pathData.match(/[MLQ]|-?\d*\.?\d+/g) ?? [];
const encoded: number[] = [];
let index = 0;
while (index < tokens.length) {
const command = PATH_COMMAND_CODES[tokens[index]];
if (!command) {
throw new Error(`Unsupported terminal glyph path command in ${pathData}`);
}
const coordinates = tokens.slice(index + 1, index + 1 + command.coordinates).map(Number);
if (coordinates.length !== command.coordinates || coordinates.some(Number.isNaN)) {
throw new Error(`Malformed terminal glyph path ${pathData}`);
}
encoded.push(command.code, ...coordinates);
index += 1 + command.coordinates;
}
return encoded;
}
function path(pathData: string, strokeWidth = 1): TerminalPathGlyph {
@@ -0,0 +1,9 @@
{
"platforms": ["android", "ios"],
"android": {
"modules": ["sh.paseo.terminal.PaseoTerminalModule"]
},
"ios": {
"modules": ["PaseoTerminalModule"]
}
}
@@ -0,0 +1,34 @@
import { describe, expect, test } from "vitest";
import { encodeTerminalFrame } from "./frame-encoding";
describe("encodeTerminalFrame", () => {
test("puts cells and styles before text, so text may contain separators", () => {
const native = encodeTerminalFrame({
columns: 10,
rows: [
{
text: "안a;b,",
cells: [1, 2, 1, 1, 1, 1, 1, 1, 1, 1],
styles: [3, 0xffe5e5e5, 0, 0, 3, 0xffff0000, 0, 1],
},
{ text: "", cells: [], styles: [] },
],
cursor: { row: 1, col: 0 },
selection: { startRow: 0, startCol: 0, endRow: 0, endCol: 1 },
});
expect(native).toEqual({
columns: 10,
rows: ["1,2,1,1,1,1,1,1,1,1;3,4293256677,0,0,3,4294901760,0,1;안a;b,", ";;"],
cursor: { row: 1, col: 0 },
selection: { startRow: 0, startCol: 0, endRow: 0, endCol: 1 },
});
});
test("leaves out a missing cursor and selection instead of sending null", () => {
const native = encodeTerminalFrame({ columns: 1, rows: [], cursor: null, selection: null });
expect(Object.keys(native)).toEqual(["columns", "rows"]);
});
});
@@ -0,0 +1,27 @@
import type { PaseoTerminalCursor, PaseoTerminalFrame, PaseoTerminalSelection } from "./contract";
/** A frame as it crosses to native. */
export interface NativePaseoTerminalFrame {
columns: number;
rows: string[];
cursor?: PaseoTerminalCursor;
selection?: PaseoTerminalSelection;
}
/**
* Rows cross as `cells;styles;text`, with the numbers comma separated. One string per row keeps
* prop conversion to a single copy instead of one call per number, and the string is also the
* native shaping cache key, so an unchanged row costs one lookup.
*
* A missing cursor or selection is left out rather than sent as `null`: Expo on iOS fails to
* convert `null` into an optional record field and then drops the whole frame.
*/
export function encodeTerminalFrame(frame: PaseoTerminalFrame): NativePaseoTerminalFrame {
const native: NativePaseoTerminalFrame = {
columns: frame.columns,
rows: frame.rows.map((row) => `${row.cells.join(",")};${row.styles.join(",")};${row.text}`),
};
if (frame.cursor) native.cursor = frame.cursor;
if (frame.selection) native.selection = frame.selection;
return native;
}
@@ -0,0 +1,47 @@
import { requireNativeView } from "expo";
import { useCallback, useMemo } from "react";
import type { StyleProp, ViewStyle } from "react-native";
import type { PaseoTerminalCellMetrics, PaseoTerminalFrame, PaseoTerminalTheme } from "./contract";
import { encodeTerminalCustomGlyphs, type PaseoTerminalCustomGlyph } from "./custom-glyphs";
import { encodeTerminalFrame, type NativePaseoTerminalFrame } from "./frame-encoding";
export * from "./contract";
export interface PaseoTerminalViewProps {
frame: PaseoTerminalFrame;
theme: PaseoTerminalTheme;
fontFamily: string;
/** Font size in points after the system font scale is applied. */
fontSize: number;
onCellMetrics?: (metrics: PaseoTerminalCellMetrics) => void;
style?: StyleProp<ViewStyle>;
}
interface NativePaseoTerminalViewProps extends Omit<
PaseoTerminalViewProps,
"frame" | "onCellMetrics"
> {
frame: NativePaseoTerminalFrame;
customGlyphs: PaseoTerminalCustomGlyph[];
onCellMetrics?: (event: { nativeEvent: PaseoTerminalCellMetrics }) => void;
}
const NativePaseoTerminalView = requireNativeView<NativePaseoTerminalViewProps>("PaseoTerminal");
const CUSTOM_GLYPHS = encodeTerminalCustomGlyphs();
export function PaseoTerminalView({ frame, onCellMetrics, ...props }: PaseoTerminalViewProps) {
const nativeFrame = useMemo(() => encodeTerminalFrame(frame), [frame]);
const handleCellMetrics = useCallback(
(event: { nativeEvent: PaseoTerminalCellMetrics }) => onCellMetrics?.(event.nativeEvent),
[onCellMetrics],
);
return (
<NativePaseoTerminalView
{...props}
frame={nativeFrame}
customGlyphs={CUSTOM_GLYPHS}
onCellMetrics={handleCellMetrics}
/>
);
}
@@ -0,0 +1,22 @@
Pod::Spec.new do |s|
s.name = 'PaseoTerminal'
s.version = '0.1.0'
s.summary = 'Native terminal renderer for Paseo'
s.description = 'Shapes and paints terminal frames on the terminal cell grid'
s.license = 'Apache-2.0'
s.author = 'Paseo'
s.homepage = 'https://paseo.sh'
s.platforms = { :ios => '15.1' }
s.swift_version = '5.4'
s.source = { :path => '.' }
s.static_framework = true
s.dependency 'ExpoModulesCore'
s.pod_target_xcconfig = {
'DEFINES_MODULE' => 'YES',
'SWIFT_COMPILATION_MODE' => 'wholemodule'
}
s.source_files = "**/*.{h,m,swift}"
end
@@ -0,0 +1,21 @@
import ExpoModulesCore
public class PaseoTerminalModule: Module {
public func definition() -> ModuleDefinition {
Name("PaseoTerminal")
View(PaseoTerminalView.self) {
Events("onCellMetrics")
Prop("frame") { (view: PaseoTerminalView, frame: TerminalFrameRecord) in view.setFrame(frame) }
Prop("theme") { (view: PaseoTerminalView, theme: TerminalThemeRecord) in view.setTheme(theme) }
Prop("fontFamily") { (view: PaseoTerminalView, family: String) in view.setFontFamily(family) }
Prop("fontSize") { (view: PaseoTerminalView, size: Double) in view.setFontSize(size) }
Prop("customGlyphs") { (view: PaseoTerminalView, glyphs: [TerminalCustomGlyphRecord]) in
view.setCustomGlyphs(glyphs)
}
OnViewDidUpdateProps { (view: PaseoTerminalView) in view.commit() }
}
}
}
@@ -0,0 +1,177 @@
import ExpoModulesCore
import UIKit
private let minCachedRows = 256
private let cursorAlpha: CGFloat = 0.45
/// Paints terminal frames on the cell grid. Row shaping is cached by row content, and a frame
/// repaints only the rows whose layout, selection or cursor changed. A row's glyphs may ink outside
/// the row, so a repaint covers the old and new row's ink and redraws every row whose ink it meets.
final class PaseoTerminalView: ExpoView {
let onCellMetrics = EventDispatcher()
private var fontFamily = "Menlo"
private var fontSize: CGFloat = 12
private var font: TerminalFont?
private var customGlyphs = TerminalCustomGlyphs.empty
private var frameRecord: TerminalFrameRecord?
private var frameChanged = false
private var rows: [TerminalRowLayout] = []
private var columns = 0
private var cursor: (row: Int, col: Int)?
private var selection: TerminalSelection?
private var background = TerminalColor(Double(0xff00_0000))
private var cursorColor = TerminalColor(Double(0xffff_ffff))
private var rowPaint = TerminalRowPaint(
selectionBackground: TerminalColor(Double(0x4726_84ff)))
private var rowCache: [String: TerminalRowLayout] = [:]
required init(appContext: AppContext? = nil) {
super.init(appContext: appContext)
isOpaque = true
contentMode = .redraw
isAccessibilityElement = false
}
func setFrame(_ record: TerminalFrameRecord) {
frameRecord = record
frameChanged = true
}
func setTheme(_ record: TerminalThemeRecord) {
background = TerminalColor(record.background)
cursorColor = TerminalColor(record.cursor)
rowPaint = TerminalRowPaint(
selectionBackground: TerminalColor(record.selectionBackground))
backgroundColor = UIColor(cgColor: background.cgColor())
setNeedsDisplay()
}
func setFontFamily(_ value: String) { fontFamily = value }
func setFontSize(_ value: Double) { fontSize = CGFloat(value) }
func setCustomGlyphs(_ records: [TerminalCustomGlyphRecord]) {
customGlyphs = TerminalCustomGlyphs(records)
rowCache.removeAll()
rows = []
frameChanged = true
}
/// Applies a batch of prop updates: font first, then the frame laid out with it.
func commit() {
let displayScale = traitCollection.displayScale > 0 ? traitCollection.displayScale : UIScreen.main.scale
if font?.sameAs(family: fontFamily, size: fontSize, displayScale: displayScale) != true {
let next = TerminalFont(family: fontFamily, size: fontSize, displayScale: displayScale)
font = next
rowCache.removeAll()
rows = []
frameChanged = true
onCellMetrics(["cellWidth": next.cellWidth, "cellHeight": next.cellHeight])
setNeedsDisplay()
}
if frameChanged {
frameChanged = false
layoutFrame()
}
}
override func traitCollectionDidChange(_ previous: UITraitCollection?) {
super.traitCollectionDidChange(previous)
if previous?.displayScale != traitCollection.displayScale { commit() }
}
override func layoutSubviews() {
super.layoutSubviews()
setNeedsDisplay()
}
private func layoutFrame() {
guard let font, let record = frameRecord else { return }
let previousRows = rows
let previousSelection = selection
let previousCursor = cursor
let previousColumns = columns
columns = record.columns
cursor = record.cursor.map { ($0.row, $0.col) }
selection = record.selection.map(TerminalSelection.init)
rows = record.rows.map { encoded in
if let cached = rowCache[encoded] { return cached }
let layout = TerminalRowLayout(
source: TerminalRowSource(encoded: encoded), font: font, customGlyphs: customGlyphs)
rowCache[encoded] = layout
return layout
}
trimRowCache(keeping: record.rows)
updateAccessibility()
if previousColumns != columns || previousRows.count != rows.count {
setNeedsDisplay()
return
}
for index in rows.indices {
let layoutChanged = previousRows[index] !== rows[index]
let selectionChanged = previousSelection?.columns(onRow: index) != selection?.columns(onRow: index)
let cursorChanged =
(previousCursor?.row == index || cursor?.row == index)
&& (previousCursor?.row != cursor?.row || previousCursor?.col != cursor?.col)
if layoutChanged || selectionChanged || cursorChanged {
let previous = paintedRect(previousRows[index], at: index, font: font)
setNeedsDisplay(previous.union(paintedRect(rows[index], at: index, font: font)))
}
}
}
/// The area row `index` paints, including glyph ink outside the row.
private func paintedRect(_ row: TerminalRowLayout, at index: Int, font: TerminalFont) -> CGRect {
let top = CGFloat(index) * font.cellHeight
return CGRect(x: 0, y: top + row.inkTop, width: bounds.width, height: row.inkBottom - row.inkTop)
}
private func trimRowCache(keeping currentRows: [String]) {
guard rowCache.count > max(minCachedRows, rows.count * 2) else { return }
let current = Set(currentRows)
rowCache = rowCache.filter { current.contains($0.key) }
}
override func draw(_ rect: CGRect) {
guard let context = UIGraphicsGetCurrentContext() else { return }
context.setFillColor(background.cgColor())
context.fill(rect)
guard let font else { return }
let gridWidth = CGFloat(columns) * font.cellWidth
context.saveGState()
context.clip(to: CGRect(x: 0, y: 0, width: min(bounds.width, gridWidth), height: bounds.height))
for (index, row) in rows.enumerated() where paintedRect(row, at: index, font: font).intersects(rect) {
row.draw(in: context, row: index, top: CGFloat(index) * font.cellHeight, selection: selection, paint: rowPaint)
}
if let cursor {
context.setFillColor(cursorColor.cgColor(alphaScale: cursorAlpha))
context.fill(CGRect(
x: CGFloat(cursor.col) * font.cellWidth, y: CGFloat(cursor.row) * font.cellHeight,
width: font.cellWidth, height: font.cellHeight))
}
context.restoreGState()
}
/// Exposes each non-blank row as a static text element, `terminal-row-<index>`.
private func updateAccessibility() {
guard let font else { return }
var elements: [UIAccessibilityElement] = []
for (index, row) in rows.enumerated() {
let label = row.accessibilityText
guard !label.isEmpty else { continue }
let element = UIAccessibilityElement(accessibilityContainer: self)
element.accessibilityIdentifier = "terminal-row-\(index)"
element.accessibilityLabel = label
element.accessibilityTraits = .staticText
element.accessibilityFrameInContainerSpace = CGRect(
x: 0, y: CGFloat(index) * font.cellHeight,
width: min(bounds.width, CGFloat(columns) * font.cellWidth), height: font.cellHeight)
elements.append(element)
}
accessibilityElements = elements
}
}
@@ -0,0 +1,73 @@
import CoreGraphics
/// Box drawing and block elements painted as cell geometry instead of font glyphs, so frames and
/// blocks join across cells regardless of the font's own metrics.
final class TerminalCustomGlyph {
private let rects: [Double]
private let commands: [Double]
private let strokeWidth: CGFloat
init(_ record: TerminalCustomGlyphRecord) {
rects = record.rects
commands = record.path
strokeWidth = CGFloat(record.strokeWidth)
}
func draw(in context: CGContext, rect cell: CGRect, color: CGColor) {
context.saveGState()
context.setFillColor(color)
var index = 0
while index + 3 < rects.count {
context.fill(CGRect(
x: cell.minX + CGFloat(rects[index]) * cell.width,
y: cell.minY + CGFloat(rects[index + 1]) * cell.height,
width: CGFloat(rects[index + 2]) * cell.width,
height: CGFloat(rects[index + 3]) * cell.height))
index += 4
}
if !commands.isEmpty {
let point = { (offset: Int) in
CGPoint(
x: cell.minX + CGFloat(self.commands[offset]) * cell.width,
y: cell.minY + CGFloat(self.commands[offset + 1]) * cell.height)
}
let path = CGMutablePath()
index = 0
while index < commands.count {
switch Int(commands[index]) {
case 0:
path.move(to: point(index + 1))
index += 3
case 1:
path.addLine(to: point(index + 1))
index += 3
case 2:
path.addQuadCurve(to: point(index + 3), control: point(index + 1))
index += 5
default:
index = commands.count
}
}
context.setStrokeColor(color)
context.setLineWidth(strokeWidth)
context.setLineCap(.butt)
context.setLineJoin(.miter)
context.addPath(path)
context.strokePath()
}
context.restoreGState()
}
}
final class TerminalCustomGlyphs {
static let empty = TerminalCustomGlyphs([])
private let glyphs: [String: TerminalCustomGlyph]
init(_ records: [TerminalCustomGlyphRecord]) {
var glyphs: [String: TerminalCustomGlyph] = [:]
for record in records { glyphs[record.char] = TerminalCustomGlyph(record) }
self.glyphs = glyphs
}
subscript(text: String) -> TerminalCustomGlyph? { glyphs[text] }
}
@@ -0,0 +1,67 @@
import CoreText
import UIKit
private let measureText = "mmmmmmmmmm"
/// The terminal font at one size: a CTFont per face (regular, bold, italic, bold italic) and the
/// cell those faces are laid out on. Cells are whole device pixels so every column origin is
/// exact. CoreText's cascade list covers characters the family lacks.
final class TerminalFont {
let family: String
let size: CGFloat
let displayScale: CGFloat
private let faces: [CTFont]
/// Cell size and baseline in points, each a whole number of device pixels.
let cellWidth: CGFloat
let cellHeight: CGFloat
let baseline: CGFloat
let underlineOffset: CGFloat
let underlineThickness: CGFloat
let strikeOffset: CGFloat
let strikeThickness: CGFloat
init(family: String, size: CGFloat, displayScale: CGFloat) {
self.family = family
self.size = size
self.displayScale = displayScale
let regular = TerminalFont.makeFont(family: family, size: size, traits: [])
faces = [
regular,
TerminalFont.makeFont(family: family, size: size, traits: .traitBold),
TerminalFont.makeFont(family: family, size: size, traits: .traitItalic),
TerminalFont.makeFont(family: family, size: size, traits: [.traitBold, .traitItalic]),
]
let pixel = { (value: CGFloat) in max(1, (value * displayScale).rounded()) / displayScale }
let line = CTLineCreateWithAttributedString(
NSAttributedString(string: measureText, attributes: [.font: regular]))
let width = CGFloat(CTLineGetTypographicBounds(line, nil, nil, nil))
cellWidth = pixel(width / CGFloat(measureText.count))
let ascent = CTFontGetAscent(regular)
let descent = CTFontGetDescent(regular)
let leading = CTFontGetLeading(regular)
cellHeight = pixel(ascent + descent + leading)
baseline = pixel(ascent)
underlineOffset = -CTFontGetUnderlinePosition(regular)
underlineThickness = max(1 / displayScale, CTFontGetUnderlineThickness(regular))
strikeOffset = -CTFontGetXHeight(regular) / 2
strikeThickness = underlineThickness
}
func font(flags: Int) -> CTFont { faces[TerminalFont.face(flags: flags)] }
func sameAs(family: String, size: CGFloat, displayScale: CGFloat) -> Bool {
self.family == family && self.size == size && self.displayScale == displayScale
}
static func face(flags: Int) -> Int {
(flags & TerminalStyleFlags.bold != 0 ? 1 : 0) + (flags & TerminalStyleFlags.italic != 0 ? 2 : 0)
}
private static func makeFont(family: String, size: CGFloat, traits: UIFontDescriptor.SymbolicTraits) -> CTFont {
let base = UIFontDescriptor(fontAttributes: [.family: family])
let descriptor = traits.isEmpty ? base : (base.withSymbolicTraits(traits) ?? base)
return UIFont(descriptor: descriptor, size: size) as CTFont
}
}
@@ -0,0 +1,121 @@
import CoreGraphics
import ExpoModulesCore
struct TerminalCursorRecord: Record {
@Field var row: Int = 0
@Field var col: Int = 0
}
struct TerminalSelectionRecord: Record {
@Field var startRow: Int = 0
@Field var startCol: Int = 0
@Field var endRow: Int = 0
@Field var endCol: Int = 0
}
struct TerminalFrameRecord: Record {
@Field var columns: Int = 0
/// Encoded rows, `cells;styles;text`; see `frame-encoding.ts`.
@Field var rows: [String] = []
@Field var cursor: TerminalCursorRecord? = nil
@Field var selection: TerminalSelectionRecord? = nil
}
struct TerminalThemeRecord: Record {
@Field var background: Double = 0
@Field var cursor: Double = 0
@Field var selectionBackground: Double = 0
}
struct TerminalCustomGlyphRecord: Record {
@Field var char: String = ""
@Field var rects: [Double] = []
@Field var path: [Double] = []
@Field var strokeWidth: Double = 0
}
enum TerminalStyleFlags {
static let bold = 1
static let italic = 2
static let underline = 4
static let strikethrough = 8
}
/// JS sends colors as unsigned ARGB numbers.
struct TerminalColor: Equatable {
let argb: UInt32
init(_ value: Double) {
argb = UInt32(truncatingIfNeeded: Int64(value))
}
var isPainted: Bool { argb >> 24 != 0 }
func cgColor(alphaScale: CGFloat = 1) -> CGColor {
let channel = { (shift: UInt32) in CGFloat((argb >> shift) & 0xff) / 255 }
return CGColor(srgbRed: channel(16), green: channel(8), blue: channel(0), alpha: channel(24) * alphaScale)
}
}
/// One row as the caller described it: cell text, column spans and style spans.
struct TerminalRowSource {
let text: String
let cells: [Int]
let styles: [Double]
/// Decodes `cells;styles;text`, where both number lists are comma separated.
init(encoded: String) {
let utf8 = encoded.utf8
let separator = UInt8(ascii: ";")
let cellsEnd = utf8.firstIndex(of: separator) ?? utf8.endIndex
let stylesStart = cellsEnd == utf8.endIndex ? cellsEnd : utf8.index(after: cellsEnd)
let stylesEnd = utf8[stylesStart...].firstIndex(of: separator) ?? utf8.endIndex
let textStart = stylesEnd == utf8.endIndex ? stylesEnd : utf8.index(after: stylesEnd)
cells = TerminalRowSource.parseNumbers(utf8[utf8.startIndex..<cellsEnd]).map { Int($0) }
styles = TerminalRowSource.parseNumbers(utf8[stylesStart..<stylesEnd]).map { Double($0) }
text = String(encoded[textStart...])
}
private static func parseNumbers(_ bytes: Substring.UTF8View) -> [Int64] {
guard !bytes.isEmpty else { return [] }
var numbers: [Int64] = [0]
for byte in bytes {
if byte == UInt8(ascii: ",") {
numbers.append(0)
} else {
numbers[numbers.count - 1] = numbers[numbers.count - 1] * 10 + Int64(byte - UInt8(ascii: "0"))
}
}
return numbers
}
}
struct TerminalSelection: Equatable {
let startRow: Int
let startCol: Int
let endRow: Int
let endCol: Int
init(_ record: TerminalSelectionRecord) {
startRow = record.startRow
startCol = record.startCol
endRow = record.endRow
endCol = record.endCol
}
func intersects(row: Int) -> Bool { row >= startRow && row <= endRow }
/// A cell is selected when any column it covers is inside the inclusive range.
func contains(row: Int, col: Int, span: Int) -> Bool {
guard intersects(row: row) else { return false }
let firstCol = row == startRow ? startCol : 0
let lastCol = row == endRow ? endCol : Int.max
return col + span - 1 >= firstCol && col <= lastCol
}
/// The part of the selection on one row, so a row only repaints when its own part changes.
func columns(onRow row: Int) -> ClosedRange<Int>? {
guard intersects(row: row) else { return nil }
return (row == startRow ? startCol : 0)...(row == endRow ? endCol : Int.max)
}
}
@@ -0,0 +1,336 @@
import CoreText
import UIKit
/// Shaped glyphs may exceed their slot by this many points before they are scaled down.
private let overflowTolerance: CGFloat = 0.5
/// Stands in for an open edge when a group is clipped on one side only.
private let clipUnbounded: CGFloat = 100_000
/// Lays text out left to right in logical order. The override fixes every character's direction;
/// the base direction also covers trailing spaces, which bidi rule L1 otherwise moves to the
/// direction detected from the first strong character, ahead of an Arabic or Hebrew row.
private let leftToRightAttributes: [NSAttributedString.Key: Any] = {
var base = CTWritingDirection.leftToRight
let paragraph = withUnsafeBytes(of: &base) { bytes in
CTParagraphStyleCreate(
[CTParagraphStyleSetting(
spec: .baseWritingDirection, valueSize: MemoryLayout<CTWritingDirection>.size, value: bytes.baseAddress!)],
1)
}
let overrideLeftToRight = CTWritingDirection.leftToRight.rawValue | 2 // kCTWritingDirectionOverride
return [
NSAttributedString.Key(kCTWritingDirectionAttributeName as String): [NSNumber(value: overrideLeftToRight)],
NSAttributedString.Key(kCTParagraphStyleAttributeName as String): paragraph,
]
}()
/// Colors a row is painted with besides its own styles.
struct TerminalRowPaint {
let selectionBackground: TerminalColor
}
/// One row shaped once and placed on the terminal grid.
///
/// Each run of cells with the same font face is shaped as a whole line, in logical order and left
/// to right like the terminal grid, so contextual forms, ligatures, marks and fallback fonts see
/// their neighbours. CoreText reports which UTF-16 offset produced each glyph. Cells whose units
/// produced no advancing glyph, and cells a reordered glyph crosses, join the cluster of the cell
/// before them: a ligature, conjunct, emoji sequence or reordered mark that spans columns. Each
/// group is drawn at its first cell's column with the glyph offsets CoreText produced, centred in
/// the columns it owns and scaled down only when wider than them. Colors never split groups.
final class TerminalRowLayout {
let source: TerminalRowSource
private let font: TerminalFont
private let units: [UInt16]
private let cellCount: Int
private var cellCol: [Int]
private var cellSpan: [Int]
private var cellStart: [Int]
private var cellEnd: [Int]
private var cellForeground: [TerminalColor]
private var cellBackground: [TerminalColor]
private var cellFlags: [Int]
private var cellGlyph: [TerminalCustomGlyph?]
private var groups: [Group] = []
/// The row's painted extent, relative to its top edge. Marks stacked above or below a
/// letter and some fallback glyphs ink outside the row; the view repaints that area with it.
private(set) var inkTop: CGFloat = 0
private(set) var inkBottom: CGFloat
private struct GlyphRun {
let font: CTFont
var glyphs: [CGGlyph]
/// Relative to the group's pen origin, y up from the baseline.
var positions: [CGPoint]
}
private struct Group {
let firstCell: Int
let lastCell: Int
let col: Int
let offset: CGFloat
let scale: CGFloat
let runs: [GlyphRun]
}
private struct ShapedGlyph {
let font: CTFont
let glyph: CGGlyph
let position: CGPoint
let advance: CGFloat
let cell: Int
}
init(source: TerminalRowSource, font: TerminalFont, customGlyphs: TerminalCustomGlyphs) {
self.source = source
self.font = font
units = Array(source.text.utf16)
cellCount = source.cells.count / 2
cellCol = Array(repeating: 0, count: cellCount)
cellSpan = Array(repeating: 1, count: cellCount)
cellStart = Array(repeating: 0, count: cellCount)
cellEnd = Array(repeating: 0, count: cellCount)
cellForeground = Array(repeating: TerminalColor(0), count: cellCount)
cellBackground = Array(repeating: TerminalColor(0), count: cellCount)
cellFlags = Array(repeating: 0, count: cellCount)
cellGlyph = Array(repeating: nil, count: cellCount)
inkBottom = font.cellHeight
readCells(customGlyphs: customGlyphs)
shapeRuns()
}
var accessibilityText: String {
var text = source.text
while text.last == " " { text.removeLast() }
return text
}
private func readCells(customGlyphs: TerminalCustomGlyphs) {
var offset = 0
var col = 0
var styleIndex = 0
var styleEndCol = 0
for cell in 0..<cellCount {
let length = source.cells[cell * 2]
let span = max(1, source.cells[cell * 2 + 1])
while col >= styleEndCol && styleIndex + 3 < source.styles.count {
styleEndCol += Int(source.styles[styleIndex])
styleIndex += 4
}
let style = styleIndex - 4
if style >= 0 {
cellForeground[cell] = TerminalColor(source.styles[style + 1])
cellBackground[cell] = TerminalColor(source.styles[style + 2])
cellFlags[cell] = Int(source.styles[style + 3])
}
cellCol[cell] = col
cellSpan[cell] = span
cellStart[cell] = offset
cellEnd[cell] = min(units.count, offset + length)
cellGlyph[cell] = customGlyphs[text(from: cellStart[cell], to: cellEnd[cell])]
offset = cellEnd[cell]
col += span
}
}
private func text(from start: Int, to end: Int) -> String {
String(utf16CodeUnits: Array(units[start..<end]), count: end - start)
}
private func shapesWith(_ cell: Int, _ other: Int) -> Bool {
cellGlyph[cell] == nil && cellGlyph[other] == nil
&& TerminalFont.face(flags: cellFlags[cell]) == TerminalFont.face(flags: cellFlags[other])
}
private func shapeRuns() {
var cell = 0
while cell < cellCount {
if cellGlyph[cell] != nil {
cell += 1
continue
}
var last = cell
while last + 1 < cellCount && shapesWith(cell, last + 1) { last += 1 }
shapeRun(first: cell, last: last)
cell = last + 1
}
}
private func shapeRun(first: Int, last: Int) {
let start = cellStart[first]
let end = cellEnd[last]
guard end > start else { return }
var cellOfUnit = Array(repeating: first, count: end - start)
for cell in first...last where cellEnd[cell] > cellStart[cell] {
for unit in cellStart[cell]..<cellEnd[cell] { cellOfUnit[unit - start] = cell }
}
var attributes = leftToRightAttributes
attributes[NSAttributedString.Key(kCTFontAttributeName as String)] = font.font(flags: cellFlags[first])
let line = CTLineCreateWithAttributedString(
NSAttributedString(string: text(from: start, to: end), attributes: attributes))
var shaped: [ShapedGlyph] = []
for run in CTLineGetGlyphRuns(line) as? [CTRun] ?? [] {
let count = CTRunGetGlyphCount(run)
guard count > 0 else { continue }
let runAttributes = CTRunGetAttributes(run) as NSDictionary
let runFont = runAttributes[kCTFontAttributeName as String].map { $0 as! CTFont }
?? font.font(flags: cellFlags[first])
var glyphs = Array(repeating: CGGlyph(0), count: count)
var positions = Array(repeating: CGPoint.zero, count: count)
var advances = Array(repeating: CGSize.zero, count: count)
var indices = Array(repeating: CFIndex(0), count: count)
let all = CFRange(location: 0, length: 0)
CTRunGetGlyphs(run, all, &glyphs)
CTRunGetPositions(run, all, &positions)
CTRunGetAdvances(run, all, &advances)
CTRunGetStringIndices(run, all, &indices)
for index in 0..<count {
let unit = min(max(0, indices[index]), cellOfUnit.count - 1)
shaped.append(ShapedGlyph(
font: runFont, glyph: glyphs[index], position: positions[index],
advance: advances[index].width, cell: cellOfUnit[unit]))
}
}
// A cell starts a cluster unless a reordered glyph crosses into it or it has no advance.
var startsCluster = Array(repeating: true, count: last - first + 1)
var advance = Array(repeating: CGFloat(0), count: last - first + 1)
var furthestCell = first
for glyph in shaped {
advance[glyph.cell - first] += glyph.advance
if glyph.cell < furthestCell {
for cell in (glyph.cell + 1)...furthestCell { startsCluster[cell - first] = false }
} else {
furthestCell = glyph.cell
}
}
if last > first {
for cell in (first + 1)...last where advance[cell - first] == 0 {
startsCluster[cell - first] = false
}
}
var groupFirst = first
for cell in first...last {
let closesGroup = cell == last || startsCluster[cell + 1 - first]
guard closesGroup else { continue }
addGroup(first: groupFirst, last: cell, glyphs: shaped.filter { $0.cell >= groupFirst && $0.cell <= cell })
groupFirst = cell + 1
}
}
private func addGroup(first: Int, last: Int, glyphs: [ShapedGlyph]) {
let isBlank = (cellStart[first]..<cellEnd[last]).allSatisfy { units[$0] == 0x20 }
guard let origin = glyphs.first?.position.x, !isBlank else { return }
let columns = (first...last).reduce(0) { $0 + cellSpan[$1] }
let slot = CGFloat(columns) * font.cellWidth
let advance = glyphs.reduce(CGFloat(0)) { $0 + $1.advance }
let scale = advance > slot + overflowTolerance ? slot / advance : 1
let offset = scale < 1 ? 0 : (slot - advance) / 2
var runs: [GlyphRun] = []
for glyph in glyphs {
let position = CGPoint(x: glyph.position.x - origin, y: glyph.position.y)
if let lastRun = runs.last, CFEqual(lastRun.font, glyph.font) {
runs[runs.count - 1].glyphs.append(glyph.glyph)
runs[runs.count - 1].positions.append(position)
} else {
runs.append(GlyphRun(font: glyph.font, glyphs: [glyph.glyph], positions: [position]))
}
}
groups.append(Group(
firstCell: first, lastCell: last, col: cellCol[first], offset: offset, scale: scale, runs: runs))
extendInk(runs: runs, scale: scale)
}
/// Grows the row's ink extent to cover the glyphs as `draw` places them, padded by a device pixel
/// for antialiasing.
private func extendInk(runs: [GlyphRun], scale: CGFloat) {
let centerY = font.cellHeight / 2
let baselineInTextSpace = font.cellHeight / 2 - font.baseline
let pixel = 1 / font.displayScale
for run in runs {
var bounds = Array(repeating: CGRect.zero, count: run.glyphs.count)
CTFontGetBoundingRectsForGlyphs(run.font, .horizontal, run.glyphs, &bounds, run.glyphs.count)
for (glyph, position) in zip(bounds, run.positions) where !glyph.isEmpty {
let top = centerY - (position.y + baselineInTextSpace + glyph.maxY) * scale - pixel
let bottom = centerY - (position.y + baselineInTextSpace + glyph.minY) * scale + pixel
inkTop = min(inkTop, (top * font.displayScale).rounded(.down) / font.displayScale)
inkBottom = max(inkBottom, (bottom * font.displayScale).rounded(.up) / font.displayScale)
}
}
}
private func isSelected(_ cell: Int, row: Int, selection: TerminalSelection?) -> Bool {
selection?.contains(row: row, col: cellCol[cell], span: cellSpan[cell]) ?? false
}
/// Draws cell backgrounds, the selection overlay, then text with its original colors.
func draw(in context: CGContext, row: Int, top: CGFloat, selection: TerminalSelection?, paint: TerminalRowPaint) {
let cellWidth = font.cellWidth
let cellHeight = font.cellHeight
for cell in 0..<cellCount {
let rect = CGRect(x: CGFloat(cellCol[cell]) * cellWidth, y: top, width: CGFloat(cellSpan[cell]) * cellWidth, height: cellHeight)
let background = cellBackground[cell]
if background.isPainted {
context.setFillColor(background.cgColor())
context.fill(rect)
}
if isSelected(cell, row: row, selection: selection) {
context.setFillColor(paint.selectionBackground.cgColor())
context.fill(rect)
}
}
let centerY = top + cellHeight / 2
let baselineInTextSpace = cellHeight / 2 - font.baseline
// A group whose cells differ in color is drawn once per color, clipped to those
// cells' columns. Only edges between differently colored cells clip; outer edges may overhang.
for group in groups {
var first = group.firstCell
while first <= group.lastCell {
let color = cellForeground[first]
var last = first
while last < group.lastCell && cellForeground[last + 1] == color {
last += 1
}
context.saveGState()
if first > group.firstCell || last < group.lastCell {
let left = first > group.firstCell ? CGFloat(cellCol[first]) * cellWidth : -clipUnbounded
let right = last < group.lastCell ? CGFloat(cellCol[last] + cellSpan[last]) * cellWidth : clipUnbounded
context.clip(to: CGRect(x: left, y: -clipUnbounded, width: right - left, height: 2 * clipUnbounded))
}
context.setFillColor(color.cgColor())
context.translateBy(x: CGFloat(group.col) * cellWidth + group.offset, y: centerY)
context.scaleBy(x: group.scale, y: -group.scale)
context.textMatrix = .identity
for run in group.runs {
let positions = run.positions.map { CGPoint(x: $0.x, y: $0.y + baselineInTextSpace) }
CTFontDrawGlyphs(run.font, run.glyphs, positions, run.glyphs.count, context)
}
context.restoreGState()
first = last + 1
}
}
let baseline = top + font.baseline
for cell in 0..<cellCount {
let color = cellForeground[cell]
let left = CGFloat(cellCol[cell]) * cellWidth
let width = CGFloat(cellSpan[cell]) * cellWidth
if let glyph = cellGlyph[cell] {
glyph.draw(in: context, rect: CGRect(x: left, y: top, width: width, height: cellHeight), color: color.cgColor())
}
let flags = cellFlags[cell]
if flags & (TerminalStyleFlags.underline | TerminalStyleFlags.strikethrough) == 0 { continue }
context.setFillColor(color.cgColor())
if flags & TerminalStyleFlags.underline != 0 {
context.fill(CGRect(x: left, y: baseline + font.underlineOffset, width: width, height: font.underlineThickness))
}
if flags & TerminalStyleFlags.strikethrough != 0 {
context.fill(CGRect(x: left, y: baseline + font.strikeOffset, width: width, height: font.strikeThickness))
}
}
}
}
@@ -0,0 +1,5 @@
{
"name": "paseo-terminal",
"version": "0.1.0",
"private": true
}
+1
View File
@@ -154,6 +154,7 @@
"@types/ws": "^8.18.1",
"@vitest/browser": "^4.1.7",
"@vitest/browser-playwright": "^4.1.7",
"@xterm/addon-serialize": "0.14.0",
"@xterm/headless": "^6.1.0-beta.213",
"babel-preset-expo": "~57.0.16",
"dotenv": "^17.2.3",
@@ -4,7 +4,6 @@ import type {
} from "../terminal/runtime/terminal-emulator-runtime";
import type { Ref } from "react";
import type { ITheme } from "@xterm/xterm";
import type { TerminalState } from "@getpaseo/protocol/messages";
import type { TerminalInputModeState } from "@getpaseo/protocol/terminal-input-mode";
import type { TerminalOutputData } from "../terminal/runtime/terminal-emulator-runtime";
import type {
@@ -19,8 +18,7 @@ import type { TerminalRendererReadyChange } from "../utils/terminal-renderer-rea
export interface TerminalEmulatorHandle {
find?: TerminalFindHandle;
writeOutput: (data: TerminalOutputData) => void;
restoreOutput: (data: TerminalOutputData) => void;
renderSnapshot: (state: TerminalState | null) => void;
replay: (event: import("@getpaseo/client").TerminalReplayEvent) => void;
paste: (text: string) => void;
copySelection: (clipboard: TerminalClipboardWriter) => Promise<string>;
clear: () => void;
@@ -44,7 +42,6 @@ export interface TerminalEmulatorProps {
swipeGesturesEnabled?: boolean;
onSwipeLeft?: () => void;
onSwipeRight?: () => void;
initialSnapshot?: TerminalState | null;
onFindRequest?: () => void;
onFindResult?: (result: TerminalFindResult) => void;
onInput?: (data: string) => Promise<void> | void;
@@ -1,19 +1,17 @@
import Svg, { Path } from "react-native-svg";
import { useCallback, useEffect, useImperativeHandle, useMemo, useRef, useState } from "react";
import {
Keyboard,
type LayoutChangeEvent,
PanResponder,
type PanResponderGestureState,
Pressable,
StyleSheet,
Text,
View,
type GestureResponderEvent,
type StyleProp,
type ViewStyle,
} from "react-native";
import type { ITheme } from "@xterm/xterm";
import type { TerminalState } from "@getpaseo/protocol/messages";
import {
TerminalInputModeTracker,
terminalInputModeStatesEqual,
@@ -48,13 +46,10 @@ import {
type TerminalSelectionViewport,
} from "../terminal/native-renderer/terminal-selection";
import {
TERMINAL_GESTURE_LONG_PRESS_MS,
TERMINAL_GESTURE_TAP_TOLERANCE_PX,
advanceTerminalScrollGesture,
classifyTerminalGestureIntent,
resolveTerminalGestureReleaseAction,
type TerminalGestureIntent,
} from "../terminal/native-renderer/terminal-selection-gesture";
createTerminalSelectionController,
terminalSelectionHandles,
TERMINAL_SELECTION_GRIP_SIZE,
} from "../terminal/native-renderer/terminal-selection-controller";
import { resolveNativeTerminalMountAction } from "../terminal/native-renderer/terminal-mount-policy";
import {
forwardNativeTerminalKey,
@@ -88,75 +83,8 @@ const DEFAULT_XTERM_THEME: ITheme = {
foreground: "#e6e6e6",
cursor: "#e6e6e6",
};
interface NativeTerminalPanState {
lastDy: number;
rowRemainder: number;
didScroll: boolean;
didNavigate: boolean;
movedBeyondTapTolerance: boolean;
intent: TerminalGestureIntent | null;
}
interface NativeTerminalSelectionPress {
startX: number;
startY: number;
startedAt: number;
startedWithSelection: boolean;
status: "pressing" | "selecting";
}
function resolvePanResponderPoint(
press: NativeTerminalSelectionPress,
event: GestureResponderEvent,
gesture: PanResponderGestureState,
): { x: number; y: number } {
const eventDx = event.nativeEvent.locationX - press.startX;
const eventDy = event.nativeEvent.locationY - press.startY;
const dx = Math.abs(eventDx) > Math.abs(gesture.dx) ? eventDx : gesture.dx;
const dy = Math.abs(eventDy) > Math.abs(gesture.dy) ? eventDy : gesture.dy;
return {
x: press.startX + dx,
y: press.startY + dy,
};
}
function initialNativeTerminalSize(snapshot: TerminalState | null): TerminalMeasuredSize {
return {
rows: snapshot?.rows ?? MIN_NATIVE_TERMINAL_ROWS,
cols: snapshot?.cols ?? MIN_NATIVE_TERMINAL_COLS,
};
}
function screenStateFromViewport(viewport: TerminalViewportState): TerminalScreenState {
const visibleRows = viewport.grid.length;
const currentViewport = {
firstRow: viewport.firstRow,
lastRow: Math.min(viewport.newestRow, viewport.firstRow + Math.max(1, visibleRows) - 1),
};
return {
viewport,
scroll: {
mode: "following",
firstRow: viewport.firstRow,
visibleRows,
oldestRow: viewport.oldestRow,
newestRow: viewport.newestRow,
currentViewport,
bottomViewport: currentViewport,
},
};
}
function viewportStateFromSnapshot(state: TerminalState): TerminalViewportState {
return {
rows: state.grid.length,
cols: state.cols,
firstRow: 0,
oldestRow: 0,
newestRow: Math.max(0, state.grid.length - 1),
grid: state.grid,
cursor: state.cursor,
};
function initialNativeTerminalSize(): TerminalMeasuredSize {
return { rows: MIN_NATIVE_TERMINAL_ROWS, cols: MIN_NATIVE_TERMINAL_COLS };
}
function NativeTerminalEmulator({
@@ -169,7 +97,6 @@ function NativeTerminalEmulator({
fontSize,
keyboardInset = 0,
isKeyboardVisible = false,
initialSnapshot = null,
onInput,
onTerminalKey,
onResize,
@@ -181,20 +108,18 @@ function NativeTerminalEmulator({
resizeRequestToken = 0,
}: TerminalEmulatorProps) {
const terminalRef = useRef<NativeHeadlessTerminal | null>(null);
const mountInputRef = useRef({ streamKey, initialSnapshot });
const mountInputRef = useRef({ streamKey });
if (
resolveNativeTerminalMountAction({
mountedStreamKey: mountInputRef.current.streamKey,
nextStreamKey: streamKey,
}) === "mount"
) {
mountInputRef.current = { streamKey, initialSnapshot };
mountInputRef.current = { streamKey };
}
const inputRef = useRef<TerminalInputHandle>(null);
const terminalSizeRef = useRef<TerminalMeasuredSize>(initialNativeTerminalSize(initialSnapshot));
const resizePolicyRef = useRef(
createTerminalResizePolicy(initialNativeTerminalSize(initialSnapshot)),
);
const terminalSizeRef = useRef<TerminalMeasuredSize>(initialNativeTerminalSize());
const resizePolicyRef = useRef(createTerminalResizePolicy(initialNativeTerminalSize()));
const activeResizeClaimTokenRef = useRef(0);
const layoutRef = useRef<TerminalMeasuredLayout | null>(null);
const metricsRef = useRef<TerminalGridCellMetrics | null>(null);
@@ -202,29 +127,20 @@ function NativeTerminalEmulator({
const outputDrainRef = useRef<NativeTerminalOutputDrain | null>(null);
const screenModelRef = useRef<TerminalScreenModel | null>(null);
const selectionModelRef = useRef<TerminalSelectionModel>(createTerminalSelectionModel());
const selectionLongPressTimeoutRef = useRef<ReturnType<typeof setTimeout> | null>(null);
const selectionPressRef = useRef<NativeTerminalSelectionPress | null>(null);
const selectionControllerRef = useRef<ReturnType<
typeof createTerminalSelectionController
> | null>(null);
const gestureStartRef = useRef({ x: 0, y: 0 });
const [cellMetrics, setCellMetrics] = useState<TerminalGridCellMetrics | null>(null);
const latestResolvedScreenRef = useRef<TerminalScreenState | null>(null);
const paintFrameRef = useRef<number | null>(null);
const outputDecoderRef = useRef(new TextDecoder());
const panStateRef = useRef<NativeTerminalPanState>({
lastDy: 0,
rowRemainder: 0,
didScroll: false,
didNavigate: false,
movedBeyondTapTolerance: false,
intent: null,
});
const inputModeTrackerRef = useRef(new TerminalInputModeTracker());
const lastInputModeStateRef = useRef<TerminalInputModeState>({
...inputModeTrackerRef.current.getState(),
applicationCursorKeys: false,
});
const [terminalScreen, setTerminalScreen] = useState<TerminalScreenState | null>(() => {
return initialSnapshot
? screenStateFromViewport(viewportStateFromSnapshot(initialSnapshot))
: null;
});
const [terminalScreen, setTerminalScreen] = useState<TerminalScreenState | null>(null);
const [selectionRange, setSelectionRange] = useState<TerminalSelectionRange | null>(null);
const selectionRangeRef = useRef<TerminalSelectionRange | null>(null);
const hasNotifiedSelectionRef = useRef(false);
@@ -288,6 +204,7 @@ function NativeTerminalEmulator({
}, []);
const clearSelection = useCallback(() => {
selectionControllerRef.current?.cancel();
const snapshot = selectionModelRef.current.clear();
commitSelectionRange(snapshot.range);
}, [commitSelectionRange]);
@@ -298,20 +215,14 @@ function NativeTerminalEmulator({
const syncSelectionWithTerminal = useCallback(
(terminal: NativeHeadlessTerminal) => {
const previous = selectionModelRef.current.getSnapshot().range;
const snapshot = selectionModelRef.current.sync({ bounds: terminal.getBufferBounds() });
if (previous && !snapshot.range) selectionControllerRef.current?.cancel();
commitSelectionRange(snapshot.range);
},
[commitSelectionRange],
);
const clearSelectionLongPressTimeout = useCallback(() => {
if (selectionLongPressTimeoutRef.current === null) {
return;
}
clearTimeout(selectionLongPressTimeoutRef.current);
selectionLongPressTimeoutRef.current = null;
}, []);
const resolveVisibleRows = useCallback((terminal: NativeHeadlessTerminal): number => {
return (
resolveMeasuredNativeTerminalSize({
@@ -361,10 +272,14 @@ function NativeTerminalEmulator({
(terminal: NativeHeadlessTerminal): NativeTerminalOutputDrain =>
createNativeTerminalOutputDrain({
write: async (chunk) => {
inputModeTrackerRef.current.feed(chunk);
await terminal.write(chunk);
emitInputModeChange();
},
reset: () => {
restoreSize: () => terminal.resize(terminalSizeRef.current),
reset: (size) => {
inputModeTrackerRef.current.reset();
if (size) terminal.resize(size);
terminal.reset();
emitInputModeChange();
},
@@ -415,11 +330,11 @@ function NativeTerminalEmulator({
return;
}
const isFirstMeasuredSize = !hasNotifiedMeasuredSizeRef.current;
hasNotifiedMeasuredSizeRef.current = true;
terminalSizeRef.current = policyResult.measuredSize;
if (policyResult.measuredSizeChanged) {
terminalRef.current?.resize(policyResult.measuredSize);
schedulePaint();
outputDrainRef.current?.resize();
}
callbacksRef.current.onResize?.({
rows: policyResult.measuredSize.rows,
@@ -427,69 +342,60 @@ function NativeTerminalEmulator({
shouldClaim: policyResult.resizeClaim !== null,
forceClaim: policyResult.resizeClaim?.force,
});
},
[schedulePaint],
);
const resetTerminal = useCallback(
(snapshot: TerminalState | null) => {
outputDrainRef.current?.dispose();
outputDrainRef.current = null;
terminalRef.current?.dispose();
screenModelRef.current = null;
latestResolvedScreenRef.current = null;
clearSelection();
const measuredSize = resolveMeasuredNativeTerminalSize({
layout: layoutRef.current,
metrics: metricsRef.current,
});
const size =
measuredSize ??
(snapshot ? { rows: snapshot.rows, cols: snapshot.cols } : terminalSizeRef.current);
terminalSizeRef.current = size;
resizePolicyRef.current = createTerminalResizePolicy(size);
outputDecoderRef.current.decode();
const terminal = createNativeHeadlessTerminal({
rows: size.rows,
cols: size.cols,
scrollbackLines,
});
terminalRef.current = terminal;
screenModelRef.current = createNativeTerminalScreenModel({ terminal });
const outputDrain = createOutputDrain(terminal);
outputDrainRef.current = outputDrain;
const screen = snapshot
? screenStateFromViewport(viewportStateFromSnapshot(snapshot))
: resolveTerminalScreen(terminal);
commitTerminalScreen(screen);
resetInputModeTracker();
if (snapshot) {
outputDrain.restoreSnapshot(snapshot);
// Ready waits for the grid size, so the pane attaches with it and the daemon replays the
// terminal at that size instead of the PTY's.
if (isFirstMeasuredSize) {
callbacksRef.current.onRendererReadyChange?.({
streamKey: mountInputRef.current.streamKey,
isReady: true,
});
}
},
[
commitTerminalScreen,
createOutputDrain,
resetInputModeTracker,
resolveTerminalScreen,
[],
);
const resetTerminal = useCallback(() => {
outputDrainRef.current?.dispose();
outputDrainRef.current = null;
terminalRef.current?.dispose();
screenModelRef.current = null;
latestResolvedScreenRef.current = null;
clearSelection();
const measuredSize = resolveMeasuredNativeTerminalSize({
layout: layoutRef.current,
metrics: metricsRef.current,
});
const size = measuredSize ?? terminalSizeRef.current;
terminalSizeRef.current = size;
resizePolicyRef.current = createTerminalResizePolicy(size);
outputDecoderRef.current.decode();
const terminal = createNativeHeadlessTerminal({
rows: size.rows,
cols: size.cols,
scrollbackLines,
clearSelection,
],
);
});
terminalRef.current = terminal;
screenModelRef.current = createNativeTerminalScreenModel({ terminal });
const outputDrain = createOutputDrain(terminal);
outputDrainRef.current = outputDrain;
const screen = resolveTerminalScreen(terminal);
commitTerminalScreen(screen);
resetInputModeTracker();
}, [
commitTerminalScreen,
createOutputDrain,
resetInputModeTracker,
resolveTerminalScreen,
scrollbackLines,
clearSelection,
]);
const enqueueOutputText = useCallback(
(text: string) => {
if (text.length === 0) {
return;
}
const inputModeUpdate = inputModeTrackerRef.current.feed(text);
if (inputModeUpdate.changed) {
emitInputModeChange();
}
outputDrainRef.current?.enqueueText(text);
},
[emitInputModeChange],
);
const enqueueOutputText = useCallback((text: string) => {
if (text.length === 0) {
return;
}
outputDrainRef.current?.enqueueText(text);
}, []);
const claimActiveTerminalSize = useCallback(() => {
activeResizeClaimTokenRef.current += 1;
@@ -512,27 +418,7 @@ function NativeTerminalEmulator({
const text = outputDecoderRef.current.decode(data, { stream: true });
enqueueOutputText(text);
},
restoreOutput: (data: TerminalOutputData) => {
outputDecoderRef.current.decode();
resetInputModeTracker();
const text = outputDecoderRef.current.decode(data, { stream: false });
outputDrainRef.current?.restoreText(text);
},
renderSnapshot: (state: TerminalState | null) => {
outputDecoderRef.current.decode();
resetInputModeTracker();
if (!state) {
resetTerminal(null);
return;
}
clearSelection();
const outputDrain = outputDrainRef.current;
if (!outputDrain) {
resetTerminal(state);
return;
}
outputDrain.restoreSnapshot(state);
},
replay: (event) => outputDrainRef.current?.replay(event),
paste: (text: string) => {
if (text.length === 0) {
return;
@@ -563,7 +449,6 @@ function NativeTerminalEmulator({
screenModelRef.current?.reset();
clearSelection();
resetInputModeTracker();
terminalRef.current?.reset();
schedulePaint();
},
claimSize: claimActiveTerminalSize,
@@ -582,19 +467,17 @@ function NativeTerminalEmulator({
claimActiveTerminalSizeForAction,
clearSelection,
resetInputModeTracker,
resetTerminal,
schedulePaint,
],
);
useEffect(() => {
hasNotifiedMeasuredSizeRef.current = false;
resetTerminal(mountInputRef.current.initialSnapshot);
callbacksRef.current.onRendererReadyChange?.({ streamKey, isReady: true });
resetTerminal();
emitMeasuredSize({ source: "measure" });
return () => {
callbacksRef.current.onRendererReadyChange?.({ streamKey, isReady: false });
clearSelectionLongPressTimeout();
selectionPressRef.current = null;
selectionControllerRef.current?.cancel();
if (paintFrameRef.current !== null) {
cancelAnimationFrame(paintFrameRef.current);
paintFrameRef.current = null;
@@ -604,7 +487,7 @@ function NativeTerminalEmulator({
terminalRef.current?.dispose();
terminalRef.current = null;
};
}, [clearSelectionLongPressTimeout, resetTerminal, streamKey]);
}, [emitMeasuredSize, resetTerminal, streamKey]);
useEffect(() => {
if (focusRequestToken <= 0) return;
@@ -661,6 +544,7 @@ function NativeTerminalEmulator({
const handleCellMetricsChange = useCallback(
(metrics: TerminalGridCellMetrics) => {
metricsRef.current = metrics;
setCellMetrics(metrics);
emitMeasuredSize({ source: "measure" });
},
[emitMeasuredSize],
@@ -733,14 +617,6 @@ function NativeTerminalEmulator({
if (!coordinate) {
return;
}
const existingPress = selectionPressRef.current;
selectionPressRef.current = {
startX: point.x,
startY: point.y,
startedAt: existingPress?.startedAt ?? Date.now(),
startedWithSelection: existingPress?.startedWithSelection ?? false,
status: "selecting",
};
const bounds = terminal.getBufferBounds();
const wordSelection = resolveTerminalWordSelection({ terminal, coordinate });
let snapshot = selectionModelRef.current.begin({
@@ -755,222 +631,61 @@ function NativeTerminalEmulator({
[commitSelectionRange, resolveSelectionCoordinate],
);
const updateSelectionAtPoint = useCallback(
(point: { x: number; y: number }) => {
const terminal = terminalRef.current;
if (!terminal || selectionPressRef.current?.status !== "selecting") {
return;
}
const coordinate = resolveSelectionCoordinate(point);
if (!coordinate) {
return;
}
const snapshot = selectionModelRef.current.update({
coordinate,
bounds: terminal.getBufferBounds(),
});
commitSelectionRange(snapshot.range);
},
[commitSelectionRange, resolveSelectionCoordinate],
);
const handlePanResponderScroll = useCallback(
(currentDy: number) => {
const cellHeight = metricsRef.current?.cellHeight;
if (!cellHeight || cellHeight <= 0) {
return;
}
const panState = panStateRef.current;
const update = advanceTerminalScrollGesture({
state: panState,
currentDy,
cellHeight,
});
panState.lastDy = update.state.lastDy;
panState.rowRemainder = update.state.rowRemainder;
panState.didScroll = update.state.didScroll;
const { rowDelta } = update;
if (rowDelta === 0) {
return;
}
if (rowDelta > 0) {
applyScroll("up", rowDelta);
return;
}
applyScroll("down", Math.abs(rowDelta));
},
[applyScroll],
const selectionController = useMemo(
() =>
createTerminalSelectionController({
getGeometry: () => {
const viewport = resolveSelectionViewport();
const metrics = metricsRef.current;
return viewport && metrics
? { range: selectionRangeRef.current, viewport, metrics }
: null;
},
onBeginHandle: (endpoint, cols) =>
selectionModelRef.current.beginEndpointDrag(endpoint, cols),
onMoveHandle: (coordinate) => {
const terminal = terminalRef.current;
if (!terminal) return;
commitSelectionRange(
selectionModelRef.current.update({ coordinate, bounds: terminal.getBufferBounds() })
.range,
);
},
onLongPress: beginSelectionAtPoint,
onTap: focusTerminalFromTap,
onScroll: applyScroll,
schedule: (callback, delay) => setTimeout(callback, delay) as unknown as number,
cancel: (timer) => clearTimeout(timer),
}),
[
applyScroll,
beginSelectionAtPoint,
commitSelectionRange,
focusTerminalFromTap,
resolveSelectionViewport,
],
);
selectionControllerRef.current = selectionController;
const panResponder = useMemo(
() =>
PanResponder.create({
onStartShouldSetPanResponder: () => true,
onStartShouldSetPanResponderCapture: () => true,
onMoveShouldSetPanResponder: (_event, gesture) => {
const intent = classifyTerminalGestureIntent({
status: selectionRangeRef.current ? "selecting" : "pressing",
dx: gesture.dx,
dy: gesture.dy,
vx: gesture.vx,
vy: gesture.vy,
});
return intent === "scroll" || intent === "select";
},
onMoveShouldSetPanResponderCapture: (_event, gesture) => {
const intent = classifyTerminalGestureIntent({
status: selectionRangeRef.current ? "selecting" : "pressing",
dx: gesture.dx,
dy: gesture.dy,
vx: gesture.vx,
vy: gesture.vy,
});
return intent === "scroll" || intent === "select";
},
onPanResponderGrant: (event) => {
panStateRef.current = {
lastDy: 0,
rowRemainder: 0,
didScroll: false,
didNavigate: false,
movedBeyondTapTolerance: false,
intent: null,
};
const point = {
x: event.nativeEvent.locationX,
y: event.nativeEvent.locationY,
};
const pressStatus = selectionRangeRef.current ? "selecting" : "pressing";
selectionPressRef.current = {
startX: point.x,
startY: point.y,
startedAt: Date.now(),
startedWithSelection: pressStatus === "selecting",
status: pressStatus,
};
clearSelectionLongPressTimeout();
if (pressStatus === "selecting") {
return;
}
selectionLongPressTimeoutRef.current = setTimeout(() => {
selectionLongPressTimeoutRef.current = null;
const press = selectionPressRef.current;
if (press?.status !== "pressing") {
return;
}
beginSelectionAtPoint({ x: press.startX, y: press.startY });
}, TERMINAL_GESTURE_LONG_PRESS_MS);
},
onPanResponderMove: (event, gesture) => {
const selectionPress = selectionPressRef.current;
const panState = panStateRef.current;
if (Math.hypot(gesture.dx, gesture.dy) > TERMINAL_GESTURE_TAP_TOLERANCE_PX) {
panState.movedBeyondTapTolerance = true;
}
if (selectionPress?.status === "selecting") {
if (panState.movedBeyondTapTolerance) {
updateSelectionAtPoint(resolvePanResponderPoint(selectionPress, event, gesture));
}
return;
}
if (panState.intent === "scroll") {
handlePanResponderScroll(gesture.dy);
return;
}
if (panState.didNavigate) {
return;
}
if (selectionPress?.status === "pressing") {
const point = resolvePanResponderPoint(selectionPress, event, gesture);
const dx = point.x - selectionPress.startX;
const dy = point.y - selectionPress.startY;
const intent = classifyTerminalGestureIntent({
status: "pressing",
dx,
dy,
vx: gesture.vx,
vy: gesture.vy,
elapsedMs: Date.now() - selectionPress.startedAt,
});
if (intent === "tap" || intent === "pending") {
return;
}
clearSelectionLongPressTimeout();
panState.intent = intent;
if (intent === "scroll") {
selectionPressRef.current = null;
handlePanResponderScroll(gesture.dy);
return;
}
if (intent === "select") {
beginSelectionAtPoint({ x: selectionPress.startX, y: selectionPress.startY });
updateSelectionAtPoint(point);
return;
}
}
},
onPanResponderRelease: (event, gesture) => {
clearSelectionLongPressTimeout();
const selectionPress = selectionPressRef.current;
if (
selectionPress?.status === "selecting" &&
panStateRef.current.movedBeyondTapTolerance
) {
updateSelectionAtPoint(resolvePanResponderPoint(selectionPress, event, gesture));
}
selectionPressRef.current = null;
const { didScroll, didNavigate, movedBeyondTapTolerance } = panStateRef.current;
panStateRef.current = {
lastDy: 0,
rowRemainder: 0,
didScroll: false,
didNavigate: false,
movedBeyondTapTolerance: false,
intent: null,
};
const releaseAction = resolveTerminalGestureReleaseAction({
status: selectionPress?.status ?? "idle",
startedWithSelection: selectionPress?.startedWithSelection,
didScroll,
didNavigate,
movedBeyondTapTolerance,
pressDurationMs: selectionPress ? Date.now() - selectionPress.startedAt : 0,
longPressMs: TERMINAL_GESTURE_LONG_PRESS_MS,
scrollMode: terminalScreenRef.current?.scroll.mode ?? "following",
});
if (releaseAction === "select" && selectionPress) {
beginSelectionAtPoint({ x: selectionPress.startX, y: selectionPress.startY });
return;
}
if (releaseAction === "focus" || releaseAction === "clear") {
focusTerminalFromTap();
}
},
onPanResponderTerminate: () => {
clearSelectionLongPressTimeout();
selectionPressRef.current = null;
panStateRef.current = {
lastDy: 0,
rowRemainder: 0,
didScroll: false,
didNavigate: false,
movedBeyondTapTolerance: false,
intent: null,
};
const point = { x: event.nativeEvent.locationX, y: event.nativeEvent.locationY };
gestureStartRef.current = point;
selectionController.press(point);
},
onPanResponderMove: (_event, gesture) =>
selectionController.move({
x: gestureStartRef.current.x + gesture.dx,
y: gestureStartRef.current.y + gesture.dy,
}),
onPanResponderRelease: () => selectionController.release(),
onPanResponderTerminate: () => selectionController.cancel(),
}),
[
beginSelectionAtPoint,
clearSelectionLongPressTimeout,
focusTerminalFromTap,
handlePanResponderScroll,
updateSelectionAtPoint,
],
[selectionController],
);
const backgroundColor = xtermTheme.background ?? "#0b0b0b";
@@ -981,6 +696,11 @@ function NativeTerminalEmulator({
const terminalState = terminalScreen?.viewport ?? null;
const isScrolled = terminalScreen?.scroll.mode === "scrolled";
const viewport = resolveSelectionViewport();
const handles =
viewport && cellMetrics
? terminalSelectionHandles({ range: selectionRange, viewport, metrics: cellMetrics })
: [];
const terminalGrid = terminalState ? (
<TerminalGridView
state={terminalState}
@@ -997,6 +717,41 @@ function NativeTerminalEmulator({
<View onLayout={handleLayout} style={rootStyle} testID={testId}>
<View {...panResponder.panHandlers} accessible={false} style={styles.nativeSurface}>
{terminalGrid}
<View pointerEvents="none" style={StyleSheet.absoluteFill}>
{handles.map((handle) => (
<View key={handle.endpoint}>
<View
style={[
styles.selectionStem,
{
left: Math.max(
0,
Math.min(handle.x - 1, viewport!.cols * cellMetrics!.cellWidth - 2),
),
top: handle.stemTop,
height: handle.stemHeight,
},
]}
/>
<Svg
width={TERMINAL_SELECTION_GRIP_SIZE}
height={TERMINAL_SELECTION_GRIP_SIZE}
viewBox="0 0 18 18"
style={[styles.selectionGrip, { left: handle.gripX - 9, top: handle.gripY - 9 }]}
>
<Path
fill="#2684ff"
d={
handle.gripDirection === "left"
? "M18 0H9C4 0 0 4 0 9S4 18 9 18 18 14 18 9Z"
: "M0 0H9C14 0 18 4 18 9S14 18 9 18 0 14 0 9Z"
}
transform={handle.gripAbove ? "translate(0 18) scale(1 -1)" : undefined}
/>
</Svg>
</View>
))}
</View>
<TerminalInput
ref={inputRef}
isKeyboardVisible={isKeyboardVisible}
@@ -1039,6 +794,8 @@ const styles = StyleSheet.create({
nativeGrid: {
flex: 1,
},
selectionGrip: { position: "absolute" },
selectionStem: { position: "absolute", width: 2, backgroundColor: "#2684ff" },
followButton: {
position: "absolute",
right: 12,
@@ -19,7 +19,6 @@ import type { DOMProps } from "expo/dom";
import { useDOMImperativeHandle, type DOMImperativeFactory } from "expo/dom";
import "@xterm/xterm/css/xterm.css";
import type { ITheme } from "@xterm/xterm";
import type { TerminalState } from "@getpaseo/protocol/messages";
import type { TerminalInputModeState } from "@getpaseo/protocol/terminal-input-mode";
import type { PendingTerminalModifiers } from "../utils/terminal-keys";
import {
@@ -40,8 +39,7 @@ import { focusWithRetries } from "../utils/web-focus";
export interface TerminalEmulatorHandle {
find?: TerminalFindHandle;
writeOutput: (data: TerminalOutputData) => void;
restoreOutput: (data: TerminalOutputData) => void;
renderSnapshot: (state: TerminalState | null) => void;
replay: (event: import("@getpaseo/client").TerminalReplayEvent) => void;
paste: (text: string) => void;
copySelection: (clipboard: TerminalClipboardWriter) => Promise<string>;
clear: () => void;
@@ -108,7 +106,6 @@ interface TerminalEmulatorProps {
swipeGesturesEnabled?: boolean;
onSwipeLeft?: () => void;
onSwipeRight?: () => void;
initialSnapshot?: TerminalState | null;
onFindRequest?: () => void;
onFindResult?: (result: TerminalFindResult) => void;
onInput?: (data: string) => Promise<void> | void;
@@ -147,16 +144,6 @@ declare global {
interface Window {}
}
function isTerminalState(value: unknown): value is TerminalState {
return (
typeof value === "object" &&
value !== null &&
"rows" in value &&
"cols" in value &&
"grid" in value
);
}
export default function TerminalEmulator({
ref,
streamKey,
@@ -172,7 +159,6 @@ export default function TerminalEmulator({
swipeGesturesEnabled = false,
onSwipeLeft,
onSwipeRight,
initialSnapshot = null,
onFindRequest,
onFindResult,
onInput,
@@ -228,8 +214,6 @@ export default function TerminalEmulator({
onOpenLocalFileLink,
onFilePaste,
};
const initialSnapshotRef = useRef(initialSnapshot);
initialSnapshotRef.current = initialSnapshot;
const pendingModifiersRef = useRef(pendingModifiers);
pendingModifiersRef.current = pendingModifiers;
@@ -253,17 +237,17 @@ export default function TerminalEmulator({
const data = args[0];
if (data instanceof Uint8Array) runtimeRef.current?.write({ data });
},
restoreOutput: (...args) => {
const data = args[0];
if (data instanceof Uint8Array) runtimeRef.current?.restoreOutput({ data });
},
renderSnapshot: (...args) => {
const state = args[0];
if (state === null) {
runtimeRef.current?.renderSnapshot({ state: null });
} else if (isTerminalState(state)) {
runtimeRef.current?.renderSnapshot({ state });
}
replay: (event) => {
if (!event || typeof event !== "object" || Array.isArray(event)) return;
if (event.type === "end") runtimeRef.current?.replay({ type: "end" });
if (event.type === "data" && event.data instanceof Uint8Array)
runtimeRef.current?.replay({ type: "data", data: event.data });
if (event.type === "begin")
runtimeRef.current?.replay({
type: "begin",
rows: typeof event.rows === "number" ? event.rows : undefined,
cols: typeof event.cols === "number" ? event.cols : undefined,
});
},
paste: (...args) => {
const text = args[0];
@@ -299,12 +283,7 @@ export default function TerminalEmulator({
writeOutput: (data: TerminalOutputData) => {
runtimeRef.current?.write({ data });
},
restoreOutput: (data: TerminalOutputData) => {
runtimeRef.current?.restoreOutput({ data });
},
renderSnapshot: (state: TerminalState | null) => {
runtimeRef.current?.renderSnapshot({ state });
},
replay: (event) => runtimeRef.current?.replay(event),
paste: (text: string) => {
pasteText(text);
},
@@ -471,7 +450,6 @@ export default function TerminalEmulator({
runtime.mount({
root,
host,
initialSnapshot: initialSnapshotRef.current,
scrollback: scrollbackLinesRef.current,
theme: mountedThemeRef.current,
fontFamily: fontFamilyRef.current,
+5 -43
View File
@@ -15,7 +15,6 @@ import Animated, { runOnJS, useAnimatedReaction } from "react-native-reanimated"
import { StyleSheet, useUnistyles } from "react-native-unistyles";
import { Keyboard as KeyboardIcon, KeyboardOff as KeyboardOffIcon } from "lucide-react-native";
import type { TerminalKeyInput } from "@getpaseo/protocol/terminal-key-input";
import type { TerminalState } from "@getpaseo/protocol/messages";
import {
DEFAULT_TERMINAL_INPUT_MODE_STATE,
type TerminalInputModeState,
@@ -60,7 +59,6 @@ import { getDesktopHost } from "@/desktop/host";
import { routeTerminalDrop } from "@/terminal/drop/terminal-file-drop";
import { prepareDroppedPathsForTerminal } from "@/terminal/drop/terminal-path";
import { toErrorMessage } from "@/utils/error-messages";
import { getWorkspaceTerminalSession } from "@/terminal/runtime/workspace-terminal-session";
import {
EMPTY_FOCUS_CLAIM_STATE,
canRequestFocusClaim,
@@ -88,7 +86,6 @@ import { isNative } from "@/constants/platform";
import {
applyTerminalRendererReadyChange,
resolveTerminalStreamTarget,
shouldReplayTerminalSnapshotForRenderer,
shouldShowTerminalLoadingOverlay,
type TerminalRendererReadyChange,
} from "@/utils/terminal-renderer-readiness";
@@ -316,10 +313,6 @@ export function TerminalPane({
const measuredTerminalSizeRef = useRef<{ rows: number; cols: number } | null>(null);
const lastSentTerminalSizeRef = useRef<{ rows: number; cols: number } | null>(null);
const streamControllerRef = useRef<TerminalStreamController | null>(null);
const workspaceTerminalSession = useMemo(
() => getWorkspaceTerminalSession({ scopeKey }),
[scopeKey],
);
const [isAttaching, setIsAttaching] = useState(false);
const [streamError, setStreamError] = useState<string | null>(null);
const [rendererReadyStreamKey, setRendererReadyStreamKey] = useState<string | null>(null);
@@ -383,7 +376,6 @@ export function TerminalPane({
const keyboardRefitTimeoutsRef = useRef<Array<ReturnType<typeof setTimeout>>>([]);
const lastAutoFocusKeyRef = useRef<string | null>(null);
const paneFocusResizeClaimRef = useRef(EMPTY_FOCUS_CLAIM_STATE);
const initialSnapshot = workspaceTerminalSession.snapshots.get({ terminalId });
useEffect(() => {
terminalIdRef.current = terminalId;
@@ -441,16 +433,8 @@ export function TerminalPane({
(change: TerminalRendererReadyChange) => {
if (!change.isReady && change.streamKey === terminalStreamKey) findRef.current?.reset();
setRendererReadyStreamKey((current) => applyTerminalRendererReadyChange(current, change));
if (!shouldReplayTerminalSnapshotForRenderer({ change, terminalStreamKey })) {
return;
}
const snapshot = workspaceTerminalSession.snapshots.get({ terminalId });
if (snapshot) {
emulatorRef.current?.renderSnapshot(snapshot);
}
},
[terminalId, terminalStreamKey, workspaceTerminalSession.snapshots],
[terminalStreamKey],
);
useEffect(() => {
@@ -564,7 +548,6 @@ export function TerminalPane({
);
const handleStreamExit = useStableEvent((exitedTerminalId: string) => {
workspaceTerminalSession.snapshots.clear({ terminalId: exitedTerminalId });
if (terminalIdRef.current === exitedTerminalId) emulatorRef.current?.clear();
setModifiers({ ...EMPTY_MODIFIERS });
});
@@ -604,29 +587,10 @@ export function TerminalPane({
},
);
const handleStreamRestore = useStableEvent(
({ terminalId: restoreTerminalId, data }: { terminalId: string; data: Uint8Array }) => {
workspaceTerminalSession.snapshots.clear({ terminalId: restoreTerminalId });
if (terminalIdRef.current !== restoreTerminalId) {
return;
}
emulatorRef.current?.restoreOutput(data);
},
);
const handleStreamSnapshot = useStableEvent(
({ terminalId: snapshotTerminalId, state }: { terminalId: string; state: TerminalState }) => {
workspaceTerminalSession.snapshots.set({ terminalId: snapshotTerminalId, state });
if (terminalIdRef.current !== snapshotTerminalId) {
return;
}
emulatorRef.current?.renderSnapshot(state);
},
);
const getStreamRestoreOptions = useStableEvent(() =>
resolveTerminalRestoreOptions({
supportsTerminalRestoreModes,
scrollbackLines: settings.terminalScrollbackLines,
canClaimSize: canRequestFocusClaim({
isWorkspaceFocused: terminalPresentedRef.current,
isPaneFocused,
@@ -653,8 +617,9 @@ export function TerminalPane({
client,
getPreferredSize: getPreferredStreamSize,
onOutput: handleStreamOutput,
onRestore: handleStreamRestore,
onSnapshot: handleStreamSnapshot,
onReplay: ({ terminalId: id, replay }) => {
if (terminalIdRef.current === id) emulatorRef.current?.replay(replay);
},
onExit: handleStreamExit,
getRestoreOptions: getStreamRestoreOptions,
onStatusChange: handleStreamControllerStatus,
@@ -674,8 +639,6 @@ export function TerminalPane({
getStreamRestoreOptions,
handleStreamControllerStatus,
handleStreamOutput,
handleStreamRestore,
handleStreamSnapshot,
handleStreamExit,
isConnected,
]);
@@ -1216,7 +1179,6 @@ export function TerminalPane({
keyboardInset={keyboardInset}
isKeyboardVisible={isKeyboardVisible}
swipeGesturesEnabled={swipeGesturesEnabled}
initialSnapshot={initialSnapshot}
onRendererReadyChange={handleRendererReadyChange}
onSwipeRight={handleSwipeRight}
onSwipeLeft={handleSwipeLeft}
+1
View File
@@ -617,6 +617,7 @@ export const ar: TranslationResources = {
terminal: {
hostDisconnected: "Host غير متصل",
updateHost: "حدّث المضيف لاستخدام عارض الطرفية الأصلي.",
restoreRequiresUpdate: "حدّث المضيف لعرض الطرفيات.",
unableToSubscribe: "غير قادر على الاشتراك في المحطة",
fileUploaded: "تم رفع الملف",
pasteFileFailed: "تعذر لصق الملف: {{reason}}",
+1
View File
@@ -614,6 +614,7 @@ export const en = {
terminal: {
hostDisconnected: "Host is not connected",
updateHost: "Update the host to use the native terminal renderer.",
restoreRequiresUpdate: "Update the host to view terminals.",
unableToSubscribe: "Unable to subscribe to terminal",
fileUploaded: "File uploaded",
pasteFileFailed: "Failed to paste file: {{reason}}",
+1
View File
@@ -623,6 +623,7 @@ export const es: TranslationResources = {
terminal: {
hostDisconnected: "Hostno está conectado",
updateHost: "Actualiza el host para usar el renderizador de terminal nativo.",
restoreRequiresUpdate: "Actualiza el host para ver las terminales.",
unableToSubscribe: "No se puede suscribir al terminal",
fileUploaded: "Archivo subido",
pasteFileFailed: "No se pudo pegar el archivo: {{reason}}",
+1
View File
@@ -623,6 +623,7 @@ export const fr: TranslationResources = {
terminal: {
hostDisconnected: "L’hôte n’est pas connecté",
updateHost: "Mettez à jour l’hôte pour utiliser le rendu natif du terminal.",
restoreRequiresUpdate: "Mettez à jour l’hôte pour afficher les terminaux.",
unableToSubscribe: "Impossible de s’abonner au terminal",
fileUploaded: "Fichier envoyé",
pasteFileFailed: "Impossible de coller le fichier : {{reason}}",
+1
View File
@@ -623,6 +623,7 @@ export const ja: TranslationResources = {
terminal: {
hostDisconnected: "ホストが接続されていません",
updateHost: "ネイティブターミナルを使用するにはホストを更新してください。",
restoreRequiresUpdate: "ターミナルを表示するにはホストを更新してください。",
unableToSubscribe: "ターミナルに接続できません",
fileUploaded: "ファイルをアップロードしました",
pasteFileFailed: "ファイルを貼り付けられませんでした: {{reason}}",
+1
View File
@@ -618,6 +618,7 @@ export const ko: TranslationResources = {
terminal: {
hostDisconnected: "호스트가 연결되어 있지 않습니다",
updateHost: "기본 터미널 렌더러를 사용하도록 호스트를 업데이트합니다.",
restoreRequiresUpdate: "터미널을 보려면 호스트를 업데이트하세요.",
unableToSubscribe: "터미널을 구독할 수 없습니다",
fileUploaded: "파일을 업로드했습니다",
pasteFileFailed: "파일을 붙여넣지 못했습니다: {{reason}}",
+1
View File
@@ -622,6 +622,7 @@ export const ptBR: TranslationResources = {
terminal: {
hostDisconnected: "Host não está conectado",
updateHost: "Atualize o host para usar o renderizador de terminal nativo.",
restoreRequiresUpdate: "Atualize o host para visualizar os terminais.",
unableToSubscribe: "Não foi possível assinar o terminal",
fileUploaded: "Arquivo enviado",
pasteFileFailed: "Falha ao colar o arquivo: {{reason}}",
+1
View File
@@ -624,6 +624,7 @@ export const ru: TranslationResources = {
terminal: {
hostDisconnected: "Хост не подключён",
updateHost: "Обновите хост, чтобы использовать нативный рендерер терминала.",
restoreRequiresUpdate: "Обновите хост, чтобы просматривать терминалы.",
unableToSubscribe: "Не удалось подключиться к терминалу",
fileUploaded: "Файл загружен",
pasteFileFailed: "Не удалось вставить файл: {{reason}}",
+1
View File
@@ -617,6 +617,7 @@ export const zhCN: TranslationResources = {
terminal: {
hostDisconnected: "Host 未连接",
updateHost: "请更新主机以使用原生终端渲染器。",
restoreRequiresUpdate: "更新主机以查看终端。",
unableToSubscribe: "无法订阅 Terminal",
fileUploaded: "文件已上传",
pasteFileFailed: "无法粘贴文件:{{reason}}",
@@ -127,7 +127,6 @@ import {
useWorkspaceSetupStore,
} from "@/stores/workspace-setup-store";
import { useWorkspace } from "@/stores/session-store-hooks";
import { useWorkspaceTerminalSessionRetention } from "@/terminal/hooks/use-workspace-terminal-session-retention";
import type { CheckoutStatusPayload } from "@/git/use-status-query";
import { confirmDialog } from "@/utils/confirm-dialog";
import { useArchiveAgent } from "@/hooks/use-archive-agent";
@@ -881,13 +880,6 @@ function shouldShowWorkspaceScreenHeader(input: {
return !input.isFocusModeEnabled || input.isMobile;
}
function buildWorkspaceTerminalScopeKey(serverId: string, workspaceId: string): string | null {
if (!serverId || !workspaceId) {
return null;
}
return `${serverId}:${workspaceId}`;
}
/**
* A pane the user acted inside owns the tab: it opens there, and an existing tab
* moves there. No pane means the open has no opinion beyond the focused pane.
@@ -1066,14 +1058,6 @@ function WorkspaceScreenContent({
const { handleRetryHost, handleManageHost, handleDismissMissingWorkspace } =
useWorkspaceRouteActions(normalizedServerId);
const workspaceTerminalScopeKey = useMemo(
() => buildWorkspaceTerminalScopeKey(normalizedServerId, normalizedWorkspaceId),
[normalizedServerId, normalizedWorkspaceId],
);
useWorkspaceTerminalSessionRetention({
scopeKey: workspaceTerminalScopeKey,
});
const client = useHostRuntimeClient(normalizedServerId);
const isConnected = useHostRuntimeIsConnected(normalizedServerId);
const supportsProvidersSnapshot = useSessionStore(
@@ -1,18 +0,0 @@
import { useEffect } from "react";
import {
releaseWorkspaceTerminalSession,
retainWorkspaceTerminalSession,
} from "@/terminal/runtime/workspace-terminal-session";
export function useWorkspaceTerminalSessionRetention(input: { scopeKey: string | null }): void {
useEffect(() => {
if (!input.scopeKey) {
return;
}
retainWorkspaceTerminalSession({ scopeKey: input.scopeKey });
return () => {
releaseWorkspaceTerminalSession({ scopeKey: input.scopeKey! });
};
}, [input.scopeKey]);
}
@@ -1,6 +1,6 @@
import type { ITheme } from "@xterm/xterm";
import type { TextStyle } from "react-native";
import type { TerminalCell } from "@getpaseo/protocol/messages";
import { PASEO_TERMINAL_STYLE_FLAGS } from "../../../modules/paseo-terminal/contract";
import { darkTheme } from "@/styles/theme";
import { toXtermTheme } from "@/utils/to-xterm-theme";
@@ -29,77 +29,114 @@ const DEFAULT_COLOR_MODE = 0;
const ANSI_COLOR_MODE = 1;
const INDEXED_COLOR_MODE = 2;
const RGB_COLOR_MODE = 3;
const FLAG_BOLD = 1 << 0;
const FLAG_ITALIC = 1 << 1;
const FLAG_UNDERLINE = 1 << 2;
const FLAG_DIM = 1 << 3;
const FLAG_INVERSE = 1 << 4;
const FLAG_STRIKETHROUGH = 1 << 5;
const OPAQUE_BLACK = 0xff000000;
const DIM_ALPHA = 0.65;
interface ResolvedCellStyle {
key: string;
style: TextStyle;
foregroundColor: string;
}
interface ResolvedCellColors {
foreground: string;
background: string;
paintsBackground: boolean;
/** Colors are unsigned ARGB. A background of 0 is the terminal background. */
export interface ResolvedCellStyle {
foreground: number;
background: number;
flags: number;
}
export interface TerminalCellStyleResolver {
readonly themeKey: string;
readonly backgroundColor: string;
readonly cursorColor: string;
readonly backgroundColor: number;
readonly cursorColor: number;
resolve(cell: TerminalCell): ResolvedCellStyle;
}
export const DEFAULT_TERMINAL_THEME = toXtermTheme(darkTheme.colors.terminal);
export const NATIVE_TERMINAL_SELECTION_COLORS = {
background: "#ffff00",
foreground: "#000000",
background: 0x472684ff,
} as const;
function build256Palette(theme: ITheme): string[] {
const palette = Array.from({ length: 256 }, () => "");
function build256Palette(theme: ITheme): number[] {
const palette = Array.from({ length: 256 }, () => OPAQUE_BLACK);
for (let index = 0; index < ANSI_THEME_KEYS.length; index += 1) {
const key = ANSI_THEME_KEYS[index];
palette[index] = theme[key] ?? DEFAULT_TERMINAL_THEME[key] ?? "#000000";
palette[index] = parseTerminalColor(theme[key] ?? DEFAULT_TERMINAL_THEME[key], OPAQUE_BLACK);
}
for (let red = 0; red < CUBE_LEVELS.length; red += 1) {
for (let green = 0; green < CUBE_LEVELS.length; green += 1) {
for (let blue = 0; blue < CUBE_LEVELS.length; blue += 1) {
const index = 16 + red * 36 + green * 6 + blue;
palette[index] = `rgb(${CUBE_LEVELS[red]}, ${CUBE_LEVELS[green]}, ${CUBE_LEVELS[blue]})`;
palette[index] = rgbColor(
(CUBE_LEVELS[red] << 16) | (CUBE_LEVELS[green] << 8) | CUBE_LEVELS[blue],
);
}
}
}
for (let index = 0; index < 24; index += 1) {
const value = 8 + index * 10;
palette[232 + index] = `rgb(${value}, ${value}, ${value})`;
palette[232 + index] = rgbColor((value << 16) | (value << 8) | value);
}
return palette;
}
function rgbColor(value: number): string {
const red = (value >> 16) & 0xff;
const green = (value >> 8) & 0xff;
const blue = value & 0xff;
return `rgb(${red}, ${green}, ${blue})`;
function rgbColor(value: number): number {
return (OPAQUE_BLACK | (value & 0xffffff)) >>> 0;
}
function argb(input: { alpha: number; red: number; green: number; blue: number }): number {
const channel = (value: number) => Math.max(0, Math.min(255, Math.round(value)));
return (
((channel(input.alpha) << 24) |
(channel(input.red) << 16) |
(channel(input.green) << 8) |
channel(input.blue)) >>>
0
);
}
/** Parses the CSS color forms terminal themes use: `#rgb`, `#rrggbb`, `#rrggbbaa`, `rgb()`, `rgba()`. */
export function parseTerminalColor(value: string | undefined, fallback: number): number {
if (!value) return fallback;
const color = value.trim().toLowerCase();
const hex = /^#([0-9a-f]{3}|[0-9a-f]{6}|[0-9a-f]{8})$/.exec(color)?.[1];
if (hex) {
const digits = hex.length === 3 ? [...hex].map((digit) => digit + digit).join("") : hex;
const channel = (offset: number) => Number.parseInt(digits.slice(offset, offset + 2), 16);
return argb({
alpha: digits.length === 8 ? channel(6) : 255,
red: channel(0),
green: channel(2),
blue: channel(4),
});
}
const functional = /^rgba?\(([^)]*)\)$/.exec(color)?.[1];
if (functional) {
const parts = functional
.split(/[\s,/]+/)
.filter(Boolean)
.map(Number);
if (parts.length >= 3 && parts.every((part) => Number.isFinite(part))) {
return argb({
alpha: parts.length >= 4 ? parts[3] * 255 : 255,
red: parts[0],
green: parts[1],
blue: parts[2],
});
}
}
return fallback;
}
function withDimAlpha(color: number): number {
const alpha = (color >>> 24) & 0xff;
return (((Math.round(alpha * DIM_ALPHA) & 0xff) << 24) | (color & 0xffffff)) >>> 0;
}
function resolveColor(input: {
value: number | undefined;
mode: number | undefined;
fallback: string;
palette: string[];
}): string {
fallback: number;
palette: number[];
}): number {
const mode = input.mode ?? DEFAULT_COLOR_MODE;
const value = input.value ?? 0;
@@ -114,131 +151,50 @@ function resolveColor(input: {
function cellFlags(cell: TerminalCell): number {
let flags = 0;
if (cell.bold) flags |= FLAG_BOLD;
if (cell.italic) flags |= FLAG_ITALIC;
if (cell.underline) flags |= FLAG_UNDERLINE;
if (cell.dim) flags |= FLAG_DIM;
if (cell.inverse) flags |= FLAG_INVERSE;
if (cell.strikethrough) flags |= FLAG_STRIKETHROUGH;
if (cell.bold) flags |= PASEO_TERMINAL_STYLE_FLAGS.bold;
if (cell.italic) flags |= PASEO_TERMINAL_STYLE_FLAGS.italic;
if (cell.underline) flags |= PASEO_TERMINAL_STYLE_FLAGS.underline;
if (cell.strikethrough) flags |= PASEO_TERMINAL_STYLE_FLAGS.strikethrough;
if (cell.dim) flags |= PASEO_TERMINAL_STYLE_FLAGS.dim;
return flags;
}
function resolveCellColors(input: {
cell: TerminalCell;
palette: string[];
foregroundColor: string;
backgroundColor: string;
}): ResolvedCellColors {
const foreground = resolveColor({
value: input.cell.fg,
mode: input.cell.fgMode,
fallback: input.foregroundColor,
palette: input.palette,
});
const background = resolveColor({
value: input.cell.bg,
mode: input.cell.bgMode,
fallback: input.backgroundColor,
palette: input.palette,
});
const resolvedForeground = input.cell.inverse ? background : foreground;
const resolvedBackground = input.cell.inverse ? foreground : background;
return {
foreground: resolvedForeground,
background: resolvedBackground,
paintsBackground: resolvedBackground !== input.backgroundColor,
};
}
function textDecorationLine(flags: number): TextStyle["textDecorationLine"] | undefined {
const underline = (flags & FLAG_UNDERLINE) !== 0;
const strikethrough = (flags & FLAG_STRIKETHROUGH) !== 0;
if (underline && strikethrough) return "underline line-through";
if (underline) return "underline";
if (strikethrough) return "line-through";
return undefined;
}
function createTextStyle(input: {
foreground: string;
background: string;
paintsBackground: boolean;
flags: number;
}): TextStyle {
const style: TextStyle = {
color: input.foreground,
};
if (input.paintsBackground) {
style.backgroundColor = input.background;
}
if ((input.flags & FLAG_BOLD) !== 0) {
style.fontWeight = "700";
}
if ((input.flags & FLAG_ITALIC) !== 0) {
style.fontStyle = "italic";
}
if ((input.flags & FLAG_DIM) !== 0) {
style.opacity = 0.65;
}
const decorationLine = textDecorationLine(input.flags);
if (decorationLine) {
style.textDecorationLine = decorationLine;
style.textDecorationColor = input.foreground;
}
return style;
}
function buildStyleKey(input: {
foreground: string;
background: string;
paintsBackground: boolean;
flags: number;
}): string {
const background = input.paintsBackground ? input.background : "default";
return `${input.foreground}|${background}|${input.flags}`;
}
function buildThemeKey(theme: ITheme): string {
return JSON.stringify(theme);
}
export function createTerminalCellStyleResolver(theme: ITheme): TerminalCellStyleResolver {
const palette = build256Palette(theme);
const foregroundColor = theme.foreground ?? DEFAULT_TERMINAL_THEME.foreground ?? "#fafafa";
const backgroundColor = theme.background ?? DEFAULT_TERMINAL_THEME.background ?? "#181B1A";
const cursorColor = theme.cursor ?? foregroundColor;
const styleCache = new Map<string, TextStyle>();
const foregroundColor = parseTerminalColor(
theme.foreground ?? DEFAULT_TERMINAL_THEME.foreground,
0xfffafafa,
);
const backgroundColor = parseTerminalColor(
theme.background ?? DEFAULT_TERMINAL_THEME.background,
0xff181b1a,
);
const cursorColor = parseTerminalColor(theme.cursor, foregroundColor);
return {
themeKey: buildThemeKey(theme),
backgroundColor,
cursorColor,
resolve(cell: TerminalCell): ResolvedCellStyle {
const foreground = resolveColor({
value: cell.fg,
mode: cell.fgMode,
fallback: foregroundColor,
palette,
});
const background = resolveColor({
value: cell.bg,
mode: cell.bgMode,
fallback: backgroundColor,
palette,
});
const resolvedForeground = cell.inverse ? background : foreground;
const resolvedBackground = cell.inverse ? foreground : background;
const flags = cellFlags(cell);
const colors = resolveCellColors({ cell, palette, foregroundColor, backgroundColor });
const key = buildStyleKey({
foreground: colors.foreground,
background: colors.background,
paintsBackground: colors.paintsBackground,
return {
foreground: cell.dim ? withDimAlpha(resolvedForeground) : resolvedForeground,
background: resolvedBackground === backgroundColor ? 0 : resolvedBackground,
flags,
});
const cachedStyle = styleCache.get(key);
if (cachedStyle) {
return { key, style: cachedStyle, foregroundColor: colors.foreground };
}
const style = createTextStyle({
foreground: colors.foreground,
background: colors.background,
paintsBackground: colors.paintsBackground,
flags,
});
styleCache.set(key, style);
return { key, style, foregroundColor: colors.foreground };
};
},
};
}
@@ -1,8 +1,8 @@
import { createTerminalResizePolicy, updateTerminalResizePolicy } from "./terminal-resize-policy";
import { describe, expect, test } from "vitest";
import {
createNativeHeadlessTerminal,
type TerminalCellRow,
type TerminalViewportState,
} from "./headless-terminal-state";
import { createNativeTerminalBenchmarkPayload } from "./native-terminal-benchmark-payload";
@@ -11,7 +11,8 @@ import {
NATIVE_TERMINAL_PARSE_CHUNK_CHARS,
} from "./headless-terminal-output-drain";
import { createNativeTerminalScreenModel, type TerminalScreenState } from "./terminal-screen-model";
import { renderTerminalSnapshotToAnsi } from "../runtime/terminal-snapshot";
import { Terminal as ReplaySource } from "@xterm/headless";
import { SerializeAddon } from "@xterm/addon-serialize";
const ROWS = 12;
const COLS = 80;
@@ -41,33 +42,6 @@ function createFrameRecorder() {
};
}
function lineCells(line: string, cols: number): TerminalCellRow {
const cells: TerminalCellRow = [];
for (let index = 0; index < cols; index += 1) {
cells.push({ char: line[index] ?? " ", width: 1 });
}
return cells;
}
function terminalStateFromLines(input: {
lines: string[];
rows: number;
cols: number;
cursor: TerminalViewportState["cursor"];
}) {
const grid: TerminalCellRow[] = [];
for (let row = 0; row < input.rows; row += 1) {
grid.push(lineCells(input.lines[row] ?? "", input.cols));
}
return {
rows: input.rows,
cols: input.cols,
grid,
scrollback: [],
cursor: input.cursor,
};
}
async function runScheduledWork(input: {
callbacks: Array<() => void>;
flush: Promise<void>;
@@ -80,11 +54,13 @@ async function runScheduledWork(input: {
}
async function benchmarkSnapshot(lineCount: number) {
const terminal = createNativeHeadlessTerminal({ rows: ROWS, cols: COLS, scrollbackLines: 100 });
await terminal.write(
createNativeTerminalBenchmarkPayload({ startLine: 0, lineCount, cols: COLS }),
);
return terminal.getState();
return {
rows: ROWS,
cols: COLS,
data: new TextEncoder().encode(
createNativeTerminalBenchmarkPayload({ startLine: 0, lineCount, cols: COLS }),
),
};
}
function createScreenRestorer(
@@ -94,6 +70,7 @@ function createScreenRestorer(
const frameRecorder = createFrameRecorder();
let screen: TerminalScreenState | null = null;
const drain = createNativeTerminalOutputDrain({
restoreSize: () => {},
write: (chunk) => terminal.write(chunk),
reset: () => terminal.reset(),
getViewportState: () => {
@@ -107,7 +84,12 @@ function createScreenRestorer(
return {
async restore(snapshot: Awaited<ReturnType<typeof benchmarkSnapshot>>) {
drain.restoreSnapshot(snapshot);
drain.replay({ type: "begin", rows: snapshot.rows, cols: snapshot.cols });
drain.replay({
type: "data",
data: snapshot.data,
});
drain.replay({ type: "end" });
await drain.flush();
frameRecorder.frames[0]?.();
return screen;
@@ -122,6 +104,7 @@ describe("native terminal output drain", () => {
const frameRecorder = createFrameRecorder();
const payload = "x".repeat(NATIVE_TERMINAL_PARSE_CHUNK_CHARS * 2);
const drain = createNativeTerminalOutputDrain({
restoreSize: () => {},
write: async (chunk) => {
writes.push(chunk);
},
@@ -170,6 +153,7 @@ describe("native terminal output drain", () => {
const paintedStates: TerminalViewportState[] = [];
const frameRecorder = createFrameRecorder();
const drain = createNativeTerminalOutputDrain({
restoreSize: () => {},
write: (chunk) => terminal.write(chunk),
reset: () => terminal.reset(),
getViewportState: () => terminal.getViewportState(),
@@ -202,6 +186,7 @@ describe("native terminal output drain", () => {
const scheduledWork: Array<() => void> = [];
const frameRecorder = createFrameRecorder();
const drain = createNativeTerminalOutputDrain({
restoreSize: () => {},
write: (chunk) => terminal.write(chunk),
reset: () => terminal.reset(),
getViewportState: () => terminal.getViewportState(),
@@ -210,21 +195,22 @@ describe("native terminal output drain", () => {
scheduleFrame: frameRecorder.scheduleFrame,
cancelFrame: frameRecorder.cancelFrame,
});
const restoredSnapshot = terminalStateFromLines({
rows: 4,
cols: 32,
lines: ["restored-one", "restored-two"],
cursor: { row: 1, col: "restored-two".length },
});
const restoredCursor = { row: 1, col: "restored-two".length };
const replay = new TextEncoder().encode("restored-one\r\nrestored-two");
await terminal.write("old-one\r\nold-two\r\nold-three\r\n");
drain.enqueueText("stale-queued\r\n");
drain.restoreText(renderTerminalSnapshotToAnsi(restoredSnapshot));
drain.replay({ type: "begin" });
drain.replay({
type: "data",
data: replay,
});
drain.replay({ type: "end" });
await runScheduledWork({ callbacks: scheduledWork, flush: drain.flush() });
const state = terminal.getViewportState();
expect(state.grid.map(rowText)).toEqual(["restored-one", "restored-two", "", ""]);
expect(state.cursor).toEqual(restoredSnapshot.cursor);
expect(state.cursor).toEqual(restoredCursor);
});
test("snapshot restore preserves a scrolled viewport anchor while replacing terminal state", async () => {
@@ -242,7 +228,7 @@ describe("native terminal output drain", () => {
paintedMode: screen?.scroll.mode,
paintedTopRow: rowText(screen?.viewport.grid[0] ?? []),
beforeTopRow,
restoredBottomRows: terminal.getState().grid.slice(-2).map(rowText),
restoredBottomRows: terminal.getViewportState().grid.slice(-2).map(rowText),
}).toEqual({
paintedMode: "scrolled",
paintedTopRow: beforeTopRow,
@@ -268,3 +254,255 @@ describe("native terminal output drain", () => {
});
});
});
test("replays split Unicode and ANSI with one reset then live output", async () => {
const terminal = createNativeHeadlessTerminal({ rows: 4, cols: 40, scrollbackLines: 1000 });
let resets = 0;
const drain = createNativeTerminalOutputDrain({
restoreSize: () => {},
write: (text) => terminal.write(text),
reset: (size) => {
resets++;
if (size) terminal.resize(size);
terminal.reset();
},
getViewportState: () => terminal.getViewportState(),
onPaint: () => {},
});
try {
drain.replay({ type: "begin", rows: 4, cols: 40, retainedHistoryLines: 400 });
const bytes = new TextEncoder().encode("\x1b[31m界🙂 replay\x1b[0m\r\n");
for (let i = 0; i < bytes.length; i++)
drain.replay({ type: "data", data: bytes.subarray(i, i + 1) });
drain.replay({ type: "end" });
drain.enqueueText("live");
await drain.flush();
expect(resets).toBe(1);
expect(
terminal
.getBufferWindow({ startRow: 0, rowCount: 4 })
.rows.map((row) =>
row
.filter((cell) => cell.width !== 0)
.map((cell) => cell.char)
.join(""),
)
.join("\n"),
).toContain("界🙂 replay");
expect(
terminal
.getBufferWindow({ startRow: 0, rowCount: 4 })
.rows.map((row) =>
row
.filter((cell) => cell.width !== 0)
.map((cell) => cell.char)
.join(""),
)
.join("\n"),
).toContain("live");
} finally {
drain.dispose();
terminal.dispose();
}
});
test("an empty replacement replay resets after an in-flight write finishes", async () => {
let finish!: () => void;
let started!: () => void;
const writing = new Promise<void>((resolve) => {
started = resolve;
});
const blocked = new Promise<void>((resolve) => {
finish = resolve;
});
let resets = 0;
const drain = createNativeTerminalOutputDrain({
restoreSize: () => {},
write: async () => {
started();
await blocked;
},
reset: () => {
resets++;
},
getViewportState: () => null,
onPaint: () => {},
});
try {
drain.enqueueText("old terminal");
await writing;
drain.replay({ type: "begin" });
drain.replay({ type: "end" });
finish();
await drain.flush();
expect(resets).toBe(1);
expect(drain.getQueuedChars()).toBe(0);
} finally {
finish();
drain.dispose();
}
});
test("replay geometry returns to measured layout before live writes and unchanged-layout focus", async () => {
const measured = { rows: 24, cols: 40 };
const terminal = createNativeHeadlessTerminal({ ...measured, scrollbackLines: 1000 });
const policy = createTerminalResizePolicy(measured);
const sizes: number[] = [];
const drain = createNativeTerminalOutputDrain({
write: async (text) => {
sizes.push(terminal.getViewportState().cols);
await terminal.write(text);
},
reset: (size) => {
if (size) terminal.resize(size);
terminal.reset();
},
restoreSize: () => terminal.resize(measured),
getViewportState: () => terminal.getViewportState(),
onPaint: () => {},
});
try {
drain.replay({ type: "begin", rows: 30, cols: 120 });
drain.replay({ type: "data", data: new TextEncoder().encode("x".repeat(100) + "\r\n") });
drain.replay({ type: "end" });
drain.enqueueText("LIVE-" + "y".repeat(60));
await drain.flush();
expect(sizes).toEqual([120, 40]);
const focus = updateTerminalResizePolicy(policy, {
source: "claim",
size: measured,
claimToken: 1,
});
expect(focus.measuredSizeChanged).toBe(false);
expect(focus.resizeClaim).toMatchObject(measured);
expect(terminal.getViewportState()).toMatchObject(measured);
expect(terminal.getBufferBounds().cols).toBe(40);
const lines = terminal
.getViewportState()
.grid.map((row) =>
row
.map((cell) => cell.char)
.join("")
.trimEnd(),
)
.join("\n");
expect(lines).toContain("LIVE-" + "y".repeat(35) + "\n" + "y".repeat(25));
} finally {
drain.dispose();
terminal.dispose();
}
});
test.each(["clear", "replacement", "dispose"] as const)(
"cancels queued replay geometry on %s",
async (action) => {
const local = { rows: 24, cols: 40 };
const terminal = createNativeHeadlessTerminal({ ...local, scrollbackLines: 1000 });
let finish!: () => void;
const block = new Promise<void>((resolve) => {
finish = resolve;
});
let started!: () => void;
const writing = new Promise<void>((resolve) => {
started = resolve;
});
let first = true;
let restores = 0;
const drain = createNativeTerminalOutputDrain({
restoreSize: () => {
restores++;
terminal.resize(local);
},
reset: (size) => {
if (size) terminal.resize(size);
terminal.reset();
},
write: async (text) => {
await terminal.write(text);
if (first) {
first = false;
started();
await block;
}
},
getViewportState: () => terminal.getViewportState(),
onPaint: () => {},
});
try {
drain.replay({ type: "begin", rows: 30, cols: 120 });
drain.replay({ type: "data", data: new TextEncoder().encode("old") });
await writing;
local.cols = 60;
drain.resize();
expect(terminal.getViewportState().cols).toBe(120);
drain.replay({ type: "end" });
if (action === "clear") drain.clear();
else if (action === "dispose") {
drain.dispose();
drain.clear();
} else {
drain.replay({ type: "begin", rows: 20, cols: 80 });
drain.replay({ type: "data", data: new TextEncoder().encode("new") });
drain.replay({ type: "end" });
}
finish();
await drain.flush();
expect(restores).toBe(action === "dispose" ? 0 : 1);
if (action !== "dispose") expect(terminal.getViewportState()).toMatchObject(local);
} finally {
finish();
drain.dispose();
terminal.dispose();
}
},
);
test("holds captured geometry across mid-replay measurement changes", async () => {
const source = new ReplaySource({ rows: 4, cols: 8, scrollback: 100, allowProposedApi: true });
const serializer = new SerializeAddon();
source.loadAddon(serializer);
await new Promise<void>((resolve) =>
source.write("ABCDEFGH\r\n12345678\r\nabcdefgh\r\nxyz\x1b[2;8H", resolve),
);
const ansi = new TextEncoder().encode(serializer.serialize());
const terminal = createNativeHeadlessTerminal({ rows: 4, cols: 8, scrollbackLines: 100 });
const expected = createNativeHeadlessTerminal({ rows: 4, cols: 8, scrollbackLines: 100 });
await expected.write(new TextDecoder().decode(ansi));
expected.resize({ rows: 4, cols: 4 });
let measured = { rows: 4, cols: 8 };
const drain = createNativeTerminalOutputDrain({
write: (chunk) => terminal.write(chunk),
reset: (size) => {
if (size) terminal.resize(size);
terminal.reset();
},
restoreSize: () => terminal.resize(measured),
getViewportState: () => terminal.getViewportState(),
onPaint: () => {},
});
try {
drain.replay({ type: "begin", rows: 4, cols: 8 });
await drain.flush();
measured = { rows: 4, cols: 4 };
drain.resize();
drain.replay({ type: "data", data: ansi });
drain.replay({ type: "end" });
await drain.flush();
expect(terminal.getViewportState()).toEqual(expected.getViewportState());
const actualBounds = terminal.getBufferBounds();
const expectedBounds = expected.getBufferBounds();
expect(
terminal.getBufferWindow({
startRow: actualBounds.oldestRow,
rowCount: actualBounds.newestRow - actualBounds.oldestRow + 1,
}),
).toEqual(
expected.getBufferWindow({
startRow: expectedBounds.oldestRow,
rowCount: expectedBounds.newestRow - expectedBounds.oldestRow + 1,
}),
);
} finally {
drain.dispose();
}
});
@@ -1,5 +1,3 @@
import type { TerminalState } from "@getpaseo/protocol/messages";
import { renderTerminalSnapshotToAnsi } from "../runtime/terminal-snapshot";
import type { TerminalViewportState } from "./headless-terminal-state";
import { nativeTerminalPerformanceNow } from "./terminal-performance";
@@ -14,9 +12,9 @@ export interface NativeTerminalParseSample {
}
export interface NativeTerminalOutputDrain {
replay(event: import("@getpaseo/client").TerminalReplayEvent): void;
enqueueText(text: string): void;
restoreText(text: string): void;
restoreSnapshot(snapshot: TerminalState): void;
resize(): void;
clear(): void;
flush(): Promise<void>;
dispose(): void;
@@ -25,7 +23,8 @@ export interface NativeTerminalOutputDrain {
export interface NativeTerminalOutputDrainOptions {
write: (chunk: string) => Promise<void>;
reset: () => void;
restoreSize: () => void;
reset: (size?: { rows: number; cols: number }) => void;
getViewportState: () => TerminalViewportState | null;
onPaint: (state: TerminalViewportState) => void;
onParse?: (sample: NativeTerminalParseSample) => void;
@@ -68,16 +67,22 @@ export function createNativeTerminalOutputDrain(
const chunkChars = options.chunkChars ?? NATIVE_TERMINAL_PARSE_CHUNK_CHARS;
const chunksPerTurn = options.chunksPerTurn ?? NATIVE_TERMINAL_PARSE_CHUNKS_PER_TURN;
const idleWaiters: Array<() => void> = [];
let pendingText = "";
type Operation =
| { type: "write"; text: string }
| { type: "reset"; size?: { rows: number; cols: number } }
| { type: "restore-size" };
let operations: Operation[] = [];
let queuedChars = 0;
let drainScheduled = false;
let draining = false;
let disposed = false;
let replaying = false;
let paintFrame: number | null = null;
let generation = 0;
let resetBeforeNextWrite = false;
const replayDecoder = new TextDecoder();
function resolveIdleIfReady(): void {
if (drainScheduled || draining || pendingText.length > 0) {
if (drainScheduled || draining || operations.length > 0) {
return;
}
while (idleWaiters.length > 0) {
@@ -119,15 +124,6 @@ export function createNativeTerminalOutputDrain(
});
}
function replacePendingText(text: string): void {
generation += 1;
pendingText = text;
resetBeforeNextWrite = true;
cancelPendingPaint();
scheduleDrain();
resolveIdleIfReady();
}
async function drainPending(): Promise<void> {
if (disposed || draining) {
return;
@@ -138,16 +134,23 @@ export function createNativeTerminalOutputDrain(
let parsedChunks = 0;
try {
while (pendingText.length > 0 && parsedChunks < chunksPerTurn) {
if (disposed || activeGeneration !== generation) {
return;
while (operations.length > 0 && parsedChunks < chunksPerTurn) {
if (disposed || activeGeneration !== generation) return;
const operation = operations[0]!;
if (operation.type !== "write") {
operations.shift();
if (operation.type === "reset") options.reset(operation.size);
else {
options.restoreSize();
replaying = false;
}
requestPaint();
continue;
}
if (resetBeforeNextWrite) {
options.reset();
resetBeforeNextWrite = false;
}
const chunk = pendingText.slice(0, chunkChars);
pendingText = pendingText.slice(chunk.length);
const chunk = operation.text.slice(0, chunkChars);
operation.text = operation.text.slice(chunk.length);
queuedChars -= chunk.length;
if (!operation.text) operations.shift();
const parseStart = nativeTerminalPerformanceNow();
await options.write(chunk);
if (disposed || activeGeneration !== generation) {
@@ -156,14 +159,14 @@ export function createNativeTerminalOutputDrain(
options.onParse?.({
durationMs: nativeTerminalPerformanceNow() - parseStart,
parsedChars: chunk.length,
queuedChars: pendingText.length,
queuedChars,
});
requestPaint();
parsedChunks += 1;
}
} finally {
draining = false;
if (!disposed && pendingText.length > 0) {
if (!disposed && operations.length > 0) {
scheduleDrain();
}
resolveIdleIfReady();
@@ -171,38 +174,56 @@ export function createNativeTerminalOutputDrain(
}
return {
enqueueText(text: string): void {
if (disposed || text.length === 0) {
return;
replay(event): void {
if (disposed) return;
if (event.type === "begin") {
replaying = true;
generation++;
replayDecoder.decode();
operations = [
{
type: "reset",
size: event.rows && event.cols ? { rows: event.rows, cols: event.cols } : undefined,
},
];
queuedChars = 0;
cancelPendingPaint();
} else if (event.type === "data") {
this.enqueueText(replayDecoder.decode(event.data, { stream: true }));
} else {
this.enqueueText(replayDecoder.decode());
operations.push({ type: "restore-size" });
}
pendingText += text;
scheduleDrain();
},
enqueueText(text: string): void {
if (disposed || !text) return;
const last = operations.at(-1);
if (last?.type === "write") last.text += text;
else operations.push({ type: "write", text });
queuedChars += text.length;
scheduleDrain();
},
restoreText(text: string): void {
if (disposed) {
return;
}
replacePendingText(text);
},
restoreSnapshot(snapshot: TerminalState): void {
if (disposed) {
return;
}
replacePendingText(renderTerminalSnapshotToAnsi(snapshot));
resize(): void {
if (disposed || replaying) return;
operations.push({ type: "restore-size" });
scheduleDrain();
},
clear(): void {
if (disposed) return;
generation += 1;
pendingText = "";
resetBeforeNextWrite = false;
operations = [{ type: "restore-size" }, { type: "reset" }];
queuedChars = 0;
replayDecoder.decode();
cancelPendingPaint();
scheduleDrain();
resolveIdleIfReady();
},
flush(): Promise<void> {
if (!drainScheduled && !draining && pendingText.length === 0) {
if (!drainScheduled && !draining && operations.length === 0) {
return Promise.resolve();
}
scheduleDrain();
@@ -214,8 +235,8 @@ export function createNativeTerminalOutputDrain(
dispose(): void {
disposed = true;
generation += 1;
pendingText = "";
resetBeforeNextWrite = false;
operations = [];
queuedChars = 0;
cancelPendingPaint();
while (idleWaiters.length > 0) {
idleWaiters.shift()?.();
@@ -223,7 +244,7 @@ export function createNativeTerminalOutputDrain(
},
getQueuedChars(): number {
return pendingText.length;
return queuedChars;
},
};
}
@@ -21,7 +21,6 @@ export interface NativeHeadlessTerminalOptions {
export interface NativeHeadlessTerminal {
write(data: NativeTerminalWriteData): Promise<void>;
getState(): TerminalState;
getViewportState(input?: TerminalViewportStateInput): TerminalViewportState;
getInputModeState(): NativeHeadlessTerminalInputModeState;
getBufferBounds(): TerminalBufferBounds;
@@ -165,35 +164,6 @@ function extractRow(
return rowCells;
}
function extractGrid(terminal: HeadlessTerminalInstance): TerminalCellRow[] {
const grid: TerminalCellRow[] = [];
const baseY = terminal.buffer.active.baseY;
const reusableCell = terminal.buffer.active.getNullCell();
for (let row = 0; row < terminal.rows; row += 1) {
grid.push(extractRow(terminal, baseY + row, reusableCell));
}
return grid;
}
function extractScrollback(
terminal: HeadlessTerminalInstance,
options: { scrollbackLines?: number },
): TerminalCellRow[] {
const scrollback: TerminalCellRow[] = [];
const scrollbackLines = terminal.buffer.active.baseY;
const startRow =
typeof options.scrollbackLines === "number"
? Math.max(0, scrollbackLines - options.scrollbackLines)
: 0;
const reusableCell = terminal.buffer.active.getNullCell();
for (let row = startRow; row < scrollbackLines; row += 1) {
scrollback.push(extractRow(terminal, row, reusableCell));
}
return scrollback;
}
function extractBufferWindow(
terminal: HeadlessTerminalInstance,
oldestRow: number,
@@ -290,19 +260,6 @@ function extractInputModeState(
};
}
function extractState(
terminal: HeadlessTerminalInstance,
options: { scrollbackLines?: number },
): TerminalState {
return {
rows: terminal.rows,
cols: terminal.cols,
grid: extractGrid(terminal),
scrollback: extractScrollback(terminal, options),
cursor: extractCursorState(terminal),
};
}
function extractViewportState(
terminal: HeadlessTerminalInstance,
coordinateEpoch: number,
@@ -380,9 +337,6 @@ export function createNativeHeadlessTerminal(
});
});
},
getState(): TerminalState {
return extractState(terminal, { scrollbackLines: options.scrollbackLines });
},
getViewportState(input?: TerminalViewportStateInput): TerminalViewportState {
return extractViewportState(
terminal,
@@ -0,0 +1,246 @@
import { describe, expect, test } from "vitest";
import graphemeRows from "../../../modules/paseo-terminal/android/src/androidTest/assets/grapheme-rows.json";
import { PASEO_TERMINAL_STYLE_FLAGS } from "../../../modules/paseo-terminal/contract";
import { encodeTerminalFrame } from "../../../modules/paseo-terminal/frame-encoding";
import {
createTerminalCellStyleResolver,
DEFAULT_TERMINAL_THEME,
parseTerminalColor,
} from "./colors";
import { createNativeHeadlessTerminal } from "./headless-terminal-state";
import { buildTerminalFrame } from "./terminal-frame";
import { createNativeTerminalOutputDrain } from "./headless-terminal-output-drain";
import { resolveMeasuredNativeTerminalSize } from "./terminal-size-measurement";
const resolver = createTerminalCellStyleResolver(DEFAULT_TERMINAL_THEME);
const RED = parseTerminalColor(DEFAULT_TERMINAL_THEME.red, 0);
const FOREGROUND = parseTerminalColor(DEFAULT_TERMINAL_THEME.foreground, 0);
async function frameFor(output: string, options: { cols?: number; rows?: number } = {}) {
const terminal = createNativeHeadlessTerminal({
cols: options.cols ?? 20,
rows: options.rows ?? 4,
});
await terminal.write(output);
const state = terminal.getViewportState({ firstRow: 0, rowCount: options.rows ?? 4 });
terminal.dispose();
return {
state,
frame: buildTerminalFrame({ state, columns: state.cols, resolver, selection: null }),
};
}
function cellLayout(row: { text: string; cells: number[] }) {
const layout: Array<{ text: string; col: number; span: number }> = [];
let offset = 0;
let col = 0;
for (let index = 0; index < row.cells.length; index += 2) {
const [length, span] = [row.cells[index], row.cells[index + 1]];
layout.push({ text: row.text.slice(offset, offset + length), col, span });
offset += length;
col += span;
}
return layout;
}
/** Indexes of the cells that start a grapheme cluster. */
function clusterStartCells(row: { text: string; cells: number[] }, segmenter: Intl.Segmenter) {
const boundaries = new Set(Array.from(segmenter.segment(row.text), (segment) => segment.index));
const starts: number[] = [];
let offset = 0;
for (let cell = 0; cell < row.cells.length / 2; cell += 1) {
if (boundaries.has(offset)) starts.push(cell);
offset += row.cells[cell * 2];
}
return starts;
}
describe("native terminal frame", () => {
test("keeps each Hangul syllable on xterm's two-column allocation", async () => {
const { frame } = await frameFor("> 안녕하세요");
expect(cellLayout(frame.rows[0]).slice(0, 7)).toEqual([
{ text: ">", col: 0, span: 1 },
{ text: " ", col: 1, span: 1 },
{ text: "안", col: 2, span: 2 },
{ text: "녕", col: 4, span: 2 },
{ text: "하", col: 6, span: 2 },
{ text: "세", col: 8, span: 2 },
{ text: "요", col: 10, span: 2 },
]);
expect(frame.cursor).toEqual({ row: 0, col: 12 });
});
test("covers every column once, including trailing blanks", async () => {
const corpus = ["안녕하세요NEXT", "日本語 中文", "áé é x̸", "क्ष कि ❤️ 👩‍💻 🇰🇷"];
const { frame } = await frameFor(corpus.join("\r\n"), { rows: 4, cols: 24 });
for (const row of frame.rows) {
const spans = row.cells.filter((_, index) => index % 2 === 1);
const styleColumns = row.styles.filter((_, index) => index % 4 === 0);
expect(spans.reduce((total, span) => total + span, 0)).toBe(24);
expect(styleColumns.reduce((total, span) => total + span, 0)).toBe(24);
expect(row.cells.filter((_, index) => index % 2 === 0).reduce((a, b) => a + b, 0)).toBe(
row.text.length,
);
}
});
test("keeps combining marks and joiners inside the cell xterm assigned them", async () => {
const { frame } = await frameFor("éx̸ 각 क्ष 👩‍💻");
expect(cellLayout(frame.rows[0]).slice(0, 11)).toEqual([
{ text: "é", col: 0, span: 1 },
{ text: "x̸", col: 1, span: 1 },
{ text: " ", col: 2, span: 1 },
{ text: "각", col: 3, span: 2 },
{ text: " ", col: 5, span: 1 },
{ text: "क्", col: 6, span: 1 },
{ text: "ष", col: 7, span: 1 },
{ text: " ", col: 8, span: 1 },
{ text: "👩‍", col: 9, span: 1 },
{ text: "💻", col: 10, span: 1 },
{ text: " ", col: 11, span: 1 },
]);
});
test("splits style spans at SGR changes without moving cells", async () => {
const { frame } = await frameFor("안녕\x1b[31mNEXT\x1b[0m\x1b[1;4m!\x1b[0m");
const row = frame.rows[0];
expect(
cellLayout(row)
.slice(0, 7)
.map((cell) => cell.col),
).toEqual([0, 2, 4, 5, 6, 7, 8]);
expect(row.styles.slice(0, 12)).toEqual([
4,
FOREGROUND,
0,
0,
4,
RED,
0,
0,
1,
FOREGROUND,
0,
PASEO_TERMINAL_STYLE_FLAGS.bold | PASEO_TERMINAL_STYLE_FLAGS.underline,
]);
});
test("resolves inverse and dim into paint colors", async () => {
const { frame } = await frameFor("\x1b[7mI\x1b[0m\x1b[2mD\x1b[0m");
const background = parseTerminalColor(DEFAULT_TERMINAL_THEME.background, 0);
expect(frame.rows[0].styles.slice(0, 8)).toEqual([
1,
background,
FOREGROUND,
0,
1,
(((Math.round(255 * 0.65) & 0xff) << 24) | (FOREGROUND & 0xffffff)) >>> 0,
0,
PASEO_TERMINAL_STYLE_FLAGS.dim,
]);
});
test("rows follow content and style but not cursor or selection", async () => {
const plain = await frameFor("same\r\nrow");
const moved = await frameFor("same\r\nrow\x1b[1;1H");
const recolored = await frameFor("\x1b[31msame\x1b[0m\r\nrow");
expect(moved.frame.rows[0]).toEqual(plain.frame.rows[0]);
expect(moved.frame.cursor).not.toEqual(plain.frame.cursor);
expect(recolored.frame.rows[0]).not.toEqual(plain.frame.rows[0]);
const selected = buildTerminalFrame({
state: plain.state,
columns: plain.state.cols,
resolver,
selection: {
start: { row: 0, col: 1 },
end: { row: 1, col: 0 },
coordinateEpoch: 0,
},
});
expect(selected.rows).toEqual(plain.frame.rows);
expect(selected.selection).toEqual({ startRow: 0, startCol: 1, endRow: 1, endCol: 0 });
});
test("clips the frame to the visible columns", async () => {
const { state } = await frameFor("0123456789abcdefghij");
const frame = buildTerminalFrame({ state, columns: 8, resolver, selection: null });
expect(frame.columns).toBe(8);
expect(frame.rows[0].text).toBe("01234567");
});
// The Android instrumented test draws these rows and compares them with each cluster drawn on its
// own. This keeps its input equal to what xterm produces, and its clusters equal to UAX #29
// grapheme clusters. `contrastStarts` is a wrong clustering the comparison must reject.
test("Android cluster fixture matches xterm cells and grapheme clusters", async () => {
const segmenter = new Intl.Segmenter("und", { granularity: "grapheme" });
const actual = await Promise.all(
graphemeRows.map(async ({ output, contrastStarts }) => {
const { frame } = await frameFor(output, { cols: 8, rows: 1 });
const row = frame.rows[0];
const [encoded] = encodeTerminalFrame({ ...frame, rows: [row] }).rows;
return {
output,
row: encoded,
clusterStarts: clusterStartCells(row, segmenter),
contrastStarts,
};
}),
);
expect(actual).toEqual(graphemeRows);
});
});
test("builds native frames after replay commits at captured geometry and the latest measurement precedes live text", async () => {
let measured = resolveMeasuredNativeTerminalSize({
layout: { width: 400, height: 240 },
metrics: { cellWidth: 10, cellHeight: 10 },
})!;
const terminal = createNativeHeadlessTerminal({ ...measured, scrollbackLines: 10000 });
const parsedColumns: number[] = [];
const drain = createNativeTerminalOutputDrain({
write: async (text) => {
parsedColumns.push(terminal.getViewportState().cols);
await terminal.write(text);
},
reset: (size) => {
if (size) terminal.resize(size);
terminal.reset();
},
restoreSize: () => terminal.resize(measured),
getViewportState: () => terminal.getViewportState(),
onPaint: () => {},
});
try {
drain.replay({ type: "begin", rows: 30, cols: 120 });
drain.replay({ type: "data", data: new TextEncoder().encode("x".repeat(100) + "\r\n") });
measured = resolveMeasuredNativeTerminalSize({
layout: { width: 500, height: 100 },
metrics: { cellWidth: 10, cellHeight: 10 },
})!;
drain.resize();
drain.replay({ type: "end" });
drain.enqueueText("\x1b[H\x1b[2K\x1b[31mLIVE-界🙂\x1b[0m");
await drain.flush();
expect(parsedColumns).toEqual([120, 50]);
const state = terminal.getViewportState();
const frame = buildTerminalFrame({ state, columns: state.cols, resolver, selection: null });
expect(frame.columns).toBe(50);
expect(frame.rows).toHaveLength(10);
expect(frame.rows[0].text.trimEnd()).toBe("LIVE-界🙂");
expect(frame.rows[0].styles.slice(0, 4)).toEqual([8, RED, 0, 0]);
expect(encodeTerminalFrame(frame).rows[0]).toContain("LIVE-界🙂");
} finally {
drain.dispose();
terminal.dispose();
}
});
@@ -0,0 +1,84 @@
import type {
PaseoTerminalFrame,
PaseoTerminalRow,
PaseoTerminalSelection,
} from "../../../modules/paseo-terminal/contract";
import type { TerminalCellStyleResolver } from "./colors";
import type { NativeTerminalCell, TerminalViewportState } from "./headless-terminal-state";
import type { TerminalSelectionRange } from "./terminal-selection";
/**
* Converts the xterm viewport into the native renderer's frame. Every cell keeps its own text and
* xterm's column span; continuation cells of wide characters (width 0) belong to the cell before
* them. Nothing here measures or joins text: the renderer shapes rows and places the result on
* these columns.
*/
export function buildTerminalFrame(input: {
state: TerminalViewportState;
columns: number;
resolver: TerminalCellStyleResolver;
selection: TerminalSelectionRange | null;
}): PaseoTerminalFrame {
const grid = input.state.grid as NativeTerminalCell[][];
return {
columns: input.columns,
rows: grid.map((cells) =>
buildRow({ cells, columns: input.columns, resolver: input.resolver }),
),
cursor: input.state.cursor.hidden
? null
: { row: input.state.cursor.row, col: input.state.cursor.col },
selection: input.selection
? toFrameSelection({ range: input.selection, firstRow: input.state.firstRow })
: null,
};
}
function buildRow(input: {
cells: NativeTerminalCell[];
columns: number;
resolver: TerminalCellStyleResolver;
}): PaseoTerminalRow {
let text = "";
const cells: number[] = [];
const styles: number[] = [];
const lastColumn = Math.min(input.columns, input.cells.length);
for (let col = 0; col < lastColumn; col += 1) {
const cell = input.cells[col];
const span = cell.width ?? 1;
if (span <= 0) {
continue;
}
const cellText = cell.char || " ";
text += cellText;
cells.push(cellText.length, span);
const style = input.resolver.resolve(cell);
const previous = styles.length - 4;
if (
previous >= 0 &&
styles[previous + 1] === style.foreground &&
styles[previous + 2] === style.background &&
styles[previous + 3] === style.flags
) {
styles[previous] += span;
} else {
styles.push(span, style.foreground, style.background, style.flags);
}
}
return { text, cells, styles };
}
function toFrameSelection(input: {
range: TerminalSelectionRange;
firstRow: number;
}): PaseoTerminalSelection {
return {
startRow: input.range.start.row - input.firstRow,
startCol: input.range.start.col,
endRow: input.range.end.row - input.firstRow,
endCol: input.range.end.col,
};
}
@@ -1,68 +1,8 @@
import { describe, expect, it } from "vitest";
import {
resolveTerminalCustomGlyphCellTransform,
resolveTerminalGridMetricsMeasurement,
resolveMeasuredTerminalCellMetrics,
resolveTerminalCursorOffset,
} from "./terminal-grid-metrics";
import { resolveTerminalGridMetricsMeasurement } from "./terminal-grid-metrics";
describe("native terminal grid metrics", () => {
it("places each normalized custom glyph in run viewport coordinates", () => {
expect(
resolveTerminalCustomGlyphCellTransform({
cellOffset: 57,
cellWidth: 7.4,
cellHeight: 16.2,
}),
).toBe("matrix(7.4 0 0 16.2 421.8 0)");
});
it("preserves fractional measured cell width for horizontal layout", () => {
expect(
resolveMeasuredTerminalCellMetrics({
measuredTextWidth: 72.246,
measuredTextHeight: 16.2,
measureTextLength: 10,
roundToNearestPixel: (value) => value,
}),
).toEqual({
cellWidth: 7.2246,
cellHeight: 16.2,
});
});
it.each([1, 2, 2.75, 3, 3.5])(
"aligns cells to the physical pixel grid at density %s",
(density) => {
const metrics = resolveMeasuredTerminalCellMetrics({
measuredTextWidth: 72.246,
measuredTextHeight: 16.2,
measureTextLength: 10,
roundToNearestPixel: (value) => Math.round(value * density) / density,
});
expect(metrics.cellWidth * density).toBeCloseTo(Math.round(metrics.cellWidth * density), 10);
expect(metrics.cellHeight * density).toBeCloseTo(
Math.round(metrics.cellHeight * density),
10,
);
},
);
it("positions the cursor with the measured fractional cell width", () => {
expect(
resolveTerminalCursorOffset({
cursorCol: 80,
cursorRow: 3,
metrics: { cellWidth: 7.2246, cellHeight: 16 },
}),
).toEqual({
x: 577.968,
y: 48,
});
});
it("emits measured metrics once until the measurement changes", () => {
const measured = { cellWidth: 7.2, cellHeight: 16 };
@@ -3,47 +3,6 @@ export interface TerminalGridCellMetrics {
cellHeight: number;
}
export interface TerminalGridCellMetricsInput {
measuredTextWidth: number;
measuredTextHeight: number;
measureTextLength: number;
roundToNearestPixel: (value: number) => number;
}
export interface TerminalCursorOffsetInput {
cursorCol: number;
cursorRow: number;
metrics: TerminalGridCellMetrics;
}
export interface TerminalCursorOffset {
x: number;
y: number;
}
export interface TerminalCustomGlyphCellTransformInput {
cellOffset: number;
cellWidth: number;
cellHeight: number;
}
export function resolveTerminalCustomGlyphCellTransform(
input: TerminalCustomGlyphCellTransformInput,
): string {
const translateX = input.cellOffset * input.cellWidth;
return `matrix(${input.cellWidth} 0 0 ${input.cellHeight} ${translateX} 0)`;
}
export function resolveMeasuredTerminalCellMetrics(
input: TerminalGridCellMetricsInput,
): TerminalGridCellMetrics {
const textLength = Math.max(1, input.measureTextLength);
return {
cellWidth: snapCellMetric(input.measuredTextWidth / textLength, input.roundToNearestPixel),
cellHeight: snapCellMetric(input.measuredTextHeight, input.roundToNearestPixel),
};
}
export function resolveTerminalGridMetricsMeasurement(
previous: TerminalGridCellMetrics | null,
next: TerminalGridCellMetrics,
@@ -53,16 +12,3 @@ export function resolveTerminalGridMetricsMeasurement(
}
return next;
}
export function resolveTerminalCursorOffset(
input: TerminalCursorOffsetInput,
): TerminalCursorOffset {
return {
x: input.cursorCol * input.metrics.cellWidth,
y: input.cursorRow * input.metrics.cellHeight,
};
}
function snapCellMetric(value: number, roundToNearestPixel: (value: number) => number): number {
return Math.max(1, roundToNearestPixel(value));
}
@@ -1,71 +1,34 @@
import { memo, useCallback, useMemo, useRef, useState } from "react";
import { useCallback, useMemo, useRef, useState } from "react";
import {
PixelRatio,
Text,
useWindowDimensions,
View,
type LayoutChangeEvent,
type StyleProp,
type TextStyle,
type ViewStyle,
} from "react-native";
import { StyleSheet } from "react-native-unistyles";
import Svg, { G, Path } from "react-native-svg";
import type { ITheme } from "@xterm/xterm";
import {
PaseoTerminalView,
type PaseoTerminalCellMetrics,
type PaseoTerminalTheme,
} from "../../../modules/paseo-terminal";
import {
createTerminalCellStyleResolver,
DEFAULT_TERMINAL_THEME,
NATIVE_TERMINAL_SELECTION_COLORS,
} from "./colors";
import type { TerminalGlyphRect } from "./terminal-custom-glyph";
import { resolveNativeTerminalFontFamily } from "./font.native";
import type { TerminalViewportState } from "./headless-terminal-state";
import {
resolveMeasuredTerminalCellMetrics,
resolveTerminalCustomGlyphCellTransform,
resolveTerminalGridMetricsMeasurement,
resolveTerminalCursorOffset,
type TerminalGridCellMetrics,
} from "./terminal-grid-metrics";
import {
buildRows,
type TerminalCustomGlyphCell,
type TerminalCustomGlyphRun,
type TerminalRowModel,
type TerminalRun,
} from "./terminal-row-model";
import { buildTerminalFrame } from "./terminal-frame";
import type { TerminalSelectionRange } from "./terminal-selection";
const MEASURE_TEXT = "mmmmmmmmmm";
const DEFAULT_FONT_SIZE = 12;
const INITIAL_CELL_WIDTH_RATIO = 0.62;
const INITIAL_CELL_HEIGHT_RATIO = 1.35;
interface CellMetrics {
cellWidth: number;
cellHeight: number;
}
interface TerminalGridViewport {
width: number;
height: number;
}
interface TerminalGridRowProps {
row: TerminalRowModel;
cellWidth: number;
cellHeight: number;
fontFamily?: string;
fontSize: number;
styleEpoch: string;
}
interface TerminalGridRunProps {
run: TerminalRun;
cellWidth: number;
cellHeight: number;
textStyle: StyleProp<TextStyle>;
}
export interface TerminalGridViewProps {
state: TerminalViewportState;
@@ -77,221 +40,20 @@ export interface TerminalGridViewProps {
onCellMetricsChange?: (metrics: TerminalGridCellMetrics) => void;
}
function estimateCellMetrics(fontSize: number): CellMetrics {
return {
cellWidth: snapPixel(fontSize * INITIAL_CELL_WIDTH_RATIO),
cellHeight: snapPixel(fontSize * INITIAL_CELL_HEIGHT_RATIO),
};
}
function snapPixel(value: number): number {
return Math.max(1, PixelRatio.roundToNearestPixel(value));
}
function resolveVisibleCols(input: {
viewportWidth: number;
cellWidth: number;
viewportWidth: number | null;
cellWidth: number | null;
gridCols: number;
}): number {
if (input.viewportWidth === null || input.cellWidth === null) {
return input.gridCols;
}
if (input.viewportWidth <= 0 || input.cellWidth <= 0 || input.gridCols <= 0) {
return 0;
}
return Math.min(input.gridCols, Math.max(1, Math.floor(input.viewportWidth / input.cellWidth)));
}
function TerminalGridRun({ run, cellWidth, cellHeight, textStyle }: TerminalGridRunProps) {
const runStyle = useMemo<StyleProp<ViewStyle>>(
() => [
styles.run,
{
backgroundColor: run.style.backgroundColor,
height: cellHeight,
width: run.cellCount * cellWidth,
},
],
[cellHeight, cellWidth, run.cellCount, run.style.backgroundColor],
);
const runTextStyle = useMemo<StyleProp<TextStyle>>(
() => [textStyle, run.style],
[run.style, textStyle],
);
return (
<View style={runStyle}>
{run.renderKind === "custom-glyph" ? (
<TerminalGridCustomGlyphRun run={run} cellWidth={cellWidth} cellHeight={cellHeight} />
) : (
<Text numberOfLines={1} style={runTextStyle}>
{run.text}
</Text>
)}
</View>
);
}
interface TerminalGridCustomGlyphRunProps {
run: TerminalCustomGlyphRun;
cellWidth: number;
cellHeight: number;
}
interface TerminalGridCustomGlyphRectProps {
cell: TerminalCustomGlyphCell;
rect: TerminalGlyphRect;
cellWidth: number;
cellHeight: number;
foregroundColor: string;
}
function TerminalGridCustomGlyphRect({
cell,
rect,
cellWidth,
cellHeight,
foregroundColor,
}: TerminalGridCustomGlyphRectProps) {
const style = useMemo<ViewStyle>(
() => ({
position: "absolute",
backgroundColor: foregroundColor,
left: (cell.offset + rect.x) * cellWidth,
top: rect.y * cellHeight,
width: rect.width * cellWidth,
height: rect.height * cellHeight,
}),
[cell.offset, cellHeight, cellWidth, foregroundColor, rect],
);
return <View style={style} />;
}
function TerminalGridCustomGlyphRun({
run,
cellWidth,
cellHeight,
}: TerminalGridCustomGlyphRunProps) {
const opacity = typeof run.style.opacity === "number" ? run.style.opacity : 1;
return (
<View style={[styles.customGlyphRun, { opacity }]}>
{run.glyphs.map((cell) =>
cell.glyph.kind === "rects"
? cell.glyph.rects.map((rect) => (
<TerminalGridCustomGlyphRect
key={`${cell.key}:${rect.x}:${rect.y}:${rect.width}:${rect.height}`}
cell={cell}
rect={rect}
cellWidth={cellWidth}
cellHeight={cellHeight}
foregroundColor={run.foregroundColor}
/>
))
: null,
)}
<Svg
height={cellHeight}
pointerEvents="none"
preserveAspectRatio="none"
style={styles.customGlyphSvg}
viewBox={`0 0 ${run.cellCount * cellWidth} ${cellHeight}`}
width={run.cellCount * cellWidth}
>
<G fill="none" stroke={run.foregroundColor}>
{run.glyphs.map((cell) =>
cell.glyph.kind === "path" ? (
<Path
d={cell.glyph.path}
key={cell.key}
strokeLinecap="butt"
strokeLinejoin="miter"
strokeWidth={cell.glyph.strokeWidth}
transform={resolveTerminalCustomGlyphCellTransform({
cellOffset: cell.offset,
cellWidth,
cellHeight,
})}
vectorEffect="non-scaling-stroke"
/>
) : null,
)}
</G>
</Svg>
</View>
);
}
const MemoTerminalGridRun = memo(TerminalGridRun, (previous, next) => {
return (
previous.run === next.run &&
previous.cellWidth === next.cellWidth &&
previous.cellHeight === next.cellHeight &&
previous.textStyle === next.textStyle
);
});
function TerminalGridRow({
row,
cellWidth,
cellHeight,
fontFamily,
fontSize,
}: TerminalGridRowProps) {
const rowStyle = useMemo<StyleProp<ViewStyle>>(
() => [styles.row, { height: cellHeight }],
[cellHeight],
);
const textStyle = useMemo<StyleProp<TextStyle>>(
() => [
styles.rowText,
{
height: cellHeight,
lineHeight: cellHeight,
fontFamily,
fontSize,
},
],
[cellHeight, fontFamily, fontSize],
);
const accessibilityLabel = useMemo(
() =>
row.runs
.map((run) => run.text)
.join("")
.trimEnd(),
[row.runs],
);
return (
<View
accessibilityLabel={accessibilityLabel}
accessible={accessibilityLabel.length > 0}
style={rowStyle}
testID={`terminal-row-${row.index}`}
>
{row.runs.map((run) => (
<MemoTerminalGridRun
key={run.key}
run={run}
cellWidth={cellWidth}
cellHeight={cellHeight}
textStyle={textStyle}
/>
))}
</View>
);
}
const MemoTerminalGridRow = memo(TerminalGridRow, (previous, next) => {
return (
previous.row.hash === next.row.hash &&
previous.cellWidth === next.cellWidth &&
previous.cellHeight === next.cellHeight &&
previous.fontFamily === next.fontFamily &&
previous.fontSize === next.fontSize &&
previous.styleEpoch === next.styleEpoch
);
});
export function TerminalGridView({
state,
xtermTheme = DEFAULT_TERMINAL_THEME,
@@ -301,129 +63,60 @@ export function TerminalGridView({
selection = null,
onCellMetricsChange,
}: TerminalGridViewProps) {
const [metrics, setMetrics] = useState<CellMetrics>(() => estimateCellMetrics(fontSize));
const { fontScale } = useWindowDimensions();
const [cellWidth, setCellWidth] = useState<number | null>(null);
const [viewportWidth, setViewportWidth] = useState<number | null>(null);
const measuredMetricsRef = useRef<TerminalGridCellMetrics | null>(null);
const [viewport, setViewport] = useState<TerminalGridViewport | null>(null);
const resolvedFontFamily = useMemo(
() => resolveNativeTerminalFontFamily(fontFamily),
[fontFamily],
);
const resolver = useMemo(() => createTerminalCellStyleResolver(xtermTheme), [xtermTheme]);
const visibleCols = useMemo(() => {
const viewportWidth = viewport?.width ?? state.cols * metrics.cellWidth;
return resolveVisibleCols({
viewportWidth,
cellWidth: metrics.cellWidth,
gridCols: state.cols,
});
}, [metrics.cellWidth, state.cols, viewport?.width]);
const projectedGrid = useMemo(
() => state.grid.map((row) => row.slice(0, visibleCols)),
[state.grid, visibleCols],
const theme = useMemo<PaseoTerminalTheme>(
() => ({
background: resolver.backgroundColor,
cursor: resolver.cursorColor,
selectionBackground: NATIVE_TERMINAL_SELECTION_COLORS.background,
}),
[resolver],
);
const rows = useMemo(
() =>
buildRows({
grid: projectedGrid,
resolver,
selection: selection
? {
range: selection,
firstRow: state.firstRow,
backgroundColor: NATIVE_TERMINAL_SELECTION_COLORS.background,
foregroundColor: NATIVE_TERMINAL_SELECTION_COLORS.foreground,
}
: undefined,
}),
[projectedGrid, resolver, selection, state.firstRow],
const columns = resolveVisibleCols({ viewportWidth, cellWidth, gridCols: state.cols });
const frame = useMemo(
() => buildTerminalFrame({ state, columns, resolver, selection }),
[columns, resolver, selection, state],
);
const containerStyle = useMemo<StyleProp<ViewStyle>>(
() => [styles.root, { backgroundColor: resolver.backgroundColor }, style],
[resolver.backgroundColor, style],
);
const gridStyle = useMemo<StyleProp<ViewStyle>>(
() => [
styles.grid,
{
width: visibleCols * metrics.cellWidth,
height: state.grid.length * metrics.cellHeight,
},
],
[metrics.cellHeight, metrics.cellWidth, state.grid.length, visibleCols],
);
const measureStyle = useMemo<StyleProp<TextStyle>>(
() => [styles.measureText, { fontFamily: resolvedFontFamily, fontSize }],
[resolvedFontFamily, fontSize],
);
const cursorStyle = useMemo<StyleProp<ViewStyle>>(() => {
const cursorOffset = resolveTerminalCursorOffset({
cursorCol: state.cursor.col,
cursorRow: state.cursor.row,
metrics,
});
return [
styles.cursor,
{
backgroundColor: resolver.cursorColor,
width: metrics.cellWidth,
height: metrics.cellHeight,
transform: [{ translateX: cursorOffset.x }, { translateY: cursorOffset.y }],
},
];
}, [metrics, state.cursor.col, state.cursor.row, resolver.cursorColor]);
const handleMeasure = useCallback(
(event: LayoutChangeEvent) => {
const nextMetrics = resolveMeasuredTerminalCellMetrics({
measuredTextWidth: event.nativeEvent.layout.width,
measuredTextHeight: event.nativeEvent.layout.height,
measureTextLength: MEASURE_TEXT.length,
roundToNearestPixel: (value) => PixelRatio.roundToNearestPixel(value),
});
const handleCellMetrics = useCallback(
(metrics: PaseoTerminalCellMetrics) => {
const changedMetrics = resolveTerminalGridMetricsMeasurement(
measuredMetricsRef.current,
nextMetrics,
metrics,
);
if (!changedMetrics) {
return;
}
measuredMetricsRef.current = changedMetrics;
setMetrics(changedMetrics);
setCellWidth(changedMetrics.cellWidth);
onCellMetricsChange?.(changedMetrics);
},
[onCellMetricsChange],
);
const handleContainerLayout = useCallback((event: LayoutChangeEvent) => {
const { width, height } = event.nativeEvent.layout;
setViewport((current) => {
if (current?.width === width && current.height === height) {
return current;
}
return { width, height };
});
const { width } = event.nativeEvent.layout;
setViewportWidth((current) => (current === width ? current : width));
}, []);
return (
<View onLayout={handleContainerLayout} pointerEvents="none" style={containerStyle}>
<View style={gridStyle}>
<Text onLayout={handleMeasure} pointerEvents="none" style={measureStyle}>
{MEASURE_TEXT}
</Text>
{rows.map((row) => (
<MemoTerminalGridRow
key={row.index}
row={row}
cellWidth={metrics.cellWidth}
cellHeight={metrics.cellHeight}
fontFamily={resolvedFontFamily}
fontSize={fontSize}
styleEpoch={resolver.themeKey}
/>
))}
{!state.cursor.hidden && <View pointerEvents="none" style={cursorStyle} />}
</View>
<View onLayout={handleContainerLayout} pointerEvents="none" style={[styles.root, style]}>
<PaseoTerminalView
frame={frame}
theme={theme}
fontFamily={resolvedFontFamily}
fontSize={fontSize * fontScale}
onCellMetrics={handleCellMetrics}
style={styles.surface}
/>
</View>
);
}
@@ -432,38 +125,7 @@ const styles = StyleSheet.create({
root: {
overflow: "hidden",
},
grid: {
position: "relative",
},
row: {
flexDirection: "row",
},
run: {
overflow: "hidden",
},
customGlyphRun: {
surface: {
flex: 1,
position: "relative",
},
customGlyphSvg: {
left: 0,
position: "absolute",
top: 0,
},
rowText: {
includeFontPadding: false,
margin: 0,
padding: 0,
},
measureText: {
includeFontPadding: false,
opacity: 0,
position: "absolute",
},
cursor: {
left: 0,
opacity: 0.45,
position: "absolute",
top: 0,
},
});
@@ -1,120 +0,0 @@
import type { TerminalCell } from "@getpaseo/protocol/messages";
import { describe, expect, test } from "vitest";
import { createTerminalCellStyleResolver, DEFAULT_TERMINAL_THEME } from "./colors";
import { buildRows } from "./terminal-row-model";
function cell(
char: string,
overrides: Partial<TerminalCell> & { width?: number } = {},
): TerminalCell & { width?: number } {
return { char, ...overrides };
}
describe("terminal row model", () => {
test("preserves terminal cell width for styled runs and trailing spaces", () => {
const resolver = createTerminalCellStyleResolver(DEFAULT_TERMINAL_THEME);
const rows = buildRows({
grid: [
[cell("n", { bg: 2, bgMode: 1 }), cell("v", { bg: 2, bgMode: 1 }), cell(" "), cell(" ")],
],
resolver,
});
expect(rows[0].runs.map((run) => ({ text: run.text, cellCount: run.cellCount }))).toEqual([
{ text: "nv", cellCount: 2 },
{ text: " ", cellCount: 2 },
]);
});
test("uses xterm's authoritative width instead of guessing from the code point", () => {
const resolver = createTerminalCellStyleResolver(DEFAULT_TERMINAL_THEME);
const rows = buildRows({
grid: [[cell("A", { width: 2 }), cell(" ", { width: 0 }), cell("界", { width: 1 })]],
resolver,
});
expect(rows[0].runs.map((run) => ({ text: run.text, cellCount: run.cellCount }))).toEqual([
{ text: "A界", cellCount: 3 },
]);
});
test("redraws selected cells with the terminal selection colors", () => {
const resolver = createTerminalCellStyleResolver(DEFAULT_TERMINAL_THEME);
const grid = [[cell("a", { fg: 1, fgMode: 1 }), cell("b", { dim: true }), cell("c")]];
const rows = buildRows({
grid,
resolver,
selection: {
range: {
start: { row: 7, col: 1 },
end: { row: 7, col: 2 },
coordinateEpoch: 1,
},
firstRow: 7,
backgroundColor: "#ffff00",
foregroundColor: "#000000",
},
});
expect(
rows[0].runs.map((run) => ({
text: run.text,
color: run.style.color,
backgroundColor: run.style.backgroundColor,
opacity: run.style.opacity,
})),
).toEqual([
{
text: "a",
color: DEFAULT_TERMINAL_THEME.red,
backgroundColor: undefined,
opacity: undefined,
},
{ text: "b", color: "#000000", backgroundColor: "#ffff00", opacity: 1 },
{ text: "c", color: "#000000", backgroundColor: "#ffff00", opacity: 1 },
]);
expect(rows[0].hash).not.toBe(buildRows({ grid, resolver })[0].hash);
});
test("splits Claude box drawing from font text at exact terminal columns", () => {
const resolver = createTerminalCellStyleResolver(DEFAULT_TERMINAL_THEME);
const frame = "╭─ Claude Code ───╮";
const [row] = buildRows({
grid: [frame.split("").map((char) => cell(char, { fg: 1, fgMode: 1 }))],
resolver,
});
expect(
row.runs.map((run) => ({
text: run.text,
cellCount: run.cellCount,
renderKind: run.renderKind,
})),
).toEqual([
{ text: "╭─", cellCount: 2, renderKind: "custom-glyph" },
{ text: " Claude Code ", cellCount: 13, renderKind: "text" },
{ text: "───╮", cellCount: 4, renderKind: "custom-glyph" },
]);
});
test("keeps Claude mascot glyphs custom while preserving copied row text", () => {
const resolver = createTerminalCellStyleResolver(DEFAULT_TERMINAL_THEME);
const mascot = "▐▛███▜▌ Claude Code";
const [row] = buildRows({
grid: [mascot.split("").map((char) => cell(char, { fg: 1, fgMode: 1 }))],
resolver,
});
expect(row.runs.map((run) => [run.text, run.renderKind])).toEqual([
["▐▛███▜▌", "custom-glyph"],
[" Claude Code", "text"],
]);
expect(row.runs.map((run) => run.text).join("")).toBe(mascot);
});
});
@@ -1,253 +0,0 @@
import type { TextStyle } from "react-native";
import type { TerminalCell } from "@getpaseo/protocol/messages";
import type { TerminalCellStyleResolver } from "./colors";
import { resolveTerminalCustomGlyph, type TerminalCustomGlyph } from "./terminal-custom-glyph";
import type { TerminalSelectionRange } from "./terminal-selection";
const WIDE_CHAR_RANGES: ReadonlyArray<readonly [number, number]> = [
[0x1100, 0x115f],
[0x2329, 0x232a],
[0x2e80, 0xa4cf],
[0xac00, 0xd7a3],
[0xf900, 0xfaff],
[0xfe10, 0xfe19],
[0xfe30, 0xfe6f],
[0xff00, 0xff60],
[0xffe0, 0xffe6],
[0x1f300, 0x1faff],
];
interface TerminalRunBase {
key: string;
text: string;
cellCount: number;
styleKey: string;
style: TextStyle;
foregroundColor: string;
}
export interface TerminalTextRun extends TerminalRunBase {
renderKind: "text";
}
export interface TerminalCustomGlyphRun extends TerminalRunBase {
renderKind: "custom-glyph";
glyphs: TerminalCustomGlyphCell[];
}
export type TerminalRun = TerminalCustomGlyphRun | TerminalTextRun;
export interface TerminalCustomGlyphCell {
key: string;
offset: number;
glyph: TerminalCustomGlyph;
}
export interface TerminalRowModel {
index: number;
hash: string;
runs: TerminalRun[];
}
type TerminalRenderableCell = TerminalCell & { width?: number };
interface TerminalRowSelectionStyle {
range: TerminalSelectionRange;
firstRow: number;
backgroundColor: string;
foregroundColor: string;
}
function hashStringPart(hash: number, value: string): number {
let nextHash = hash;
for (let index = 0; index < value.length; index += 1) {
nextHash = Math.imul(nextHash ^ value.charCodeAt(index), 16777619);
}
return nextHash;
}
function finishHash(hash: number): string {
return (hash >>> 0).toString(36);
}
function terminalCharWidth(char: string): number {
const codePoint = char.codePointAt(0);
if (codePoint === undefined) return 1;
const isWide = WIDE_CHAR_RANGES.some(([start, end]) => codePoint >= start && codePoint <= end);
return isWide ? 2 : 1;
}
function shouldSkipSpacerCell(cells: TerminalRenderableCell[], col: number, char: string): boolean {
if (terminalCharWidth(char) < 2) {
return false;
}
return cells[col + 1]?.char === " ";
}
function terminalCellCount(cells: TerminalRenderableCell[], col: number, char: string): number {
const authoritativeWidth = cells[col]?.width;
if (authoritativeWidth !== undefined) {
return Math.max(1, authoritativeWidth);
}
if (shouldSkipSpacerCell(cells, col, char)) {
return 2;
}
return 1;
}
function appendRun(input: {
runs: TerminalRun[];
text: string;
cellCount: number;
styleKey: string;
style: TextStyle;
foregroundColor: string;
customGlyph: TerminalCustomGlyph | null;
col: number;
}): void {
const renderKind = input.customGlyph ? "custom-glyph" : "text";
const previousRun = input.runs[input.runs.length - 1];
if (
previousRun &&
previousRun.styleKey === input.styleKey &&
previousRun.renderKind === renderKind
) {
const offset = previousRun.cellCount;
previousRun.text += input.text;
previousRun.cellCount += input.cellCount;
if (previousRun.renderKind === "custom-glyph" && input.customGlyph) {
previousRun.glyphs.push({
key: `${input.col}:${input.text}`,
offset,
glyph: input.customGlyph,
});
}
return;
}
const baseRun: TerminalRunBase = {
key: `${input.col}:${input.styleKey}`,
text: input.text,
cellCount: input.cellCount,
styleKey: input.styleKey,
style: input.style,
foregroundColor: input.foregroundColor,
};
if (input.customGlyph) {
input.runs.push({
...baseRun,
renderKind: "custom-glyph",
glyphs: [{ key: `${input.col}:${input.text}`, offset: 0, glyph: input.customGlyph }],
});
return;
}
input.runs.push({ ...baseRun, renderKind: "text" });
}
function cellIntersectsSelection(input: {
selection: TerminalRowSelectionStyle;
row: number;
col: number;
cellCount: number;
}): boolean {
const absoluteRow = input.selection.firstRow + input.row;
const { start, end } = input.selection.range;
if (absoluteRow < start.row || absoluteRow > end.row) {
return false;
}
const selectedStartCol = absoluteRow === start.row ? start.col : 0;
const selectedEndCol = absoluteRow === end.row ? end.col : Number.POSITIVE_INFINITY;
const cellEndCol = input.col + input.cellCount - 1;
return cellEndCol >= selectedStartCol && input.col <= selectedEndCol;
}
function selectedCellStyle(input: {
style: TextStyle;
foregroundColor: string;
backgroundColor: string;
}): TextStyle {
return {
...input.style,
backgroundColor: input.backgroundColor,
color: input.foregroundColor,
opacity: 1,
...(input.style.textDecorationLine
? { textDecorationColor: input.foregroundColor }
: undefined),
};
}
function buildRowModel(input: {
cells: TerminalRenderableCell[];
index: number;
resolver: TerminalCellStyleResolver;
selection?: TerminalRowSelectionStyle;
}): TerminalRowModel {
const runs: TerminalRun[] = [];
let hash = 2166136261;
for (let col = 0; col < input.cells.length; col += 1) {
const cell = input.cells[col];
const text = cell.char || " ";
const resolvedStyle = input.resolver.resolve(cell);
const cellCount = terminalCellCount(input.cells, col, text);
const customGlyph = resolveTerminalCustomGlyph(text);
const selection = input.selection;
let styleKey = resolvedStyle.key;
let style = resolvedStyle.style;
let foregroundColor = resolvedStyle.foregroundColor;
if (
selection &&
cellIntersectsSelection({
selection,
row: input.index,
col,
cellCount,
})
) {
styleKey = `${resolvedStyle.key}|selection:${selection.foregroundColor}:${selection.backgroundColor}`;
style = selectedCellStyle({
style: resolvedStyle.style,
foregroundColor: selection.foregroundColor,
backgroundColor: selection.backgroundColor,
});
foregroundColor = selection.foregroundColor;
}
appendRun({
runs,
text,
cellCount,
styleKey,
style,
foregroundColor,
customGlyph,
col,
});
hash = hashStringPart(hash, text);
hash = hashStringPart(hash, String(cellCount));
hash = hashStringPart(hash, styleKey);
hash = hashStringPart(hash, customGlyph ? "custom-glyph" : "text");
if (cellCount > 1) {
col += 1;
}
}
return {
index: input.index,
hash: finishHash(hash),
runs,
};
}
export function buildRows(input: {
grid: TerminalRenderableCell[][];
resolver: TerminalCellStyleResolver;
selection?: TerminalRowSelectionStyle;
}): TerminalRowModel[] {
return input.grid.map((cells, index) =>
buildRowModel({ cells, index, resolver: input.resolver, selection: input.selection }),
);
}
@@ -54,16 +54,19 @@ describe("native terminal scrollback retention", () => {
scrollbackLines: SCROLLBACK,
lineCount: SCROLLBACK + ROWS + 10,
});
const state = terminal.getState();
const bounds = terminal.getBufferBounds();
expect(state.scrollback.length).toBeGreaterThan(0);
expect(state.scrollback.length).toBeLessThanOrEqual(SCROLLBACK);
const historyRows = bounds.bottomViewport.firstRow - bounds.oldestRow;
expect(historyRows).toBeGreaterThan(0);
expect(historyRows).toBeLessThanOrEqual(SCROLLBACK);
expect(bounds.newestRow).toBeGreaterThan(ROWS);
expect(bounds.oldestRow).toBeGreaterThan(0);
expect(bounds.newestRow - bounds.oldestRow + 1).toBe(
state.scrollback.length + state.grid.length,
);
const retained = terminal.getBufferWindow({
startRow: bounds.oldestRow,
rowCount: SCROLLBACK + ROWS + 1,
});
expect(retained.rows).toHaveLength(SCROLLBACK + ROWS);
expect(rowText(retained.rows[0]!)).toBe(expectedBenchmarkLine(bounds.oldestRow));
});
test("observable scrollback count is bounded by configured lines", async () => {
@@ -73,9 +76,9 @@ describe("native terminal scrollback retention", () => {
scrollbackLines: SCROLLBACK,
lineCount: SCROLLBACK * 3,
});
const state = terminal.getState();
expect(state.scrollback.length).toBe(SCROLLBACK);
const bounds = terminal.getBufferBounds();
expect(bounds.bottomViewport.firstRow - bounds.oldestRow).toBe(SCROLLBACK);
});
test("scroll up moves viewport into retained history", async () => {
@@ -0,0 +1,411 @@
import { describe, expect, it } from "vitest";
import { createNativeHeadlessTerminal } from "./headless-terminal-state";
import {
createTerminalSelectionModel,
extractTerminalSelectedText,
resolveTerminalSelectionRects,
} from "./terminal-selection";
import {
createTerminalSelectionController,
terminalSelectionHandles,
} from "./terminal-selection-controller";
describe("selection handle controller", () => {
it("preserves the grab offset while moving a handle", () => {
const range = { start: { row: 1, col: 2 }, end: { row: 1, col: 5 }, coordinateEpoch: 0 };
const moves: Array<{ row: number; col: number }> = [];
const controller = createTerminalSelectionController({
getGeometry: () => ({
range,
viewport: { firstRow: 0, rows: 10, cols: 10 },
metrics: { cellWidth: 10, cellHeight: 10 },
}),
onBeginHandle: () => {},
onMoveHandle: (coordinate) => moves.push(coordinate),
onLongPress: () => {},
onTap: () => {},
onScroll: () => {},
schedule: () => 1,
cancel: () => {},
});
controller.press({ x: 23, y: 15 });
controller.move({ x: 63, y: 15 });
controller.release();
expect(moves).toEqual([{ row: 1, col: 5 }]);
});
});
it("selects on hold, preserves a handle tap, and cancels an active drag", () => {
const actions: string[] = [];
let timer: (() => void) | null = null;
const controller = createTerminalSelectionController({
getGeometry: () => ({
range: { start: { row: 2, col: 2 }, end: { row: 2, col: 5 }, coordinateEpoch: 0 },
viewport: { firstRow: 0, rows: 10, cols: 10 },
metrics: { cellWidth: 10, cellHeight: 10 },
}),
onBeginHandle: (endpoint) => actions.push(endpoint),
onMoveHandle: () => actions.push("move"),
onLongPress: () => actions.push("long"),
onTap: () => actions.push("tap"),
onScroll: () => actions.push("scroll"),
schedule: (callback) => {
timer = callback;
return 1;
},
cancel: () => {
timer = null;
},
});
controller.press({ x: 90, y: 80 });
(timer as (() => void) | null)?.();
controller.release();
controller.press({ x: 20, y: 25 });
controller.release();
controller.press({ x: 20, y: 25 });
controller.cancel();
controller.move({ x: 50, y: 25 });
expect(actions).toEqual(["long", "start", "start"]);
});
it("scrolls selection into history while holding a handle at the edge", () => {
let firstRow = 10;
let timer: (() => void) | null = null;
const coordinates: Array<{ row: number; col: number }> = [];
const controller = createTerminalSelectionController({
getGeometry: () => ({
range: { start: { row: 12, col: 2 }, end: { row: 13, col: 5 }, coordinateEpoch: 0 },
viewport: { firstRow, rows: 10, cols: 10 },
metrics: { cellWidth: 10, cellHeight: 10 },
}),
onBeginHandle: () => {},
onMoveHandle: (point) => coordinates.push(point),
onLongPress: () => {},
onTap: () => {},
onScroll: (direction) => {
if (direction === "up") firstRow--;
},
schedule: (callback) => {
timer = callback;
return 1;
},
cancel: () => {
timer = null;
},
});
controller.press({ x: 20, y: 25 });
controller.move({ x: 20, y: 1 });
(timer as (() => void) | null)?.();
(timer as (() => void) | null)?.();
controller.release();
expect(coordinates).toEqual([
{ row: 10, col: 2 },
{ row: 9, col: 2 },
{ row: 8, col: 2 },
]);
expect(timer).toBeNull();
});
it("scrolls outside handles without clearing selection and clears on an outside tap", () => {
const actions: string[] = [];
const controller = createTerminalSelectionController({
getGeometry: () => ({
range: { start: { row: 2, col: 2 }, end: { row: 2, col: 5 }, coordinateEpoch: 0 },
viewport: { firstRow: 0, rows: 10, cols: 10 },
metrics: { cellWidth: 10, cellHeight: 10 },
}),
onBeginHandle: () => actions.push("handle"),
onMoveHandle: () => actions.push("move"),
onLongPress: () => actions.push("long"),
onTap: () => actions.push("tap"),
onScroll: (direction, rows) => actions.push(`${direction}:${rows}`),
schedule: () => 1,
cancel: () => {},
});
controller.press({ x: 95, y: 70 });
controller.move({ x: 95, y: 90 });
controller.release();
controller.press({ x: 95, y: 70 });
controller.release();
expect(actions).toEqual(["up:2", "tap"]);
});
it("extends the selection after a long press and drag", () => {
let timer: (() => void) | null = null;
const moves: Array<{ row: number; col: number }> = [];
const controller = createTerminalSelectionController({
getGeometry: () => ({
range: null,
viewport: { firstRow: 0, rows: 10, cols: 10 },
metrics: { cellWidth: 10, cellHeight: 10 },
}),
onBeginHandle: () => {},
onMoveHandle: (coordinate) => moves.push(coordinate),
onLongPress: () => {},
onTap: () => {},
onScroll: () => {},
schedule: (callback) => {
timer = callback;
return 1;
},
cancel: () => {
timer = null;
},
});
controller.press({ x: 25, y: 25 });
(timer as (() => void) | null)?.();
controller.move({ x: 65, y: 35 });
controller.release();
expect(moves).toEqual([{ row: 3, col: 6 }]);
});
it.each([
{
endpoint: "start" as const,
startX: 20,
crossedX: 80,
crossedText: "gh",
crossedStart: 6,
crossedEnd: 7,
backX: 10,
backText: "bcdef",
backStart: 1,
backEnd: 5,
},
{
endpoint: "end" as const,
startX: 60,
crossedX: 10,
crossedText: "b",
crossedStart: 1,
crossedEnd: 1,
backX: 80,
backText: "cdefgh",
backStart: 2,
backEnd: 7,
},
])("tracks the $endpoint handle through crossing and back", async (scenario) => {
const terminal = createNativeHeadlessTerminal({ rows: 4, cols: 10 });
try {
await terminal.write("abcdefghij");
const bounds = terminal.getBufferBounds();
const model = createTerminalSelectionModel();
model.begin({ coordinate: { row: 0, col: 2 }, bounds });
model.update({ coordinate: { row: 0, col: 5 }, bounds });
const viewport = { firstRow: 0, rows: 4, cols: 10 };
const metrics = { cellWidth: 10, cellHeight: 10 };
const geometry = () => ({ range: model.getSnapshot().range, viewport, metrics });
const controller = createTerminalSelectionController({
getGeometry: geometry,
onBeginHandle: (endpoint, cols) => model.beginEndpointDrag(endpoint, cols),
onMoveHandle: (coordinate) => {
model.update({ coordinate, bounds });
},
onLongPress: () => {},
onTap: () => {},
onScroll: () => {},
schedule: () => 1,
cancel: () => {},
});
const check = (start: number, end: number, text: string) => {
const range = model.getSnapshot().range;
expect(range).toEqual({
start: { row: 0, col: start },
end: { row: 0, col: end },
coordinateEpoch: bounds.coordinateEpoch,
});
expect(terminalSelectionHandles(geometry())).toMatchObject([
{ endpoint: "start", x: start * 10, y: 5 },
{ endpoint: "end", x: (end + 1) * 10, y: 5 },
]);
expect(resolveTerminalSelectionRects({ selection: range, viewport, metrics })).toEqual([
{
key: `0:${start}:${end}`,
x: start * 10,
y: 0,
width: (end - start + 1) * 10,
height: 10,
},
]);
expect(extractTerminalSelectedText({ terminal, selection: range })).toBe(text);
};
controller.press({ x: scenario.startX, y: 5 });
controller.move({ x: scenario.crossedX, y: 5 });
check(scenario.crossedStart, scenario.crossedEnd, scenario.crossedText);
controller.move({ x: scenario.backX, y: 5 });
check(scenario.backStart, scenario.backEnd, scenario.backText);
controller.release();
} finally {
terminal.dispose();
}
});
it.each([
{
endpoint: "end" as const,
initialRow: 0,
targetRow: 1,
targetX: 0,
expectedRow: 0,
expectedCol: 9,
text: "cdefghij",
},
{
endpoint: "start" as const,
initialRow: 1,
targetRow: 0,
targetX: 100,
expectedRow: 1,
expectedCol: 0,
text: "KLMNOP",
},
])("preserves a $endpoint boundary at a row edge", async (scenario) => {
const terminal = createNativeHeadlessTerminal({ rows: 4, cols: 10 });
try {
await terminal.write("abcdefghij\r\nKLMNOPQRST");
const bounds = terminal.getBufferBounds();
const model = createTerminalSelectionModel();
model.begin({ coordinate: { row: scenario.initialRow, col: 2 }, bounds });
model.update({ coordinate: { row: scenario.initialRow, col: 5 }, bounds });
const viewport = { firstRow: 0, rows: 4, cols: 10 };
const metrics = { cellWidth: 10, cellHeight: 10 };
const geometry = () => ({ range: model.getSnapshot().range, viewport, metrics });
const controller = createTerminalSelectionController({
getGeometry: geometry,
onBeginHandle: (endpoint, cols) => model.beginEndpointDrag(endpoint, cols),
onMoveHandle: (coordinate) => {
model.update({ coordinate, bounds });
},
onLongPress: () => {},
onTap: () => {},
onScroll: () => {},
schedule: () => 1,
cancel: () => {},
});
controller.press({ x: scenario.endpoint === "end" ? 60 : 20, y: scenario.initialRow * 10 + 5 });
controller.move({ x: scenario.targetX, y: scenario.targetRow * 10 + 5 });
const range = model.getSnapshot().range;
expect(range?.[scenario.endpoint]).toEqual({
row: scenario.expectedRow,
col: scenario.expectedCol,
});
expect(extractTerminalSelectedText({ terminal, selection: range })).toBe(scenario.text);
expect(
terminalSelectionHandles(geometry()).find((handle) => handle.endpoint === scenario.endpoint),
).toMatchObject({
x: scenario.endpoint === "end" ? 100 : 0,
y: scenario.expectedRow * 10 + 5,
});
controller.release();
} finally {
terminal.dispose();
}
});
it("cancels a drag when buffer coordinates are invalidated", () => {
const model = createTerminalSelectionModel();
const bounds = { oldestRow: 0, newestRow: 9, coordinateEpoch: 0 };
model.begin({ coordinate: { row: 2, col: 2 }, bounds });
model.update({ coordinate: { row: 2, col: 5 }, bounds });
const viewport = { firstRow: 0, rows: 10, cols: 10 };
const metrics = { cellWidth: 10, cellHeight: 10 };
const controller = createTerminalSelectionController({
getGeometry: () => ({ range: model.getSnapshot().range, viewport, metrics }),
onBeginHandle: (endpoint, cols) => model.beginEndpointDrag(endpoint, cols),
onMoveHandle: (coordinate) => {
model.update({ coordinate, bounds });
},
onLongPress: () => {},
onTap: () => {},
onScroll: () => {},
schedule: () => 1,
cancel: () => {},
});
controller.press({ x: 20, y: 25 });
const previous = model.getSnapshot().range;
const snapshot = model.sync({ bounds: { ...bounds, coordinateEpoch: 1 } });
if (previous && !snapshot.range) controller.cancel();
controller.move({ x: 80, y: 25 });
controller.release();
expect(model.getSnapshot().range).toBeNull();
});
it("preserves a newly selected word through small movement at the viewport edge", () => {
const model = createTerminalSelectionModel();
const bounds = { oldestRow: 0, newestRow: 9, coordinateEpoch: 0 };
let timer: (() => void) | null = null;
const controller = createTerminalSelectionController({
getGeometry: () => ({
range: model.getSnapshot().range,
viewport: { firstRow: 0, rows: 10, cols: 20 },
metrics: { cellWidth: 10, cellHeight: 10 },
}),
onBeginHandle: (endpoint, cols) => model.beginEndpointDrag(endpoint, cols),
onMoveHandle: (coordinate) => {
model.update({ coordinate, bounds });
},
onLongPress: () => {
model.begin({ coordinate: { row: 0, col: 2 }, bounds });
model.update({ coordinate: { row: 0, col: 6 }, bounds });
},
onTap: () => {},
onScroll: () => {},
schedule: (callback) => {
timer = callback;
return 1;
},
cancel: () => {
timer = null;
},
});
controller.press({ x: 45, y: 5 });
const fire = timer as (() => void) | null;
timer = null;
fire?.();
controller.move({ x: 44, y: 4 });
controller.release();
expect(model.getSnapshot().range).toEqual({
start: { row: 0, col: 2 },
end: { row: 0, col: 6 },
coordinateEpoch: 0,
});
expect(timer).toBeNull();
});
it("places mirrored teardrop grips below the selected row", () => {
const handles = terminalSelectionHandles({
range: { start: { row: 2, col: 2 }, end: { row: 2, col: 5 }, coordinateEpoch: 0 },
viewport: { firstRow: 0, rows: 10, cols: 10 },
metrics: { cellWidth: 10, cellHeight: 10 },
});
expect(handles).toMatchObject([
{ endpoint: "start", x: 20, y: 25, gripX: 11, gripY: 39, gripDirection: "left" },
{ endpoint: "end", x: 60, y: 25, gripX: 69, gripY: 39, gripDirection: "right" },
]);
});
it("keeps edge grips reachable and preserves the offset from the cell when dragging a grip", () => {
const range = { start: { row: 0, col: 0 }, end: { row: 9, col: 9 }, coordinateEpoch: 0 };
const viewport = { firstRow: 0, rows: 10, cols: 10 };
const metrics = { cellWidth: 10, cellHeight: 10 };
const handles = terminalSelectionHandles({ range, viewport, metrics });
expect(handles.map(({ gripX, gripY }) => ({ gripX, gripY }))).toEqual([
{ gripX: 9, gripY: 19 },
{ gripX: 91, gripY: 81 },
]);
const moves: Array<{ row: number; col: number }> = [];
const controller = createTerminalSelectionController({
getGeometry: () => ({ range, viewport, metrics }),
onBeginHandle: () => {},
onMoveHandle: (coordinate) => moves.push(coordinate),
onLongPress: () => {},
onTap: () => {},
onScroll: () => {},
schedule: () => 1,
cancel: () => {},
});
controller.press({ x: 9, y: 19 });
controller.move({ x: 19, y: 29 });
controller.release();
expect(moves).toEqual([{ row: 1, col: 1 }]);
});
@@ -0,0 +1,208 @@
import type { TerminalGridCellMetrics } from "./terminal-grid-metrics";
import type {
TerminalBufferCoordinate,
TerminalSelectionPoint,
TerminalSelectionRange,
TerminalSelectionViewport,
} from "./terminal-selection";
export const TERMINAL_SELECTION_GRIP_SIZE = 18;
const TERMINAL_GESTURE_LONG_PRESS_MS = 450;
const TERMINAL_GESTURE_TAP_TOLERANCE_PX = 8;
type Endpoint = "start" | "end";
interface Geometry {
range: TerminalSelectionRange | null;
viewport: TerminalSelectionViewport;
metrics: TerminalGridCellMetrics;
}
interface Ports {
getGeometry(): Geometry | null;
onBeginHandle(endpoint: Endpoint, cols: number): void;
onMoveHandle(coordinate: TerminalBufferCoordinate): void;
onLongPress(point: TerminalSelectionPoint): void;
onTap(): void;
onScroll(direction: "up" | "down", rows: number): void;
schedule(callback: () => void, delay: number): number;
cancel(timer: number): void;
}
export function terminalSelectionHandles(geometry: Geometry): Array<{
endpoint: Endpoint;
x: number;
y: number;
gripX: number;
gripY: number;
gripDirection: "left" | "right";
gripAbove: boolean;
stemTop: number;
stemHeight: number;
}> {
const { range, viewport, metrics } = geometry;
if (!range) return [];
return (["start", "end"] as const).flatMap((endpoint) => {
const cell = range[endpoint];
if (cell.row < viewport.firstRow || cell.row >= viewport.firstRow + viewport.rows) return [];
const x = (cell.col + (endpoint === "end" ? 1 : 0)) * metrics.cellWidth;
const stemTop = (cell.row - viewport.firstRow) * metrics.cellHeight;
const size = TERMINAL_SELECTION_GRIP_SIZE;
const width = viewport.cols * metrics.cellWidth;
const height = viewport.rows * metrics.cellHeight;
const wantsLeft = endpoint === "start";
const gripDirection =
(wantsLeft && x >= size) || (!wantsLeft && x > width - size) ? "left" : "right";
const gripAbove = stemTop + metrics.cellHeight + size > height;
const gripTop = gripAbove ? Math.max(0, stemTop - size) : stemTop + metrics.cellHeight;
return [
{
endpoint,
x,
y: stemTop + metrics.cellHeight / 2,
gripX: x + (gripDirection === "left" ? -size / 2 : size / 2),
gripY: gripTop + size / 2,
gripDirection,
gripAbove,
stemTop,
stemHeight: metrics.cellHeight,
},
];
});
}
export function createTerminalSelectionController(ports: Ports) {
let press: {
start: TerminalSelectionPoint;
point: TerminalSelectionPoint;
endpoint: Endpoint | null;
offset: TerminalSelectionPoint;
fixed: TerminalBufferCoordinate | null;
moved: boolean;
long: boolean;
scrolling: boolean;
remainder: number;
} | null = null;
let timer: number | null = null;
function stopTimer() {
if (timer !== null) ports.cancel(timer);
timer = null;
}
function updateHandle() {
const geometry = ports.getGeometry();
if (!press || (!press.endpoint && !press.long) || !geometry) return;
const { viewport, metrics } = geometry;
const x = press.point.x - press.offset.x;
const y = press.point.y - press.offset.y;
let row =
viewport.firstRow +
Math.max(0, Math.min(viewport.rows - 1, Math.floor(y / metrics.cellHeight)));
let col = Math.floor(x / metrics.cellWidth);
if (press.endpoint && press.fixed) {
const boundary = Math.round(x / metrics.cellWidth);
const isEnd =
row > press.fixed.row || (row === press.fixed.row && boundary > press.fixed.col);
col = boundary - (isEnd ? 1 : 0);
if (col < 0 && isEnd) {
row -= 1;
col = viewport.cols - 1;
} else if (col >= viewport.cols && !isEnd) {
row += 1;
col = 0;
}
}
col = Math.max(0, Math.min(viewport.cols - 1, col));
ports.onMoveHandle({ row, col });
}
function edgeTick() {
timer = null;
const geometry = ports.getGeometry();
if (!press || (!press.endpoint && !press.long) || !geometry) return;
const y = press.point.y - press.offset.y;
const height = geometry.viewport.rows * geometry.metrics.cellHeight;
let direction: "up" | "down" | null = null;
if (y < geometry.metrics.cellHeight) direction = "up";
else if (y > height - geometry.metrics.cellHeight) direction = "down";
if (!direction) return;
ports.onScroll(direction, 1);
if (!press) return;
updateHandle();
if (press) timer = ports.schedule(edgeTick, 100);
}
return {
press(point: TerminalSelectionPoint) {
stopTimer();
const geometry = ports.getGeometry();
const handles = geometry ? terminalSelectionHandles(geometry) : [];
const handle = handles
.map((item) => ({
endpoint: item.endpoint,
x: item.x,
y: item.y,
distance: Math.hypot(point.x - item.gripX, point.y - item.gripY),
}))
.filter((item) => item.distance <= 28)
.sort((a, b) => a.distance - b.distance)[0];
press = {
start: point,
point,
endpoint: handle?.endpoint ?? null,
offset: handle ? { x: point.x - handle.x, y: point.y - handle.y } : { x: 0, y: 0 },
fixed:
handle && geometry?.range
? geometry.range[handle.endpoint === "start" ? "end" : "start"]
: null,
moved: false,
long: false,
scrolling: false,
remainder: 0,
};
if (handle && geometry) {
ports.onBeginHandle(handle.endpoint, geometry.viewport.cols);
return;
}
timer = ports.schedule(() => {
timer = null;
if (press && !press.moved) {
press.long = true;
ports.onLongPress(press.start);
}
}, TERMINAL_GESTURE_LONG_PRESS_MS);
},
move(point: TerminalSelectionPoint) {
if (!press) return;
const previous = press.point;
press.point = point;
const dx = point.x - press.start.x,
dy = point.y - press.start.y;
if (Math.hypot(dx, dy) > TERMINAL_GESTURE_TAP_TOLERANCE_PX) {
press.moved = true;
if (!press.endpoint) stopTimer();
}
if (press.endpoint || press.long) {
if (press.endpoint || press.moved) {
updateHandle();
stopTimer();
if (press) timer = ports.schedule(edgeTick, 100);
}
} else if (!press.long) {
if (!press.scrolling && Math.abs(dy) > 12 && Math.abs(dy) > Math.abs(dx)) {
press.scrolling = true;
press.remainder = dy;
} else if (press.scrolling) press.remainder += point.y - previous.y;
const height = ports.getGeometry()?.metrics.cellHeight ?? 0;
if (press.scrolling && height > 0) {
const rows = Math.trunc(press.remainder / height);
press.remainder -= rows * height;
if (rows) ports.onScroll(rows > 0 ? "up" : "down", Math.abs(rows));
}
}
},
release() {
stopTimer();
if (press && !press.endpoint && !press.long && !press.moved) ports.onTap();
press = null;
},
cancel() {
stopTimer();
press = null;
},
};
}
@@ -1,354 +0,0 @@
import { describe, expect, it } from "vitest";
import {
TERMINAL_GESTURE_LONG_PRESS_MS,
TERMINAL_GESTURE_TAP_TOLERANCE_PX,
TERMINAL_GESTURE_VERTICAL_SCROLL_THRESHOLD_PX,
advanceTerminalScrollGesture,
classifyTerminalGestureIntent,
resolveTerminalGestureReleaseAction,
} from "./terminal-selection-gesture";
describe("native terminal gesture policy", () => {
describe("advanceTerminalScrollGesture", () => {
it("keeps consuming a slow drag after scroll intent arms below one row", () => {
let state = { lastDy: 0, rowRemainder: 0, didScroll: false };
const rowDeltas: number[] = [];
for (const currentDy of [13, 15, 18, 22, 28]) {
const update = advanceTerminalScrollGesture({
state,
currentDy,
cellHeight: 14,
});
state = update.state;
rowDeltas.push(update.rowDelta);
}
expect({ rowDeltas, state }).toEqual({
rowDeltas: [0, 1, 0, 0, 1],
state: { lastDy: 28, rowRemainder: 0, didScroll: true },
});
});
});
describe("classifyTerminalGestureIntent", () => {
it("treats a motionless press as a tap", () => {
expect(
classifyTerminalGestureIntent({
status: "pressing",
dx: 0,
dy: 0,
vx: 0,
vy: 0,
}),
).toEqual("tap");
});
it("treats a tiny jitter within tap tolerance as a tap", () => {
expect(
classifyTerminalGestureIntent({
status: "pressing",
dx: TERMINAL_GESTURE_TAP_TOLERANCE_PX - 4,
dy: TERMINAL_GESTURE_TAP_TOLERANCE_PX - 4,
vx: 0,
vy: 0,
}),
).toEqual("tap");
});
it("leaves horizontal movement available to terminal selection", () => {
expect(
classifyTerminalGestureIntent({
status: "pressing",
dx: TERMINAL_GESTURE_TAP_TOLERANCE_PX + 20,
dy: 4,
vx: 0,
vy: 0,
}),
).toEqual("pending");
});
it("does not infer selection from slow horizontal drag dwell", () => {
expect(
classifyTerminalGestureIntent({
status: "pressing",
dx: TERMINAL_GESTURE_TAP_TOLERANCE_PX + 40,
dy: 3,
vx: 0,
vy: 0,
elapsedMs: TERMINAL_GESTURE_LONG_PRESS_MS + 50,
}),
).toEqual("pending");
});
it("keeps tiny horizontal jitter inside tap tolerance as a tap", () => {
expect(
classifyTerminalGestureIntent({
status: "pressing",
dx: TERMINAL_GESTURE_TAP_TOLERANCE_PX - 1,
dy: 1,
vx: 2,
vy: 0,
elapsedMs: 20,
}),
).toEqual("tap");
});
it("keeps horizontal movement below navigation distance pending", () => {
expect(
classifyTerminalGestureIntent({
status: "pressing",
dx: TERMINAL_GESTURE_TAP_TOLERANCE_PX + 10,
dy: 2,
vx: 0,
vy: 0,
}),
).toEqual("pending");
});
it("treats a clearly vertical drag as scroll", () => {
expect(
classifyTerminalGestureIntent({
status: "pressing",
dx: 4,
dy: TERMINAL_GESTURE_VERTICAL_SCROLL_THRESHOLD_PX + 5,
vx: 0,
vy: 0.2,
}),
).toEqual("scroll");
});
it("does not navigate on a fast rightward swipe", () => {
expect(
classifyTerminalGestureIntent({
status: "pressing",
dx: TERMINAL_GESTURE_TAP_TOLERANCE_PX + 40,
dy: 4,
vx: 2,
vy: 0,
}),
).toEqual("pending");
});
it("does not navigate on a slow rightward swipe", () => {
expect(
classifyTerminalGestureIntent({
status: "pressing",
dx: TERMINAL_GESTURE_TAP_TOLERANCE_PX + 40,
dy: 4,
vx: 0,
vy: 0,
}),
).toEqual("pending");
});
it("does not navigate on a fast leftward swipe", () => {
expect(
classifyTerminalGestureIntent({
status: "pressing",
dx: -(TERMINAL_GESTURE_TAP_TOLERANCE_PX + 40),
dy: -4,
vx: -2,
vy: 0,
}),
).toEqual("pending");
});
it("does not navigate while movement stays inside tap tolerance", () => {
expect(
classifyTerminalGestureIntent({
status: "pressing",
dx: TERMINAL_GESTURE_TAP_TOLERANCE_PX - 1,
dy: 2,
vx: 2,
vy: 0,
}),
).toEqual("tap");
});
it("keeps selection intent once selection is active", () => {
expect(
classifyTerminalGestureIntent({
status: "selecting",
dx: 100,
dy: 50,
vx: 2,
vy: 1,
}),
).toEqual("select");
});
});
describe("resolveTerminalGestureReleaseAction", () => {
it("focuses the terminal after a normal tap", () => {
expect(
resolveTerminalGestureReleaseAction({
status: "pressing",
didScroll: false,
didNavigate: false,
movedBeyondTapTolerance: false,
pressDurationMs: 80,
longPressMs: TERMINAL_GESTURE_LONG_PRESS_MS,
scrollMode: "following",
}),
).toEqual("focus");
});
it("focuses the terminal after a normal tap while scrolled", () => {
expect(
resolveTerminalGestureReleaseAction({
status: "pressing",
didScroll: false,
didNavigate: false,
movedBeyondTapTolerance: false,
pressDurationMs: 80,
longPressMs: TERMINAL_GESTURE_LONG_PRESS_MS,
scrollMode: "scrolled",
}),
).toEqual("focus");
});
it("starts selection after a long press", () => {
expect(
resolveTerminalGestureReleaseAction({
status: "pressing",
didScroll: false,
didNavigate: false,
movedBeyondTapTolerance: false,
pressDurationMs: TERMINAL_GESTURE_LONG_PRESS_MS + 50,
longPressMs: TERMINAL_GESTURE_LONG_PRESS_MS,
scrollMode: "following",
}),
).toEqual("select");
});
it("starts selection after a 500ms hold", () => {
expect(
resolveTerminalGestureReleaseAction({
status: "pressing",
didScroll: false,
didNavigate: false,
movedBeyondTapTolerance: false,
pressDurationMs: 500,
longPressMs: TERMINAL_GESTURE_LONG_PRESS_MS,
scrollMode: "following",
}),
).toEqual("select");
});
it("keeps a 400ms press as a tap", () => {
expect(
resolveTerminalGestureReleaseAction({
status: "pressing",
didScroll: false,
didNavigate: false,
movedBeyondTapTolerance: false,
pressDurationMs: 400,
longPressMs: TERMINAL_GESTURE_LONG_PRESS_MS,
scrollMode: "following",
}),
).toEqual("focus");
});
it("does nothing after a scroll gesture", () => {
expect(
resolveTerminalGestureReleaseAction({
status: "pressing",
didScroll: true,
didNavigate: false,
movedBeyondTapTolerance: true,
pressDurationMs: 80,
longPressMs: TERMINAL_GESTURE_LONG_PRESS_MS,
scrollMode: "scrolled",
}),
).toEqual("none");
});
it("does nothing after a navigation swipe", () => {
expect(
resolveTerminalGestureReleaseAction({
status: "pressing",
didScroll: false,
didNavigate: true,
movedBeyondTapTolerance: true,
pressDurationMs: 80,
longPressMs: TERMINAL_GESTURE_LONG_PRESS_MS,
scrollMode: "following",
}),
).toEqual("none");
});
it("does nothing while actively selecting", () => {
expect(
resolveTerminalGestureReleaseAction({
status: "selecting",
didScroll: false,
didNavigate: false,
movedBeyondTapTolerance: true,
pressDurationMs: 80,
longPressMs: TERMINAL_GESTURE_LONG_PRESS_MS,
scrollMode: "following",
}),
).toEqual("none");
});
it("clears an existing selection after a short tap", () => {
expect(
resolveTerminalGestureReleaseAction({
status: "selecting",
startedWithSelection: true,
didScroll: false,
didNavigate: false,
movedBeyondTapTolerance: false,
pressDurationMs: 80,
longPressMs: TERMINAL_GESTURE_LONG_PRESS_MS,
scrollMode: "following",
}),
).toEqual("clear");
});
it("preserves a word selection created by the current long press", () => {
expect(
resolveTerminalGestureReleaseAction({
status: "selecting",
startedWithSelection: false,
didScroll: false,
didNavigate: false,
movedBeyondTapTolerance: false,
pressDurationMs: TERMINAL_GESTURE_LONG_PRESS_MS + 50,
longPressMs: TERMINAL_GESTURE_LONG_PRESS_MS,
scrollMode: "following",
}),
).toEqual("none");
});
it("does not focus after an undecided fast drag", () => {
expect(
resolveTerminalGestureReleaseAction({
status: "pressing",
didScroll: false,
didNavigate: false,
movedBeyondTapTolerance: true,
pressDurationMs: 80,
longPressMs: TERMINAL_GESTURE_LONG_PRESS_MS,
scrollMode: "following",
}),
).toEqual("none");
});
it("does nothing from idle", () => {
expect(
resolveTerminalGestureReleaseAction({
status: "idle",
didScroll: false,
didNavigate: false,
movedBeyondTapTolerance: false,
pressDurationMs: 80,
longPressMs: TERMINAL_GESTURE_LONG_PRESS_MS,
scrollMode: "following",
}),
).toEqual("none");
});
});
});
@@ -1,108 +0,0 @@
export type TerminalGestureStatus = "idle" | "pressing" | "selecting";
export type TerminalGestureIntent = "tap" | "pending" | "select" | "scroll";
export type TerminalGestureScrollMode = "following" | "scrolled";
export interface TerminalGestureMoveInput {
status: TerminalGestureStatus;
dx: number;
dy: number;
vx: number;
vy: number;
elapsedMs?: number;
}
export interface TerminalGestureReleaseInput {
status: TerminalGestureStatus;
startedWithSelection?: boolean;
didScroll: boolean;
didNavigate: boolean;
movedBeyondTapTolerance: boolean;
pressDurationMs: number;
longPressMs: number;
scrollMode: TerminalGestureScrollMode;
}
export interface TerminalScrollGestureState {
lastDy: number;
rowRemainder: number;
didScroll: boolean;
}
export interface TerminalScrollGestureUpdate {
state: TerminalScrollGestureState;
rowDelta: number;
}
export type TerminalGestureAction = "none" | "focus" | "select" | "clear";
export const TERMINAL_GESTURE_TAP_TOLERANCE_PX = 8;
export const TERMINAL_GESTURE_LONG_PRESS_MS = 450;
export const TERMINAL_GESTURE_VERTICAL_SCROLL_THRESHOLD_PX = 12;
export function classifyTerminalGestureIntent(
input: TerminalGestureMoveInput,
): TerminalGestureIntent {
if (input.status === "selecting") {
return "select";
}
const absDx = Math.abs(input.dx);
const absDy = Math.abs(input.dy);
if (absDy > TERMINAL_GESTURE_VERTICAL_SCROLL_THRESHOLD_PX && absDy > absDx) {
return "scroll";
}
if (Math.hypot(input.dx, input.dy) > TERMINAL_GESTURE_TAP_TOLERANCE_PX) {
return "pending";
}
return "tap";
}
export function advanceTerminalScrollGesture(input: {
state: TerminalScrollGestureState;
currentDy: number;
cellHeight: number;
}): TerminalScrollGestureUpdate {
const deltaY = input.currentDy - input.state.lastDy;
const accumulatedRows = input.state.rowRemainder + deltaY;
const rowDelta = Math.trunc(accumulatedRows / input.cellHeight);
return {
state: {
lastDy: input.currentDy,
rowRemainder: accumulatedRows - rowDelta * input.cellHeight,
didScroll: input.state.didScroll || rowDelta !== 0,
},
rowDelta,
};
}
export function resolveTerminalGestureReleaseAction(
input: TerminalGestureReleaseInput,
): TerminalGestureAction {
if (input.didScroll || input.didNavigate) {
return "none";
}
if (input.status === "selecting") {
if (!input.startedWithSelection) {
return "none";
}
return input.movedBeyondTapTolerance ? "none" : "clear";
}
if (input.status !== "pressing") {
return "none";
}
if (input.pressDurationMs >= input.longPressMs) {
return "select";
}
if (input.movedBeyondTapTolerance) {
return "none";
}
return "focus";
}
@@ -483,3 +483,51 @@ describe("native terminal selection", () => {
expect(copied).toEqual([]);
});
});
describe("endpoint dragging", () => {
it.each([
{
endpoint: "start" as const,
fixed: { row: 2, col: 9 },
target: { row: 3, col: 2 },
expected: { row: 3, col: 0 },
},
{
endpoint: "end" as const,
fixed: { row: 2, col: 0 },
target: { row: 1, col: 7 },
expected: { row: 1, col: 9 },
},
])(
"preserves the fixed boundary across a row edge for $endpoint",
({ endpoint, fixed, target, expected }) => {
const selection = createTerminalSelectionModel();
const bounds = { oldestRow: 0, newestRow: 10, coordinateEpoch: 1 };
selection.begin({ coordinate: fixed, bounds });
selection.update({ coordinate: fixed, bounds });
selection.beginEndpointDrag(endpoint, 10);
selection.update({ coordinate: target, bounds });
expect(selection.getSnapshot().range?.[endpoint === "start" ? "start" : "end"]).toEqual(
expected,
);
},
);
it.each(["start", "end"] as const)(
"keeps the opposite endpoint fixed as %s crosses it",
(endpoint) => {
const selection = createTerminalSelectionModel();
const bounds = { oldestRow: 0, newestRow: 10, coordinateEpoch: 1 };
selection.begin({ coordinate: { row: 2, col: 2 }, bounds });
selection.update({ coordinate: { row: 3, col: 4 }, bounds });
selection.beginEndpointDrag(endpoint, 10);
const coordinate = endpoint === "start" ? { row: 4, col: 5 } : { row: 1, col: 1 };
selection.update({ coordinate, bounds });
expect(selection.getSnapshot().range).toEqual(
endpoint === "start"
? { start: { row: 3, col: 5 }, end: coordinate, coordinateEpoch: 1 }
: { start: coordinate, end: { row: 2, col: 1 }, coordinateEpoch: 1 },
);
},
);
});
@@ -25,6 +25,7 @@ export interface TerminalSelectionBounds {
export interface TerminalSelectionModel {
begin(input: TerminalSelectionUpdateInput): TerminalSelectionSnapshot;
update(input: TerminalSelectionUpdateInput): TerminalSelectionSnapshot;
beginEndpointDrag(endpoint: "start" | "end", cols: number): void;
clear(): TerminalSelectionSnapshot;
sync(input: TerminalSelectionSyncInput): TerminalSelectionSnapshot;
getSnapshot(): TerminalSelectionSnapshot;
@@ -252,6 +253,7 @@ export function resolveTerminalSelectionRects(
export function createTerminalSelectionModel(): TerminalSelectionModel {
let state: TerminalSelectionState = { anchor: null, range: null };
let drag: { endpoint: "start" | "end"; cols: number } | null = null;
function snapshot(): TerminalSelectionSnapshot {
return { range: state.range };
@@ -259,18 +261,31 @@ export function createTerminalSelectionModel(): TerminalSelectionModel {
function setSelection(input: TerminalSelectionUpdateInput): TerminalSelectionSnapshot {
const coordinate = clampCoordinate(input.coordinate, input.bounds);
const anchor = state.anchor ?? coordinate;
const fixed = state.anchor ?? coordinate;
let anchor = fixed;
if (drag?.endpoint === "start" && compareCoordinates(coordinate, fixed) > 0) {
anchor =
fixed.col + 1 < drag.cols
? { row: fixed.row, col: fixed.col + 1 }
: { row: fixed.row + 1, col: 0 };
} else if (drag?.endpoint === "end" && compareCoordinates(coordinate, fixed) < 0) {
anchor =
fixed.col > 0
? { row: fixed.row, col: fixed.col - 1 }
: { row: fixed.row - 1, col: drag.cols - 1 };
}
const range = normalizeTerminalSelection({
anchor,
focus: coordinate,
coordinateEpoch: input.bounds.coordinateEpoch,
});
state = { anchor, range };
state = { anchor: fixed, range };
return snapshot();
}
return {
begin(input: TerminalSelectionUpdateInput): TerminalSelectionSnapshot {
drag = null;
const coordinate = clampCoordinate(input.coordinate, input.bounds);
state = {
anchor: coordinate,
@@ -285,7 +300,14 @@ export function createTerminalSelectionModel(): TerminalSelectionModel {
update(input: TerminalSelectionUpdateInput): TerminalSelectionSnapshot {
return setSelection(input);
},
beginEndpointDrag(endpoint, cols) {
if (state.range) {
drag = { endpoint, cols };
state = { ...state, anchor: state.range[endpoint === "start" ? "end" : "start"] };
}
},
clear(): TerminalSelectionSnapshot {
drag = null;
state = { anchor: null, range: null };
return snapshot();
},
@@ -293,6 +315,7 @@ export function createTerminalSelectionModel(): TerminalSelectionModel {
if (!state.range || rangeIsSafe(state.range, input.bounds)) {
return snapshot();
}
drag = null;
state = { anchor: null, range: null };
return snapshot();
},
@@ -166,7 +166,6 @@ function createTerminalHost(input: CreateTerminalHostInput): MountedTerminal {
runtime.mount({
root,
host,
initialSnapshot: null,
scrollback: input.scrollback ?? 10_000,
theme: {
background: "#0b0b0b",
@@ -750,30 +749,11 @@ describe("terminal emulator runtime in a real browser", () => {
const reset = vi.fn(originalReset);
terminal.reset = reset;
mounted.runtime.renderSnapshot({
state: {
rows: terminal.rows,
cols: terminal.cols,
scrollback: [],
grid: [
[
{ char: "p" },
{ char: "r" },
{ char: "o" },
{ char: "m" },
{ char: "p" },
{ char: "t" },
],
],
cursor: {
row: 0,
col: 6,
},
},
});
await nextFrame();
mounted.runtime.replay({ type: "begin", rows: terminal.rows, cols: terminal.cols });
mounted.runtime.replay({ type: "data", data: terminalOutput("prompt") });
mounted.runtime.replay({ type: "end" });
expect(reset).not.toHaveBeenCalled();
await nextFrame();
});
it("opens OSC 8 hyperlinks the same way as plain-text URLs", async () => {
@@ -795,3 +775,95 @@ describe("terminal emulator runtime in a real browser", () => {
expect(confirm).not.toHaveBeenCalled();
});
});
describe("incremental replay lifecycle", () => {
it.each(["clear", "remount"] as const)(
"recovers live input after interrupted replay and %s",
async (cleanup) => {
const mounted = createTerminalHost({ width: 720, height: 360 });
mounted.runtime.replay({ type: "begin", rows: 30, cols: 120 });
mounted.root.style.width = "360px";
mounted.runtime.resize({ shouldClaim: false });
mounted.runtime.replay({ type: "data", data: terminalOutput("interrupted") });
if (cleanup === "clear")
await new Promise<void>((resolve) => mounted.runtime.clear({ onCommitted: resolve }));
else {
mounted.runtime.unmount();
mounted.runtime.mount({
root: mounted.root,
host: mounted.host,
scrollback: 1000,
theme: {},
});
}
await new Promise<void>((resolve) =>
mounted.runtime.write({ data: terminalOutput("live"), onCommitted: resolve }),
);
getBrowserTerminal().input("user-input", true);
expect(mounted.inputs).toContain("user-input");
expect(getBrowserTerminal().cols).toBeLessThan(60);
},
);
it("suppresses generated replies until queued replay chunks commit after end", async () => {
const mounted = createTerminalHost({ width: 720, height: 360 });
mounted.runtime.replay({ type: "begin" });
mounted.runtime.replay({ type: "data", data: terminalOutput("\x1b]4;1;?\x07") });
mounted.runtime.replay({ type: "data", data: terminalOutput("\x1b]4;1;?\x07") });
mounted.runtime.replay({ type: "end" });
await new Promise<void>((resolve) =>
mounted.runtime.write({ data: terminalOutput("committed"), onCommitted: resolve }),
);
expect(mounted.inputs).toEqual([]);
await new Promise<void>((resolve) =>
mounted.runtime.write({ data: terminalOutput("\x1b]4;1;?\x07"), onCommitted: resolve }),
);
expect(mounted.inputs).toHaveLength(1);
expect(mounted.inputs[0]?.startsWith("\x1b]4;1;rgb:")).toBe(true);
});
});
it("restores fitted web geometry after replay before live output", async () => {
const mounted = createTerminalHost({ width: 720, height: 360 });
await settleMountRefits();
const local = latestSize(mounted.sizes);
mounted.runtime.replay({ type: "begin", rows: 30, cols: 120 });
mounted.runtime.replay({ type: "data", data: terminalOutput("x".repeat(100)) });
mounted.runtime.replay({ type: "end" });
await new Promise<void>((resolve) =>
mounted.runtime.write({ data: terminalOutput("LIVE"), onCommitted: resolve }),
);
expect(getBrowserTerminal().cols).toBe(latestSize(mounted.sizes).cols);
expect(getBrowserTerminal().cols).toBeLessThan(120);
expect(getBrowserTerminal().rows).toBe(local.rows);
mounted.runtime.resize({ forceClaim: true, shouldClaim: true });
expect(getBrowserTerminal().cols).toBe(latestSize(mounted.sizes).cols);
});
it("defers layout fit until all replay chunks commit", async () => {
const mounted = createTerminalHost({ width: 720, height: 360 });
await settleMountRefits();
mounted.runtime.replay({ type: "begin", rows: 30, cols: 120 });
await new Promise<void>((resolve) =>
mounted.runtime.write({
data: terminalOutput("first"),
suppressInput: true,
onCommitted: resolve,
}),
);
expect(getBrowserTerminal().cols).toBe(120);
mounted.root.style.width = "360px";
mounted.runtime.resize({ shouldClaim: true, forceClaim: true, forceRefresh: true });
await nextFrame();
expect(getBrowserTerminal().cols).toBe(120);
mounted.runtime.replay({ type: "data", data: terminalOutput("\x1b[2;110Hsecond") });
mounted.runtime.replay({ type: "end" });
await new Promise<void>((resolve) =>
mounted.runtime.write({ data: terminalOutput("LIVE"), onCommitted: resolve }),
);
expect(getBrowserTerminal().cols).toBe(latestSize(mounted.sizes).cols);
expect(getBrowserTerminal().cols).toBeLessThan(60);
expect(latestSize(mounted.sizes)).toMatchObject({ shouldClaim: true, forceClaim: true });
mounted.runtime.resize({ shouldClaim: true, forceClaim: true });
expect(getBrowserTerminal().cols).toBe(latestSize(mounted.sizes).cols);
});
@@ -302,25 +302,14 @@ describe("terminal-emulator-runtime", () => {
expect(committed).toEqual(["first", "second", "clear", "third"]);
});
it("falls back to timeout commit for a barrier op when the gate sentinel never fires", () => {
it("unblocks queued replay writes if a begin barrier never commits", () => {
vi.useFakeTimers();
const { runtime, terminal } = createRuntimeWithTerminal();
const onCommitted = vi.fn();
// restoreOutput is a barrier; if xterm never commits the gate sentinel, the barrier still
// applies (and commits) after the 5s safety timeout instead of stalling forever.
runtime.restoreOutput({
data: terminalOutput("stuck"),
onCommitted,
});
expect(onCommitted).not.toHaveBeenCalled();
expect(terminal.resetCalls).toBe(0);
vi.advanceTimersByTime(5_000);
// The barrier now runs (write submitted) but its own commit still waits on xterm; advance
// again to fire the barrier's own write timeout.
vi.advanceTimersByTime(5_000);
expect(onCommitted).toHaveBeenCalledTimes(1);
const { runtime, writeTexts } = createRuntimeWithTerminal();
runtime.replay({ type: "begin" });
runtime.replay({ type: "data", data: terminalOutput("stuck") });
expect(writeTexts).toEqual(["\x1bc"]);
vi.advanceTimersByTime(5000);
expect(writeTexts).toEqual(["\x1bc", "stuck"]);
});
it("reports input mode changes from terminal output and resets them on snapshots", () => {
@@ -343,18 +332,7 @@ describe("terminal-emulator-runtime", () => {
});
runtime.write({ data: terminalOutput("\x1b[>7u") });
runtime.renderSnapshot({
state: {
rows: 2,
cols: 8,
scrollback: [],
grid: [[{ char: "$" }, { char: " " }]],
cursor: {
row: 0,
col: 2,
},
},
});
runtime.replay({ type: "begin", rows: 2, cols: 8 });
// The plain write reports kitty flags synchronously during drain; the snapshot resets
// them only after its barrier gate (the sentinel write callback) resolves.
expect(inputModeChanges).toEqual([
@@ -410,40 +388,18 @@ describe("terminal-emulator-runtime", () => {
expect(committed).toEqual(["second", "first"]);
});
it("applies a snapshot after the writes ahead of it, never interleaving the reset", () => {
it("keeps replay reset and data after preceding writes, without interleaving", () => {
const { runtime, terminal, writeTexts, writeCallbacks } = createRuntimeWithTerminal();
const committed: string[] = [];
runtime.write({
data: terminalOutput("before-a"),
onCommitted: () => {
committed.push("before-a");
},
});
runtime.write({
data: terminalOutput("before-b"),
onCommitted: () => {
committed.push("before-b");
},
});
runtime.restoreOutput({
data: terminalOutput("snap"),
onCommitted: () => {
committed.push("snap");
},
});
// Plain writes are submitted up front; the snapshot's reset+write has not run yet.
runtime.write({ data: terminalOutput("before-a") });
runtime.write({ data: terminalOutput("before-b") });
runtime.replay({ type: "begin" });
runtime.replay({ type: "data", data: terminalOutput("snap") });
runtime.replay({ type: "end" });
expect(writeTexts).toEqual(["before-a", "before-b"]);
// writeCallbacks: [0]=before-a, [1]=before-b, [2]=barrier gate sentinel.
// The snapshot is gated behind the prior writes; resolving the gate runs it after them.
writeCallbacks[2]?.();
expect(writeTexts).toEqual(["before-a", "before-b", "csnap"]);
// Snapshot commit fires only after its own write callback, strictly after the writes.
expect(writeTexts).toEqual(["before-a", "before-b", "\x1bc"]);
writeCallbacks[3]?.();
expect(committed).toEqual(["snap"]);
expect(writeTexts).toEqual(["before-a", "before-b", "\x1bc", "snap"]);
expect(terminal.resetCalls).toBe(0);
});
@@ -456,7 +412,7 @@ describe("terminal-emulator-runtime", () => {
// No plain writes precede this barrier (mount), so there is nothing to gate: it starts
// at once with no sentinel, flipping suppressInput synchronously.
runtime.restoreOutput({ data: terminalOutput("snapshot") });
runtime.replay({ type: "begin" });
expect(readSuppressInput()).toBe(true);
// writeCallbacks[0] is the barrier's own snapshot write; committing it restores input.
@@ -471,7 +427,7 @@ describe("terminal-emulator-runtime", () => {
// A plain write is now ungated, so the following barrier must wait on the sentinel.
runtime.write({ data: terminalOutput("output") });
runtime.restoreOutput({ data: terminalOutput("snapshot") });
runtime.replay({ type: "begin" });
// The plain write commits first. Only the following sentinel opens the barrier.
expect(readSuppressInput()).toBe(false);
@@ -505,57 +461,40 @@ describe("terminal-emulator-runtime", () => {
expect(onCommittedB).toHaveBeenCalledTimes(1);
});
it("clears ungated writes on unmount so remount barriers apply immediately", () => {
it("clears ungated writes on unmount so remount replay begins immediately", () => {
const { runtime } = createRuntimeWithTerminal();
runtime.write({ data: terminalOutput("before unmount") });
runtime.unmount();
const remounted = attachStubTerminal(runtime);
runtime.restoreOutput({ data: terminalOutput("restored screen") });
expect(remounted.writeTexts).toEqual(["\u001bcrestored screen"]);
expect(remounted.writeCallbacks).toHaveLength(1);
runtime.replay({ type: "begin" });
runtime.replay({ type: "data", data: terminalOutput("restored screen") });
expect(remounted.writeTexts).toEqual(["\x1bc"]);
remounted.writeCallbacks[0]?.();
expect(remounted.writeTexts).toEqual(["\x1bc", "restored screen"]);
});
it("replays snapshots through a single write without first painting a reset terminal", () => {
it("parses replay chunks serially without synchronously resetting the terminal", () => {
const { runtime, terminal, writeTexts, writeCallbacks } = createRuntimeWithTerminal();
runtime.renderSnapshot({
state: {
rows: 2,
cols: 8,
scrollback: [],
grid: [
[{ char: "h" }, { char: "i" }],
[{ char: "$" }, { char: " " }],
],
cursor: {
row: 1,
col: 2,
},
},
});
// The snapshot is a barrier; its write applies after the gate sentinel (writeCallbacks[0]).
writeCallbacks[0]?.();
runtime.replay({ type: "begin", rows: 2, cols: 8 });
runtime.replay({ type: "data", data: terminalOutput("hi") });
runtime.replay({ type: "data", data: terminalOutput("\r\n$") });
runtime.replay({ type: "end" });
expect(terminal.resetCalls).toBe(0);
expect(writeTexts).toHaveLength(1);
expect(writeTexts[0]?.startsWith("\u001bc")).toBe(true);
expect(writeTexts[0]).toContain("hi");
expect(writeTexts).toEqual(["\x1bc"]);
writeCallbacks[0]?.();
expect(writeTexts).toEqual(["\x1bc", "hi"]);
writeCallbacks[1]?.();
expect(writeTexts).toEqual(["\x1bc", "hi", "\r\n$"]);
});
it("restores server-rendered ANSI snapshots through the snapshot write path", () => {
it("restores worker-rendered ANSI through the replay lifecycle", () => {
const { runtime, terminal, writeTexts, writeCallbacks } = createRuntimeWithTerminal();
runtime.restoreOutput({ data: terminalOutput("restored screen") });
// restoreOutput is a barrier (suppressInput); it applies after the gate sentinel.
runtime.replay({ type: "begin" });
runtime.replay({ type: "data", data: terminalOutput("restored screen") });
runtime.replay({ type: "end" });
writeCallbacks[0]?.();
expect(terminal.resetCalls).toBe(0);
expect(writeTexts).toEqual(["\u001bcrestored screen"]);
expect(writeTexts).toEqual(["\x1bc", "restored screen"]);
});
it("forces a refit when resize is requested", () => {
@@ -7,7 +7,6 @@ import { WebLinksAddon } from "@xterm/addon-web-links";
import { WebglAddon } from "@xterm/addon-webgl";
import { LigaturesAddon } from "@xterm/addon-ligatures/lib/addon-ligatures.mjs";
import { Terminal, type ITheme, type IMarker } from "@xterm/xterm";
import type { TerminalState } from "@getpaseo/protocol/messages";
import {
type TerminalInputModeState,
TerminalInputModeTracker,
@@ -24,7 +23,6 @@ import {
resolveMacTerminalEditingShortcut,
shouldInterceptDomTerminalKey,
} from "@/utils/terminal-keys";
import { renderTerminalSnapshotToAnsi } from "./terminal-snapshot";
import {
createTerminalLocalFileLinkProvider,
type TerminalLocalFileLinkSource,
@@ -55,7 +53,6 @@ const FIND_HIGHLIGHT_LIMIT = 20_000;
export interface TerminalEmulatorRuntimeMountInput {
root: HTMLDivElement;
host: HTMLDivElement;
initialSnapshot: TerminalState | null;
scrollback: number;
theme: ITheme;
fontFamily?: string;
@@ -134,7 +131,7 @@ interface TerminalEmulatorRuntimeDisposables {
}
interface TerminalOutputOperation {
type: "write" | "clear" | "snapshot";
type: "write" | "clear" | "snapshot" | "fit";
data: TerminalOutputData;
rows?: number;
cols?: number;
@@ -280,6 +277,7 @@ export class TerminalEmulatorRuntime {
},
};
private replayResize: TerminalResizeRequest | null = null;
private fitAndEmitResize: ((input?: TerminalResizeRequest) => void) | null = null;
private lastSize: { rows: number; cols: number } | null = null;
private cleanup: (() => void) | null = null;
@@ -652,6 +650,7 @@ export class TerminalEmulatorRuntime {
window.__paseoTerminal = terminal;
const fitAndEmitResize = (resizeInput?: TerminalResizeRequest): void => {
if (this.deferReplayResize(resizeInput)) return;
const forceRefresh = resizeInput?.forceRefresh ?? false;
const shouldClaim = resizeInput?.shouldClaim ?? true;
const forceClaim = resizeInput?.forceClaim ?? false;
@@ -777,10 +776,6 @@ export class TerminalEmulatorRuntime {
fitAndEmitResize({ forceRefresh: true, shouldClaim: false });
}, 0);
if (input.initialSnapshot) {
this.renderSnapshot({ state: input.initialSnapshot });
}
this.processOutputQueue();
const disposables: TerminalEmulatorRuntimeDisposables = {
@@ -898,20 +893,19 @@ export class TerminalEmulatorRuntime {
onFilePaste?.(file);
}
renderSnapshot(input: { state: TerminalState | null; onCommitted?: () => void }): void {
if (!input.state) {
this.clear(input);
return;
replay(event: import("@getpaseo/client").TerminalReplayEvent): void {
if (event.type === "begin") {
this.replayResize ??= { shouldClaim: false };
this.restoreOutput({ data: EMPTY_TERMINAL_OUTPUT, rows: event.rows, cols: event.cols });
} else if (event.type === "data") {
this.write({ data: event.data, suppressInput: true });
} else {
this.outputOperations.push({ type: "fit", data: EMPTY_TERMINAL_OUTPUT });
this.processOutputQueue();
}
this.restoreOutput({
data: encodeTerminalOutput(renderTerminalSnapshotToAnsi(input.state)),
rows: input.state.rows,
cols: input.state.cols,
...(input.onCommitted ? { onCommitted: input.onCommitted } : {}),
});
}
restoreOutput(input: {
private restoreOutput(input: {
data: TerminalOutputData;
rows?: number;
cols?: number;
@@ -928,6 +922,16 @@ export class TerminalEmulatorRuntime {
this.processOutputQueue();
}
private deferReplayResize(input?: TerminalResizeRequest): boolean {
if (!this.replayResize) return false;
this.replayResize = {
forceRefresh: this.replayResize.forceRefresh || input?.forceRefresh,
shouldClaim: this.replayResize.shouldClaim || (input?.shouldClaim ?? true),
forceClaim: this.replayResize.forceClaim || input?.forceClaim,
};
return true;
}
resize(input?: TerminalResizeRequest): void {
this.fitAndEmitResize?.(input);
}
@@ -1047,6 +1051,7 @@ export class TerminalEmulatorRuntime {
commit();
}
this.hasUngatedWrites = false;
this.replayResize = null;
this.cleanup?.();
this.cleanup = null;
@@ -1176,16 +1181,40 @@ export class TerminalEmulatorRuntime {
this.processOutputQueue();
};
if (operation.type === "fit") {
// xterm resize flushes its write buffer synchronously. Leave the parser's
// commit callback before fitting, or that flush consumes the next write.
queueMicrotask(() => {
if (this.inFlightOutputOperation !== operation || this.terminal !== terminal) return;
const resize = this.replayResize ?? { shouldClaim: false };
this.replayResize = null;
this.fitAndEmitResize?.(resize);
finalizeOperation(operation);
});
return;
}
if (operation.type === "clear") {
this.inputModeDecoder.decode();
this.inputModeTracker.reset();
this.emitInputModeChange();
terminal.reset();
finalizeOperation(operation);
if (!this.replayResize) {
finalizeOperation(operation);
return;
}
queueMicrotask(() => {
if (this.inFlightOutputOperation !== operation || this.terminal !== terminal) return;
const resize = this.replayResize ?? { shouldClaim: false };
this.replayResize = null;
this.fitAndEmitResize?.(resize);
finalizeOperation(operation);
});
return;
}
if (operation.type === "snapshot") {
this.replayResize ??= { shouldClaim: false };
this.inputModeDecoder.decode();
this.inputModeTracker.reset();
this.emitInputModeChange();
@@ -31,7 +31,6 @@ function mount(options?: { isMac: boolean }) {
runtime.mount({
root,
host,
initialSnapshot: null,
scrollback: 1000,
theme: { background: "#ffffff", foreground: "#111111" },
});
@@ -38,7 +38,6 @@ function mountTerminal(left: number): TerminalView {
runtime.mount({
root,
host,
initialSnapshot: null,
scrollback: 1000,
fontFamily: "monospace",
fontSize: 16,
@@ -1,15 +1,14 @@
import { Terminal as ReplaySource } from "@xterm/xterm";
import { SerializeAddon } from "@xterm/addon-serialize";
import { page } from "@vitest/browser/context";
import { afterEach, describe, expect, it } from "vitest";
import type { TerminalState } from "@getpaseo/protocol/messages";
import { encodeTerminalOutput, TerminalEmulatorRuntime } from "./terminal-emulator-runtime";
// Regression: "streaming pino log, resized the Paseo terminal, old logs stayed
// narrow and new logs drew on top of the old ones."
//
// A heavy stream overflows MAX_TERMINAL_OUTPUT_FRAME_BYTES, so the server sends a
// SNAPSHOT mid-stream. The client restores it via renderTerminalSnapshotToAnsi.
// When the snapshot carries per-row soft-wrap flags, restored long lines must
// reflow on resize just like live output — not freeze at the snapshot width.
// Backpressure triggers an ANSI replay serialized directly from xterm. Replayed
// soft-wrapped lines must reflow on resize like live output.
interface Mounted {
host: HTMLDivElement;
@@ -57,7 +56,6 @@ function mount(width: number, height: number): Mounted {
runtime.mount({
root,
host,
initialSnapshot: null,
scrollback: 10_000,
theme: { background: "#0b0b0b", foreground: "#e6e6e6", cursor: "#e6e6e6" },
});
@@ -90,9 +88,18 @@ function someRowContains(term: InspectableTerminal, text: string): boolean {
return dumpRows(term).some((r) => r.text.includes(text));
}
function renderSnapshotCommitted(runtime: TerminalEmulatorRuntime, state: TerminalState) {
function replayCommitted(
runtime: TerminalEmulatorRuntime,
state: { rows: number; cols: number; data: Uint8Array },
) {
return new Promise<void>((resolve) => {
runtime.renderSnapshot({ state, onCommitted: resolve });
runtime.replay({ type: "begin", rows: state.rows, cols: state.cols });
runtime.replay({
type: "data",
data: state.data,
});
runtime.replay({ type: "end" });
runtime.write({ data: new Uint8Array([0]), onCommitted: resolve });
});
}
@@ -102,31 +109,18 @@ function writeCommitted(runtime: TerminalEmulatorRuntime, data: Uint8Array) {
});
}
// Build a server-style snapshot of one long pino line that the SERVER soft-wrapped
// at `cols`, represented as multiple grid rows (exactly what the daemon stores in
// its headless xterm and ships in a snapshot).
function buildWrappedSnapshot(cols: number): TerminalState {
const longLine = `[server] [15:30:00.123] TRACE: provider.claude.raw_event {"module":"agent","seq":1,"sessionId":"ed8972f4-d3be-45d0-992c-631f8f1ed04e","turnId":"foreground-turn-1","payload":"${"A".repeat(40)}"}`;
const grid: TerminalState["grid"] = [];
for (let i = 0; i < longLine.length; i += cols) {
const chunk = longLine.slice(i, i + cols);
grid.push([...chunk].map((char) => ({ char })));
// Serialize one long pino line from a real server-width xterm buffer.
// The replay must retain its soft-wrap boundaries for later client reflow.
async function buildWrappedSnapshot(cols: number) {
const source = new ReplaySource({ rows: 24, cols, allowProposedApi: true });
const serializer = new SerializeAddon();
source.loadAddon(serializer);
try {
await new Promise<void>((resolve) => source.write(pinoLine(0), resolve));
return { rows: 24, cols, data: new TextEncoder().encode(serializer.serialize()) };
} finally {
source.dispose();
}
// The fixed daemon ships per-row soft-wrap flags: every row of the logical line
// continues onto the next except the last.
const gridWrapped = grid.map((_, index) => index < grid.length - 1);
// Cursor sits just below the restored content, exactly where the daemon's
// headless terminal leaves it after a line break, so streamed output appends
// cleanly below instead of overwriting the restored rows.
return {
rows: 24,
cols,
scrollback: [],
scrollbackWrapped: [],
grid,
gridWrapped,
cursor: { row: grid.length, col: 0 },
};
}
function pinoLine(seq: number): string {
@@ -141,15 +135,14 @@ afterEach(() => {
});
describe("terminal resize reflow repro (Paseo terminal)", () => {
it("snapshot-restored rows stay frozen at the snapshot width after the terminal grows", async () => {
it("replayed soft-wrapped rows reflow after the terminal grows", async () => {
await page.viewport(1600, 700);
const m = mount(560, 360); // ~70 cols
await waitFor(() => m.terminal.cols > 40);
const narrowCols = m.terminal.cols;
// 1) Mid-stream snapshot arrives (server overflowed 256KB). It carries the
// long line wrapped at the server width as separate grid rows.
await renderSnapshotCommitted(m.runtime, buildWrappedSnapshot(narrowCols));
// 1) A mid-stream ANSI replay arrives, preserving wraps at the captured width.
await replayCommitted(m.runtime, await buildWrappedSnapshot(narrowCols));
await waitFor(() => someRowContains(m.terminal, "[15:30:00.123]"));
// 2) Normal post-snapshot streaming resumes (autowrap on -> soft-wrapped).
@@ -4,25 +4,27 @@ import { resolveTerminalRestoreOptions } from "./terminal-restore-options";
describe("terminal restore options", () => {
it("omits restore options for daemons without terminal restore modes", () => {
expect(
expect(() =>
resolveTerminalRestoreOptions({
scrollbackLines: 10000,
supportsTerminalRestoreModes: false,
canClaimSize: true,
size: { rows: 24, cols: 80 },
}),
).toBeUndefined();
).toThrow("Update the host to view terminals.");
});
it("requests visible snapshot restore with bounded scrollback for capable daemons", () => {
it("requests visible snapshot restore with configured scrollback for capable daemons", () => {
expect(
resolveTerminalRestoreOptions({
scrollbackLines: 10000,
supportsTerminalRestoreModes: true,
canClaimSize: true,
size: { rows: 24, cols: 80 },
}),
).toEqual({
mode: "visible-snapshot",
scrollbackLines: 200,
scrollbackLines: 10000,
size: { rows: 24, cols: 80 },
});
});
@@ -30,26 +32,39 @@ describe("terminal restore options", () => {
it("omits size until the terminal has been measured", () => {
expect(
resolveTerminalRestoreOptions({
scrollbackLines: 10000,
supportsTerminalRestoreModes: true,
canClaimSize: true,
size: null,
}),
).toEqual({
mode: "visible-snapshot",
scrollbackLines: 200,
scrollbackLines: 10000,
});
});
it("does not let a background attach resize the PTY", () => {
expect(
resolveTerminalRestoreOptions({
scrollbackLines: 10000,
supportsTerminalRestoreModes: true,
canClaimSize: false,
size: { rows: 24, cols: 80 },
}),
).toEqual({
mode: "visible-snapshot",
scrollbackLines: 200,
scrollbackLines: 10000,
});
});
});
it.each([0, 5, 400, 10000])("requests exactly %s configured history rows", (scrollbackLines) => {
expect(
resolveTerminalRestoreOptions({
supportsTerminalRestoreModes: true,
scrollbackLines,
canClaimSize: false,
size: null,
}),
).toEqual({ mode: "visible-snapshot", scrollbackLines });
});
@@ -1,23 +1,23 @@
import { i18n } from "@/i18n/i18next";
import type { SubscribeTerminalRequest } from "@getpaseo/protocol/messages";
export const TERMINAL_VISIBLE_RESTORE_SCROLLBACK_LINES = 200;
export interface ResolveTerminalRestoreOptionsInput {
supportsTerminalRestoreModes: boolean;
scrollbackLines: number;
canClaimSize: boolean;
size: { rows: number; cols: number } | null;
}
export function resolveTerminalRestoreOptions(
input: ResolveTerminalRestoreOptionsInput,
): SubscribeTerminalRequest["restore"] | undefined {
): NonNullable<SubscribeTerminalRequest["restore"]> {
if (!input.supportsTerminalRestoreModes) {
return undefined;
throw new Error(i18n.t("workspace.terminal.restoreRequiresUpdate"));
}
return {
mode: "visible-snapshot",
scrollbackLines: TERMINAL_VISIBLE_RESTORE_SCROLLBACK_LINES,
scrollbackLines: input.scrollbackLines,
...(input.canClaimSize && input.size ? { size: input.size } : {}),
};
}
@@ -2,7 +2,7 @@ import { Terminal as HeadlessTerminal } from "@xterm/headless";
import { Terminal as ClientTerminal } from "@xterm/xterm";
import { describe, expect, it } from "vitest";
import { renderTerminalSnapshotToAnsi } from "./terminal-snapshot";
import { SerializeAddon } from "@xterm/addon-serialize";
interface SnapshotCell {
char: string;
@@ -122,7 +122,7 @@ function extractRow(terminal: ClientTerminal | HeadlessTerminal, row: number): S
}
describe("terminal-snapshot", () => {
it("replays extracted terminal state into a client xterm with matching grid, scrollback, and cursor presentation", async () => {
it("replays upstream serialized ANSI into a client xterm with matching grid, scrollback, and cursor presentation", async () => {
const source = new HeadlessTerminal({
rows: 4,
cols: 12,
@@ -138,6 +138,8 @@ describe("terminal-snapshot", () => {
await writeToTerminal(source, "\u001b[2 q");
await writeToTerminal(source, "\u001b[?25l");
const serializer = new SerializeAddon();
source.loadAddon(serializer);
const snapshot = extractState(source);
const client = new ClientTerminal({
@@ -147,7 +149,7 @@ describe("terminal-snapshot", () => {
scrollback: 100,
});
await writeToTerminal(client, renderTerminalSnapshotToAnsi(snapshot));
await writeToTerminal(client, serializer.serialize() + "\x1b[2 q\x1b[?25l");
expect(extractState(client)).toEqual(snapshot);
});
@@ -1 +0,0 @@
export { renderTerminalSnapshotToAnsi } from "@getpaseo/protocol/terminal-snapshot";
@@ -1,3 +1,4 @@
import { resolveTerminalRestoreOptions } from "./terminal-restore-options";
import type { SessionOutboundMessage } from "@getpaseo/protocol/messages";
import { describe, expect, it } from "vitest";
@@ -7,34 +8,16 @@ import {
type TerminalStreamControllerStatus,
} from "./terminal-stream-controller";
interface TerminalSnapshot {
rows: number;
cols: number;
grid: Array<Array<{ char: string }>>;
scrollback: Array<Array<{ char: string }>>;
cursor: { row: number; col: number };
}
function terminalCellText(cell: { char: string }): string {
return cell.char;
}
function terminalRowText(row: Array<{ char: string }>): string {
return row.map(terminalCellText).join("");
}
function terminalSnapshotText(state: TerminalSnapshot): string {
return state.grid.map(terminalRowText).join("\n");
}
function terminalOutput(text: string): Uint8Array {
return new TextEncoder().encode(text);
}
type TerminalStreamEvent =
| { terminalId: string; type: "output"; data: Uint8Array }
| { terminalId: string; type: "snapshot"; state: TerminalSnapshot }
| { terminalId: string; type: "restore"; data: Uint8Array };
type StreamEvent = import("@getpaseo/client").TerminalStreamEvent;
type TerminalStreamEvent = StreamEvent extends infer Event
? Event extends StreamEvent
? Omit<Event, "subscriptionId">
: never
: never;
class FakeTerminalStreamClient implements TerminalStreamControllerClient {
private readonly updates = new Set<(message: SessionOutboundMessage) => void>();
@@ -115,32 +98,23 @@ class FakeTerminalStreamClient implements TerminalStreamControllerClient {
function createHarness(input?: { client?: FakeTerminalStreamClient }) {
const client = input?.client ?? new FakeTerminalStreamClient();
const outputs: Array<{ terminalId: string; data: Uint8Array }> = [];
const restores: Array<{ terminalId: string; data: Uint8Array }> = [];
const snapshots: Array<{ terminalId: string; text: string }> = [];
const replays: import("@getpaseo/client").TerminalReplayEvent[] = [];
const statuses: TerminalStreamControllerStatus[] = [];
const exits: string[] = [];
const controller = new TerminalStreamController({
client,
onReplay: ({ replay }) => replays.push(replay),
onExit: (terminalId) => exits.push(terminalId),
getPreferredSize: () => ({ rows: 24, cols: 80 }),
onOutput: (output) => {
outputs.push(output);
},
onRestore: (restore) => {
restores.push(restore);
},
onSnapshot: ({ terminalId, state }) => {
snapshots.push({
terminalId,
text: terminalSnapshotText(state),
});
},
onStatusChange: (status) => {
statuses.push(status);
},
});
return { client, controller, outputs, restores, snapshots, statuses, exits };
return { client, controller, outputs, replays, statuses, exits };
}
async function flushAsyncWork(): Promise<void> {
@@ -149,24 +123,20 @@ async function flushAsyncWork(): Promise<void> {
}
describe("terminal-stream-controller", () => {
it("subscribes, resizes, and forwards snapshot/output events", async () => {
it("subscribes, resizes, and forwards replay/output events", async () => {
const harness = createHarness();
harness.client.nextSubscribeResults.push({ terminalId: "term-1", error: null });
harness.controller.setTerminal({ terminalId: "term-1" });
await flushAsyncWork();
harness.client.emit({
terminalId: "term-1",
type: "snapshot",
state: {
rows: 1,
cols: 5,
grid: [[{ char: "h" }, { char: "e" }, { char: "l" }, { char: "l" }, { char: "o" }]],
scrollback: [],
cursor: { row: 0, col: 5 },
},
});
const replay: import("@getpaseo/client").TerminalReplayEvent[] = [
{ type: "begin", rows: 24, cols: 80, retainedHistoryLines: 400 },
{ type: "data", data: terminalOutput("hello") },
{ type: "end" },
];
for (const event of replay)
harness.client.emit({ terminalId: "term-1", type: "replay", replay: event });
const outputData = terminalOutput(" world");
harness.client.emit({
terminalId: "term-1",
@@ -178,7 +148,7 @@ describe("terminal-stream-controller", () => {
expect(harness.client.resizeCalls).toEqual([
{ terminalId: "term-1", rows: 24, cols: 80, intent: "claim" },
]);
expect(harness.snapshots).toEqual([{ terminalId: "term-1", text: "hello" }]);
expect(harness.replays).toEqual(replay);
expect(harness.outputs[0]?.data).toBe(outputData);
expect(harness.outputs).toEqual([{ terminalId: "term-1", data: terminalOutput(" world") }]);
expect(harness.statuses.at(-1)).toEqual({
@@ -236,23 +206,19 @@ describe("terminal-stream-controller", () => {
size: { rows: 24, cols: 80 },
}),
onOutput: (output) => harness.outputs.push(output),
onRestore: (restore) => harness.restores.push(restore),
onSnapshot: ({ terminalId, state }) => {
harness.snapshots.push({
terminalId,
text: terminalSnapshotText(state),
});
},
onReplay: ({ replay }) => harness.replays.push(replay),
});
controller.setTerminal({ terminalId: "term-1" });
await flushAsyncWork();
const restoreData = terminalOutput("restored");
client.emit({
terminalId: "term-1",
type: "restore",
data: restoreData,
});
const replay: import("@getpaseo/client").TerminalReplayEvent[] = [
{ type: "begin" },
{ type: "data", data: restoreData },
{ type: "end" },
];
for (const event of replay)
client.emit({ terminalId: "term-1", type: "replay", replay: event });
controller.dispose();
expect(client.subscribeCalls).toEqual([
@@ -270,8 +236,7 @@ describe("terminal-stream-controller", () => {
expect(client.resizeCalls).toEqual([
{ terminalId: "term-1", rows: 24, cols: 80, intent: "claim" },
]);
expect(harness.restores[0]?.data).toBe(restoreData);
expect(harness.restores).toEqual([{ terminalId: "term-1", data: terminalOutput("restored") }]);
expect(harness.replays).toEqual(replay);
expect(harness.outputs).toEqual([]);
});
@@ -319,3 +284,28 @@ it("reports observation failure without declaring the PTY exited, then allows re
expect(h.statuses.at(-1)?.error).toBe(null);
h.controller.dispose();
});
it("does not resize or attach on a JSON-era host and reports the required update", () => {
const client = new FakeTerminalStreamClient();
const statuses: TerminalStreamControllerStatus[] = [];
const controller = new TerminalStreamController({
client,
getPreferredSize: () => ({ rows: 24, cols: 40 }),
onOutput: () => {},
getRestoreOptions: () =>
resolveTerminalRestoreOptions({
supportsTerminalRestoreModes: false,
scrollbackLines: 10000,
canClaimSize: true,
size: { rows: 24, cols: 40 },
}),
onStatusChange: (status) => statuses.push(status),
});
controller.setTerminal({ terminalId: "old-host-terminal" });
expect(client.subscribeCalls).toEqual([]);
expect(client.resizeCalls).toEqual([]);
expect(statuses.at(-1)).toMatchObject({
isAttaching: false,
error: "Update the host to view terminals.",
});
});
@@ -1,5 +1,5 @@
import type { DaemonClient } from "@getpaseo/client/internal/daemon-client";
import type { SubscribeTerminalRequest, TerminalState } from "@getpaseo/protocol/messages";
import type { SubscribeTerminalRequest } from "@getpaseo/protocol/messages";
import type { TerminalOutputData } from "./terminal-emulator-runtime";
import { i18n } from "@/i18n/i18next";
@@ -23,9 +23,11 @@ export interface TerminalStreamControllerOptions {
client: TerminalStreamControllerClient;
getPreferredSize: () => TerminalStreamControllerSize | null;
onOutput: (input: { terminalId: string; data: TerminalOutputData }) => void;
onSnapshot: (input: { terminalId: string; state: TerminalState }) => void;
onExit?: (terminalId: string) => void;
onRestore?: (input: { terminalId: string; data: TerminalOutputData }) => void;
onReplay?: (input: {
terminalId: string;
replay: import("@getpaseo/client").TerminalReplayEvent;
}) => void;
getRestoreOptions?: () => SubscribeTerminalRequest["restore"] | undefined;
onStatusChange?: (status: TerminalStreamControllerStatus) => void;
}
@@ -43,17 +45,11 @@ export class TerminalStreamController {
if (this.disposed || event.terminalId !== this.terminalId) {
return;
}
if (event.type === "snapshot") {
this.options.onSnapshot({ terminalId: event.terminalId, state: event.state });
if (event.type === "replay") {
this.options.onReplay?.({ terminalId: event.terminalId, replay: event.replay });
return;
}
if (event.type === "restore") {
if (event.data.length > 0) {
this.options.onRestore?.({ terminalId: event.terminalId, data: event.data });
}
return;
}
if (event.data.length > 0) {
if (event.type === "output" && event.data.length > 0) {
this.options.onOutput({ terminalId: event.terminalId, data: event.data });
}
};
@@ -70,10 +66,10 @@ export class TerminalStreamController {
this.options.onStatusChange?.({ terminalId: null, isAttaching: false, error: null });
return;
}
const restore = this.options.getRestoreOptions?.();
this.options.onStatusChange?.({ terminalId: nextTerminalId, isAttaching: true, error: null });
let subscription: ReturnType<DaemonClient["observeTerminal"]>;
try {
const restore = this.options.getRestoreOptions?.();
const preferredSize = restore?.size ?? this.options.getPreferredSize();
if (preferredSize)
this.options.client.sendTerminalInput(nextTerminalId, {
@@ -1,75 +0,0 @@
import { describe, expect, it } from "vitest";
import {
getWorkspaceTerminalSession,
releaseWorkspaceTerminalSession,
retainWorkspaceTerminalSession,
} from "./workspace-terminal-session";
describe("workspace-terminal-session", () => {
it("returns the same workspace session instance for the same scope", () => {
const first = getWorkspaceTerminalSession({
scopeKey: "workspace-a",
});
const second = getWorkspaceTerminalSession({
scopeKey: "workspace-a",
});
expect(second).toBe(first);
});
it("preserves snapshots across repeated lookups", () => {
const first = getWorkspaceTerminalSession({
scopeKey: "workspace-snapshots",
});
first.snapshots.set({
terminalId: "term-1",
state: {
rows: 1,
cols: 1,
grid: [[{ char: "A" }]],
scrollback: [],
cursor: { row: 0, col: 0 },
},
});
const second = getWorkspaceTerminalSession({
scopeKey: "workspace-snapshots",
});
expect(second.snapshots.get({ terminalId: "term-1" })).toEqual({
rows: 1,
cols: 1,
grid: [[{ char: "A" }]],
scrollback: [],
cursor: { row: 0, col: 0 },
});
});
it("evicts workspace terminal session state when the retain count returns to zero", () => {
const scopeKey = "workspace-release";
const first = getWorkspaceTerminalSession({
scopeKey,
});
first.snapshots.set({
terminalId: "term-1",
state: {
rows: 1,
cols: 1,
grid: [[{ char: "A" }]],
scrollback: [],
cursor: { row: 0, col: 0 },
},
});
retainWorkspaceTerminalSession({ scopeKey });
releaseWorkspaceTerminalSession({ scopeKey });
const second = getWorkspaceTerminalSession({
scopeKey,
});
expect(second).not.toBe(first);
expect(second.snapshots.get({ terminalId: "term-1" })).toBeNull();
});
});
@@ -1,79 +0,0 @@
import type { TerminalState } from "@getpaseo/protocol/messages";
export interface WorkspaceTerminalSnapshots {
get: (input: { terminalId: string }) => TerminalState | null;
set: (input: { terminalId: string; state: TerminalState }) => void;
clear: (input: { terminalId: string }) => void;
prune: (input: { terminalIds: string[] }) => void;
}
export interface WorkspaceTerminalSession {
scopeKey: string;
snapshots: WorkspaceTerminalSnapshots;
}
interface WorkspaceTerminalSessionRecord {
snapshotByTerminalId: Map<string, TerminalState>;
session: WorkspaceTerminalSession;
}
const sessionsByScopeKey = new Map<string, WorkspaceTerminalSessionRecord>();
const refCountByScopeKey = new Map<string, number>();
function createSnapshots(input: {
snapshotByTerminalId: Map<string, TerminalState>;
}): WorkspaceTerminalSnapshots {
return {
get: ({ terminalId }) => input.snapshotByTerminalId.get(terminalId) ?? null,
set: ({ terminalId, state }) => {
input.snapshotByTerminalId.set(terminalId, state);
},
clear: ({ terminalId }) => {
input.snapshotByTerminalId.delete(terminalId);
},
prune: ({ terminalIds }) => {
const terminalIdSet = new Set(terminalIds);
for (const terminalId of Array.from(input.snapshotByTerminalId.keys())) {
if (!terminalIdSet.has(terminalId)) {
input.snapshotByTerminalId.delete(terminalId);
}
}
},
};
}
export function getWorkspaceTerminalSession(input: { scopeKey: string }): WorkspaceTerminalSession {
const existing = sessionsByScopeKey.get(input.scopeKey);
if (existing) {
return existing.session;
}
const snapshotByTerminalId = new Map<string, TerminalState>();
const session: WorkspaceTerminalSession = {
scopeKey: input.scopeKey,
snapshots: createSnapshots({
snapshotByTerminalId,
}),
};
sessionsByScopeKey.set(input.scopeKey, {
snapshotByTerminalId,
session,
});
return session;
}
export function retainWorkspaceTerminalSession(input: { scopeKey: string }): void {
const current = refCountByScopeKey.get(input.scopeKey) ?? 0;
refCountByScopeKey.set(input.scopeKey, current + 1);
}
export function releaseWorkspaceTerminalSession(input: { scopeKey: string }): void {
const current = refCountByScopeKey.get(input.scopeKey) ?? 0;
if (current > 1) {
refCountByScopeKey.set(input.scopeKey, current - 1);
return;
}
refCountByScopeKey.delete(input.scopeKey);
sessionsByScopeKey.delete(input.scopeKey);
}
@@ -3,7 +3,6 @@ import { describe, expect, it } from "vitest";
import {
applyTerminalRendererReadyChange,
resolveTerminalStreamTarget,
shouldReplayTerminalSnapshotForRenderer,
shouldShowTerminalLoadingOverlay,
} from "./terminal-renderer-readiness";
@@ -74,27 +73,6 @@ describe("terminal-renderer-readiness", () => {
expect(current).toBeNull();
});
it("replays snapshots only for ready events from the current renderer", () => {
expect(
shouldReplayTerminalSnapshotForRenderer({
change: { streamKey: "scope:terminal-1", isReady: true },
terminalStreamKey: "scope:terminal-1",
}),
).toBe(true);
expect(
shouldReplayTerminalSnapshotForRenderer({
change: { streamKey: "scope:terminal-1", isReady: false },
terminalStreamKey: "scope:terminal-1",
}),
).toBe(false);
expect(
shouldReplayTerminalSnapshotForRenderer({
change: { streamKey: "scope:terminal-1", isReady: true },
terminalStreamKey: "scope:terminal-2",
}),
).toBe(false);
});
it("does not attach the stream before the matching renderer is ready", () => {
expect(
resolveTerminalStreamTarget({
@@ -14,13 +14,6 @@ export function applyTerminalRendererReadyChange(
return currentReadyStreamKey === change.streamKey ? null : currentReadyStreamKey;
}
export function shouldReplayTerminalSnapshotForRenderer(input: {
change: TerminalRendererReadyChange;
terminalStreamKey: string;
}): boolean {
return input.change.isReady && input.change.streamKey === input.terminalStreamKey;
}
export function resolveTerminalStreamTarget(input: {
terminalId: string;
terminalStreamKey: string;

Some files were not shown because too many files have changed in this diff Show More