Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 39 additions & 0 deletions apps/web/src/terminal/ghostty/core.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -534,6 +534,45 @@ describe("GhosttyTerminalCore snapshots", () => {

expect(modes()).toEqual(live);
});

it.each([
// The shell's cursor-position query, ESC[6n.
{ name: "a query", start: "\x1b[6", rest: "n" },
// A window title, which runs until its BEL.
{ name: "a title string", start: "\x1b]0;ti", rest: "tle\x07" },
])("completes a control sequence that a clear splits ($name)", async ({ start, rest }) => {
const replies: string[] = [];
const referenceReplies: string[] = [];
const [core, reference] = await Promise.all([
createCore((data) => replies.push(data)),
createCore((data) => referenceReplies.push(data)),
]);
let state = createSession("");
const initial = readTerminalOutputUpdate(state.output, INITIAL_TERMINAL_OUTPUT_CURSOR);
writeTerminalOutputUpdate(core, initial);
let cursor = initial.cursor;
const apply = (next: TerminalBufferState) => {
state = next;
const update = readTerminalOutputUpdate(state.output, cursor);
writeTerminalOutputUpdate(core, update);
cursor = update.cursor;
};

apply(append(state, `before${start}`));
apply(
applyTerminalAttachStreamEvent(state, {
type: "cleared",
threadId: "terminal-stream-test",
terminalId: "term-1",
}),
);
apply(append(state, `${rest}after`));

// An empty screen that got the sequence in one piece.
reference.write(`${start}${rest}after`);
expect(core.snapshot()).toEqual(reference.snapshot());
expect(replies).toEqual(referenceReplies);
});
});

