mirror of
https://github.com/JimLiu/baoyu-skills.git
synced 2026-07-12 22:09:48 +08:00
Yelban
e98fa33bc2
Implements the preferred_image_backend: codex-imagegen config key
already referenced in several SKILL.md files but with no corresponding
backend. Bridges non-Codex runtimes (Claude Code, etc.) to Codex CLI's
built-in image_gen tool via 'codex exec'. Uses the user's Codex
subscription — no OPENAI_API_KEY required.
Reliability:
- Retry with exponential backoff (default 2 retries, configurable)
- 9 classified error kinds (retryable vs non-retryable)
- Node child_process timeout with SIGTERM→SIGKILL ladder
Correctness:
- Verifies image_gen was actually invoked (not bypassed) by checking
$CODEX_HOME/generated_images/{thread_id}/ for a PNG
- PNG magic byte validation
- Output file size sanity check
Observability:
- Structured JSONL logging with --log-file
- Verbose stderr mode with --verbose
- Returns thread_id, tool_calls, token usage in result JSON
- Raw codex event stream preserved per attempt for debugging
Efficiency:
- Idempotency cache via --cache-dir (sha256 of prompt+aspect+refs)
- Cache hit returns in <0.3s vs 50-90s cold
Features:
- --ref reference images (repeatable, passed through to codex exec --image)
- --retries, --retry-delay, --timeout all configurable
- File lock serializes concurrent invocations
Testing:
- 16 Bun unit tests across parser, cache, validator
- Path-filtered CI workflow at .github/workflows/codex-imagegen-tests.yml
- Composes with existing test.yml without conflicts
Architecture:
- scripts/codex-imagegen.sh: thin bash entrypoint (bun → npx -y bun fallback)
- scripts/codex-imagegen/: TypeScript module
- main.ts (orchestrator), types.ts (CliOptions/GenerateResult/GenError),
spawn.ts (child_process), parser.ts (JSONL events), validator.ts
(image_gen check + PNG magic), cache.ts (sha256 cache + FileLock),
logger.ts (JSONL structured logger)
Trade-offs documented in docs/codex-imagegen-backend.md:
- 5-10x slower than direct OpenAI API (or near-free on cache hit)
- ToS gray area: image_gen is documented for interactive use; non-
interactive invocation via codex exec is not explicitly addressed.
Suitable for personal low-volume use; users are responsible for
ensuring their usage complies with applicable terms of service.
63 lines
3.1 KiB
TypeScript
63 lines
3.1 KiB
TypeScript
import { test, expect } from "bun:test";
|
|
import { parseEventStream, hasImageGenInvocation, parseFinalJson } from "./parser.ts";
|
|
|
|
const REAL_PoC_STREAM = `{"type":"thread.started","thread_id":"019e40d3-30e3-7030-874d-773bc0d6d1eb"}
|
|
{"type":"turn.started"}
|
|
{"type":"item.started","item":{"id":"item_0","type":"command_execution","command":"sed -n '1,5p' /tmp/x.md","status":"in_progress"}}
|
|
{"type":"item.completed","item":{"id":"item_0","type":"command_execution","command":"sed -n '1,5p' /tmp/x.md","exit_code":0,"status":"completed"}}
|
|
{"type":"item.started","item":{"id":"item_1","type":"command_execution","command":"cp /Users/x/.codex/generated_images/019e40d3/ig_abc.png /tmp/out.png","status":"in_progress"}}
|
|
{"type":"item.completed","item":{"id":"item_1","type":"command_execution","command":"cp /Users/x/.codex/generated_images/019e40d3/ig_abc.png /tmp/out.png","exit_code":0,"status":"completed"}}
|
|
{"type":"item.completed","item":{"id":"item_2","type":"agent_message","text":"{\\"status\\":\\"ok\\",\\"path\\":\\"/tmp/out.png\\",\\"bytes\\":1234567}"}}
|
|
{"type":"turn.completed","usage":{"input_tokens":100000,"cached_input_tokens":80000,"output_tokens":500,"reasoning_output_tokens":50}}`;
|
|
|
|
test("parseEventStream extracts threadId, toolCalls, agentMessage, usage", () => {
|
|
const r = parseEventStream(REAL_PoC_STREAM);
|
|
expect(r.threadId).toBe("019e40d3-30e3-7030-874d-773bc0d6d1eb");
|
|
expect(r.toolCalls.length).toBe(3);
|
|
expect(r.usage).toEqual({
|
|
input: 100000,
|
|
cached_input: 80000,
|
|
output: 500,
|
|
reasoning: 50,
|
|
});
|
|
expect(r.agentMessage).toContain('"status":"ok"');
|
|
});
|
|
|
|
test("parseEventStream tolerates malformed lines", () => {
|
|
const stream = `not json at all
|
|
{"type":"thread.started","thread_id":"abc"}
|
|
{partial json
|
|
{"type":"turn.completed","usage":{"input_tokens":1,"cached_input_tokens":0,"output_tokens":1,"reasoning_output_tokens":0}}`;
|
|
const r = parseEventStream(stream);
|
|
expect(r.threadId).toBe("abc");
|
|
expect(r.usage?.input).toBe(1);
|
|
});
|
|
|
|
test("hasImageGenInvocation finds shell calls touching generated_images", () => {
|
|
const r = parseEventStream(REAL_PoC_STREAM);
|
|
// image_gen itself is not an event; inferred via generated_images cp path
|
|
// this test only verifies parser behavior; driver logic lives in validator
|
|
const hasCp = r.toolCalls.some((tc) => tc.command?.includes("generated_images"));
|
|
expect(hasCp).toBe(true);
|
|
});
|
|
|
|
test("parseFinalJson extracts {status:ok, path, bytes}", () => {
|
|
expect(parseFinalJson('{"status":"ok","path":"/tmp/a.png","bytes":1234}')).toEqual({
|
|
path: "/tmp/a.png",
|
|
bytes: 1234,
|
|
});
|
|
expect(parseFinalJson("garbage text {\"status\":\"ok\",\"path\":\"/x\",\"bytes\":5} trailer")).toEqual({
|
|
path: "/x",
|
|
bytes: 5,
|
|
});
|
|
expect(parseFinalJson(null)).toBeNull();
|
|
expect(parseFinalJson('{"status":"error","reason":"x"}')).toBeNull();
|
|
});
|
|
|
|
test("hasImageGenInvocation (proper) returns false when no image_gen tool", () => {
|
|
expect(hasImageGenInvocation([{ id: "1", tool: "shell", status: "completed" }])).toBe(false);
|
|
expect(
|
|
hasImageGenInvocation([{ id: "1", tool: "image_gen", status: "completed" }]),
|
|
).toBe(true);
|
|
});
|