mirror of
https://github.com/JimLiu/baoyu-skills.git
synced 2026-07-12 22:09:48 +08:00
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.
81 lines
2.2 KiB
TypeScript
81 lines
2.2 KiB
TypeScript
import { createHash } from "node:crypto";
|
|
import { mkdir, readFile, writeFile, copyFile, stat } from "node:fs/promises";
|
|
import { existsSync, openSync, closeSync } from "node:fs";
|
|
import path from "node:path";
|
|
import { setTimeout as delay } from "node:timers/promises";
|
|
|
|
export function cacheKey(prompt: string, aspect: string, refs: string[]): string {
|
|
const h = createHash("sha256");
|
|
h.update(prompt);
|
|
h.update("|");
|
|
h.update(aspect);
|
|
h.update("|");
|
|
for (const r of [...refs].sort()) h.update(r);
|
|
return h.digest("hex").slice(0, 16);
|
|
}
|
|
|
|
export async function lookupCache(cacheDir: string, key: string): Promise<string | null> {
|
|
const entry = path.join(cacheDir, `${key}.png`);
|
|
try {
|
|
const s = await stat(entry);
|
|
if (s.size > 1000) return entry;
|
|
} catch {}
|
|
return null;
|
|
}
|
|
|
|
export async function storeCache(cacheDir: string, key: string, sourcePath: string): Promise<void> {
|
|
await mkdir(cacheDir, { recursive: true });
|
|
const entry = path.join(cacheDir, `${key}.png`);
|
|
await copyFile(sourcePath, entry);
|
|
}
|
|
|
|
export class FileLock {
|
|
private fd: number | null = null;
|
|
constructor(private lockPath: string) {}
|
|
|
|
async acquire(timeoutMs = 30_000): Promise<void> {
|
|
const start = Date.now();
|
|
await mkdir(path.dirname(this.lockPath), { recursive: true });
|
|
while (Date.now() - start < timeoutMs) {
|
|
try {
|
|
this.fd = openSync(this.lockPath, "wx");
|
|
return;
|
|
} catch (e: any) {
|
|
if (e.code !== "EEXIST") throw e;
|
|
if (await this.isStale()) {
|
|
try {
|
|
await this.release(true);
|
|
} catch {}
|
|
continue;
|
|
}
|
|
await delay(200);
|
|
}
|
|
}
|
|
throw new Error(`Failed to acquire lock at ${this.lockPath} within ${timeoutMs}ms`);
|
|
}
|
|
|
|
private async isStale(): Promise<boolean> {
|
|
try {
|
|
const s = await stat(this.lockPath);
|
|
return Date.now() - s.mtimeMs > 10 * 60 * 1000;
|
|
} catch {
|
|
return true;
|
|
}
|
|
}
|
|
|
|
async release(force = false): Promise<void> {
|
|
if (this.fd != null) {
|
|
try {
|
|
closeSync(this.fd);
|
|
} catch {}
|
|
this.fd = null;
|
|
}
|
|
if (existsSync(this.lockPath) || force) {
|
|
const { unlink } = await import("node:fs/promises");
|
|
try {
|
|
await unlink(this.lockPath);
|
|
} catch {}
|
|
}
|
|
}
|
|
}
|