Files
orca/src/main/command-code/hook-service.test.ts
T
Jorge SilvaandJinwoo Hong 1fde7f553c fix(agent-hooks): wrap Windows hook commands in cmd.exe to survive spaces in profile path (#6078) (#6083)
* fix(codex): wrap Windows hook command in cmd.exe to survive spaces in profile path (#6078)

Windows splits raw hook commands on whitespace, so a user profile path
like `C:\Users\Jane Doe` made Codex hooks exit with code 1. Add a
wrapWindowsHookCommand helper that invokes the .cmd through
`cmd.exe /d /c call "..."` and use it in getManagedCommand.

* fix(agent-hooks): wrap Windows hook command in cmd.exe for all agents with raw .cmd path (#6078)

Apply the wrapWindowsHookCommand helper to cursor, command-code, gemini,
grok, and droid, which shared the same raw-scriptPath-on-Windows pattern
as codex. A user profile path with a space (e.g. `C:\Users\Jane Doe`)
used to split at the space and fail with exit code 1.

Agents that already handle spaces correctly are left untouched:
- claude/openclaude (Git Bash + forward slashes)
- copilot (PowerShell with quoted path)
- kimi (Git Bash + forward slashes)
- antigravity (event-specific wrapper .cmd files)
- devin (already wraps via `cmd /d /s /c ""...""`)

Each fixed agent gets a Windows-only test asserting the cmd.exe wrapping
survives spaces in the profile path.

* fix(claude): wrap Windows hook command in cmd.exe to survive spaces in profile path (#6078)

Claude Code runs hooks through Git Bash on Windows. The previous
forward-slash trick only works when the path has no spaces — Git Bash
splits `C:/Users/Jane Doe/...` at the space and tries to execute
`C:/Users/Jane` as a command. Use wrapWindowsHookCommand so the .cmd is
invoked through `cmd.exe /d /c call "..."`, which Git Bash treats as one
argument. Applies to both Claude and OpenClaude (shared getManagedCommand).

* Harden Windows agent hook launcher

---------

Co-authored-by: Jinwoo Hong <73622457+Jinwoo-H@users.noreply.github.com>
2026-06-22 16:04:01 -07:00

211 lines
7.5 KiB
TypeScript

import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest'
import { spawn } from 'child_process'
import { mkdirSync, mkdtempSync, readFileSync, rmSync, writeFileSync } from 'fs'
import { createServer } from 'http'
import { tmpdir } from 'os'
import { dirname, join } from 'path'
import type { AddressInfo } from 'net'
const { homedirMock } = vi.hoisted(() => ({
homedirMock: vi.fn<() => string>()
}))
vi.mock('os', async () => {
const actual = (await vi.importActual('os')) as Record<string, unknown>
return {
...actual,
homedir: homedirMock
}
})
import { CommandCodeHookService } from './hook-service'
describe('CommandCodeHookService', () => {
let homeDir: string
beforeEach(() => {
homeDir = mkdtempSync(join(tmpdir(), 'orca-command-code-home-'))
homedirMock.mockReturnValue(homeDir)
})
afterEach(() => {
vi.clearAllMocks()
rmSync(homeDir, { recursive: true, force: true })
})
it('installs the managed command for Command Code status events', () => {
const status = new CommandCodeHookService().install()
expect(status.state).toBe('installed')
expect(status.managedHooksPresent).toBe(true)
const config = JSON.parse(
readFileSync(join(homeDir, '.commandcode', 'settings.json'), 'utf8')
) as {
hooks: Record<string, { matcher?: string; hooks: { command: string }[] }[]>
}
expect(Object.keys(config.hooks).sort()).toEqual(['PostToolUse', 'PreToolUse', 'Stop'].sort())
expect(config.hooks.PreToolUse[0].matcher).toBe('.*')
expect(config.hooks.PostToolUse[0].matcher).toBe('.*')
expect(config.hooks.Stop[0].matcher).toBeUndefined()
expect(config.hooks.PreToolUse[0].hooks[0].command).toMatch(
process.platform === 'win32'
? /^powershell -NoProfile -ExecutionPolicy Bypass -EncodedCommand \S+$/
: /command-code-hook/
)
if (process.platform !== 'win32') {
expect(config.hooks.PreToolUse[0].hooks[0].command).toContain(join(homeDir, '.orca'))
}
if (process.platform !== 'win32') {
expect(config.hooks.PreToolUse[0].hooks[0].command).toMatch(/^if \[ -x /)
}
})
// Why: #6078 — a Windows user profile path with a space used to be written
// verbatim as the hook command, so the agent split it at the space. The
// managed command must use an encoded launcher so the path never appears raw
// on the cmd.exe command line.
it.skipIf(process.platform !== 'win32')(
'wraps the managed hook command to survive spaces in the profile path (#6078)',
() => {
const spaceHome = join(tmpdir(), 'orca command-code home with spaces')
mkdirSync(spaceHome, { recursive: true })
homedirMock.mockReturnValue(spaceHome)
try {
expect(new CommandCodeHookService().install().state).toBe('installed')
const config = JSON.parse(
readFileSync(join(spaceHome, '.commandcode', 'settings.json'), 'utf8')
) as { hooks: Record<string, { hooks: { command: string }[] }[]> }
const command = config.hooks.PreToolUse[0].hooks[0].command
expect(command).toMatch(
/^powershell -NoProfile -ExecutionPolicy Bypass -EncodedCommand \S+$/
)
} finally {
rmSync(spaceHome, { recursive: true, force: true })
}
}
)
it('installs a hook script that can recover the endpoint when Command Code strips token env', () => {
new CommandCodeHookService().install()
const scriptFileName =
process.platform === 'win32' ? 'command-code-hook.cmd' : 'command-code-hook.sh'
const script = readFileSync(join(homeDir, '.orca', 'agent-hooks', scriptFileName), 'utf8')
if (process.platform === 'win32') {
expect(script).toContain('sourceEndpointByPort')
expect(script).toContain('orca-dev\\agent-hooks')
expect(script).toContain('set ORCA_AGENT_HOOK_PORT=')
} else {
expect(script).toContain('Command Code strips TOKEN-like env vars')
expect(script).toContain('Command Code sanitizes hook subprocess env')
expect(script).toContain('__orca_read_ancestor_var')
expect(script).toContain('__orca_fill_from_endpoint_file')
expect(script).toContain('[ "$__orca_endpoint_port" != "$ORCA_AGENT_HOOK_PORT" ]')
expect(script).toContain('ORCA_PANE_KEY')
expect(script).toContain('ORCA_AGENT_LAUNCH_TOKEN')
expect(script).toContain('orca-dev/agent-hooks')
expect(script).toContain('endpoint_port=')
}
})
const itPosix = process.platform === 'win32' ? it.skip : it
itPosix('does not let stale endpoint files clobber recovered connection fields', async () => {
new CommandCodeHookService().install()
const staleEndpointPath = join(homeDir, 'stale-endpoint.env')
writeFileSync(
staleEndpointPath,
[
'ORCA_AGENT_HOOK_PORT=9',
'ORCA_AGENT_HOOK_TOKEN=stale-token',
'ORCA_AGENT_HOOK_ENV=development',
'ORCA_AGENT_HOOK_VERSION=1',
''
].join('\n')
)
const requests: { body: string; token: string | string[] | undefined }[] = []
const server = createServer((req, res) => {
let body = ''
req.setEncoding('utf8')
req.on('data', (chunk) => {
body += chunk
})
req.on('end', () => {
requests.push({ body, token: req.headers['x-orca-agent-hook-token'] })
res.statusCode = 204
res.end()
})
})
try {
await new Promise<void>((resolve) => server.listen(0, '127.0.0.1', resolve))
const address = server.address() as AddressInfo
const scriptPath = join(homeDir, '.orca', 'agent-hooks', 'command-code-hook.sh')
const child = spawn('/bin/sh', [scriptPath], {
env: {
...process.env,
HOME: homeDir,
ORCA_AGENT_HOOK_ENDPOINT: staleEndpointPath,
ORCA_AGENT_HOOK_PORT: String(address.port),
ORCA_AGENT_HOOK_TOKEN: 'current-token',
ORCA_PANE_KEY: 'tab:leaf',
ORCA_TAB_ID: 'tab',
ORCA_WORKTREE_ID: 'worktree',
ORCA_AGENT_HOOK_ENV: 'development',
ORCA_AGENT_HOOK_VERSION: '1'
},
stdio: ['pipe', 'ignore', 'pipe']
})
child.stdin.end(JSON.stringify({ hook_event_name: 'Stop' }))
const exitCode = await new Promise<number | null>((resolve, reject) => {
let stderr = ''
child.stderr.setEncoding('utf8')
child.stderr.on('data', (chunk) => {
stderr += chunk
})
child.on('error', reject)
child.on('exit', (code) => {
if (stderr.trim()) {
reject(new Error(stderr))
} else {
resolve(code)
}
})
})
expect(exitCode).toBe(0)
expect(requests).toHaveLength(1)
expect(requests[0].token).toBe('current-token')
expect(new URLSearchParams(requests[0].body).get('paneKey')).toBe('tab:leaf')
} finally {
await new Promise<void>((resolve) => server.close(() => resolve()))
}
})
it('reports partial when one managed event is missing', () => {
const service = new CommandCodeHookService()
service.install()
const configPath = join(homeDir, '.commandcode', 'settings.json')
const config = JSON.parse(readFileSync(configPath, 'utf8')) as {
hooks: Record<string, unknown>
}
delete config.hooks.Stop
mkdirSync(dirname(configPath), { recursive: true })
writeFileSync(configPath, `${JSON.stringify(config, null, 2)}\n`)
const status = service.getStatus()
expect(status.state).toBe('partial')
expect(status.managedHooksPresent).toBe(true)
expect(status.detail).toBe('Managed hook missing for events: Stop')
})
})