程序员阿江(Relakkes) 386a41e606 feat(desktop): enable Electron migration path
Introduce the Electron desktop shell alongside the existing React renderer and local Bun server boundary. The migration keeps the DesktopHost contract explicit across Tauri, Electron, and browser runtimes while adding Electron main/preload services for dialogs, shell, notifications, updates, tray/window lifecycle, terminal, preview WebContentsView, app mode, and release/package validation.

The commit also carries the latest local main desktop command updates, including agent slash entries and hidden-by-default markdown thinking details, so the packaged Electron build matches the current main UX surface.

Constraint: React renderer, local Bun server, REST/WebSocket, and sidecar boundaries must remain reusable during the migration
Constraint: macOS dev packages are ad-hoc signed and cannot prove Developer ID notarization or Gatekeeper release launch
Rejected: Browser-only smoke validation | it cannot exercise native dialogs, keychain prompts, notification behavior, or packaged app startup
Confidence: medium
Scope-risk: broad
Directive: Do not remove Tauri host support until signed Electron release artifacts pass native OS smoke on macOS, Windows, and Linux
Tested: bun run check:desktop
Tested: cd desktop && bun run check:electron
Tested: CSC_IDENTITY_AUTO_DISCOVERY=false bun run electron📦dir
Tested: bun run test:package-smoke --platform macos --package-kind dir --artifacts-dir desktop/build-artifacts/electron
Tested: Computer Use read packaged Electron app window at desktop/build-artifacts/electron/mac-arm64/Claude Code Haha.app
Not-tested: Developer ID signed/notarized Gatekeeper launch
Not-tested: Real OS notification click-to-session action
Not-tested: Windows and Linux packaged app smoke on real hosts
2026-06-01 22:43:16 +08:00

555 lines
17 KiB
TypeScript

