@muyichengshayu/promptx 0.2.16 → 0.2.17

package/apps/runner/src/engines/runnerContract.test.js

@@ -0,0 +1,510 @@
+import fs from 'node:fs'
+import os from 'node:os'
+import path from 'node:path'
+import test from 'node:test'
+import assert from 'node:assert/strict'
+
+function withEnv(overrides, fn) {
+  const previous = new Map()
+
+  for (const [key, value] of Object.entries(overrides)) {
+    previous.set(key, process.env[key])
+    if (typeof value === 'undefined') {
+      delete process.env[key]
+    } else {
+      process.env[key] = value
+    }
+  }
+
+  return Promise.resolve()
+    .then(fn)
+    .finally(() => {
+      for (const [key, value] of previous.entries()) {
+        if (typeof value === 'undefined') {
+          delete process.env[key]
+        } else {
+          process.env[key] = value
+        }
+      }
+    })
+}
+
+async function importFreshRunnerModules() {
+  const suffix = `test=${Date.now()}-${Math.random().toString(16).slice(2)}`
+  const [
+    { streamPromptToCodexSession },
+    { streamPromptToClaudeCodeSession },
+    { streamPromptToOpenCodeSession },
+  ] = await Promise.all([
+    import(`../codex.js?${suffix}`),
+    import(`./claudeCodeRunner.js?${suffix}`),
+    import(`./openCodeRunner.js?${suffix}`),
+  ])
+
+  return {
+    streamPromptToCodexSession,
+    streamPromptToClaudeCodeSession,
+    streamPromptToOpenCodeSession,
+  }
+}
+
+function createFakeCodexBinary(tempDir) {
+  const scriptPath = path.join(tempDir, process.platform === 'win32' ? 'fake-codex.js' : 'fake-codex')
+  const script = `#!/usr/bin/env node
+const fs = require('node:fs')
+
+const args = process.argv.slice(2)
+const outputIndex = args.indexOf('--output-last-message')
+const outputFile = outputIndex >= 0 ? args[outputIndex + 1] : ''
+const threadId = 'thread-contract-1'
+
+let prompt = ''
+process.stdin.setEncoding('utf8')
+process.stdin.on('data', (chunk) => {
+  prompt += chunk
+})
+process.stdin.on('end', () => {
+  if (outputFile) {
+    fs.writeFileSync(outputFile, '最终回复')
+  }
+
+  process.stdout.write(JSON.stringify({ type: 'thread.started', thread_id: threadId }) + '\\n')
+  process.stdout.write(JSON.stringify({ type: 'item.started', item: { type: 'reasoning', text: '先分析' } }) + '\\n')
+  process.stdout.write(JSON.stringify({ type: 'item.started', item: { type: 'command_execution', command: 'Bash: pwd', status: 'in_progress' } }) + '\\n')
+  process.stdout.write(JSON.stringify({ type: 'item.completed', item: { type: 'command_execution', command: 'Bash: pwd', status: 'completed', exit_code: 0, aggregated_output: '/tmp/demo' } }) + '\\n')
+  process.stdout.write(JSON.stringify({ type: 'item.completed', item: { type: 'agent_message', text: '已完成修改' } }) + '\\n')
+  process.stdout.write(JSON.stringify({ type: 'turn.completed', result: '最终回复' }) + '\\n')
+})
+`
+
+  fs.writeFileSync(scriptPath, script, { mode: 0o755 })
+
+  if (process.platform !== 'win32') {
+    return scriptPath
+  }
+
+  const cmdPath = path.join(tempDir, 'fake-codex.cmd')
+  fs.writeFileSync(cmdPath, '@echo off\r\nnode "%~dp0fake-codex.js" %*\r\n')
+  return cmdPath
+}
+
+function createFakeClaudeBinary(tempDir) {
+  const scriptPath = path.join(tempDir, process.platform === 'win32' ? 'fake-claude.js' : 'fake-claude')
+  const script = `#!/usr/bin/env node
+const args = process.argv.slice(2)
+const promptIndex = args.indexOf('-p')
+const prompt = promptIndex >= 0 ? args[promptIndex + 1] || '' : ''
+const resumeIndex = args.indexOf('--resume')
+const threadId = resumeIndex >= 0 ? args[resumeIndex + 1] || 'thread-contract-1' : 'thread-contract-1'
+
+if (!prompt) {
+  process.stderr.write('missing prompt\\n')
+  process.exit(1)
+  return
+}
+
+process.stdout.write(JSON.stringify({
+  type: 'system',
+  subtype: 'init',
+  session_id: threadId,
+}) + '\\n')
+
+process.stdout.write(JSON.stringify({
+  type: 'assistant',
+  message: {
+    content: [
+      { type: 'thinking', thinking: '先分析' },
+      { type: 'tool_use', id: 'tool-1', name: 'Bash', input: { command: 'pwd' } },
+    ],
+  },
+}) + '\\n')
+
+process.stdout.write(JSON.stringify({
+  type: 'user',
+  message: {
+    content: [
+      { type: 'tool_result', tool_use_id: 'tool-1', content: '/tmp/demo', is_error: false },
+    ],
+  },
+}) + '\\n')
+
+process.stdout.write(JSON.stringify({
+  type: 'assistant',
+  message: {
+    content: [
+      { type: 'text', text: '已完成修改' },
+    ],
+  },
+}) + '\\n')
+
+process.stdout.write(JSON.stringify({
+  type: 'result',
+  result: '最终回复',
+}) + '\\n')
+`
+
+  fs.writeFileSync(scriptPath, script, { mode: 0o755 })
+
+  if (process.platform !== 'win32') {
+    return scriptPath
+  }
+
+  const cmdPath = path.join(tempDir, 'fake-claude.cmd')
+  fs.writeFileSync(cmdPath, '@echo off\r\nnode "%~dp0fake-claude.js" %*\r\n')
+  return cmdPath
+}
+
+function createHangingFakeClaudeBinary(tempDir) {
+  const scriptPath = path.join(tempDir, process.platform === 'win32' ? 'fake-claude-hang.js' : 'fake-claude-hang')
+  const script = `#!/usr/bin/env node
+process.stdout.write(JSON.stringify({
+  type: 'system',
+  subtype: 'init',
+  session_id: 'thread-contract-1',
+}) + '\\n')
+
+process.stdout.write(JSON.stringify({
+  type: 'assistant',
+  message: {
+    content: [
+      { type: 'text', text: '已完成修改' },
+    ],
+  },
+}) + '\\n')
+
+process.stdout.write(JSON.stringify({
+  type: 'result',
+  result: '最终回复',
+}) + '\\n')
+
+setInterval(() => {}, 1000)
+`
+
+  fs.writeFileSync(scriptPath, script, { mode: 0o755 })
+
+  if (process.platform !== 'win32') {
+    return scriptPath
+  }
+
+  const cmdPath = path.join(tempDir, 'fake-claude-hang.cmd')
+  fs.writeFileSync(cmdPath, '@echo off\r\nnode "%~dp0fake-claude-hang.js" %*\r\n')
+  return cmdPath
+}
+
+function createHangingFakeCodexBinary(tempDir) {
+  const scriptPath = path.join(tempDir, process.platform === 'win32' ? 'fake-codex-hang.js' : 'fake-codex-hang')
+  const script = `#!/usr/bin/env node
+const fs = require('node:fs')
+
+const args = process.argv.slice(2)
+const outputIndex = args.indexOf('--output-last-message')
+const outputFile = outputIndex >= 0 ? args[outputIndex + 1] : ''
+
+if (outputFile) {
+  fs.writeFileSync(outputFile, '最终回复')
+}
+
+process.stdout.write(JSON.stringify({ type: 'thread.started', thread_id: 'thread-contract-1' }) + '\\n')
+process.stdout.write(JSON.stringify({ type: 'item.completed', item: { type: 'agent_message', text: '已完成修改' } }) + '\\n')
+process.stdout.write(JSON.stringify({ type: 'turn.completed', result: '最终回复' }) + '\\n')
+
+setInterval(() => {}, 1000)
+`
+
+  fs.writeFileSync(scriptPath, script, { mode: 0o755 })
+
+  if (process.platform !== 'win32') {
+    return scriptPath
+  }
+
+  const cmdPath = path.join(tempDir, 'fake-codex-hang.cmd')
+  fs.writeFileSync(cmdPath, '@echo off\r\nnode "%~dp0fake-codex-hang.js" %*\r\n')
+  return cmdPath
+}
+
+function createFakeOpenCodeBinary(tempDir) {
+  const scriptPath = path.join(tempDir, process.platform === 'win32' ? 'fake-opencode.js' : 'fake-opencode')
+  const script = `#!/usr/bin/env node
+const args = process.argv.slice(2)
+const sessionIndex = args.indexOf('--session')
+const sessionId = sessionIndex >= 0 ? args[sessionIndex + 1] || 'thread-contract-1' : 'thread-contract-1'
+const prompt = args[args.length - 1] || ''
+
+if (!prompt) {
+  process.stderr.write('missing prompt\\n')
+  process.exit(1)
+  return
+}
+
+process.stdout.write(JSON.stringify({
+  type: 'step_start',
+  sessionID: sessionId,
+  part: {
+    type: 'step-start',
+  },
+}) + '\\n')
+
+process.stdout.write(JSON.stringify({
+  type: 'tool_use',
+  sessionID: sessionId,
+  part: {
+    type: 'tool',
+    tool: 'read',
+    state: {
+      status: 'completed',
+      input: {
+        filePath: '/tmp/demo',
+      },
+      output: 'demo output',
+    },
+  },
+}) + '\\n')
+
+process.stdout.write(JSON.stringify({
+  type: 'text',
+  sessionID: sessionId,
+  part: {
+    type: 'text',
+    text: '最终回复',
+  },
+}) + '\\n')
+
+process.stdout.write(JSON.stringify({
+  type: 'step_finish',
+  sessionID: sessionId,
+  part: {
+    type: 'step-finish',
+    reason: 'stop',
+    tokens: {
+      input: 100,
+      output: 20,
+      cache: {
+        read: 10,
+      },
+    },
+  },
+}) + '\\n')
+`
+
+  fs.writeFileSync(scriptPath, script, { mode: 0o755 })
+
+  if (process.platform !== 'win32') {
+    return scriptPath
+  }
+
+  const cmdPath = path.join(tempDir, 'fake-opencode.cmd')
+  fs.writeFileSync(cmdPath, '@echo off\r\nnode "%~dp0fake-opencode.js" %*\r\n')
+  return cmdPath
+}
+
+function simplifyEvent(event = {}) {
+  if (event.type === 'status') {
+    return {
+      type: 'status',
+      stage: event.stage,
+      message: event.message,
+    }
+  }
+
+  if (event.type === 'completed') {
+    return {
+      type: 'completed',
+      message: event.message,
+    }
+  }
+
+  if (event.type !== 'agent_event') {
+    return { type: event.type }
+  }
+
+  return {
+    type: 'agent_event',
+    event: event.event,
+  }
+}
+
+async function collectRunnerContractEvents(streamSessionPrompt) {
+  const events = []
+  const stream = streamSessionPrompt(
+    { id: 'session-1', cwd: process.cwd() },
+    'runner-contract-case',
+    {
+      onEvent(event) {
+        events.push(simplifyEvent(event))
+      },
+    }
+  )
+
+  const result = await stream.result
+  return {
+    events,
+    result,
+  }
+}
+
+function projectRunnerContractPhases(events = []) {
+  return events.map((event) => {
+    if (event.type === 'status') {
+      return 'status'
+    }
+
+    if (event.type === 'completed') {
+      return 'completed'
+    }
+
+    if (event.type !== 'agent_event') {
+      return ''
+    }
+
+    const payload = event.event || {}
+    if (payload.type === 'thread.started') {
+      return 'thread.started'
+    }
+
+    if (payload.type === 'turn.started') {
+      return 'turn.started'
+    }
+
+    if (payload.type === 'item.started' && payload.item?.type === 'command_execution') {
+      return 'command.started'
+    }
+
+    if (payload.type === 'item.completed' && payload.item?.type === 'command_execution') {
+      return 'command.completed'
+    }
+
+    if (payload.type === 'item.completed' && payload.item?.type === 'agent_message') {
+      return 'agent_message'
+    }
+
+    if (payload.type === 'turn.completed') {
+      return 'turn.completed'
+    }
+
+    return ''
+  }).filter(Boolean)
+}
+
+function assertOrderedSubsequence(actual = [], expected = []) {
+  let actualIndex = 0
+
+  expected.forEach((item) => {
+    while (actualIndex < actual.length && actual[actualIndex] !== item) {
+      actualIndex += 1
+    }
+
+    assert.ok(actualIndex < actual.length, `未找到预期阶段：${item}，实际阶段：${actual.join(' -> ')}`)
+    actualIndex += 1
+  })
+}
+
+function assertRunnerContract(result, expectedThreadId) {
+  assert.deepEqual(result.result, {
+    sessionId: 'session-1',
+    threadId: expectedThreadId,
+    message: '最终回复',
+  })
+
+  const phases = projectRunnerContractPhases(result.events)
+  assertOrderedSubsequence(phases, [
+    'status',
+    'thread.started',
+    'command.started',
+    'command.completed',
+    'agent_message',
+    'turn.completed',
+    'completed',
+  ])
+}
+
+test('Codex / Claude Code / OpenCode runner 会产出兼容的核心事件结构', async () => {
+  const tempDir = fs.mkdtempSync(path.join(os.tmpdir(), 'promptx-runner-contract-'))
+  const fakeCodexBin = createFakeCodexBinary(tempDir)
+  const fakeClaudeBin = createFakeClaudeBinary(tempDir)
+  const fakeOpenCodeBin = createFakeOpenCodeBinary(tempDir)
+
+  await withEnv(
+    {
+      CODEX_BIN: fakeCodexBin,
+      CLAUDE_CODE_BIN: fakeClaudeBin,
+      OPENCODE_BIN: fakeOpenCodeBin,
+    },
+    async () => {
+      const {
+        streamPromptToCodexSession,
+        streamPromptToClaudeCodeSession,
+        streamPromptToOpenCodeSession,
+      } = await importFreshRunnerModules()
+
+      const [codexResult, claudeResult, openCodeResult] = await Promise.all([
+        collectRunnerContractEvents(streamPromptToCodexSession),
+        collectRunnerContractEvents(streamPromptToClaudeCodeSession),
+        collectRunnerContractEvents(streamPromptToOpenCodeSession),
+      ])
+
+      assertRunnerContract(codexResult, 'thread-contract-1')
+      assertRunnerContract(claudeResult, 'thread-contract-1')
+      assertRunnerContract(openCodeResult, 'thread-contract-1')
+    }
+  )
+})
+
+test('Claude Code runner 在 result 后进程不退出时会按 grace timeout 完成', async () => {
+  const tempDir = fs.mkdtempSync(path.join(os.tmpdir(), 'promptx-runner-claude-hang-'))
+  const fakeClaudeBin = createHangingFakeClaudeBinary(tempDir)
+
+  await withEnv(
+    {
+      CLAUDE_CODE_BIN: fakeClaudeBin,
+      PROMPTX_CLAUDE_RESULT_EXIT_GRACE_MS: '30',
+      PROMPTX_CLAUDE_RESULT_FORCE_STOP_GRACE_MS: '30',
+    },
+    async () => {
+      const { streamPromptToClaudeCodeSession } = await importFreshRunnerModules()
+      const result = await collectRunnerContractEvents(streamPromptToClaudeCodeSession)
+
+      assert.deepEqual(result.result, {
+        sessionId: 'session-1',
+        threadId: 'thread-contract-1',
+        message: '最终回复',
+      })
+      assertOrderedSubsequence(projectRunnerContractPhases(result.events), [
+        'status',
+        'thread.started',
+        'agent_message',
+        'turn.completed',
+        'completed',
+      ])
+    }
+  )
+})
+
+test('Codex runner 在 turn.completed 后进程不退出时会按 grace timeout 完成', async () => {
+  const tempDir = fs.mkdtempSync(path.join(os.tmpdir(), 'promptx-runner-codex-hang-'))
+  const fakeCodexBin = createHangingFakeCodexBinary(tempDir)
+
+  await withEnv(
+    {
+      CODEX_BIN: fakeCodexBin,
+      PROMPTX_CODEX_RESULT_EXIT_GRACE_MS: '30',
+      PROMPTX_CODEX_RESULT_FORCE_STOP_GRACE_MS: '30',
+    },
+    async () => {
+      const { streamPromptToCodexSession } = await importFreshRunnerModules()
+      const result = await collectRunnerContractEvents(streamPromptToCodexSession)
+
+      assert.deepEqual(result.result, {
+        sessionId: 'session-1',
+        threadId: 'thread-contract-1',
+        message: '最终回复',
+      })
+      assertOrderedSubsequence(projectRunnerContractPhases(result.events), [
+        'status',
+        'thread.started',
+        'agent_message',
+        'turn.completed',
+        'completed',
+      ])
+    }
+  )
+})

