Skip to content
Closed
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
12 changes: 12 additions & 0 deletions src/main/runtime/rpc/methods/terminal.ts
Original file line number Diff line number Diff line change
Expand Up @@ -77,11 +77,14 @@ type SnapshotFrameOptions = {
source?: 'headless' | 'renderer'
oscLinks?: TerminalOscLinkRange[]
pendingEscapeTailAnsi?: string
alternateScreen?: boolean
scrollbackAnsiLength?: number
}

type SerializedSnapshot = {
data: string
scrollbackAnsi?: string
alternateScreen?: boolean
cols: number
rows: number
seq?: number
Expand Down Expand Up @@ -665,6 +668,10 @@ function sendSnapshotFrames(
source: options.source,
oscLinks: options.oscLinks,
pendingEscapeTailAnsi: options.pendingEscapeTailAnsi,
...(options.alternateScreen === true ? { alternateScreen: true } : {}),
...(typeof options.scrollbackAnsiLength === 'number'
? { scrollbackAnsiLength: options.scrollbackAnsiLength }
: {}),
truncated: options.truncated === true,
truncatedByByteBudget: options.truncatedByByteBudget === true
})
Expand Down Expand Up @@ -2096,6 +2103,11 @@ export const TERMINAL_METHODS: RpcAnyMethod[] = [
source: serialized?.source,
oscLinks: serialized?.oscLinks,
pendingEscapeTailAnsi: serialized?.pendingEscapeTailAnsi,
alternateScreen: serialized?.alternateScreen,
scrollbackAnsiLength:
typeof serialized?.scrollbackAnsi === 'string'
? serialized.scrollbackAnsi.length
: undefined,
truncated: false,
truncatedByByteBudget: serialized?.truncatedByByteBudget,
data: serialized?.data ?? ''
Expand Down
146 changes: 146 additions & 0 deletions src/main/runtime/rpc/terminal-multiplex-escape-tail.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ import {
TerminalStreamOpcode,
decodeTerminalStreamFrame,
decodeTerminalStreamJson,
decodeTerminalStreamText,
encodeTerminalStreamFrame,
encodeTerminalStreamJson
} from '../../../shared/terminal-stream-protocol'
Expand Down Expand Up @@ -128,4 +129,149 @@ describe('terminal.multiplex pending-escape-tail threading (#7329)', () => {
vi.useRealTimers()
}
})

