Preserve terminal mouse encoding and grid across workspace transfers #630
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,4 @@ | ||
| import type { TerminalGrid } from './terminal-transfer'; | ||
| import { adoptOrphanedHelper, restoreHelper } from './helper-terminal'; | ||
| import type { LathPersistedLayout } from './lath/persistence'; | ||
| import type { PlatformAdapter, PtyInfo } from './platform/types'; | ||
|
|
@@ -38,6 +39,8 @@ export interface LivePtys { | |
| * same behavior through `resumeOrRestore`. | ||
| */ | ||
| export interface ResumePlanOptions { | ||
| /** Source grids for serialized transfer buffers, before target layout fits. */ | ||
| terminalGrids?: ReadonlyMap<string, TerminalGrid>; | ||
| /** The record to plan from; `undefined` reads the platform slot, `null` is "none". */ | ||
| savedSession?: PersistedSession | null; | ||
| /** Live ids this plan owns by name. Omitted claims every live PTY. */ | ||
|
|
@@ -196,7 +199,7 @@ export function resumeOrRestoreFrom( | |
|
|
||
| const mine = live.ptys.filter((pty) => | ||
| opts.ptyIds === undefined || opts.ptyIds.has(pty.id) || opts.claimUnowned?.has(pty.id)); | ||
| const resumed = mine.length > 0 ? resumeLivePtys(mine, live.replay, saved, opts.terminalGrids) : null; | ||
| if (resumed) return hydrateNotepad(platform, resumed); | ||
|
|
||
| const restored = restoreSession(platform, { savedSession: saved }); | ||
|
|
@@ -217,15 +220,18 @@ function resumeLivePtys( | |
| ptyList: PtyInfo[], | ||
| replayBuffer: Map<string, string>, | ||
| saved: PersistedSession | null, | ||
| grids?: ReadonlyMap<string, TerminalGrid>, | ||
| ): ReconnectResult { | ||
| const savedResumeInfo = getSavedPaneResumeInfo(saved, ptyList.map((pty) => pty.id)); | ||
| const ids: string[] = []; | ||
| const ptyById = new Map(ptyList.map((pty) => [pty.id, pty])); | ||
| for (const pty of ptyList) { | ||
| const resumeInfo: { alive: boolean; exitCode?: number; shell?: string; title?: string; untouched?: boolean; helper?: PtyInfo['helper']; grid?: TerminalGrid } = { | ||
| alive: pty.alive, | ||
| exitCode: pty.exitCode, | ||
| }; | ||
| const grid = grids?.get(pty.id); | ||
| if (grid) resumeInfo.grid = grid; | ||
| if (pty.shell !== undefined) resumeInfo.shell = pty.shell; | ||
| const savedInfo = savedResumeInfo.get(pty.id); | ||
| if (savedInfo?.title !== undefined) resumeInfo.title = savedInfo.title; | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,4 @@ | ||
| import { serializeTransferTerminal, type TerminalGrid } from './terminal-transfer'; | ||
| import { Terminal, type IBufferRange } from '@xterm/xterm'; | ||
| import { FitAddon } from '@xterm/addon-fit'; | ||
| import { SerializeAddon } from '@xterm/addon-serialize'; | ||
|
|
@@ -133,13 +134,14 @@ function readDisplayTextFromBuffer(terminal: Terminal, range: IBufferRange): str | |
| } | ||
| } | ||
|
|
||
| function createXtermHost(grid?: TerminalGrid): { terminal: Terminal; fit: FitAddon; serialize: SerializeAddon; element: HTMLDivElement } { | ||
| const styles = getComputedStyle(document.body); | ||
| const editorFontSize = parseInt(styles.getPropertyValue('--vscode-editor-font-size'), 10) || 12; | ||
| const editorFontFamily = styles.getPropertyValue('--vscode-editor-font-family').trim() || "'SF Mono', Menlo, Monaco, monospace"; | ||
|
|
||
| const theme = getTerminalTheme(); | ||
| const terminal = new Terminal({ | ||
| ...grid, | ||
| allowProposedApi: true, | ||
| fontSize: editorFontSize, | ||
| fontFamily: editorFontFamily, | ||
|
|
@@ -290,8 +292,8 @@ function wireXtermHandlers( | |
| }; | ||
| } | ||
|
|
||
| function setupTerminalEntry(id: string, options: { shell?: string; untouched?: boolean; helper?: HelperIdentity; grid?: TerminalGrid } = {}): TerminalEntry { | ||
| const { terminal, fit, serialize, element } = createXtermHost(options.grid); | ||
| const selectionBaselineRef = { current: null as string | null }; | ||
| // Every module that finalizes a selection arms the render handler through | ||
| // this one setter: the mouse router at drag end, a note's pin on reveal. | ||
|
|
@@ -439,12 +441,13 @@ export function getOrCreateTerminal(id: string): TerminalEntry { | |
| export function resumeTerminal( | ||
| id: string, | ||
| replayData: string | null, | ||
| exitInfo?: { alive: boolean; exitCode?: number; shell?: string; title?: string | null; untouched?: boolean; helper?: HelperIdentity; grid?: TerminalGrid }, | ||
| ): TerminalEntry { | ||
| const existing = registry.get(id); | ||
| if (existing) return existing; | ||
|
|
||
| const entry = setupTerminalEntry(id, { | ||
| grid: exitInfo?.grid, | ||
| helper: exitInfo?.helper, | ||
| shell: exitInfo?.shell, | ||
| untouched: exitInfo?.untouched ?? false, | ||
|
|
@@ -544,7 +547,7 @@ export async function serializeTerminal(id: string): Promise<string | null> { | |
| const entry = registry.get(id); | ||
| if (!entry) return null; | ||
| await flushTerminal(id); | ||
| return serializeTransferTerminal(entry.terminal, entry.serialize); | ||
| } | ||
|
|
||
| /** Resolves once everything written to the Session so far is in its buffer. | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,56 @@ | ||
| // @vitest-environment jsdom | ||
| import { describe, expect, it } from 'vitest'; | ||
| import { Terminal } from '@xterm/xterm'; | ||
| import { SerializeAddon } from '@xterm/addon-serialize'; | ||
| import { serializeTransferTerminal } from './terminal-transfer'; | ||
|
|
||
| const write = (terminal: Terminal, data: string) => new Promise<void>(resolve => terminal.write(data, resolve)); | ||
| async function mode(terminal: Terminal, number: number): Promise<string> { | ||
| let report = ''; | ||
| const listener = terminal.onData(data => { report += data; }); | ||
| await write(terminal, `\x1b[?${number}$p`); | ||
| listener.dispose(); | ||
| return report; | ||
| } | ||
|
|
||
| describe('terminal transfer serialization', () => { | ||
| it.each([1006, 1016])('preserves mouse tracking and encoding %i through real xterm parsing', async encoding => { | ||
| const source = new Terminal({ allowProposedApi: true }); | ||
| const target = new Terminal({ allowProposedApi: true }); | ||
| const serializer = new SerializeAddon(); | ||
| source.loadAddon(serializer); | ||
| try { | ||
| await write(source, `\x1b[?1003h\x1b[?${encoding}h`); | ||
| await write(target, serializeTransferTerminal(source, serializer)); | ||
| expect(target.modes.mouseTrackingMode).toBe('any'); | ||
| expect(await mode(target, encoding)).toBe(`\x1b[?${encoding};1$y`); | ||
| } finally { source.dispose(); target.dispose(); } | ||
| }); | ||
|
|
||
| it.each(['\x1b[?1006l', '\x1bc'])('does not resurrect encoding after reset %j', async reset => { | ||
| const source = new Terminal({ allowProposedApi: true }); | ||
| const target = new Terminal({ allowProposedApi: true }); | ||
| const serializer = new SerializeAddon(); | ||
| source.loadAddon(serializer); | ||
| try { | ||
| await write(source, '\x1b[?1006h' + reset); | ||
| await write(target, serializeTransferTerminal(source, serializer)); | ||
| expect(await mode(target, 1006)).toBe('\x1b[?1006;2$y'); | ||
| } finally { source.dispose(); target.dispose(); } | ||
| }); | ||
|
|
||
| it('rebuilds a full-screen grid larger than xterm defaults without clipping', async () => { | ||
| const grid = { cols: 120, rows: 45 }; | ||
| const source = new Terminal({ ...grid, allowProposedApi: true }); | ||
| const target = new Terminal({ ...grid, allowProposedApi: true }); | ||
| const serializer = new SerializeAddon(); | ||
| source.loadAddon(serializer); | ||
| try { | ||
| await write(source, '\x1b[?1049h\x1b[45;100Hbottom-right'); | ||
| await write(target, serializeTransferTerminal(source, serializer)); | ||
| expect(target.buffer.active.type).toBe('alternate'); | ||
| expect(target.buffer.active.getLine(44)?.translateToString(true)).toContain('bottom-right'); | ||
| expect(target.buffer.active.cursorY).toBe(source.buffer.active.cursorY); | ||
| } finally { source.dispose(); target.dispose(); } | ||
| }); | ||
| }); |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| @@ -0,0 +1,16 @@ | ||||||||||||||
| import type { Terminal } from '@xterm/xterm'; | ||||||||||||||
| import type { SerializeAddon } from '@xterm/addon-serialize'; | ||||||||||||||
|
|
||||||||||||||
| export interface TerminalGrid { cols: number; rows: number } | ||||||||||||||
|
|
||||||||||||||
| /** The pinned serializer omits mouse encoding. Read xterm's resolved state, | ||||||||||||||
| * including resets, rather than infer it from output chunks. This private | ||||||||||||||
| * accessor is pinned by real-xterm round-trip tests in terminal-transfer.test.ts. | ||||||||||||||
| */ | ||||||||||||||
| export function serializeTransferTerminal(terminal: Terminal, serialize: SerializeAddon): string { | ||||||||||||||
| const encoding = (terminal as unknown as { | ||||||||||||||
| _core: { mouseStateService: { activeEncoding: string } }; | ||||||||||||||
| })._core.mouseStateService.activeEncoding; | ||||||||||||||
|
Comment on lines
+11
to
+13
Collaborator
There was a problem hiding this comment. A missing
Suggested change
|
||||||||||||||
| const mode = encoding === 'SGR' ? 1006 : encoding === 'SGR_PIXELS' ? 1016 : null; | ||||||||||||||
| return serialize.serialize() + (mode === null ? '' : `\x1b[?${mode}h`); | ||||||||||||||
| } | ||||||||||||||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
AGENTS.md: "Name the test that pins a rule" — and the
Source of truth:paragraph just below already cites by test title. This fits the 5,850-word budget (5,840); adding theworkspace-move.test.tscase needs a--ratchetin the same commit.