Skip to content
Merged
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
71 changes: 71 additions & 0 deletions ui/src/components/TerminalTab.test.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
import { createRef } from 'react'
import { fireEvent, render, screen, within } from '@testing-library/react'
import { beforeEach, expect, it, vi } from 'vitest'
import type { ConnectionStatus } from '../hooks/useTerminalConnection'
import TerminalTab from './TerminalTab'

const connection = vi.hoisted(() => ({
status: 'connected' as ConnectionStatus,
connect: vi.fn(),
sendShortcut: vi.fn(),
}))
vi.mock('../hooks/useTerminalConnection', () => ({
useTerminalConnection: () => ({
...connection, containerRef: createRef(), termRef: { current: {} }, errorMsg: '连接已断开',
}),
}))
vi.mock('../contexts/ThemeContext', () => ({ useTheme: () => ({ mode: 'dark', colors: { colorPrimary: '#1677ff' } }) }))
const props = { serverId: 1, serverName: 'demo', isActive: true, fontSize: 14 }

beforeEach(() => { connection.status = 'connected'; vi.clearAllMocks() })

it('keeps the shortcut group and toggle together outside the terminal body', () => {
const { container } = render(<TerminalTab {...props} />)
const group = screen.getByRole('group', { name: '终端快捷键' })
const toggle = screen.getByRole('button', { name: '隐藏快捷键' })
expect(group.parentElement).toBe(toggle.parentElement)
expect(group.parentElement).toHaveClass('terminal-tools')
expect(container.querySelector('.terminal-body')).not.toHaveAttribute('style')
expect(toggle).not.toHaveAttribute('style')
expect(within(group).getAllByRole('button')).toHaveLength(16)
expect(toggle).toHaveAttribute('aria-expanded', 'true')
})

it('collapses and restores shortcuts without replacing the terminal host', () => {
const { container } = render(<TerminalTab {...props} />)
const host = container.querySelector('.terminal-container')
fireEvent.click(screen.getByRole('button', { name: '隐藏快捷键' }))
expect(screen.queryByRole('group', { name: '终端快捷键' })).not.toBeInTheDocument()
const toggle = screen.getByRole('button', { name: '显示快捷键' })
expect(toggle).toHaveAttribute('aria-expanded', 'false')
expect(toggle).toHaveTextContent('快捷键')
fireEvent.click(toggle)
expect(screen.getByRole('group', { name: '终端快捷键' })).toBeInTheDocument()
expect(container.querySelector('.terminal-container')).toBe(host)
expect(connection.connect).not.toHaveBeenCalled()
})

it('preserves control sequences and does not take keyboard focus on mouse down', () => {
render(<TerminalTab {...props} />)
const ctrlC = screen.getByRole('button', { name: 'Ctrl+C' })
expect(fireEvent.mouseDown(ctrlC)).toBe(false)
fireEvent.click(ctrlC)
fireEvent.click(screen.getByRole('button', { name: '↑' }))
fireEvent.click(screen.getByRole('button', { name: ':wq' }))
expect(connection.sendShortcut.mock.calls).toEqual([['\x03'], ['\x1b[A'], [':wq\r']])
})

