-
Notifications
You must be signed in to change notification settings - Fork 161
feat(agent-relay-claude-code): add the Agent Relay Claude Code module #1114
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
Emyrk
wants to merge
1
commit into
main
Choose a base branch
from
sm/agent-relay-claude-code
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,87 @@ | ||
| --- | ||
| display_name: Agent Relay Claude Code | ||
| description: Serves Claude Code self-hosted runner sessions in Coder workspaces that Agent Relay dispatches. | ||
| icon: ../../../../.icons/claude.svg | ||
| verified: true | ||
| tags: [agent, claude, agent-relay] | ||
| --- | ||
|
|
||
| # Agent Relay Claude Code | ||
|
|
||
| Makes a Coder template a target for [Agent Relay](https://coder.com/docs/ai-coder/agent-relay) | ||
| Claude Code pools. Agent Relay dispatches Claude Code sessions to workspaces | ||
| built from the template; the module declares the parameters the relay stamps | ||
| on each build and runs the Claude Code self-hosted runner. | ||
|
|
||
| ```tf | ||
| module "claude_code_runner" { | ||
| source = "registry.coder.com/coder/agent-relay-claude-code/coder" | ||
| version = "0.1.0" | ||
| agent_id = coder_agent.main.id | ||
|
|
||
| # Downloads the Claude Code CLI at start when it is not in the image. Bake | ||
| # the CLI into the image and set this to false for faster workspaces. | ||
| install_cli = true | ||
| } | ||
|
|
||
| resource "coder_agent" "main" { | ||
| # ... | ||
| metadata { | ||
| key = "agent_relay_status" | ||
| display_name = "Session" | ||
| script = module.claude_code_runner.status_metadata_script | ||
| interval = 10 | ||
| timeout = 5 | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| The `agent_relay_status` metadata block is required. It has to live on the | ||
| `coder_agent`, which the module cannot declare; the relay reads it to decide | ||
| when to reap the workspace. | ||
|
|
||
| ## Requirements | ||
|
|
||
| - The `claude` CLI must be in the workspace. `install_cli` (default `true`) | ||
| downloads it at start only when it is not already on PATH; bake it into the | ||
| image for the fastest start. `cli_binary` overrides the path. | ||
| - Builds must finish inside Agent Relay's 300s spawn budget: pre-pulled | ||
| images, no persistent volumes. | ||
|
|
||
| ## Parameters | ||
|
|
||
| Agent Relay verifies this contract against the template's active version at | ||
| startup and refuses to serve a pool that does not satisfy it. Every parameter | ||
| renders disabled with a "Set by Agent Relay on dispatch" placeholder; the | ||
| credential is masked. | ||
|
|
||
| | parameter | kind | value | | ||
| | ----------------------------------------- | ---------- | ---------------------------------------------------------------------------- | | ||
| | `agent_relay_session_id` | persistent | Anthropic session this workspace serves | | ||
| | `agent_relay_delivery_id` | persistent | work order that dispatched the build; rotates per attempt | | ||
| | `agent_relay_pool` | persistent | Agent Relay pool that dispatched the build | | ||
| | `agent_relay_credential` | ephemeral | single-use work order JWT (`SELF_HOSTED_RUNNER_POOL_SECRET`) | | ||
| | `agent_relay_claude_code_lock_to_account` | ephemeral | Anthropic account the runner locks to (`SELF_HOSTED_RUNNER_LOCK_TO_ACCOUNT`) | | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. it's good to know it's single use but how Template insights work we capture every unique value of a parameter. Not sure if it's the same for ephemeral parameters too. So I would suggest verifying. |
||
| | `agent_relay_attempt` | ephemeral | delivery attempt, echoed back when the relay nacks the session | | ||
|
|
||
| ## Runner lifecycle | ||
|
|
||
| The script starts `claude self-hosted-runner --capacity 1` detached and exits, | ||
| so the agent reaches `ready` immediately. The runner is wrapped so every | ||
| session runs with `--permission-mode bypassPermissions`; there is no terminal | ||
| attached, so an approval prompt would hang it. When the runner exits, Agent | ||
| Relay deletes the workspace; when it fails, the relay nacks the work order. | ||
|
|
||
| `agent_relay_status` reports one of: | ||
|
|
||
| | value | meaning | | ||
| | ----------------- | -------------------------------------------------------------------------- | | ||
| | `pending` | no state recorded yet | | ||
| | `idle` | no credential: workspace was created manually | | ||
| | `working` | runner alive, no session picked up | | ||
| | `serving` | runner alive, session picked up (best effort, see `serving_log_pattern`) | | ||
| | `orphaned` | runner process gone without recording an exit | | ||
| | `done <code>` | runner exited with that status; `137` means it was killed | | ||
| | `failed <reason>` | runner could not start, e.g. `runner-agent-missing` when the CLI is absent | | ||
|
|
||
| Renaming the `agent_relay_status` key breaks reaping. | ||
202 changes: 202 additions & 0 deletions
202
registry/coder/modules/agent-relay-claude-code/main.test.ts
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,202 @@ | ||
| import { | ||
| afterEach, | ||
| beforeAll, | ||
| describe, | ||
| expect, | ||
| it, | ||
| setDefaultTimeout, | ||
| } from "bun:test"; | ||
| import { | ||
| execContainer, | ||
| findResourceInstance, | ||
| readFileContainer, | ||
| removeContainer, | ||
| runContainer, | ||
| runTerraformApply, | ||
| runTerraformInit, | ||
| testRequiredVariables, | ||
| writeFileContainer, | ||
| } from "~test"; | ||
|
|
||
| // The runner script is exercised inside a throwaway container with a stub | ||
| // `claude` binary standing in for the Claude Code CLI, so the supervisor | ||
| // lifecycle the relay's reaper depends on (idle, working, done, failed) is | ||
| // observed rather than grepped for. The real installer and the real runner | ||
| // are out of scope: both need the network and Anthropic's side. | ||
|
|
||
| let cleanupFunctions: (() => Promise<void>)[] = []; | ||
| const registerCleanup = (cleanup: () => Promise<void>) => { | ||
| cleanupFunctions.push(cleanup); | ||
| }; | ||
| afterEach(async () => { | ||
| const cleanupFnsCopy = cleanupFunctions.slice().reverse(); | ||
| cleanupFunctions = []; | ||
| for (const cleanup of cleanupFnsCopy) { | ||
| try { | ||
| await cleanup(); | ||
| } catch (error) { | ||
| console.error("Error during cleanup:", error); | ||
| } | ||
| } | ||
| }); | ||
|
|
||
| const STATE_FILE = "/tmp/agent-relay/runner-state"; | ||
| const DISPATCH_ENV = [ | ||
| "SELF_HOSTED_RUNNER_POOL_SECRET=test-work-order-jwt", | ||
| "SELF_HOSTED_RUNNER_LOCK_TO_ACCOUNT=acct-123", | ||
| ]; | ||
|
|
||
| const setup = async (vars: Record<string, string> = {}) => { | ||
| const state = await runTerraformApply(import.meta.dir, { | ||
| agent_id: "foo", | ||
| ...vars, | ||
| }); | ||
| const script = findResourceInstance(state, "coder_script").script; | ||
| const id = await runContainer("lorello/alpine-bash"); | ||
| registerCleanup(async () => { | ||
| await removeContainer(id); | ||
| }); | ||
| return { id, script }; | ||
| }; | ||
|
|
||
| // Installs a fake Claude Code CLI whose body is the given shell snippet. | ||
| const stubClaude = async (id: string, body: string) => { | ||
| await writeFileContainer( | ||
| id, | ||
| "/usr/local/bin/claude", | ||
| `#!/usr/bin/env bash\n${body}\n`, | ||
| { user: "root" }, | ||
| ); | ||
| const chmod = await execContainer(id, [ | ||
| "chmod", | ||
| "755", | ||
| "/usr/local/bin/claude", | ||
| ]); | ||
| expect(chmod.exitCode).toBe(0); | ||
| }; | ||
|
|
||
| const runDispatched = (id: string, script: string) => | ||
| execContainer(id, ["env", ...DISPATCH_ENV, "bash", "-c", script]); | ||
|
|
||
| const readState = async (id: string) => | ||
| (await readFileContainer(id, STATE_FILE)).trim(); | ||
|
|
||
| // The supervisor writes terminal state after the runner exits; poll rather | ||
| // than sleep a fixed amount. | ||
| const waitForState = async (id: string, pattern: RegExp, timeoutMs = 5000) => { | ||
| const deadline = Date.now() + timeoutMs; | ||
| let last = ""; | ||
| while (Date.now() < deadline) { | ||
| last = await readState(id); | ||
| if (pattern.test(last)) { | ||
| return last; | ||
| } | ||
| await Bun.sleep(200); | ||
| } | ||
| throw new Error( | ||
| `state never matched ${pattern}; last was ${JSON.stringify(last)}`, | ||
| ); | ||
| }; | ||
|
|
||
| setDefaultTimeout(60 * 1000); | ||
|
|
||
| describe("agent-relay-claude-code", () => { | ||
| beforeAll(async () => { | ||
| await runTerraformInit(import.meta.dir); | ||
| }); | ||
|
|
||
| testRequiredVariables(import.meta.dir, { | ||
| agent_id: "foo", | ||
| }); | ||
|
|
||
| it("idles when no credential is set", async () => { | ||
| const { id, script } = await setup(); | ||
| // No SELF_HOSTED_RUNNER_POOL_SECRET: a workspace a human created by hand. | ||
| const exec = await execContainer(id, ["bash", "-c", script]); | ||
| expect(exec.exitCode).toBe(0); | ||
| expect(exec.stdout).toContain("created manually, not by Agent Relay"); | ||
| expect(await readState(id)).toBe("idle"); | ||
| }); | ||
|
|
||
| it("reports runner-agent-missing when the CLI is absent", async () => { | ||
| const { id, script } = await setup({ install_cli: "false" }); | ||
| const exec = await runDispatched(id, script); | ||
| expect(exec.exitCode).toBe(1); | ||
| expect(exec.stderr).toContain( | ||
| "The runner binary 'claude' is not available", | ||
| ); | ||
| expect(await readState(id)).toBe("failed runner-agent-missing"); | ||
| }); | ||
|
|
||
| it("skips the download when the CLI is already present", async () => { | ||
| // install_cli defaults to true; a binary on PATH must short-circuit it. | ||
| const { id, script } = await setup(); | ||
| await stubClaude(id, "sleep 30"); | ||
| const exec = await runDispatched(id, script); | ||
| expect(exec.exitCode).toBe(0); | ||
| expect(exec.stdout).toContain( | ||
| "Claude Code CLI already present; skipping the install.", | ||
| ); | ||
| expect(exec.stdout).not.toContain("installing the latest release"); | ||
| expect(await readState(id)).toMatch(/^working \d+$/); | ||
| }); | ||
|
|
||
| it("starts the runner detached through the permissions wrapper", async () => { | ||
| const { id, script } = await setup(); | ||
| await stubClaude(id, 'printf "%s\\n" "$@" >/tmp/claude-args; sleep 30'); | ||
| const exec = await runDispatched(id, script); | ||
| expect(exec.exitCode).toBe(0); | ||
| expect(exec.stdout).toContain( | ||
| "Starting Claude Code self-hosted runner (detached)...", | ||
| ); | ||
|
|
||
| const args = (await readFileContainer(id, "/tmp/claude-args")).split("\n"); | ||
| expect(args[0]).toBe("self-hosted-runner"); | ||
| expect(args[args.indexOf("--capacity") + 1]).toBe("1"); | ||
| expect(args[args.indexOf("--exec-path") + 1]).toBe( | ||
| "/root/.claude/wrapper.sh", | ||
| ); | ||
|
|
||
| // The wrapper is what forces bypassPermissions on every session. | ||
| const wrapper = await readFileContainer(id, "/root/.claude/wrapper.sh"); | ||
| expect(wrapper).toContain("--permission-mode bypassPermissions"); | ||
|
|
||
| // The runner inherits the CLI's own env var names, not the relay's. | ||
| const env = await execContainer(id, [ | ||
| "sh", | ||
| "-c", | ||
| "cat /proc/$(pgrep -f 'claude self-hosted-runner' | head -1)/environ | tr '\\0' '\\n'", | ||
| ]); | ||
| expect(env.stdout).toContain( | ||
| "SELF_HOSTED_RUNNER_POOL_SECRET=test-work-order-jwt", | ||
| ); | ||
| expect(env.stdout).toContain("SELF_HOSTED_RUNNER_LOCK_TO_ACCOUNT=acct-123"); | ||
| }); | ||
|
|
||
| it("records the exit code when the runner exits", async () => { | ||
| const { id, script } = await setup(); | ||
| await stubClaude(id, "exit 3"); | ||
| const exec = await runDispatched(id, script); | ||
| expect(exec.exitCode).toBe(0); | ||
| expect(await waitForState(id, /^done \d+$/)).toBe("done 3"); | ||
| }); | ||
|
|
||
| it("uses cli_binary and state_file overrides", async () => { | ||
| const { id, script } = await setup({ | ||
| cli_binary: "/opt/claude/claude", | ||
| state_file: "/var/lib/relay/state", | ||
| }); | ||
| await execContainer(id, ["mkdir", "-p", "/opt/claude"]); | ||
| await writeFileContainer( | ||
| id, | ||
| "/opt/claude/claude", | ||
| "#!/usr/bin/env bash\nsleep 30\n", | ||
| { user: "root" }, | ||
| ); | ||
| await execContainer(id, ["chmod", "755", "/opt/claude/claude"]); | ||
| const exec = await runDispatched(id, script); | ||
| expect(exec.exitCode).toBe(0); | ||
| const state = (await readFileContainer(id, "/var/lib/relay/state")).trim(); | ||
| expect(state).toMatch(/^working \d+$/); | ||
| }); | ||
| }); |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@mattvollmer any suggestions on naming here from SEO perspective?