it('carries requested-snapshot alternate-screen metadata through the SnapshotStart frame', async () => {
vi.useFakeTimers()
try {
const messages: string[] = []
const binaryFrames: Uint8Array<ArrayBufferLike>[] = []
const handlers = new Map<
number,
(frame: NonNullable<ReturnType<typeof decodeTerminalStreamFrame>>) => void
>()
const cleanups = new Map<string, () => void>()
const runtime = stubRuntime({
resolveLiveLeafForHandle: vi.fn().mockReturnValue({ ptyId: 'pty-1' }),
readTerminal: vi.fn().mockResolvedValue({ tail: [], truncated: false }),
serializeTerminalBuffer: vi
.fn()
.mockResolvedValueOnce({
data: 'user@host:~$ ',
cols: 80,
rows: 24
})
.mockResolvedValueOnce({
data: 'alternate frame',
cols: 80,
rows: 24,
alternateScreen: true,
scrollbackAnsi: 'history\r\n'
}),
getTerminalSize: vi.fn().mockReturnValue({ cols: 80, rows: 24 }),
getMobileDisplayMode: vi.fn().mockReturnValue('auto'),
getLayout: vi.fn().mockReturnValue({ seq: 1 }),
registerRemoteTerminalViewSubscriber: vi.fn(() => () => {}),
subscribeToTerminalData: vi.fn().mockReturnValue(vi.fn()),
subscribeToTerminalResize: vi.fn().mockReturnValue(vi.fn()),
subscribeToFitOverrideChanges: vi.fn().mockReturnValue(vi.fn()),
subscribeToDriverChanges: vi.fn().mockReturnValue(vi.fn()),
getTerminalFitOverride: vi.fn().mockReturnValue(null),
getDriver: vi.fn().mockReturnValue({ kind: 'idle' }),
registerSubscriptionCleanup: vi.fn((id: string, cleanup: () => void) => {
cleanups.set(id, cleanup)
}),
cleanupSubscription: vi.fn((id: string) => {
const cleanup = cleanups.get(id)
cleanups.delete(id)
cleanup?.()
}),
waitForTerminal: vi.fn(() => new Promise<RuntimeTerminalWait>(() => {})),
updateDesktopViewport: vi.fn().mockResolvedValue(true)
})
const dispatcher = new RpcDispatcher({
runtime,
methods: TERMINAL_METHODS
})

const dispatchPromise = dispatcher.dispatchStreaming(
makeRequest('terminal.multiplex', {}),
(msg) => messages.push(msg),
{
connectionId: 'conn-1',
sendBinary: (bytes) => {
binaryFrames.push(bytes)
},
registerBinaryStreamHandler: (streamId, handler) => {
handlers.set(streamId, handler)
return () => handlers.delete(streamId)
}
}
)

await vi.runOnlyPendingTimersAsync()
expect(messages.some((msg) => JSON.parse(msg).result?.type === 'ready')).toBe(true)

const handler = handlers.get(0)!
handler(
decodeTerminalStreamFrame(
encodeTerminalStreamFrame({
opcode: TerminalStreamOpcode.Subscribe,
streamId: 0,
seq: 1,
payload: encodeTerminalStreamJson({
streamId: 5,
terminal: 'terminal-1',
client: { id: 'desktop-1', type: 'desktop' }
})
})
)!
)
for (let i = 0; i < 5; i += 1) {
await vi.runOnlyPendingTimersAsync()
}

handlers.get(5)!(
decodeTerminalStreamFrame(
encodeTerminalStreamFrame({
opcode: TerminalStreamOpcode.SnapshotRequest,
streamId: 5,
seq: 2,
payload: encodeTerminalStreamJson({
requestId: 99,
scrollbackRows: 100
})
})
)!
)
for (let i = 0; i < 5; i += 1) {
await vi.runOnlyPendingTimersAsync()
}

const requestedSnapshotStart = binaryFrames
.map((frame) => decodeTerminalStreamFrame(frame))
.find((frame) => {
if (frame?.opcode !== TerminalStreamOpcode.SnapshotStart) {
return false
}
const payload = decodeTerminalStreamJson<{ requestId?: unknown }>(frame.payload)
return payload?.requestId === 99
})!
expect(decodeTerminalStreamJson(requestedSnapshotStart.payload)).toMatchObject({
requestId: 99,
alternateScreen: true,
scrollbackAnsiLength: 'history\r\n'.length
})
const requestedSnapshotStartIndex = binaryFrames.findIndex((frame) => {
const decoded = decodeTerminalStreamFrame(frame)
if (decoded?.opcode !== TerminalStreamOpcode.SnapshotStart) {
return false
}
const payload = decodeTerminalStreamJson<{ requestId?: unknown }>(decoded.payload)
return payload?.requestId === 99
})
const requestedSnapshotChunk = binaryFrames
.slice(requestedSnapshotStartIndex + 1)
.map((frame) => decodeTerminalStreamFrame(frame))
.find((frame) => frame?.opcode === TerminalStreamOpcode.SnapshotChunk)
expect(requestedSnapshotChunk).toBeTruthy()
expect(decodeTerminalStreamText(requestedSnapshotChunk!.payload)).toBe(
'history\r\nalternate frame'
)

runtime.cleanupSubscription('terminal-multiplex:conn-1')
await dispatchPromise
} finally {
vi.useRealTimers()
}
})
})
109 changes: 109 additions & 0 deletions src/renderer/src/components/terminal-pane/pty-connection.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -11527,13 +11527,122 @@ describe('connectPanePty', () => {
expect(getMainBufferSnapshot).not.toHaveBeenCalled()
expect(transport.serializeBuffer).toHaveBeenCalledWith({ scrollbackRows: 5000 })
expect(pane.terminal.write).not.toHaveBeenCalledWith(hidden)
expect(pane.terminal.write).toHaveBeenCalledWith('\x1b[2J\x1b[3J\x1b[H', expect.any(Function))
expect(pane.terminal.write).not.toHaveBeenCalledWith(
'\x1b[0m\x1b[?1049h\x1b[2J\x1b[H',
expect.any(Function)
)
expect(pane.terminal.write).toHaveBeenCalledWith(
expect.stringContaining('remote snapshot with hidden remote output'),
expect.any(Function)
)
disposable.dispose()
})