it('removes the entire footer while connecting or disconnected', () => {
connection.status = 'connecting'
const view = render(<TerminalTab {...props} />)
expect(view.container.querySelector('.terminal-tools')).toBeNull()
connection.status = 'connected'
view.rerender(<TerminalTab {...props} />)
expect(screen.getByRole('button', { name: '隐藏快捷键' })).toBeInTheDocument()
connection.status = 'error'
view.rerender(<TerminalTab {...props} />)
expect(view.container.querySelector('.terminal-tools')).toBeNull()
expect(screen.getByRole('alert')).toHaveTextContent('连接已断开')
fireEvent.click(screen.getByRole('button', { name: /重新连接/ }))
expect(connection.connect).toHaveBeenCalledOnce()
})
16 changes: 9 additions & 7 deletions ui/src/components/TerminalTab.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ export default function TerminalTab({ serverId, serverName, isActive, fontSize,

return (
<div className="terminal-session">
<div className="terminal-body" style={{ paddingBottom: showBar && status === 'connected' ? 88 : 0 }}>
<div className="terminal-body">
<div ref={containerRef} className="terminal-container" />
{status === 'connecting' && <div className="terminal-overlay"><Spin size="small" /><span>正在连接 {serverName}…</span></div>}
{status === 'error' && termRef.current && <div className="terminal-disconnected">
Expand All @@ -65,13 +65,15 @@ export default function TerminalTab({ serverId, serverName, isActive, fontSize,
</div>
</div>}
</div>
{showBar && status === 'connected' && <div className="mobile-shortcut-bar" role="group" aria-label="终端快捷键">
{SHORTCUTS.map(shortcut => <button className="terminal-shortcut" key={shortcut.label} onMouseDown={event => event.preventDefault()} onClick={() => sendShortcut(shortcut.data)}>{shortcut.label}</button>)}
{status === 'connected' && <div className="terminal-tools">
{showBar && <div className="mobile-shortcut-bar" role="group" aria-label="终端快捷键">
{SHORTCUTS.map(shortcut => <button className="terminal-shortcut" key={shortcut.label} onMouseDown={event => event.preventDefault()} onClick={() => sendShortcut(shortcut.data)}>{shortcut.label}</button>)}
</div>}
<button className="shortcut-toggle" onMouseDown={event => event.preventDefault()} onClick={() => setShowBar(value => !value)}
aria-label={showBar ? '隐藏快捷键' : '显示快捷键'} title={showBar ? '隐藏快捷键' : '显示快捷键'} aria-expanded={showBar}>
<CodeOutlined />{!showBar && <span>快捷键</span>}
</button>
</div>}
{status === 'connected' && <button className="shortcut-toggle" onMouseDown={event => event.preventDefault()} onClick={() => setShowBar(value => !value)}
aria-label={showBar ? '隐藏快捷键' : '显示快捷键'} title={showBar ? '隐藏快捷键' : '显示快捷键'} aria-pressed={showBar} style={{ bottom: showBar ? 98 : 10 }}>
<CodeOutlined />
</button>}
</div>
)
}
12 changes: 12 additions & 0 deletions ui/src/hooks/useTerminalConnection.test.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,18 @@ describe('terminal connection ownership', () => {
view.unmount()
})

it('writes stdout and stderr without overriding the terminal scroll position', () => {
const view = render(<Harness />)
const socket = Socket.instances[0]
const terminal = mocks.terminals[0]
terminal.scrollToBottom = vi.fn()
act(() => { socket.receive(4); socket.receive(0, 'output'); socket.receive(1, 'stderr') })
expect(terminal.write.mock.calls.map(([bytes]: [Uint8Array]) => new TextDecoder().decode(bytes))).toEqual(['output', 'stderr'])
expect(terminal.scrollToBottom).not.toHaveBeenCalled()
expect(terminal.options.scrollback).toBe(5000)
view.unmount()
})

it('detaches old sockets, guards late callbacks and uses current theme/font on manual reconnect', () => {
const view = render(<Harness />)
const old = Socket.instances[0]
Expand Down
11 changes: 4 additions & 7 deletions ui/src/hooks/useTerminalConnection.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,11 @@ import { useCallback, useEffect, useRef, useState } from 'react'
import { Terminal, type ITheme } from '@xterm/xterm'
import { FitAddon } from '@xterm/addon-fit'
import { WebLinksAddon } from '@xterm/addon-web-links'
import { attachTerminalTouch } from '../utils/terminalTouch'

export type ConnectionStatus = 'connecting' | 'connected' | 'error'
export const INPUT_CHUNK_BYTES = 16 * 1024

// 新数据到达时,若光标位于视口底部(用户没有上翻浏览历史)则自动滚到底部
const autoScrollBottom = (term: Terminal) => {
const buffer = term.buffer.active
if (buffer.cursorY === term.rows - 1 || buffer.cursorY === 0) term.scrollToBottom()
}

export function* inputFrames(data: string) {
const bytes = new TextEncoder().encode(data)
for (let offset = 0; offset < bytes.length; offset += INPUT_CHUNK_BYTES) {
Expand Down Expand Up @@ -74,6 +69,7 @@ export function useTerminalConnection(serverId: number, fontSize: number, theme:
term.loadAddon(fit)
term.loadAddon(new WebLinksAddon())
term.open(containerRef.current)
const disposeTouch = attachTerminalTouch(term)
termRef.current = term
fitRef.current = fit
const proto = location.protocol === 'https:' ? 'wss:' : 'ws:'
Expand Down Expand Up @@ -134,7 +130,7 @@ export function useTerminalConnection(serverId: number, fontSize: number, theme:
const payload = buffer.subarray(1)
switch (buffer[0]) {
case 0x00:
case 0x01: term.write(payload); autoScrollBottom(term); break
case 0x01: term.write(payload); break
case 0x02: fail(new TextDecoder().decode(payload)); break
case 0x03:
try {
Expand Down Expand Up @@ -166,6 +162,7 @@ export function useTerminalConnection(serverId: number, fontSize: number, theme:
observer.disconnect()
dataSubscription.dispose()
resizeSubscription.dispose()
disposeTouch()
term.dispose()
queue = []
wsRef.current = null
Expand Down
24 changes: 15 additions & 9 deletions ui/src/styles/terminal.css

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

74 changes: 74 additions & 0 deletions ui/src/utils/terminalTouch.test.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
import type { Terminal } from '@xterm/xterm'
import { beforeEach, expect, it, vi } from 'vitest'
import { attachTerminalTouch } from './terminalTouch'

let element: HTMLDivElement
let terminal: { element: HTMLDivElement; rows: number; buffer: { active: { type: string } }; scrollLines: ReturnType<typeof vi.fn> }
const touch = (y: number, x = 20, identifier = 1) => ({ clientX: x, clientY: y, identifier })
function dispatch(type: string, touches: ReturnType<typeof touch>[], target: HTMLElement = element) {
const event = new Event(type, { bubbles: true, cancelable: true })
Object.defineProperty(event, 'touches', { value: touches })
target.dispatchEvent(event)
return event
}
beforeEach(() => {
element = document.createElement('div')
element.getBoundingClientRect = () => ({ height: 200 }) as DOMRect
terminal = { element, rows: 10, buffer: { active: { type: 'normal' } }, scrollLines: vi.fn() }
})

it('maps vertical dragging to terminal rows and accumulates fractional movement', () => {
const dispose = attachTerminalTouch(terminal as unknown as Terminal)
dispatch('touchstart', [touch(100)])
expect(dispatch('touchmove', [touch(109)]).defaultPrevented).toBe(true)
expect(terminal.scrollLines).not.toHaveBeenCalled()
dispatch('touchmove', [touch(129)])
dispatch('touchmove', [touch(145)])
dispatch('touchmove', [touch(115)])
expect(terminal.scrollLines.mock.calls).toEqual([[-1], [-1], [2]])
dispose()
})

it('leaves taps, horizontal swipes and multi-touch gestures alone', () => {
const dispose = attachTerminalTouch(terminal as unknown as Terminal)
dispatch('touchstart', [touch(100)])
expect(dispatch('touchmove', [touch(103)]).defaultPrevented).toBe(false)
expect(dispatch('touchmove', [touch(110, 100)]).defaultPrevented).toBe(false)
expect(dispatch('touchmove', [touch(140), touch(140, 40, 2)]).defaultPrevented).toBe(false)
dispatch('touchmove', [touch(160)])
dispatch('touchstart', [touch(100)])
dispatch('touchmove', [touch(160, 20, 2)])
expect(terminal.scrollLines).not.toHaveBeenCalled()
dispose()
})

it('does not intercept alternate-screen applications or scrollbar controls', () => {
const dispose = attachTerminalTouch(terminal as unknown as Terminal)
terminal.buffer.active.type = 'alternate'
dispatch('touchstart', [touch(100)])
expect(dispatch('touchmove', [touch(160)]).defaultPrevented).toBe(false)
terminal.buffer.active.type = 'normal'
const scrollbar = document.createElement('div')
scrollbar.className = 'scrollbar'
element.append(scrollbar)
dispatch('touchstart', [touch(100)], scrollbar)
dispatch('touchmove', [touch(160)], scrollbar)
expect(terminal.scrollLines).not.toHaveBeenCalled()
dispose()
})

it('ends gestures on cancellation and removes every listener on disposal', () => {
const dispose = attachTerminalTouch(terminal as unknown as Terminal)
for (const end of ['touchend', 'touchcancel']) {
dispatch('touchstart', [touch(100)])
dispatch(end, [])
dispatch('touchmove', [touch(160)])
}
expect(terminal.scrollLines).not.toHaveBeenCalled()
const remove = vi.spyOn(element, 'removeEventListener')
dispose()
expect(remove.mock.calls.map(([type]) => type)).toEqual(['touchstart', 'touchmove', 'touchend', 'touchcancel'])
dispatch('touchstart', [touch(100)])
dispatch('touchmove', [touch(160)])
expect(terminal.scrollLines).not.toHaveBeenCalled()
})
38 changes: 38 additions & 0 deletions ui/src/utils/terminalTouch.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
import type { Terminal } from '@xterm/xterm'

export function attachTerminalTouch(term: Terminal): () => void {
const element = term.element
if (!element) return () => {}
let gesture: { id: number; x: number; y: number; cellHeight: number; lines: number } | undefined
const reset = () => { gesture = undefined }
const start = (event: TouchEvent) => {
reset()
if (event.touches.length !== 1 || term.buffer.active.type !== 'normal') return
if (event.target instanceof Element && event.target.closest('.scrollbar')) return
const cellHeight = element.getBoundingClientRect().height / term.rows
if (!cellHeight) return
const touch = event.touches[0]
gesture = { id: touch.identifier, x: touch.clientX, y: touch.clientY, cellHeight, lines: 0 }
}
const move = (event: TouchEvent) => {
if (!gesture || event.touches.length !== 1 || term.buffer.active.type !== 'normal') { reset(); return }
const touch = event.touches[0]
if (touch.identifier !== gesture.id) { reset(); return }
const deltaY = gesture.y - touch.clientY
if (Math.abs(deltaY) < 6 || Math.abs(deltaY) < Math.abs(gesture.x - touch.clientX)) return
if (event.cancelable) event.preventDefault()
const lines = Math.trunc(deltaY / gesture.cellHeight)
if (lines !== gesture.lines) term.scrollLines(lines - gesture.lines)
gesture.lines = lines
}
element.addEventListener('touchstart', start, { passive: true })
element.addEventListener('touchmove', move, { passive: false })
element.addEventListener('touchend', reset)
element.addEventListener('touchcancel', reset)
return () => {
element.removeEventListener('touchstart', start)
element.removeEventListener('touchmove', move)
element.removeEventListener('touchend', reset)
element.removeEventListener('touchcancel', reset)
}
}
Loading