Stabilize dashboard runtime proxy
This commit is contained in:
+289
-55
@@ -1,85 +1,299 @@
|
||||
import http from 'node:http'
|
||||
import { randomUUID } from 'node:crypto'
|
||||
import { spawn } from 'node:child_process'
|
||||
import { existsSync } from 'node:fs'
|
||||
import { WebSocketServer } from 'ws'
|
||||
import pty from 'node-pty'
|
||||
|
||||
const PORT = Number(process.env.TERMINAL_SERVER_PORT || 3011)
|
||||
const HOST = process.env.TERMINAL_SERVER_HOST || '127.0.0.1'
|
||||
const MAX_SESSIONS = 24
|
||||
const BUFFER_LIMIT = 200000
|
||||
const INITIAL_CLEANUP_LIMIT = 16384
|
||||
const sessions = new Map()
|
||||
|
||||
const runtime = await resolveRuntime()
|
||||
|
||||
function trimSessions() {
|
||||
if (sessions.size <= MAX_SESSIONS) return
|
||||
const oldest = [...sessions.values()].sort((a, b) => a.updatedAt - b.updatedAt)[0]
|
||||
if (!oldest) return
|
||||
oldest.pty.kill()
|
||||
oldest.transport.kill()
|
||||
sessions.delete(oldest.id)
|
||||
}
|
||||
|
||||
async function resolveRuntime() {
|
||||
const preferred = (process.env.TERMINAL_TRANSPORT || 'auto').trim().toLowerCase()
|
||||
if (preferred === 'stream') return { mode: 'stream' }
|
||||
|
||||
if (preferred === 'pty' || preferred === 'auto') {
|
||||
try {
|
||||
const mod = await import('node-pty')
|
||||
return { mode: 'pty', nodePty: mod.default || mod }
|
||||
} catch (error) {
|
||||
if (preferred === 'pty' || process.platform === 'darwin') {
|
||||
throw new Error(`TERMINAL_TRANSPORT=${preferred} but node-pty is unavailable on ${process.platform}: ${error instanceof Error ? error.message : String(error)}`)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
return { mode: 'stream' }
|
||||
}
|
||||
|
||||
function shellCandidatesForPlatform() {
|
||||
const candidates = [
|
||||
process.env.TERMINAL_SHELL,
|
||||
process.env.SHELL,
|
||||
process.platform === 'darwin' ? '/bin/zsh' : '/bin/bash',
|
||||
'/bin/sh',
|
||||
].filter(Boolean)
|
||||
|
||||
return [...new Set(candidates)]
|
||||
}
|
||||
|
||||
function shellForPlatform() {
|
||||
return process.env.SHELL || '/bin/bash'
|
||||
for (const candidate of shellCandidatesForPlatform()) {
|
||||
if (typeof candidate === 'string' && candidate.startsWith('/') && existsSync(candidate)) {
|
||||
return candidate
|
||||
}
|
||||
}
|
||||
|
||||
for (const candidate of shellCandidatesForPlatform()) {
|
||||
if (typeof candidate === 'string' && candidate.trim()) {
|
||||
return candidate
|
||||
}
|
||||
}
|
||||
|
||||
return process.platform === 'darwin' ? '/bin/zsh' : '/bin/bash'
|
||||
}
|
||||
|
||||
function buildAttachCommand(sandboxId) {
|
||||
const alias = `openshell-${sandboxId}`
|
||||
return process.env.OPENSHELL_TERMINAL_ATTACH_TEMPLATE || `ssh ${alias}`
|
||||
function homebrewBinPrefix() {
|
||||
return process.platform === 'darwin' ? ['/opt/homebrew/bin', '/usr/local/bin'] : ['/usr/local/bin']
|
||||
}
|
||||
|
||||
function buildBootstrapShell(sandboxId) {
|
||||
const attachCommand = buildAttachCommand(sandboxId)
|
||||
function effectivePath() {
|
||||
return [
|
||||
`export OPENSHELL_SANDBOX_ID=${shellEscape(sandboxId)}`,
|
||||
`export PS1='[${sandboxId}] \\u@\\h:\\w\\$ '`,
|
||||
`echo '[openclaw] attaching to ${sandboxId} using: ${attachCommand}'`,
|
||||
`exec ${attachCommand}`,
|
||||
].join('; ')
|
||||
process.env.TERMINAL_EXTRA_PATH,
|
||||
...homebrewBinPrefix(),
|
||||
process.env.HOME ? `${process.env.HOME}/.local/bin` : '',
|
||||
'/usr/bin',
|
||||
'/bin',
|
||||
'/usr/sbin',
|
||||
'/sbin',
|
||||
process.env.PATH || '',
|
||||
].filter(Boolean).join(':')
|
||||
}
|
||||
|
||||
function shellEscape(value) {
|
||||
return `'${String(value).replace(/'/g, `'"'"'`)}'`
|
||||
}
|
||||
|
||||
function createSession(sandboxId) {
|
||||
trimSessions()
|
||||
const id = randomUUID()
|
||||
function openshellBin() {
|
||||
return process.env.OPENSHELL_BIN || 'openshell'
|
||||
}
|
||||
|
||||
function buildAttachCommand(sandboxId) {
|
||||
if (process.env.OPENSHELL_TERMINAL_ATTACH_TEMPLATE) {
|
||||
const alias = `openshell-${sandboxId}`
|
||||
return process.env.OPENSHELL_TERMINAL_ATTACH_TEMPLATE.replaceAll('{sandboxId}', sandboxId).replaceAll('{alias}', alias)
|
||||
}
|
||||
return shellForPlatform()
|
||||
}
|
||||
|
||||
function buildBootstrapShell(sandboxId) {
|
||||
return [
|
||||
`export PATH=${shellEscape(effectivePath())}`,
|
||||
`export OPENSHELL_SANDBOX_ID=${shellEscape(sandboxId)}`,
|
||||
`export PS1='[operator:${sandboxId || 'host'}] \\u@\\h:\\w\\$ '`,
|
||||
`exec ${shellForPlatform()} -i`,
|
||||
].join('; ')
|
||||
}
|
||||
|
||||
function stripNullBytes(value) {
|
||||
return value.replace(/\u0000/g, '')
|
||||
}
|
||||
|
||||
function stripOscSequences(value) {
|
||||
return value.replace(/\u001b\][^\u0007\u001b]*(?:\u0007|\u001b\\)/g, '')
|
||||
}
|
||||
|
||||
function stripCsiSequences(value) {
|
||||
return value.replace(/\u001b\[[0-?]*[ -/]*[@-~]/g, '')
|
||||
}
|
||||
|
||||
function stripOtherEscapeSequences(value) {
|
||||
return value.replace(/\u001b[@-_]/g, '')
|
||||
}
|
||||
|
||||
function normalizeLineEndings(value) {
|
||||
return value.replace(/\r\n?/g, '\n')
|
||||
}
|
||||
|
||||
function cleanInitialBurst(value) {
|
||||
return normalizeLineEndings(
|
||||
stripOtherEscapeSequences(
|
||||
stripCsiSequences(
|
||||
stripOscSequences(
|
||||
stripNullBytes(value)
|
||||
)
|
||||
)
|
||||
)
|
||||
)
|
||||
}
|
||||
|
||||
function sanitizeChunkForClient(session, data) {
|
||||
const text = typeof data === 'string' ? data : String(data ?? '')
|
||||
if (!text) return ''
|
||||
|
||||
if (!session.initialStreamSettled) {
|
||||
session.initialBytesSeen += text.length
|
||||
const cleaned = cleanInitialBurst(text)
|
||||
const hasReadableText = /[A-Za-z0-9_$>#:%~\-]/.test(cleaned)
|
||||
const hasLineBreak = cleaned.includes('\n')
|
||||
|
||||
if (hasReadableText && hasLineBreak) {
|
||||
session.initialStreamSettled = true
|
||||
session.clientReady = true
|
||||
return cleaned
|
||||
}
|
||||
|
||||
if (session.initialBytesSeen >= INITIAL_CLEANUP_LIMIT) {
|
||||
session.initialStreamSettled = true
|
||||
session.clientReady = true
|
||||
return cleaned
|
||||
}
|
||||
|
||||
return cleaned.trim() ? cleaned : ''
|
||||
}
|
||||
|
||||
return stripNullBytes(text)
|
||||
}
|
||||
|
||||
function appendBuffer(session, data) {
|
||||
const sanitized = sanitizeChunkForClient(session, data)
|
||||
if (!sanitized) return
|
||||
|
||||
session.updatedAt = Date.now()
|
||||
session.buffer += sanitized
|
||||
if (session.buffer.length > BUFFER_LIMIT) {
|
||||
session.buffer = session.buffer.slice(-BUFFER_LIMIT)
|
||||
}
|
||||
for (const socket of session.sockets) {
|
||||
if (socket.readyState === socket.OPEN) {
|
||||
socket.send(JSON.stringify({ type: 'data', data: sanitized }))
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
function createPtyTransport(sandboxId) {
|
||||
const shell = shellForPlatform()
|
||||
const bootstrap = buildBootstrapShell(sandboxId)
|
||||
const proc = pty.spawn(shell, ['-lc', bootstrap], {
|
||||
name: 'xterm-256color',
|
||||
cols: 120,
|
||||
rows: 34,
|
||||
const ptyEnv = {
|
||||
...process.env,
|
||||
PATH: effectivePath(),
|
||||
OPENSHELL_SANDBOX_ID: sandboxId,
|
||||
SHELL: shell,
|
||||
}
|
||||
const requestedCwd = process.env.TERMINAL_CWD || process.env.HOME || process.cwd()
|
||||
const spawnCwd = requestedCwd && existsSync(requestedCwd) ? requestedCwd : process.cwd()
|
||||
|
||||
let proc
|
||||
try {
|
||||
proc = runtime.nodePty.spawn(shell, ['-lc', bootstrap], {
|
||||
name: 'xterm-256color',
|
||||
cols: 120,
|
||||
rows: 34,
|
||||
cwd: spawnCwd,
|
||||
env: ptyEnv,
|
||||
})
|
||||
} catch (error) {
|
||||
const context = {
|
||||
shell,
|
||||
requestedShell: process.env.TERMINAL_SHELL || process.env.SHELL || null,
|
||||
spawnCwd,
|
||||
requestedCwd,
|
||||
path: ptyEnv.PATH,
|
||||
platform: process.platform,
|
||||
}
|
||||
const detail = error instanceof Error ? error.message : String(error)
|
||||
throw new Error(`PTY spawn failed: ${detail} :: ${JSON.stringify(context)}`)
|
||||
}
|
||||
|
||||
return {
|
||||
kind: 'pty',
|
||||
write(data) { proc.write(data) },
|
||||
resize(cols, rows) { proc.resize(cols, rows) },
|
||||
kill() { proc.kill() },
|
||||
onData(handler) { proc.onData(handler) },
|
||||
onExit(handler) { proc.onExit(handler) },
|
||||
}
|
||||
}
|
||||
|
||||
function createStreamTransport(sandboxId) {
|
||||
const shell = shellForPlatform()
|
||||
const bootstrap = buildBootstrapShell(sandboxId)
|
||||
const child = spawn(shell, ['-lc', bootstrap], {
|
||||
cwd: process.env.HOME,
|
||||
env: {
|
||||
...process.env,
|
||||
PATH: effectivePath(),
|
||||
TERM: process.env.TERM || 'xterm-256color',
|
||||
OPENSHELL_SANDBOX_ID: sandboxId,
|
||||
},
|
||||
stdio: ['pipe', 'pipe', 'pipe'],
|
||||
})
|
||||
|
||||
return {
|
||||
kind: 'stream',
|
||||
write(data) { if (!child.stdin.destroyed) child.stdin.write(data) },
|
||||
resize() {},
|
||||
kill() {
|
||||
if (!child.killed) child.kill('SIGTERM')
|
||||
if (!child.stdin.destroyed) child.stdin.end()
|
||||
},
|
||||
onData(handler) {
|
||||
child.stdout.on('data', (chunk) => handler(chunk.toString()))
|
||||
child.stderr.on('data', (chunk) => handler(chunk.toString()))
|
||||
},
|
||||
onExit(handler) {
|
||||
child.on('exit', (exitCode, signal) => handler({ exitCode, signal }))
|
||||
},
|
||||
}
|
||||
}
|
||||
|
||||
function createTransport(sandboxId) {
|
||||
return runtime.mode === 'pty' ? createPtyTransport(sandboxId) : createStreamTransport(sandboxId)
|
||||
}
|
||||
|
||||
function createSessionIdentity(sandboxId, dashboardSessionId) {
|
||||
return {
|
||||
sandboxId,
|
||||
dashboardSessionId: dashboardSessionId && dashboardSessionId.trim() ? dashboardSessionId.trim() : 'dashboard-host',
|
||||
}
|
||||
}
|
||||
|
||||
function createSession(identity) {
|
||||
trimSessions()
|
||||
const id = randomUUID()
|
||||
const transport = createTransport(identity.sandboxId)
|
||||
|
||||
const session = {
|
||||
id,
|
||||
sandboxId,
|
||||
attachCommand: buildAttachCommand(sandboxId),
|
||||
pty: proc,
|
||||
sandboxId: identity.sandboxId,
|
||||
dashboardSessionId: identity.dashboardSessionId,
|
||||
attachCommand: buildAttachCommand(identity.sandboxId),
|
||||
transport,
|
||||
createdAt: Date.now(),
|
||||
updatedAt: Date.now(),
|
||||
buffer: '',
|
||||
sockets: new Set(),
|
||||
initialBytesSeen: 0,
|
||||
initialStreamSettled: false,
|
||||
clientReady: false,
|
||||
}
|
||||
|
||||
proc.onData((data) => {
|
||||
session.updatedAt = Date.now()
|
||||
session.buffer += data
|
||||
if (session.buffer.length > 200000) {
|
||||
session.buffer = session.buffer.slice(-200000)
|
||||
}
|
||||
for (const socket of session.sockets) {
|
||||
if (socket.readyState === socket.OPEN) {
|
||||
socket.send(JSON.stringify({ type: 'data', data }))
|
||||
}
|
||||
}
|
||||
})
|
||||
transport.onData((data) => appendBuffer(session, data))
|
||||
|
||||
proc.onExit(({ exitCode, signal }) => {
|
||||
transport.onExit(({ exitCode, signal }) => {
|
||||
for (const socket of session.sockets) {
|
||||
if (socket.readyState === socket.OPEN) {
|
||||
socket.send(JSON.stringify({ type: 'exit', exitCode, signal }))
|
||||
@@ -93,15 +307,33 @@ function createSession(sandboxId) {
|
||||
return session
|
||||
}
|
||||
|
||||
function getOrCreateSession(sessionId, sandboxId) {
|
||||
function getOrCreateSession(sessionId, identity) {
|
||||
if (sessionId) {
|
||||
const existing = sessions.get(sessionId)
|
||||
if (existing && existing.sandboxId === sandboxId) {
|
||||
if (
|
||||
existing &&
|
||||
existing.sandboxId === identity.sandboxId &&
|
||||
existing.dashboardSessionId === identity.dashboardSessionId
|
||||
) {
|
||||
existing.updatedAt = Date.now()
|
||||
return existing
|
||||
}
|
||||
}
|
||||
return createSession(sandboxId)
|
||||
return createSession(identity)
|
||||
}
|
||||
|
||||
function serializeSession(session) {
|
||||
return {
|
||||
ok: true,
|
||||
sessionId: session.id,
|
||||
sandboxId: session.sandboxId,
|
||||
dashboardSessionId: session.dashboardSessionId,
|
||||
attachCommand: session.attachCommand,
|
||||
replay: session.buffer,
|
||||
transport: runtime.mode,
|
||||
clientReady: session.clientReady,
|
||||
initialStreamSettled: session.initialStreamSettled,
|
||||
}
|
||||
}
|
||||
|
||||
const server = http.createServer((req, res) => {
|
||||
@@ -109,7 +341,7 @@ const server = http.createServer((req, res) => {
|
||||
|
||||
if (req.method === 'GET' && url.pathname === '/healthz') {
|
||||
res.writeHead(200, { 'Content-Type': 'application/json' })
|
||||
res.end(JSON.stringify({ ok: true, sessions: sessions.size }))
|
||||
res.end(JSON.stringify({ ok: true, sessions: sessions.size, transport: runtime.mode }))
|
||||
return
|
||||
}
|
||||
|
||||
@@ -124,17 +356,13 @@ const server = http.createServer((req, res) => {
|
||||
req.on('end', () => {
|
||||
try {
|
||||
const parsed = body ? JSON.parse(body) : {}
|
||||
const sandboxId = typeof parsed.sandboxId === 'string' && parsed.sandboxId.trim() ? parsed.sandboxId.trim() : 'default'
|
||||
const sandboxId = typeof parsed.sandboxId === 'string' && parsed.sandboxId.trim() ? parsed.sandboxId.trim() : 'host'
|
||||
const requestedSessionId = typeof parsed.sessionId === 'string' ? parsed.sessionId.trim() : ''
|
||||
const session = getOrCreateSession(requestedSessionId, sandboxId)
|
||||
const dashboardSessionId = typeof parsed.dashboardSessionId === 'string' ? parsed.dashboardSessionId.trim() : 'dashboard-host'
|
||||
const identity = createSessionIdentity(sandboxId, dashboardSessionId)
|
||||
const session = getOrCreateSession(requestedSessionId, identity)
|
||||
res.writeHead(200, { 'Content-Type': 'application/json' })
|
||||
res.end(JSON.stringify({
|
||||
ok: true,
|
||||
sessionId: session.id,
|
||||
sandboxId: session.sandboxId,
|
||||
attachCommand: session.attachCommand,
|
||||
replay: session.buffer,
|
||||
}))
|
||||
res.end(JSON.stringify(serializeSession(session)))
|
||||
} catch (error) {
|
||||
res.writeHead(500, { 'Content-Type': 'application/json' })
|
||||
res.end(JSON.stringify({ ok: false, error: error instanceof Error ? error.message : 'session init failed' }))
|
||||
@@ -152,8 +380,10 @@ const wss = new WebSocketServer({ server, path: '/ws' })
|
||||
wss.on('connection', (socket, req) => {
|
||||
const url = new URL(req.url || '/', `http://${req.headers.host || `${HOST}:${PORT}`}`)
|
||||
const sessionId = url.searchParams.get('sessionId') || ''
|
||||
const sandboxId = url.searchParams.get('sandboxId') || 'default'
|
||||
const session = getOrCreateSession(sessionId, sandboxId)
|
||||
const sandboxId = url.searchParams.get('sandboxId') || 'host'
|
||||
const dashboardSessionId = url.searchParams.get('dashboardSessionId') || 'dashboard-host'
|
||||
const identity = createSessionIdentity(sandboxId, dashboardSessionId)
|
||||
const session = getOrCreateSession(sessionId, identity)
|
||||
session.sockets.add(socket)
|
||||
session.updatedAt = Date.now()
|
||||
|
||||
@@ -161,8 +391,12 @@ wss.on('connection', (socket, req) => {
|
||||
type: 'ready',
|
||||
sessionId: session.id,
|
||||
sandboxId: session.sandboxId,
|
||||
dashboardSessionId: session.dashboardSessionId,
|
||||
attachCommand: session.attachCommand,
|
||||
replay: session.buffer,
|
||||
transport: runtime.mode,
|
||||
clientReady: session.clientReady,
|
||||
initialStreamSettled: session.initialStreamSettled,
|
||||
}))
|
||||
|
||||
socket.on('message', (raw) => {
|
||||
@@ -170,14 +404,14 @@ wss.on('connection', (socket, req) => {
|
||||
const msg = JSON.parse(String(raw))
|
||||
if (msg.type === 'input' && typeof msg.data === 'string') {
|
||||
session.updatedAt = Date.now()
|
||||
session.pty.write(msg.data)
|
||||
session.transport.write(msg.data)
|
||||
} else if (msg.type === 'resize') {
|
||||
const cols = Number(msg.cols) || 120
|
||||
const rows = Number(msg.rows) || 34
|
||||
session.updatedAt = Date.now()
|
||||
session.pty.resize(cols, rows)
|
||||
session.transport.resize(cols, rows)
|
||||
} else if (msg.type === 'kill') {
|
||||
session.pty.kill()
|
||||
session.transport.kill()
|
||||
}
|
||||
} catch {
|
||||
// ignore malformed frames
|
||||
@@ -191,5 +425,5 @@ wss.on('connection', (socket, req) => {
|
||||
})
|
||||
|
||||
server.listen(PORT, HOST, () => {
|
||||
console.log(`terminal server listening on http://${HOST}:${PORT}`)
|
||||
console.log(`terminal server listening on http://${HOST}:${PORT} transport=${runtime.mode}`)
|
||||
})
|
||||
|
||||
Reference in New Issue
Block a user