it('restores remote alternate-screen snapshots with preserved scrollback', async () => {
const { connectPanePty } = await import('./pty-connection')
const transport = createMockTransport('remote:env-1@@terminal-1')
const capturedDataCallback: {
current: ((data: string, meta?: { seq?: number; rawLength?: number }) => void) | null
} = { current: null }
const hidden = 'x'.repeat(2 * 1024 * 1024 + 1)
const live = 'visible remote output\r\n'
transport.serializeBuffer = vi.fn().mockResolvedValueOnce({
data: 'remote alt snapshot with history\r\n',
cols: 120,
rows: 40,
seq: hidden.length + live.length,
source: 'headless',
alternateScreen: true,
scrollbackAnsi: 'remote shell history\r\n'
})
transport.connect.mockImplementation(async ({ callbacks }: { callbacks: ConnectCallbacks }) => {
capturedDataCallback.current = callbacks.onData ?? null
return 'remote:env-1@@terminal-1'
})
transportFactoryQueue.push(transport)

const pane = createPane(1)
const manager = createManager(1)
const deps = createDeps({ isVisibleRef: { current: false } })
const disposable = connectPanePty(pane as never, manager as never, deps as never)
await flushAsyncTicks(6)

capturedDataCallback.current?.(hidden, { seq: hidden.length, rawLength: hidden.length })
;(deps.isVisibleRef as { current: boolean }).current = true
capturedDataCallback.current?.(live, {
seq: hidden.length + live.length,
rawLength: live.length
})
await flushAsyncTicks(20)

expect(pane.terminal.write).toHaveBeenCalledWith(
'\x1b[?1049l\x1b[2J\x1b[3J\x1b[H',
expect.any(Function)
)
expect(pane.terminal.write).toHaveBeenCalledWith(
'remote shell history\r\n',
expect.any(Function)
)
expect(pane.terminal.write).toHaveBeenCalledWith(
'remote alt snapshot with history\r\n',
expect.any(Function)
)

disposable.dispose()
})

it('restores remote alternate-screen snapshots without preserved scrollback', async () => {
const { connectPanePty } = await import('./pty-connection')
const transport = createMockTransport('remote:env-1@@terminal-1')
const capturedDataCallback: {
current: ((data: string, meta?: { seq?: number; rawLength?: number }) => void) | null
} = { current: null }
const hidden = 'x'.repeat(2 * 1024 * 1024 + 1)
const live = 'visible remote output\r\n'
transport.serializeBuffer = vi.fn().mockResolvedValue({
data: 'remote alt snapshot without history\r\n',
cols: 120,
rows: 40,
seq: hidden.length + live.length,
source: 'headless',
alternateScreen: true
})
transport.connect.mockImplementation(async ({ callbacks }: { callbacks: ConnectCallbacks }) => {
capturedDataCallback.current = callbacks.onData ?? null
return 'remote:env-1@@terminal-1'
})
transportFactoryQueue.push(transport)

const pane = createPane(1)
const manager = createManager(1)
const deps = createDeps({ isVisibleRef: { current: false } })
const disposable = connectPanePty(pane as never, manager as never, deps as never)
await flushAsyncTicks(6)

capturedDataCallback.current?.(hidden, { seq: hidden.length, rawLength: hidden.length })
;(deps.isVisibleRef as { current: boolean }).current = true
capturedDataCallback.current?.(live, {
seq: hidden.length + live.length,
rawLength: live.length
})
await flushAsyncTicks(20)

expect(pane.terminal.write).toHaveBeenCalledWith(
'\x1b[0m\x1b[?1049h\x1b[2J\x1b[H',
expect.any(Function)
)
expect(pane.terminal.write).not.toHaveBeenCalledWith(
'\x1b[?1049l\x1b[2J\x1b[3J\x1b[H',
expect.any(Function)
)
expect(pane.terminal.write).toHaveBeenCalledWith(
'remote alt snapshot without history\r\n',
expect.any(Function)
)
disposable.dispose()
})

it('defers inactive split-pane plain hidden output restore until the pane returns', async () => {
const { resetHiddenOutputRestoreSchedulerForTests } =
await import('./hidden-output-restore-scheduler')
Expand Down
Loading