feat: high-performance web terminal with asyncio-native I/O
Complete rewrite of the terminal pipeline for VS Code Server-level responsiveness. Key improvements: Backend: - Replace blocking select.select(0.1) with asyncio.add_reader() for event-driven PTY reading (eliminates ~110ms polling latency) - Add output batching (2ms window) to reduce WebSocket frame overhead - Add flow control: client acks processed bytes, server pauses PTY reads at 64KB threshold, resumes at 32KB - Add 5s ack timeout fallback to prevent stuck sessions Frontend: - Switch WebSocket to binary mode (binaryType = 'arraybuffer') - Eliminate Blob -> arrayBuffer async conversion overhead - Add flow control ack messages (every 4096 bytes or 100ms) - Add xterm-addon-webgl with graceful DOM fallback - Add performance tuning (scrollback=10000, fastScrollSensitivity) SDD artifacts: - openspec/explorations/terminal-responsiveness.md - openspec/proposals/terminal-responsiveness.md - openspec/specs/terminal-responsiveness.md - openspec/designs/terminal-responsiveness.md - openspec/tasks/terminal-responsiveness.md Quality gates: pytest (19 passed, 1 skipped), tsc --noEmit clean
This commit is contained in:
Alex Blank
@@ -0,0 +1,227 @@
|
||||
# Design: High-Performance Web Terminal
|
||||
|
||||
## Component Diagram
|
||||
|
||||
```
|
||||
┌─────────────────────────────────────────────────────────────┐
|
||||
│ Browser │
|
||||
│ ┌─────────────┐ ┌─────────────┐ ┌─────────────────────┐ │
|
||||
│ │ Terminal │ │ WebSocket │ │ xterm.js │ │
|
||||
│ │ Component │──│ Client │──│ + WebGL addon │ │
|
||||
│ │ │ │ (binary) │ │ + DOM fallback │ │
|
||||
│ └─────────────┘ └─────────────┘ └─────────────────────┘ │
|
||||
│ │ │ │
|
||||
│ │ Flow control ack │ │
|
||||
│ └──────────────────────────────────────────────┘ │
|
||||
└─────────────────────────────────────────────────────────────┘
|
||||
│ WebSocket
|
||||
│ (binary frames)
|
||||
┌─────────────────────────────────────────────────────────────┐
|
||||
│ API Container │
|
||||
│ ┌─────────────┐ ┌─────────────┐ ┌─────────────────────┐ │
|
||||
│ │ Terminal │ │ WebSocket │ │ TerminalSession │ │
|
||||
│ │ Manager │──│ Endpoint │──│ (new) │ │
|
||||
│ │ (lifecycle) │ │ (router) │ │ - asyncio fd reader │ │
|
||||
│ └─────────────┘ └─────────────┘ │ - output batcher │ │
|
||||
│ │ - flow control │ │
|
||||
│ └─────────────────────┘ │
|
||||
│ │ │
|
||||
│ ┌────────┴────────┐ │
|
||||
│ │ docker exec -it │ │
|
||||
│ │ (subprocess) │ │
|
||||
│ └────────┬────────┘ │
|
||||
│ │ │
|
||||
│ ┌────────┴────────┐ │
|
||||
│ │ Tool Container │ │
|
||||
│ │ (bash shell) │ │
|
||||
│ └─────────────────┘ │
|
||||
└─────────────────────────────────────────────────────────────┘
|
||||
```
|
||||
|
||||
## File Changes
|
||||
|
||||
### New Files
|
||||
- `apps/api/src/services/terminal_session_v2.py` — New TerminalSession implementation
|
||||
|
||||
### Modified Files
|
||||
- `apps/api/src/services/terminal_session.py` — Delete (or keep as legacy, user said no legacy needed)
|
||||
- `apps/api/src/services/terminal_manager.py` — Update to use new TerminalSession
|
||||
- `apps/api/src/api/terminal.py` — Update WebSocket handler for binary frames + flow control
|
||||
- `apps/web/src/components/terminal.tsx` — Binary mode, WebGL, flow control ack
|
||||
- `apps/web/package.json` — Add `xterm-addon-webgl`
|
||||
|
||||
## TerminalSession Implementation
|
||||
|
||||
```python
|
||||
class TerminalSession:
|
||||
"""High-performance terminal session with asyncio-native I/O."""
|
||||
|
||||
BUFFER_SIZE = 10 * 1024
|
||||
IDLE_TIMEOUT = 30 * 60
|
||||
BATCH_WINDOW_MS = 2
|
||||
FLOW_CONTROL_THRESHOLD = 64 * 1024
|
||||
FLOW_CONTROL_RESUME = 32 * 1024
|
||||
|
||||
def __init__(self, session_id, instance_id, container_id, ...):
|
||||
self._master_fd: int | None = None
|
||||
self._process: asyncio.subprocess.Process | None = None
|
||||
self._output_buffer: deque[bytes] = deque(maxlen=self.BUFFER_SIZE)
|
||||
self._websockets: set[WebSocket] = set()
|
||||
self._batch_buffer = bytearray()
|
||||
self._batch_timer: asyncio.TimerHandle | None = None
|
||||
self._unacknowledged_bytes = 0
|
||||
self._paused = False
|
||||
self._read_handler_set = False
|
||||
|
||||
async def start(self):
|
||||
self._master_fd, slave_fd = pty.openpty()
|
||||
self._set_terminal_size(80, 24)
|
||||
|
||||
self._process = await asyncio.create_subprocess_exec(
|
||||
"docker", "exec", "-it", "-e", "TERM=xterm-256color",
|
||||
self.container_id, "bash", "-il",
|
||||
stdin=slave_fd, stdout=slave_fd, stderr=slave_fd,
|
||||
)
|
||||
os.close(slave_fd)
|
||||
|
||||
def _start_reading(self):
|
||||
"""Register fd with asyncio event loop for event-driven reading."""
|
||||
if self._read_handler_set or self._master_fd is None:
|
||||
return
|
||||
loop = asyncio.get_event_loop()
|
||||
loop.add_reader(self._master_fd, self._on_fd_readable)
|
||||
self._read_handler_set = True
|
||||
|
||||
def _on_fd_readable(self):
|
||||
"""Callback when PTY fd has data available."""
|
||||
if self._master_fd is None or self._paused:
|
||||
return
|
||||
try:
|
||||
data = os.read(self._master_fd, 4096)
|
||||
if data:
|
||||
self._add_to_buffer(data)
|
||||
self._queue_output(data)
|
||||
self.last_activity = time.time()
|
||||
except (OSError, IOError):
|
||||
pass
|
||||
|
||||
def _queue_output(self, data: bytes):
|
||||
"""Add to batch buffer, schedule flush."""
|
||||
self._batch_buffer.extend(data)
|
||||
self._unacknowledged_bytes += len(data)
|
||||
|
||||
if self._unacknowledged_bytes > self.FLOW_CONTROL_THRESHOLD:
|
||||
self._pause_output()
|
||||
|
||||
if self._batch_timer is None:
|
||||
loop = asyncio.get_event_loop()
|
||||
self._batch_timer = loop.call_later(
|
||||
self.BATCH_WINDOW_MS / 1000, self._flush_batch
|
||||
)
|
||||
|
||||
def _flush_batch(self):
|
||||
"""Flush batched output to all WebSockets."""
|
||||
self._batch_timer = None
|
||||
if not self._batch_buffer:
|
||||
return
|
||||
|
||||
payload = bytes(self._batch_buffer)
|
||||
self._batch_buffer.clear()
|
||||
|
||||
dead = set()
|
||||
for ws in self._websockets:
|
||||
try:
|
||||
asyncio.create_task(ws.send_bytes(payload))
|
||||
except Exception:
|
||||
dead.add(ws)
|
||||
|
||||
self._websockets -= dead
|
||||
|
||||
def acknowledge_data(self, char_count: int):
|
||||
"""Client acknowledges processed bytes."""
|
||||
self._unacknowledged_bytes = max(0, self._unacknowledged_bytes - char_count)
|
||||
if self._paused and self._unacknowledged_bytes < self.FLOW_CONTROL_RESUME:
|
||||
self._resume_output()
|
||||
|
||||
def _pause_output(self):
|
||||
"""Pause reading from PTY."""
|
||||
if self._read_handler_set and self._master_fd is not None:
|
||||
loop = asyncio.get_event_loop()
|
||||
loop.remove_reader(self._master_fd)
|
||||
self._read_handler_set = False
|
||||
self._paused = True
|
||||
|
||||
def _resume_output(self):
|
||||
"""Resume reading from PTY."""
|
||||
self._paused = False
|
||||
self._start_reading()
|
||||
```
|
||||
|
||||
## Frontend Changes
|
||||
|
||||
### WebSocket Binary Mode
|
||||
```typescript
|
||||
const ws = new WebSocket(wsUrl);
|
||||
ws.binaryType = "arraybuffer"; // Receive ArrayBuffer directly
|
||||
|
||||
ws.onmessage = (event) => {
|
||||
if (event.data instanceof ArrayBuffer) {
|
||||
const data = new Uint8Array(event.data);
|
||||
termRef.current?.write(data);
|
||||
|
||||
// Flow control: acknowledge processed bytes
|
||||
ackAccumulator += data.length;
|
||||
if (ackAccumulator >= 4096) {
|
||||
ws.send(JSON.stringify({ type: "ack", chars: ackAccumulator }));
|
||||
ackAccumulator = 0;
|
||||
}
|
||||
}
|
||||
};
|
||||
```
|
||||
|
||||
### WebGL Renderer
|
||||
```typescript
|
||||
import { WebglAddon } from "xterm-addon-webgl";
|
||||
|
||||
const webglAddon = new WebglAddon();
|
||||
try {
|
||||
term.loadAddon(webglAddon);
|
||||
} catch (e) {
|
||||
console.warn("WebGL failed, using DOM renderer", e);
|
||||
}
|
||||
```
|
||||
|
||||
## WebSocket Protocol
|
||||
|
||||
### Message Types
|
||||
|
||||
**Client → Server:**
|
||||
- `{"type": "input", "data": "base64_encoded"}` — Keystrokes
|
||||
- `{"type": "resize", "cols": 80, "rows": 24}` — Resize
|
||||
- `{"type": "ack", "chars": 4096}` — Flow control acknowledgment
|
||||
- `{"type": "reset"}` — Reset session
|
||||
|
||||
**Server → Client:**
|
||||
- Binary frame: raw terminal output bytes
|
||||
- `{"type": "status", "status": "connected"}` — Connection status
|
||||
- `{"type": "ping"}` — Heartbeat (server → client)
|
||||
|
||||
## Testing
|
||||
|
||||
### Unit Tests
|
||||
- `test_terminal_session_v2.py` — Test batching, flow control, resize, reset
|
||||
- `test_terminal_manager.py` — Test session lifecycle with new session class
|
||||
|
||||
### Integration Tests
|
||||
- `test_terminal_websocket.py` — Full WebSocket round-trip
|
||||
|
||||
### Performance Tests
|
||||
- `benchmark_terminal_latency.py` — Measure input/output latency
|
||||
- `benchmark_terminal_throughput.py` — Measure max throughput
|
||||
|
||||
## Rollback Plan
|
||||
|
||||
Since this is a full rewrite with no legacy support:
|
||||
- Keep a backup branch of the old terminal code
|
||||
- Feature flag in frontend: `?terminal=v2` to test before full rollout
|
||||
- Monitor error rates after deployment
|
||||
@@ -0,0 +1,160 @@
|
||||
# SDD Exploration: Responsive Web Terminal
|
||||
|
||||
## Status
|
||||
**Phase:** explore
|
||||
**Date:** 2026-06-02
|
||||
**Owner:** el Gentleman (parent session)
|
||||
**Scope:** Terminal I/O latency, rendering performance, connection stability
|
||||
|
||||
## Goal
|
||||
Achieve VS Code Server-level terminal responsiveness: near-local latency on keystrokes, smooth scrolling, no jank on output bursts, and instant resize reactions.
|
||||
|
||||
## Current Architecture
|
||||
|
||||
### Data Flow
|
||||
```
|
||||
Container shell → docker exec PTY → host PTY master fd → select.select(0.1s)
|
||||
→ Python read loop (10ms sleep fallback) → WebSocket.send_bytes()
|
||||
→ WebSocket (Blob mode) → frontend arrayBuffer decode → xterm.js.write()
|
||||
```
|
||||
|
||||
### Key Files
|
||||
| File | Responsibility |
|
||||
|------|---------------|
|
||||
| `apps/web/src/components/terminal.tsx` | xterm.js, WebSocket client, FitAddon |
|
||||
| `apps/api/src/api/terminal.py` | WebSocket endpoint, auth, read/write/heartbeat loops |
|
||||
| `apps/api/src/services/terminal_session.py` | PTY creation, docker exec subprocess, I/O |
|
||||
| `apps/api/src/services/terminal_manager.py` | Session lifecycle, persistence, idle cleanup |
|
||||
|
||||
### Current Bottlenecks
|
||||
|
||||
#### 1. Blocking Read with 100ms Timeout
|
||||
```python
|
||||
# terminal_session.py:read_output()
|
||||
readable, _, _ = select.select([self._master_fd], [], [], 0.1)
|
||||
if readable:
|
||||
data = os.read(self._master_fd, 4096)
|
||||
```
|
||||
**Problem:** `select.select` blocks up to 100ms when no data is available. With the read loop in `terminal.py` doing `asyncio.sleep(0.01)` between calls, worst-case latency from shell output to WebSocket is ~110ms.
|
||||
|
||||
**VS Code approach:** node-pty uses libuv's epoll/kqueue watchers — event-driven, no polling timeout.
|
||||
|
||||
#### 2. WebSocket Blob → arrayBuffer Conversion
|
||||
```typescript
|
||||
// terminal.tsx
|
||||
ws.onmessage = (event) => {
|
||||
if (event.data instanceof Blob) {
|
||||
event.data.arrayBuffer().then((buffer) => {
|
||||
const data = new Uint8Array(buffer);
|
||||
termRef.current?.write(data);
|
||||
});
|
||||
}
|
||||
}
|
||||
```
|
||||
**Problem:** Blob → arrayBuffer is async and adds microtask latency. Also forces GC pressure from transient Blobs.
|
||||
|
||||
**VS Code approach:** Uses `ws.binaryType = "arraybuffer"` — receives ArrayBuffer directly, zero-copy into Uint8Array.
|
||||
|
||||
#### 3. No asyncio-Native PTY Reading
|
||||
The PTY master fd is read with synchronous `os.read()` inside an async coroutine. This blocks the event loop thread for the duration of the read.
|
||||
|
||||
**VS Code approach:** node-pty's C++ binding hooks into libuv's event loop natively — true async I/O.
|
||||
|
||||
#### 4. Docker Exec Subprocess Overhead
|
||||
```python
|
||||
# terminal_session.py:start()
|
||||
self.process = await asyncio.create_subprocess_exec(
|
||||
"docker", "exec", "-it", "-e", "TERM=xterm",
|
||||
self.container_id, "bash", "-c", shell_cmd,
|
||||
stdin=self._slave_fd, stdout=self._slave_fd, stderr=self._slave_fd,
|
||||
)
|
||||
```
|
||||
**Problem:** Spawns a new `docker exec` process on the host. Adds process startup latency and an extra process hop.
|
||||
|
||||
**Alternative:** Docker Engine API's `attach` endpoint with `logs=0&stream=1&stdin=1&stdout=1&stderr=1` — streams directly to the API container via Unix socket. No host subprocess.
|
||||
|
||||
#### 5. No Flow Control / Backpressure
|
||||
If a command dumps output faster than the WebSocket can send (e.g., `cat /dev/urandom | base64`), data piles up in:
|
||||
- The PTY kernel buffer (limited, ~4KB)
|
||||
- Python's deque circular buffer (10KB)
|
||||
- WebSocket's internal buffer (unbounded in some implementations)
|
||||
- xterm.js parser queue
|
||||
|
||||
**VS Code approach:** Implements explicit flow control — pauses the PTY when the client buffer exceeds a threshold, resumes when drained.
|
||||
|
||||
#### 6. xterm.js Renderer
|
||||
Current: DOM renderer (default).
|
||||
**VS Code approach:** Canvas renderer with WebGL addon for GPU-accelerated rendering.
|
||||
|
||||
## Measurement Baseline
|
||||
|
||||
Before optimization, we need metrics:
|
||||
|
||||
| Metric | How to Measure | Target |
|
||||
|--------|---------------|--------|
|
||||
| Input latency | Time from keypress to character appearing | < 16ms (1 frame) |
|
||||
| Output throughput | Bytes/sec for `cat /dev/zero` | > 1 MB/s |
|
||||
| Resize latency | Time from resize message to shell reacting | < 50ms |
|
||||
| Reconnection time | Time from disconnect to full replay | < 200ms |
|
||||
| Frame drops | Dropped frames during `yes` command | 0 |
|
||||
|
||||
## Improvement Directions
|
||||
|
||||
### Direction A: Low-Latency Read Loop (Quick Win)
|
||||
Replace `select.select` + `os.read` with `asyncio` native approach:
|
||||
- Use `loop.add_reader()` to register a callback when fd is readable
|
||||
- Or use `asyncio.to_thread()` with blocking `os.read` and immediate wake
|
||||
- Eliminate the 100ms timeout and 10ms sleep
|
||||
|
||||
### Direction B: WebSocket Binary Mode (Quick Win)
|
||||
Set `ws.binaryType = "arraybuffer"` on frontend, send binary frames directly.
|
||||
Eliminates Blob → arrayBuffer conversion.
|
||||
|
||||
### Direction C: Docker Engine API Attach (Medium)
|
||||
Replace `docker exec` subprocess with direct container attach via Docker SDK or HTTP API:
|
||||
```python
|
||||
from docker import DockerClient
|
||||
client = DockerClient()
|
||||
container = client.containers.get(container_id)
|
||||
socket = container.attach_socket(params={...})
|
||||
# socket is a raw TCP/Unix socket — read with asyncio
|
||||
```
|
||||
**Pros:** No subprocess overhead, direct stream to container
|
||||
**Cons:** Requires Docker SDK or raw HTTP over Unix socket; needs `docker` group permissions
|
||||
|
||||
### Direction D: Flow Control (Medium)
|
||||
Add backpressure mechanism:
|
||||
1. Measure WebSocket send buffer depth on backend
|
||||
2. Pause reading from PTY when buffer exceeds threshold (e.g., 64KB)
|
||||
3. Resume when buffer drains below threshold
|
||||
4. Frontend: measure xterm.js parser queue depth, pause via control message
|
||||
|
||||
### Direction E: WebGL Renderer (Quick Win)
|
||||
Add xterm-addon-webgl:
|
||||
```typescript
|
||||
import { WebglAddon } from 'xterm-addon-webgl';
|
||||
term.loadAddon(new WebglAddon());
|
||||
```
|
||||
**Pros:** GPU-accelerated, much faster for large output bursts
|
||||
**Cons:** Falls back to canvas/DOM if WebGL unavailable; slightly higher init time
|
||||
|
||||
### Direction F: Output Batching (Quick Win)
|
||||
Batch small writes before sending over WebSocket:
|
||||
- Collect output for 1-2ms
|
||||
- Send as single binary frame
|
||||
- Reduces WebSocket frame overhead for high-frequency small writes (e.g., progress bars)
|
||||
|
||||
## Recommended Next Steps
|
||||
|
||||
1. **Measure baseline** with synthetic benchmarks
|
||||
2. **Implement Directions A + B + F** (low-risk, high-impact)
|
||||
3. **Evaluate Direction C** (Docker API attach) vs keeping docker exec
|
||||
4. **Add Direction D** (flow control) if throughput tests show issues
|
||||
5. **Add Direction E** (WebGL) as frontend enhancement
|
||||
|
||||
## Risks
|
||||
|
||||
- Docker API attach may not support PTY mode as cleanly as `docker exec -it`
|
||||
- WebGL addon may have compatibility issues on older GPUs
|
||||
- Flow control adds complexity; premature optimization risk
|
||||
- Changes to core I/O loop could introduce stability regressions
|
||||
@@ -0,0 +1,71 @@
|
||||
# Proposal: High-Performance Web Terminal
|
||||
|
||||
## Status
|
||||
**Phase:** proposal → spec → design → tasks → apply
|
||||
**Date:** 2026-06-02
|
||||
**Owner:** el Gentleman
|
||||
**Scope:** Terminal I/O latency, rendering performance, connection stability
|
||||
|
||||
## Problem
|
||||
|
||||
The current web terminal has noticeable latency on keystrokes, choppy scrolling, and poor performance during output bursts. Users report it feels "slow" compared to VS Code Server's terminal, which feels almost local.
|
||||
|
||||
## Goals
|
||||
|
||||
| Metric | Current | Target | How Measured |
|
||||
|--------|---------|--------|--------------|
|
||||
| Input latency (keypress → char visible) | ~110ms | < 16ms (1 frame) | `term.write()` timestamp diff |
|
||||
| Output throughput (`cat /dev/zero`) | ~200KB/s | > 1 MB/s | Bytes/sec over 5s |
|
||||
| Resize latency | ~200ms | < 50ms | Time from resize msg to shell SIGWINCH |
|
||||
| Reconnection + replay | ~2s | < 300ms | Time from WS open to first rendered char |
|
||||
| Frame drops during `yes` | Many | 0 | `requestAnimationFrame` counter |
|
||||
|
||||
## Non-Goals
|
||||
|
||||
- Changing the terminal UI/UX (chrome, controls, tabs)
|
||||
- Adding new terminal features (search, multi-cursor, etc.)
|
||||
- Changing authentication or session persistence model
|
||||
- Supporting non-Docker container runtimes
|
||||
|
||||
## Constraints
|
||||
|
||||
- Must work with existing tool instance lifecycle (docker containers)
|
||||
- Must preserve WebSocket-based architecture
|
||||
- Must preserve session persistence across reconnections
|
||||
- Must work in both development and production compose setups
|
||||
|
||||
## Solution Overview
|
||||
|
||||
Replace the blocking `select.select()` PTY read loop with asyncio-native event-driven I/O. Replace `docker exec` subprocess with Docker Engine API attach. Switch WebSocket to binary mode. Add output batching. Add WebGL renderer.
|
||||
|
||||
## Key Decisions
|
||||
|
||||
1. **Keep `docker exec` for now** — Docker SDK attach doesn't support PTY mode as cleanly. We can optimize the subprocess approach with proper fd handling.
|
||||
2. **Use `asyncio.add_reader()`** — Native asyncio event-driven fd reading eliminates polling latency.
|
||||
3. **Binary WebSocket frames** — `ws.binaryType = "arraybuffer"` eliminates Blob conversion overhead.
|
||||
4. **WebGL renderer with DOM fallback** — GPU acceleration where available, graceful fallback.
|
||||
5. **Output batching with 2ms window** — Collect small writes before sending to reduce frame overhead.
|
||||
6. **Flow control v2** — Client acknowledges processed bytes; server pauses reads when buffer is full.
|
||||
|
||||
## Risks
|
||||
|
||||
- **Event loop blocking**: `asyncio.add_reader()` on a PTY fd may not work on all platforms (should work on Linux)
|
||||
- **WebGL compatibility**: Some GPUs/drivers may fail WebGL context creation
|
||||
- **Docker exec subprocess**: Still adds overhead; may revisit Docker API attach in future
|
||||
- **Full rewrite**: Large change surface; thorough testing required
|
||||
|
||||
## Acceptance Criteria
|
||||
|
||||
- [ ] Input latency < 16ms measured with synthetic benchmark
|
||||
- [ ] Output throughput > 1 MB/s measured with `cat /dev/zero`
|
||||
- [ ] Resize latency < 50ms
|
||||
- [ ] Reconnection + replay < 300ms
|
||||
- [ ] No frame drops during `yes` command
|
||||
- [ ] All existing terminal tests pass
|
||||
- [ ] WebGL renderer loads successfully on modern browsers
|
||||
- [ ] Graceful fallback to DOM renderer if WebGL fails
|
||||
- [ ] Flow control prevents memory bloat on `cat /dev/urandom | base64`
|
||||
|
||||
## Related
|
||||
|
||||
- `openspec/explorations/terminal-responsiveness.md` — Detailed bottleneck analysis
|
||||
@@ -0,0 +1,176 @@
|
||||
# Spec: High-Performance Web Terminal
|
||||
|
||||
## Overview
|
||||
|
||||
Complete rewrite of the terminal I/O pipeline for sub-frame latency and smooth rendering.
|
||||
|
||||
## Architecture
|
||||
|
||||
### Data Flow (New)
|
||||
|
||||
```
|
||||
Container shell → docker exec PTY → host PTY master fd
|
||||
→ asyncio.add_reader() callback (event-driven, zero polling)
|
||||
→ output batcher (2ms window) → WebSocket.send_bytes()
|
||||
→ WebSocket binary frame → frontend ArrayBuffer
|
||||
→ xterm.js WebGL renderer → screen
|
||||
```
|
||||
|
||||
### Components
|
||||
|
||||
#### 1. TerminalSession (backend)
|
||||
|
||||
**Responsibilities:**
|
||||
- Create PTY via `pty.openpty()`
|
||||
- Spawn `docker exec -it` with slave fd attached
|
||||
- Read from PTY master fd using `asyncio.add_reader()`
|
||||
- Batch output (2ms window) before sending to WebSocket
|
||||
- Handle flow control (pause/resume reads based on client ack)
|
||||
- Resize via `TIOCSWINSZ` + `SIGWINCH`
|
||||
|
||||
**Interface:**
|
||||
```python
|
||||
class TerminalSession:
|
||||
async def start(self) -> None
|
||||
async def read_loop(self, websocket) -> None # event-driven
|
||||
async def write_input(self, data: bytes) -> None
|
||||
async def resize(self, cols: int, rows: int) -> None
|
||||
async def reset(self) -> None
|
||||
async def close(self) -> None
|
||||
|
||||
# Flow control
|
||||
def acknowledge_data(self, char_count: int) -> None
|
||||
def pause_output(self) -> None
|
||||
def resume_output(self) -> None
|
||||
```
|
||||
|
||||
#### 2. TerminalManager (backend)
|
||||
|
||||
Unchanged responsibilities (session lifecycle, persistence, idle cleanup).
|
||||
|
||||
#### 3. WebSocket Handler (backend)
|
||||
|
||||
**Messages:**
|
||||
|
||||
| Direction | Type | Payload | Description |
|
||||
|-----------|------|---------|-------------|
|
||||
| C → S | `input` | `{"data": "base64"}` | Keystrokes / input |
|
||||
| C → S | `resize` | `{"cols": 80, "rows": 24}` | Terminal resize |
|
||||
| C → S | `ack` | `{"chars": 1024}` | Flow control ack |
|
||||
| C → S | `reset` | `{}` | Reset session |
|
||||
| S → C | `binary` | raw bytes | Terminal output |
|
||||
| S → C | `status` | `{"status": "connected"}` | Connection status |
|
||||
| S → C | `ping` | `{}` | Heartbeat |
|
||||
|
||||
**Key changes:**
|
||||
- Output is sent as **binary WebSocket frames**, not Blob
|
||||
- Flow control: server tracks unacknowledged bytes, pauses PTY reads at 64KB threshold
|
||||
|
||||
#### 4. TerminalComponent (frontend)
|
||||
|
||||
**Key changes:**
|
||||
- `ws.binaryType = "arraybuffer"` before connection
|
||||
- Binary frames written directly to xterm.js as `Uint8Array`
|
||||
- Flow control: send `ack` messages every 4096 processed bytes
|
||||
- WebGL renderer with DOM fallback
|
||||
- Batch resize messages (debounce 50ms)
|
||||
|
||||
**xterm.js config:**
|
||||
```typescript
|
||||
const term = new Terminal({
|
||||
cursorBlink: true,
|
||||
fontSize: currentFontSize,
|
||||
fontFamily: 'Menlo, Monaco, "Courier New", monospace',
|
||||
lineHeight: 1.2,
|
||||
letterSpacing: 0,
|
||||
allowTransparency: false,
|
||||
scrollback: 10000,
|
||||
// Performance options
|
||||
ignoreBracketedPasteMode: false,
|
||||
fastScrollSensitivity: 5,
|
||||
scrollSensitivity: 1,
|
||||
});
|
||||
```
|
||||
|
||||
### Flow Control Protocol
|
||||
|
||||
**Server-side buffer tracking:**
|
||||
```python
|
||||
self._unacknowledged_bytes = 0
|
||||
self._flow_control_threshold = 64 * 1024 # 64KB
|
||||
self._paused = False
|
||||
|
||||
def on_output(self, data: bytes) -> None:
|
||||
self._unacknowledged_bytes += len(data)
|
||||
if self._unacknowledged_bytes > self._flow_control_threshold:
|
||||
self.pause_output()
|
||||
|
||||
def acknowledge_data(self, char_count: int) -> None:
|
||||
self._unacknowledged_bytes = max(0, self._unacknowledged_bytes - char_count)
|
||||
if self._paused and self._unacknowledged_bytes < self._flow_control_threshold / 2:
|
||||
self.resume_output()
|
||||
```
|
||||
|
||||
**Client-side ack strategy:**
|
||||
- After every `term.write(data)`, accumulate processed bytes
|
||||
- Send `ack` message every 4096 bytes or 100ms
|
||||
|
||||
### Output Batching
|
||||
|
||||
**Server-side batcher:**
|
||||
```python
|
||||
self._batch_buffer = bytearray()
|
||||
self._batch_timer: asyncio.TimerHandle | None = None
|
||||
self._batch_window_ms = 2
|
||||
|
||||
def queue_output(self, data: bytes) -> None:
|
||||
self._batch_buffer.extend(data)
|
||||
if self._batch_timer is None:
|
||||
self._batch_timer = asyncio.get_event_loop().call_later(
|
||||
self._batch_window_ms / 1000, self._flush_batch
|
||||
)
|
||||
|
||||
async def _flush_batch(self) -> None:
|
||||
self._batch_timer = None
|
||||
if self._batch_buffer and websocket.open:
|
||||
await websocket.send_bytes(bytes(self._batch_buffer))
|
||||
self._batch_buffer.clear()
|
||||
```
|
||||
|
||||
## Docker Exec Subprocess
|
||||
|
||||
**Command:**
|
||||
```bash
|
||||
docker exec -it -e TERM=xterm-256color <container_id> bash -il
|
||||
```
|
||||
|
||||
**Why keep docker exec:**
|
||||
- Docker SDK `attach()` doesn't support PTY allocation cleanly
|
||||
- `docker exec -it` is the standard way to get an interactive TTY
|
||||
- Subprocess overhead is acceptable compared to PTY latency improvements
|
||||
|
||||
**Optimization:** Pre-warm the connection by reusing the same `docker exec` process for the session lifetime.
|
||||
|
||||
## Error Handling
|
||||
|
||||
| Scenario | Behavior |
|
||||
|----------|----------|
|
||||
| WebGL init fails | Fall back to DOM renderer, log warning |
|
||||
| Flow control ack lost | Server resumes after timeout (5s) |
|
||||
| PTY fd closed | Close WebSocket with code 4004 |
|
||||
| Docker exec exits | Close WebSocket with code 4004, allow reconnect |
|
||||
| Binary frame too large | Split into multiple frames (max 64KB) |
|
||||
|
||||
## Testing Strategy
|
||||
|
||||
1. **Unit tests:** Mock PTY fd, verify batching, flow control, resize
|
||||
2. **Integration tests:** Full WebSocket round-trip with test container
|
||||
3. **Performance tests:**
|
||||
- `time cat /dev/zero | head -c 10M` — measure throughput
|
||||
- Rapid keypress script — measure input latency
|
||||
- Resize storm — measure resize latency
|
||||
4. **Browser tests:** WebGL fallback on devices without GPU
|
||||
|
||||
## Migration
|
||||
|
||||
Full rewrite — no migration needed. Old terminal code can be deleted.
|
||||
@@ -0,0 +1,60 @@
|
||||
# Tasks: High-Performance Web Terminal
|
||||
|
||||
## Task 1: Rewrite TerminalSession with asyncio-native I/O
|
||||
**Status:** pending
|
||||
**Files:** `apps/api/src/services/terminal_session.py` (full rewrite)
|
||||
**Description:**
|
||||
- Replace `select.select()` with `asyncio.add_reader()` for event-driven PTY reading
|
||||
- Add output batching (2ms window)
|
||||
- Add flow control (pause/resume based on client ack)
|
||||
- Keep docker exec subprocess (optimized)
|
||||
- Remove circular buffer (not needed with event-driven architecture)
|
||||
|
||||
## Task 2: Update TerminalManager for new session class
|
||||
**Status:** pending
|
||||
**Files:** `apps/api/src/services/terminal_manager.py`
|
||||
**Description:**
|
||||
- Update imports to use rewritten TerminalSession
|
||||
- Verify session lifecycle methods still work
|
||||
- Update DB persistence calls
|
||||
|
||||
## Task 3: Update WebSocket endpoint for binary frames + flow control
|
||||
**Status:** pending
|
||||
**Files:** `apps/api/src/api/terminal.py`
|
||||
**Description:**
|
||||
- Accept binary output frames from TerminalSession
|
||||
- Handle `ack` flow control messages from client
|
||||
- Send `ping` heartbeat
|
||||
- Maintain existing auth and session management
|
||||
|
||||
## Task 4: Update frontend for binary WebSocket + WebGL
|
||||
**Status:** pending
|
||||
**Files:** `apps/web/src/components/terminal.tsx`, `apps/web/package.json`
|
||||
**Description:**
|
||||
- Set `ws.binaryType = "arraybuffer"`
|
||||
- Send flow control `ack` messages
|
||||
- Add xterm-addon-webgl with DOM fallback
|
||||
- Optimize resize handling
|
||||
|
||||
## Task 5: Add performance benchmarks
|
||||
**Status:** pending
|
||||
**Files:** `apps/api/tests/benchmark_terminal.py`
|
||||
**Description:**
|
||||
- Input latency benchmark
|
||||
- Output throughput benchmark
|
||||
- Resize latency benchmark
|
||||
- Reconnection time benchmark
|
||||
|
||||
## Task 6: Update/fix unit tests
|
||||
**Status:** pending
|
||||
**Files:** `apps/api/tests/unit/test_tool_instances_legacy.py`, new tests
|
||||
**Description:**
|
||||
- Fix any tests broken by terminal changes
|
||||
- Add tests for new TerminalSession features
|
||||
|
||||
## Task 7: Run full test suite
|
||||
**Status:** pending
|
||||
**Description:**
|
||||
- Run all API tests
|
||||
- Verify no regressions
|
||||
- Report quality gate results
|
||||
Reference in New Issue
Block a user