import { execFileSync } from 'node:child_process'
import { createHash } from 'node:crypto'
import fs from 'node:fs'
import { createRequire } from 'node:module'
import os from 'node:os'
import path from 'node:path'
import process from 'node:process'
import { ELECTRON_EVENT_CHANNELS } from '../ipc/channels'
const TERMINAL_CONFIG_FILE = 'terminal-config.json'
const MIN_TERMINAL_COLS = 20
const MIN_TERMINAL_ROWS = 8
const NODE_PTY_MANIFEST_FILE = '.cc-haha-node-pty-manifest.json'
export type TerminalSpawnInput = {
cols?: number
rows?: number
cwd?: string
shell?: string
}
export type TerminalSpawnResult = {
session_id: number
shell: string
cwd: string
}
export type TerminalOutputPayload = {
session_id: number
data: string
}
export type TerminalExitPayload = {
session_id: number
code: number
signal?: string | null
}
export type TerminalPtyProcess = {
pid?: number
process?: string
write(data: string): void
resize(cols: number, rows: number): void
kill(): void
onData(handler: (data: string) => void): unknown
onExit(handler: (event: { exitCode: number, signal?: number | string | null }) => void): unknown
}
export type TerminalPtySpawnOptions = {
name: string
cols: number
rows: number
cwd: string
env: Record<string, string>
}
export type TerminalPtyFactory = {
spawn(shell: string, args: string[], options: TerminalPtySpawnOptions): TerminalPtyProcess
}
export type TerminalAppLike = {
getPath(name: 'userData'): string
}
export type TerminalWebContentsLike = {
send(channel: string, payload: unknown): void
}
export type ElectronTerminalServiceOptions = {
app?: TerminalAppLike
env?: NodeJS.ProcessEnv
platform?: NodeJS.Platform
ptyFactory?: TerminalPtyFactory | (() => Promise<TerminalPtyFactory>)
nodePtySourceDir?: string
nodePtyCacheDir?: string
fileExists?: (filePath: string) => boolean
isFile?: (filePath: string) => boolean
cwd?: () => string
}
type TerminalConfig = {
bash_path?: string | null
}
type DesktopTerminalSettingsFile = {
desktopTerminal?: DesktopTerminalConfig | null
}
type DesktopTerminalConfig = {
startupShell?: string | null
customShellPath?: string | null
}
type TerminalSession = {
pty: TerminalPtyProcess
}
const preparedNodePtyDirs = new Set<string>()
export function terminalConfigPath(app: TerminalAppLike | undefined, env: NodeJS.ProcessEnv = process.env): string | null {
const portableDir = env.CLAUDE_CONFIG_DIR?.trim()
if (portableDir) {
return path.join(portableDir, TERMINAL_CONFIG_FILE)
}
if (!app) return null
return path.join(app.getPath('userData'), TERMINAL_CONFIG_FILE)
}
export function claudeConfigDir(env: NodeJS.ProcessEnv = process.env): string | null {
const portableDir = env.CLAUDE_CONFIG_DIR?.trim()
if (portableDir) return portableDir
const home = env.HOME || env.USERPROFILE || os.homedir()
return home ? path.join(home, '.claude') : null
}
export function desktopTerminalSettingsPath(env: NodeJS.ProcessEnv = process.env): string | null {
const dir = claudeConfigDir(env)
return dir ? path.join(dir, 'settings.json') : null
}
export function normalizeTerminalBashPath(
value: string | null | undefined,
isFile: (filePath: string) => boolean = filePath => {
try {
return fs.statSync(filePath).isFile()
} catch {
return false
}
},
): string | null {
const trimmed = value?.trim()
if (!trimmed) return null
if (!isFile(trimmed)) {
throw new Error(`terminal bash path does not exist: ${trimmed}`)
}
return trimmed
}
export function defaultShell(
platform: NodeJS.Platform = process.platform,
env: NodeJS.ProcessEnv = process.env,
customBashPath: string | null = null,
fileExists: (filePath: string) => boolean = fs.existsSync,
): string {
if (platform === 'win32') {
const bashPath = customBashPath?.trim()
if (bashPath && fileExists(bashPath)) return bashPath
return env.COMSPEC || 'powershell.exe'
}
return env.SHELL || (fileExists('/bin/zsh') ? '/bin/zsh' : '/bin/bash')
}
export function resolveDesktopTerminalShell(
platform: NodeJS.Platform,
config: DesktopTerminalConfig | null | undefined,
): string | null {
if (platform !== 'win32' || !config) return null
const startupShell = config.startupShell?.trim()
switch (startupShell) {
case undefined:
case '':
case 'system':
return null
case 'pwsh':
return 'pwsh.exe'
case 'powershell':
return 'powershell.exe'
case 'cmd':
return 'cmd.exe'
case 'custom': {
const customShellPath = config.customShellPath?.trim()
if (!customShellPath) throw new Error('custom terminal shell path is empty')
return customShellPath
}
default:
return null
}
}
export function ensureUtf8Locale(env: Record<string, string>, platform: NodeJS.Platform = process.platform): Record<string, string> {
const fallback = platform === 'darwin' ? 'en_US.UTF-8' : 'C.UTF-8'
for (const key of ['LANG', 'LC_CTYPE', 'LC_ALL']) {
const value = env[key]
if (!value || !value.trim().toLowerCase().replace(/-/g, '').includes('utf8')) {
env[key] = fallback
}
}
return env
}
export function parseEnvBlock(buffer: Buffer): Record<string, string> {
const env: Record<string, string> = {}
for (const entry of buffer.toString('utf8').split('\0')) {
if (!entry) continue
const equals = entry.indexOf('=')
if (equals <= 0) continue
env[entry.slice(0, equals)] = entry.slice(equals + 1)
}
return env
}
export function loginShellEnvironment(shell: string, platform: NodeJS.Platform = process.platform): Record<string, string> {
if (platform === 'win32') return {}
try {
const stdout = execFileSync(shell, ['-l', '-c', 'env -0'], {
encoding: 'buffer',
stdio: ['ignore', 'pipe', 'ignore'],
timeout: 2000,
})
return parseEnvBlock(stdout)
} catch {
return {}
}
}
export function terminalEnvironment(
shell: string,
platform: NodeJS.Platform = process.platform,
env: NodeJS.ProcessEnv = process.env,
): Record<string, string> {
const merged: Record<string, string> = {}
for (const [key, value] of Object.entries(env)) {
if (typeof value === 'string') merged[key] = value
}
Object.assign(merged, loginShellEnvironment(shell, platform))
return ensureUtf8Locale(merged, platform)
}
export function readDesktopTerminalConfig(env: NodeJS.ProcessEnv = process.env): DesktopTerminalConfig | null {
const settingsPath = desktopTerminalSettingsPath(env)
if (!settingsPath) return null
try {
const parsed = JSON.parse(fs.readFileSync(settingsPath, 'utf8')) as DesktopTerminalSettingsFile
return parsed.desktopTerminal ?? null
} catch {
return null
}
}
function loadTerminalConfig(app: TerminalAppLike | undefined, env: NodeJS.ProcessEnv): TerminalConfig {
const configPath = terminalConfigPath(app, env)
if (!configPath) return {}
try {
return JSON.parse(fs.readFileSync(configPath, 'utf8')) as TerminalConfig
} catch {
return {}
}
}
function saveTerminalConfig(app: TerminalAppLike | undefined, env: NodeJS.ProcessEnv, config: TerminalConfig) {
const configPath = terminalConfigPath(app, env)
if (!configPath) throw new Error('terminal config path is unavailable')
fs.mkdirSync(path.dirname(configPath), { recursive: true })
fs.writeFileSync(configPath, JSON.stringify(config, null, 2))
}
export function resolveTerminalCwd(
cwd: string | undefined,
env: NodeJS.ProcessEnv = process.env,
currentDirectory: () => string = process.cwd,
): string {
const trimmed = cwd?.trim()
const resolved = trimmed
|| env.CLAUDE_CONFIG_DIR
|| env.HOME
|| env.USERPROFILE
|| currentDirectory()
let isDirectory = false
try {
isDirectory = fs.statSync(resolved).isDirectory()
} catch {
isDirectory = false
}
if (!isDirectory) {
throw new Error(`terminal cwd does not exist: ${resolved}`)
}
return resolved
}
function ensureNodePtyHelpersExecutable(moduleDir: string): void {
const prebuildsDir = path.join(moduleDir, 'prebuilds')
if (!fs.existsSync(prebuildsDir)) return
for (const platformDir of fs.readdirSync(prebuildsDir)) {
const helperPath = path.join(prebuildsDir, platformDir, 'spawn-helper')
if (!fs.existsSync(helperPath)) continue
const stat = fs.statSync(helperPath)
if (!stat.isFile()) continue
fs.chmodSync(helperPath, 0o500)
}
}
type NodePtyIntegrityManifest = {
version: 1
files: Array<{ path: string, sha256: string }>
}
function walkNodePtyFiles(rootDir: string): string[] {
const results: string[] = []
const stack = [rootDir]
while (stack.length > 0) {
const current = stack.pop()
if (!current) continue
let entries: fs.Dirent[] = []
try {
entries = fs.readdirSync(current, { withFileTypes: true })
} catch {
continue
}
for (const entry of entries) {
const fullPath = path.join(current, entry.name)
if (entry.isDirectory()) {
stack.push(fullPath)
} else if (entry.isFile() && entry.name !== NODE_PTY_MANIFEST_FILE) {
results.push(fullPath)
}
}
}
return results.sort()
}
function hashFile(filePath: string): string {
return createHash('sha256').update(fs.readFileSync(filePath)).digest('hex')
}
function buildNodePtyManifest(moduleDir: string): NodePtyIntegrityManifest {
return {
version: 1,
files: walkNodePtyFiles(moduleDir).map(filePath => ({
path: path.relative(moduleDir, filePath).replaceAll(path.sep, '/'),
sha256: hashFile(filePath),
})),
}
}
function manifestsEqual(left: NodePtyIntegrityManifest, right: NodePtyIntegrityManifest): boolean {
return JSON.stringify(left) === JSON.stringify(right)
}
function readNodePtyManifest(moduleDir: string): NodePtyIntegrityManifest | null {
try {
const parsed = JSON.parse(fs.readFileSync(path.join(moduleDir, NODE_PTY_MANIFEST_FILE), 'utf8')) as NodePtyIntegrityManifest
if (parsed.version !== 1 || !Array.isArray(parsed.files)) return null
return parsed
} catch {
return null
}
}
function writeNodePtyManifest(moduleDir: string, manifest: NodePtyIntegrityManifest): void {
fs.writeFileSync(path.join(moduleDir, NODE_PTY_MANIFEST_FILE), JSON.stringify(manifest, null, 2), { mode: 0o600 })
}
function chmodNodePtyDirectories(moduleDir: string): void {
for (const dir of [path.dirname(moduleDir), moduleDir]) {
try {
fs.chmodSync(dir, 0o700)
} catch {
// Best effort: chmod can fail on some filesystems, but the cache is still rebuilt from the bundle.
}
}
}
function isNodePtyCacheCurrent(sourceManifest: NodePtyIntegrityManifest, cacheDir: string): boolean {
const cacheManifest = readNodePtyManifest(cacheDir)
if (!cacheManifest || !manifestsEqual(sourceManifest, cacheManifest)) return false
try {
return manifestsEqual(sourceManifest, buildNodePtyManifest(cacheDir))
} catch {
return false
}
}
export function prepareNodePtyRuntime(sourceDir: string, cacheDir: string): string {
if (!fs.existsSync(path.join(sourceDir, 'package.json'))) {
throw new Error(`node-pty source directory is missing: ${sourceDir}`)
}
const sourceManifest = buildNodePtyManifest(sourceDir)
if (preparedNodePtyDirs.has(cacheDir) && isNodePtyCacheCurrent(sourceManifest, cacheDir)) {
return cacheDir
}
if (!preparedNodePtyDirs.has(cacheDir) && isNodePtyCacheCurrent(sourceManifest, cacheDir)) {
preparedNodePtyDirs.add(cacheDir)
return cacheDir
}
fs.rmSync(cacheDir, { recursive: true, force: true })
fs.mkdirSync(path.dirname(cacheDir), { recursive: true, mode: 0o700 })
fs.mkdirSync(cacheDir, { recursive: true, mode: 0o700 })
fs.cpSync(sourceDir, cacheDir, { recursive: true })
ensureNodePtyHelpersExecutable(cacheDir)
chmodNodePtyDirectories(cacheDir)
if (!manifestsEqual(sourceManifest, buildNodePtyManifest(cacheDir))) {
throw new Error('node-pty runtime cache integrity check failed')
}
writeNodePtyManifest(cacheDir, sourceManifest)
preparedNodePtyDirs.add(cacheDir)
return cacheDir
}
async function loadNodePtyFactory(sourceDir?: string, cacheDir?: string): Promise<TerminalPtyFactory> {
if (sourceDir && cacheDir) {
const moduleDir = prepareNodePtyRuntime(sourceDir, cacheDir)
const requireFromNodePty = createRequire(path.join(moduleDir, 'package.json'))
return requireFromNodePty(moduleDir) as TerminalPtyFactory
}
return import('node-pty') as Promise<TerminalPtyFactory>
}
async function resolvePtyFactory(
factory: TerminalPtyFactory | (() => Promise<TerminalPtyFactory>) | undefined,
nodePtySourceDir: string | undefined,
nodePtyCacheDir: string | undefined,
): Promise<TerminalPtyFactory> {
if (!factory) return loadNodePtyFactory(nodePtySourceDir, nodePtyCacheDir)
if (typeof factory === 'function') return factory()
return factory
}
export class ElectronTerminalService {
private readonly app?: TerminalAppLike
private readonly env: NodeJS.ProcessEnv
private readonly platform: NodeJS.Platform
private readonly ptyFactory?: TerminalPtyFactory | (() => Promise<TerminalPtyFactory>)
private readonly nodePtySourceDir?: string
private readonly nodePtyCacheDir?: string
private readonly fileExists: (filePath: string) => boolean
private readonly isFile: (filePath: string) => boolean
private readonly cwd: () => string
private nextSessionId = 1
private readonly sessions = new Map<number, TerminalSession>()
constructor(options: ElectronTerminalServiceOptions = {}) {
this.app = options.app
this.env = options.env ?? process.env
this.platform = options.platform ?? process.platform
this.ptyFactory = options.ptyFactory
this.nodePtySourceDir = options.nodePtySourceDir
this.nodePtyCacheDir = options.nodePtyCacheDir
this.fileExists = options.fileExists ?? fs.existsSync
this.isFile = options.isFile ?? (filePath => {
try {
return fs.statSync(filePath).isFile()
} catch {
return false
}
})
this.cwd = options.cwd ?? process.cwd
}
getBashPath(): string | null {
return loadTerminalConfig(this.app, this.env).bash_path ?? null
}
setBashPath(value: string | null): void {
const config = loadTerminalConfig(this.app, this.env)
config.bash_path = normalizeTerminalBashPath(value, this.isFile)
saveTerminalConfig(this.app, this.env, config)
}
resolveShell(): string {
const terminalConfig = loadTerminalConfig(this.app, this.env)
const systemDefault = defaultShell(
this.platform,
this.env,
terminalConfig.bash_path ?? null,
this.fileExists,
)
return resolveDesktopTerminalShell(this.platform, readDesktopTerminalConfig(this.env)) ?? systemDefault
}
async spawn(input: TerminalSpawnInput, webContents: TerminalWebContentsLike): Promise<TerminalSpawnResult> {
const cols = Math.max(MIN_TERMINAL_COLS, Math.floor(input.cols ?? 80))
const rows = Math.max(MIN_TERMINAL_ROWS, Math.floor(input.rows ?? 24))
const cwd = resolveTerminalCwd(input.cwd, this.env, this.cwd)
const shell = this.resolveShell()
const ptyFactory = await resolvePtyFactory(this.ptyFactory, this.nodePtySourceDir, this.nodePtyCacheDir)
const sessionId = this.nextSessionId++
const pty = ptyFactory.spawn(shell, [], {
name: 'xterm-256color',
cols,
rows,
cwd,
env: {
...terminalEnvironment(shell, this.platform, this.env),
TERM: 'xterm-256color',
COLORTERM: 'truecolor',
},
})
this.sessions.set(sessionId, { pty })
pty.onData(data => {
webContents.send(ELECTRON_EVENT_CHANNELS.terminalOutput, {
session_id: sessionId,
data,
} satisfies TerminalOutputPayload)
})
pty.onExit(({ exitCode, signal }) => {
this.sessions.delete(sessionId)
webContents.send(ELECTRON_EVENT_CHANNELS.terminalExit, {
session_id: sessionId,
code: exitCode,
signal: signal == null ? null : String(signal),
} satisfies TerminalExitPayload)
})
return {
session_id: sessionId,
shell,
cwd,
}
}
write(sessionId: number, data: string): void {
this.getSession(sessionId).pty.write(data)
}
resize(sessionId: number, cols: number, rows: number): void {
this.getSession(sessionId).pty.resize(
Math.max(MIN_TERMINAL_COLS, Math.floor(cols)),
Math.max(MIN_TERMINAL_ROWS, Math.floor(rows)),
)
}
kill(sessionId: number): void {
const session = this.sessions.get(sessionId)
if (!session) return
this.sessions.delete(sessionId)
session.pty.kill()
}
killAll(): void {
for (const sessionId of Array.from(this.sessions.keys())) {
this.kill(sessionId)
}
}
private getSession(sessionId: number): TerminalSession {
const session = this.sessions.get(sessionId)
if (!session) throw new Error('terminal session is not running')
return session
}
}