package/apps/runner/src/engines/shellRunner.test.js

@@ -0,0 +1,46 @@
+import assert from 'node:assert/strict'
+import test from 'node:test'
+
+import { shellRunner } from './shellRunner.js'
+
+function collectShellEvents(command) {
+  const events = []
+  const stream = shellRunner.streamSessionPrompt({
+    id: 'session-shell-test',
+    cwd: process.cwd(),
+  }, command, {
+    onEvent(event) {
+      events.push(event)
+    },
+  })
+
+  return {
+    events,
+    stream,
+  }
+}
+
+test('shellRunner runs a one-shot shell command and emits command events', async () => {
+  const command = `"${process.execPath}" -e "console.log('hello shell')"`
+  const { events, stream } = collectShellEvents(command)
+  const result = await stream.result
+
+  assert.match(result.message, /hello shell/)
+  assert.ok(events.some((event) => event?.event?.type === 'item.started'))
+  assert.ok(events.some((event) => event?.event?.type === 'item.completed'))
+  assert.ok(events.some((event) => event?.type === 'stdout' && /hello shell/.test(event.text || '')))
+})
+
+test('shellRunner surfaces non-zero exit output on errors', async () => {
+  const command = `"${process.execPath}" -e "console.error('shell failed'); process.exit(3)"`
+  const { events, stream } = collectShellEvents(command)
+
+  await assert.rejects(
+    stream.result,
+    (error) => /exit 3/.test(String(error?.message || '')) && /shell failed/.test(String(error?.output || ''))
+  )
+
+  const completed = events.find((event) => event?.event?.type === 'item.completed')
+  assert.equal(completed?.event?.item?.exit_code, 3)
+  assert.equal(completed?.event?.item?.status, 'failed')
+})