describe("GhosttyTerminalCore scrollback", () => {
Expand Down
12 changes: 7 additions & 5 deletions packages/client-runtime/src/state/terminalOutput.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ import {
TERMINAL_SEQUENCE_GROUND,
terminalSequenceEnd,
terminalSequenceStateAfter,
unfinishedTerminalSequence,
} from "@t3tools/contracts";

export interface TerminalOutputChunk {
Expand Down Expand Up @@ -280,13 +281,14 @@ const CLEAR_TERMINAL_TEXT = "\u001b[H\u001b[2J\u001b[3J";

/** Earlier output stays retained so a replay from the start restores those modes. */
function clearOutput(current: TerminalOutputState, maxBufferBytes: number): TerminalOutputState {
// The erase rides over the budget: trimming here would evict the output that set those modes.
// The erase's ESC makes an emulator abandon a control sequence it is partway through and draw
// the rest as text, so the start of that sequence is sent again after the erase.
const open = unfinishedTerminalSequence(current.chunks.map((chunk) => chunk.data).join(""));
// Both ride over the budget: trimming here would evict the output that set those modes.
const cleared = appendOutput(
current,
CLEAR_TERMINAL_TEXT,
maxBufferBytes <= 0
? maxBufferBytes
: Math.max(maxBufferBytes, current.retainedBytes + CLEAR_TERMINAL_TEXT.length),
`${CLEAR_TERMINAL_TEXT}${open}`,
maxBufferBytes <= 0 ? maxBufferBytes : Number.POSITIVE_INFINITY,
);
return { ...cleared, textStartOffset: cleared.nextOffset };
}
Expand Down
29 changes: 29 additions & 0 deletions packages/client-runtime/src/state/terminalSession.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ import {
INITIAL_TERMINAL_OUTPUT_CURSOR,
nextTerminalAttachSeedState,
readTerminalOutputUpdate,
terminalOutputReplay,
terminalOutputText,
} from "./terminalSession.ts";

Expand Down Expand Up @@ -352,6 +353,34 @@ describe("terminal session reducers", () => {
expect(state.lifecycleVersion).toBe(2);
});

it("sends the start of an unfinished control sequence again after the erase", () => {
const erase = "\u001b[H\u001b[2J\u001b[3J";
const open = "\u001b]0;é";
// A full 16-byte buffer that ends partway through a title string that came in two outputs.
let state = EMPTY_TERMINAL_BUFFER_STATE;
for (const data of ["0123456789\u001b]0;", "é"]) {
state = applyTerminalAttachStreamEvent(
state,
{ type: "output", threadId: TARGET.threadId, terminalId: TARGET.terminalId, data },
16,
);
}
const cursor = readTerminalOutputUpdate(state.output, INITIAL_TERMINAL_OUTPUT_CURSOR).cursor;

state = applyTerminalAttachStreamEvent(
state,
{ type: "cleared", threadId: TARGET.threadId, terminalId: TARGET.terminalId },
16,
);
expect(readTerminalOutputUpdate(state.output, cursor)).toMatchObject({
type: "append",
data: `${erase}${open}`,
});
// An older mobile binary recreates its emulator unless the new replay extends the last one.
expect(terminalOutputReplay(state.output)).toBe(`0123456789${open}${erase}${open}`);
expect(terminalOutputText(state.output)).toBe("");
});

it("does not reuse a renderer cursor when a fresh attach has matching counters", () => {
const first = applyTerminalAttachStreamEvent(nextTerminalAttachSeedState(), {
type: "snapshot",
Expand Down
17 changes: 17 additions & 0 deletions packages/contracts/src/terminal.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ import {
TerminalError,
TerminalOpenInput,
TerminalProviderEnvironmentError,
unfinishedTerminalSequence,
} from "./terminal.ts";
import { ProviderInstanceId } from "./providerInstance.ts";

Expand Down Expand Up @@ -71,3 +72,19 @@ describe("chunkTerminalWrite", () => {
expect(chunks.join("")).toBe(data);
});
});

describe("unfinishedTerminalSequence", () => {
it.each([
{ name: "a query after a finished colour change", text: "a\x1b[31mb\x1b[6", open: "\x1b[6" },
{ name: "text after a finished sequence", text: "a\x1b[31mb", open: "" },
{ name: "text with no ESC", text: "]abc", open: "" },
{ name: "an ESC alone", text: "ab\x1b", open: "\x1b" },
// A terminal runs these controls when they arrive, so they are not sent again.
{ name: "a CSI holding a space and a line feed", text: "\x1b[2 \n", open: "\x1b[2 " },
{ name: "an escape holding a tab and a backspace", text: "\x1b\t(\b", open: "\x1b(" },
{ name: "a title string holding a line feed", text: "\x1b]0;a\nb", open: "\x1b]0;a\nb" },
{ name: "an ended title string", text: "\x1b]0;a\x07", open: "" },
])("returns the open sequence after $name", ({ text, open }) => {
expect(unfinishedTerminalSequence(text)).toBe(open);
});
});
24 changes: 24 additions & 0 deletions packages/contracts/src/terminal.ts
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,30 @@ export function terminalSequenceEnd(state: number, text: string): number {
return index;
}

/**
* The unfinished control sequence `text` ends in, as text that takes a terminal in ground state
* back to the same point, or "" when `text` ends outside a sequence or lacks that sequence's ESC.
* It leaves out the C0 controls inside an escape or CSI sequence, which a terminal runs on arrival.
*/
export function unfinishedTerminalSequence(text: string): string {
const escape = text.lastIndexOf("\u001b");
if (escape < 0) return "";
const kept: string[] = [];
let keptStart = escape;
let state = SEQUENCE_ESCAPE;
for (let index = escape + 1; index < text.length; index += 1) {
const unit = text.charCodeAt(index);
if (unit < 0x20 && (state & 7) <= SEQUENCE_CSI) {
kept.push(text.slice(keptStart, index));
keptStart = index + 1;
}
state = nextTerminalSequenceState(state, unit);
if (state === TERMINAL_SEQUENCE_GROUND) return "";
}
kept.push(text.slice(keptStart));
return kept.join("");
}

/**
* The final `maxBytes` of UTF-8 a client retains, starting at a code point boundary and
* outside any control sequence the cut went through.
Expand Down