mirror of
https://github.com/headroomlabs-ai/headroom.git
synced 2026-11-22 15:10:00 +08:00
## Summary This PR implements transparent `headroom wrap opencode` support without asking users to edit OpenCode provider URLs, choose an extra CLI flag, or maintain a static provider list. The wrapper now lives at the runtime transport boundary: OpenCode keeps its user/provider config, while Headroom intercepts outbound provider traffic in-process and routes it through the local Headroom proxy. ## What changed ### Transparent OpenCode wrapping - `headroom wrap opencode` injects the `headroom-opencode` plugin through `OPENCODE_CONFIG_CONTENT`. - Existing OpenCode provider URLs are preserved. We do not rewrite user config URLs to point at Headroom. - Existing `OPENAI_BASE_URL` and `ANTHROPIC_BASE_URL` env vars are preserved. - Local OpenCode traffic, localhost traffic, and Headroom proxy traffic bypass the shim to avoid loops. ### Runtime transport interception - Added an OpenCode plugin transport shim that wraps: - `globalThis.fetch` - `http.request` / `http.get` - `https.request` / `https.get` - External provider calls are routed to the local Headroom proxy. - The original upstream origin is passed through `x-headroom-base-url`, so the proxy can forward to the real provider without changing OpenCode config. - External `http2.connect` is blocked loudly instead of allowing direct provider traffic to leak outside Headroom. ### Live provider additions Provider coverage is no longer based on a static config scan. Because routing happens at outbound request time, providers added mid-session are routed through Headroom automatically as long as they use the covered Node transport paths. ### Subagent and child-process coverage - The parent OpenCode plugin sets a packaged Node preload shim through `NODE_OPTIONS=--import=.../hook-shim/handler.js`. - The transport shim patches `child_process.spawn`, `exec`, `execFile`, and `fork` so child Node processes receive the Headroom preload even when OpenCode passes a custom `env`. - The child-process shim fails closed if it loads without `HEADROOM_OPENCODE_TRANSPORT_PROXY_URL`. - This closes the subagent leak path where a child Node process could otherwise start without Headroom transport interception. ## Why this goes beyond PR #1089 PR #1089 improves OpenCode provider registration, but it still focuses on provider config shape. This PR moves the enforcement boundary to runtime transport interception. This PR goes further because: - No provider URL rewriting is required. - New providers added mid-session are covered automatically. - Subagents and child Node processes inherit the Headroom transport shim. - Direct external HTTP/2 paths fail loudly instead of leaking. - The wrap remains transparent to the user's OpenCode provider config. - The wrapper is fail-closed for unsupported child-process preload state. ## Additional robustness fixes While validating the change in Docker, the full Python suite exposed unrelated Linux/container robustness issues. These are fixed in this PR so the suite is green: - Binary cache handling now treats cache paths under a non-writable existing parent as unavailable, including when tests run as root in Docker. - `release_version.py` honors `MANUAL_VER` before git calls so direct script execution works outside a `.git` checkout. - Test logger isolation now resets relevant Headroom child loggers so proxy logging setup cannot poison later `caplog` tests. - The scanner missing-path test now uses a guaranteed missing `tmp_path` child instead of relying on `/nonexistent/path`. ## Validation All implementation validation was run inside Docker. - Full Python suite from a fresh Docker copy: `6605 passed, 523 skipped`. - Ruff on changed Python/OpenCode paths: passed. - OpenCode plugin typecheck: passed. - OpenCode plugin tests: `9 passed`. - OpenCode plugin build: passed. - Hook shim preload smoke test: passed. ## Notes This PR intentionally does not add a CLI option. `headroom wrap opencode` means full wrap. Either Headroom wraps OpenCode transparently, or the path fails loudly instead of silently leaking provider traffic. --------- Co-authored-by: Rudimar Ronsoni <6081613+rudironsoni@users.noreply.github.com>
69 lines
1.8 KiB
TypeScript
69 lines
1.8 KiB
TypeScript
import { afterEach, describe, expect, it, vi } from "vitest";
|
|
|
|
import { HeadroomPlugin } from "./plugin.js";
|
|
|
|
function pluginInput() {
|
|
return {
|
|
client: {},
|
|
project: { id: "project-1" },
|
|
directory: "/repo",
|
|
worktree: "/repo",
|
|
experimental_workspace: {
|
|
register: vi.fn(),
|
|
},
|
|
$: {},
|
|
} as never;
|
|
}
|
|
|
|
afterEach(() => {
|
|
vi.restoreAllMocks();
|
|
});
|
|
|
|
describe("HeadroomPlugin", () => {
|
|
it("adds only Headroom metadata to shell env", async () => {
|
|
const plugin = await HeadroomPlugin(pluginInput(), {
|
|
proxyUrl: "http://127.0.0.1:8787/",
|
|
backend: "litellm",
|
|
});
|
|
const output = {
|
|
env: {
|
|
OPENAI_BASE_URL: "https://deepseek.example/v1",
|
|
ANTHROPIC_BASE_URL: "https://anthropic.example",
|
|
},
|
|
};
|
|
|
|
await plugin["shell.env"]?.({ cwd: "/repo" }, output);
|
|
|
|
expect(output.env).toMatchObject({
|
|
HEADROOM_ACTIVE: "1",
|
|
HEADROOM_PROXY_URL: "http://127.0.0.1:8787",
|
|
HEADROOM_PROJECT: "project-1",
|
|
HEADROOM_BACKEND: "litellm",
|
|
OPENAI_BASE_URL: "https://deepseek.example/v1",
|
|
ANTHROPIC_BASE_URL: "https://anthropic.example",
|
|
});
|
|
});
|
|
|
|
it("exposes a headroom_retrieve tool backed by the proxy", async () => {
|
|
const fetchMock = vi.fn(async () => ({
|
|
ok: true,
|
|
json: async () => "original content",
|
|
}));
|
|
vi.stubGlobal("fetch", fetchMock);
|
|
|
|
const plugin = await HeadroomPlugin(pluginInput(), {
|
|
proxyUrl: "http://127.0.0.1:8787",
|
|
});
|
|
const result = await plugin.tool?.headroom_retrieve.execute(
|
|
{ hash: "0123456789abcdef01234567", query: "needle" },
|
|
{} as never,
|
|
);
|
|
|
|
expect(result).toBe("original content");
|
|
expect(fetchMock).toHaveBeenCalledWith(
|
|
"http://127.0.0.1:8787/v1/retrieve/0123456789abcdef01234567?query=needle",
|
|
expect.any(Object),
|
|
);
|
|
});
|
|
});
|