mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-10-09 14:52:16 +02:00
## Thinking Path > - Paperclip is the open source app people use to manage AI agents for work. > - Agent adapters are the boundary between the control plane and the runtimes that actually do work. > - Hermes support needs to be available as first-class local and gateway adapters while still preserving the adapter-manager override path for external packages. > - The adapter work touches runtime execution, UI adapter metadata, onboarding prompts, scoped credentials, release packaging, and smoke coverage, so the handoff needs concrete verification rather than only unit tests. > - This pull request adds built-in Hermes local and Hermes gateway support, keeps external adapter overrides compatible, and documents/tests the gateway flow end to end. > - The benefit is that operators can hire Hermes-backed agents without a manual plugin install, while self-hosted installs can still override/shadow the built-ins through Adapter manager packages. ## Linked Issues or Issue Description No public GitHub issue exists for this exact Hermes built-in adapter, gateway onboarding, and release-source work. Problem description: - Hermes local and gateway adapters need a public, reviewable source path in the monorepo so package artifacts and built-in adapter behavior match the application source. - Operators need built-in `hermes_local` and `hermes_gateway` adapter choices without losing the ability to install external Hermes packages as overrides. - Gateway onboarding needs secure defaults for API server URLs, API keys, and generated agent setup text. - Hermes-originated task bridge credentials need narrower API-key scope configuration. - Related public PRs found during duplicate search include #3027, #2363, #7544, #7950, #8095, and #8543. ## What Changed - Added the unified Hermes adapter package with local and gateway server/UI/CLI exports, config schemas, transcript parsing, model detection, and package metadata. - Registered `hermes_local` and `hermes_gateway` as built-in adapters across shared constants, server registries, CLI packaging, and UI adapter registries. - Kept the external adapter override path compatible so installed Hermes packages can shadow built-ins and restore the built-in parser when disabled. - Added Hermes gateway onboarding docs, board-operator docs, Docker smoke assets, and shell smoke harnesses for join/e2e validation. - Added scoped task-bridge API-key support, authorization checks, issue-origin handling, and tests for Hermes-created Paperclip tasks. - Hardened gateway transport and redaction behavior for API keys, headers, session data, and smoke diagnostics. - Updated release packaging/bootstrap checks for the Hermes packages while leaving `pnpm-lock.yaml` out of the PR per repository policy. ## Verification Targeted local verification recorded before PR handoff: - `pnpm --filter @paperclipai/hermes-paperclip-adapter exec vitest run src/gateway/server/execute.test.ts` — 14/14 passed. - `pnpm test:hermes-gateway-smoke` — 6/6 passed. - Hermes package typecheck/build checks passed. - Focused server/UI adapter tests passed — 31/31. - Release helper Node tests passed — 18/18. - `git diff --check origin/master..HEAD` passed. Fresh Docker E2E smoke evidence: - Ran `pnpm smoke:hermes-gateway-e2e` on 2026-06-26 with a fresh state directory and fresh Docker container against a live Paperclip dev server. - Hermes direct execution reached `completed`. - Hermes stop/cancel path reached `cancelled`. - Hermes gateway created a Paperclip task, Paperclip ran the Hermes agent, and the task reached `done` with the expected marker response. - Temporary board auth keys, token files, smoke state, and Docker containers were cleaned up after the run. PR checks on head `b5eae40ce`: - GitHub Actions passed: `policy`, `review`, `Typecheck + Release Registry`, all general test shards, all serialized server shards, `Build`, `Canary Dry Run`, `e2e`, and aggregate `verify`. - External checks passed: Snyk and Socket Project Report. - External Socket Pull Request Alerts remained pending after the first-party CI matrix completed. ## Risks - Medium risk: this spans adapter registration, package publishing, gateway execution, onboarding docs, API-key scoping, and UI adapter metadata. - Migration risk is low: the scope-config migration adds a nullable column and does not rewrite existing keys. - Gateway execution depends on operator-provided Hermes API configuration; the smoke covers the Docker gateway path but real deployments may differ by network/auth setup. - Direct Greptile review on the latest expanded diff is file-count limited, although the commitperclip review gate passed. > For core feature work, check [`ROADMAP.md`](ROADMAP.md) first and discuss it in `#dev` before opening the PR. Feature PRs that overlap with planned core work may need to be redirected — check the roadmap first. See `CONTRIBUTING.md`. ## Model Used OpenAI Codex, GPT-5 coding agent, tool use enabled in a local repository workspace. Context window size is not exposed in this environment. ## Checklist - [x] I have included a thinking path that traces from project context to this change - [x] I have specified the model used (with version and capability details) - [x] I have checked ROADMAP.md and confirmed this PR does not duplicate planned core work - [x] I have searched GitHub for duplicate or related PRs and linked them above - [x] I have either (a) linked existing issues with `Fixes: #` / `Closes #` / `Refs #` OR (b) described the issue in-PR following the relevant issue template - [x] I have not referenced internal/instance-local Paperclip issues or links (only public GitHub `#NNN` / `github.com/paperclipai/paperclip` URLs) - [x] My branch name describes the change (e.g. `docs/...`, `fix/...`) and contains no internal Paperclip ticket id or instance-derived details - [x] I have run tests locally and they pass - [x] I have added or updated tests where applicable - [x] I have updated relevant documentation to reflect my changes - [x] I have considered and documented any risks above - [x] All Paperclip CI gates are green - [x] Commitperclip review gate is green; direct Greptile review is file-count limited on the latest expanded diff - [x] I will address all Greptile and reviewer comments before requesting merge --------- Co-authored-by: Paperclip <noreply@paperclip.ing>
156 lines
5.7 KiB
JavaScript
156 lines
5.7 KiB
JavaScript
import assert from "node:assert/strict";
|
|
import { spawnSync } from "node:child_process";
|
|
import fs from "node:fs";
|
|
import path from "node:path";
|
|
import { fileURLToPath } from "node:url";
|
|
import test from "node:test";
|
|
|
|
const repoRoot = path.resolve(path.dirname(fileURLToPath(import.meta.url)), "..", "..");
|
|
const joinScript = path.join(repoRoot, "scripts", "smoke", "hermes-gateway-join.sh");
|
|
const e2eScript = path.join(repoRoot, "scripts", "smoke", "hermes-gateway-e2e.sh");
|
|
const entrypointScript = path.join(repoRoot, "docker", "hermes-gateway-smoke", "entrypoint.sh");
|
|
|
|
function run(command, args, options = {}) {
|
|
return spawnSync(command, args, {
|
|
cwd: repoRoot,
|
|
encoding: "utf8",
|
|
...options,
|
|
});
|
|
}
|
|
|
|
function assertSuccess(result, label) {
|
|
assert.equal(
|
|
result.status,
|
|
0,
|
|
`${label} failed\nstdout:\n${result.stdout}\nstderr:\n${result.stderr}`,
|
|
);
|
|
}
|
|
|
|
function extractFunction(scriptText, name) {
|
|
const lines = scriptText.split("\n");
|
|
const start = lines.findIndex((line) => line.trim() === `${name}() {`);
|
|
assert.notEqual(start, -1, `missing function ${name}`);
|
|
|
|
const collected = [];
|
|
for (let index = start; index < lines.length; index += 1) {
|
|
collected.push(lines[index]);
|
|
if (index > start && lines[index].trim() === "}") {
|
|
return collected.join("\n");
|
|
}
|
|
}
|
|
assert.fail(`unterminated function ${name}`);
|
|
}
|
|
|
|
function runBashFunctions(scriptPath, functionNames, body) {
|
|
const scriptText = fs.readFileSync(scriptPath, "utf8");
|
|
const functions = functionNames.map((name) => extractFunction(scriptText, name)).join("\n\n");
|
|
return run("bash", ["-c", `set -euo pipefail\n${functions}\n${body}`]);
|
|
}
|
|
|
|
test("Hermes gateway smoke shell scripts pass bash syntax validation", () => {
|
|
const result = run("bash", ["-n", joinScript, e2eScript, entrypointScript]);
|
|
assertSuccess(result, "bash -n");
|
|
});
|
|
|
|
test("Hermes gateway smoke help documents operator safety flags", () => {
|
|
for (const script of [joinScript, e2eScript]) {
|
|
const result = run("bash", [script, "--help"]);
|
|
assertSuccess(result, `${path.basename(script)} --help`);
|
|
assert.match(result.stdout, /HERMES_GATEWAY_API_BASE_URL/);
|
|
assert.match(result.stdout, /HERMES_GATEWAY_PROBE_URL/);
|
|
assert.match(result.stdout, /HERMES_GATEWAY_ALLOW_INSECURE_HTTP/);
|
|
assert.match(result.stdout, /redact|redacted|Raw .*keys are redacted/i);
|
|
}
|
|
|
|
const e2eHelp = run("bash", [e2eScript, "--help"]).stdout;
|
|
assert.match(e2eHelp, /HERMES_SMOKE_KEEP/);
|
|
assert.match(e2eHelp, /HERMES_SMOKE_NETWORK/);
|
|
assert.match(e2eHelp, /HERMES_SMOKE_MODEL_DEFAULT/);
|
|
assert.match(e2eHelp, /Docker/);
|
|
});
|
|
|
|
test("E2E helper can seed a minimal Hermes model config without secrets", () => {
|
|
const result = runBashFunctions(
|
|
e2eScript,
|
|
["log", "fail", "yaml_single_quote", "write_hermes_model_config"],
|
|
`
|
|
tmp="$(mktemp -d)"
|
|
trap 'rm -rf "$tmp"' EXIT
|
|
HERMES_SMOKE_STATE_DIR="$tmp"
|
|
HERMES_SMOKE_MODEL_PROVIDER="openrouter"
|
|
HERMES_SMOKE_MODEL_DEFAULT="z-ai/glm-5.2"
|
|
HERMES_SMOKE_MODEL_BASE_URL="https://openrouter.ai/api/v1"
|
|
mkdir -p "$HERMES_SMOKE_STATE_DIR/hermes-home"
|
|
write_hermes_model_config
|
|
config="$HERMES_SMOKE_STATE_DIR/hermes-home/config.yaml"
|
|
grep -Fq "default: 'z-ai/glm-5.2'" "$config"
|
|
grep -Fq "provider: 'openrouter'" "$config"
|
|
grep -Fq "base_url: 'https://openrouter.ai/api/v1'" "$config"
|
|
grep -Fq "command_allowlist:" "$config"
|
|
grep -Fq -- "- execute_code" "$config"
|
|
! grep -Eiq "api[_-]?key|token|secret" "$config"
|
|
`,
|
|
);
|
|
assertSuccess(result, "write_hermes_model_config");
|
|
});
|
|
|
|
test("join helper redacts known secrets without exposing raw key material", () => {
|
|
const result = runBashFunctions(
|
|
joinScript,
|
|
["redact_text"],
|
|
`
|
|
HERMES_GATEWAY_API_KEY="gateway-secret"
|
|
CLAIM_SECRET="claim-secret"
|
|
AGENT_API_KEY="agent-secret"
|
|
PAPERCLIP_API_KEY="paperclip-secret"
|
|
PAPERCLIP_AUTH_HEADER="Bearer board-secret"
|
|
PAPERCLIP_COOKIE="session=board-cookie"
|
|
output="$(redact_text "gateway-secret claim-secret agent-secret paperclip-secret Bearer board-secret session=board-cookie")"
|
|
[[ "$output" != *"gateway-secret"* ]]
|
|
[[ "$output" != *"claim-secret"* ]]
|
|
[[ "$output" != *"agent-secret"* ]]
|
|
[[ "$output" != *"paperclip-secret"* ]]
|
|
[[ "$output" != *"board-secret"* ]]
|
|
[[ "$output" != *"board-cookie"* ]]
|
|
[[ "$output" == *"[redacted len=14]"* ]]
|
|
`,
|
|
);
|
|
assertSuccess(result, "redact_text");
|
|
});
|
|
|
|
test("URL helpers distinguish loopback HTTP from unsafe remote HTTP", () => {
|
|
for (const script of [joinScript, e2eScript]) {
|
|
const result = runBashFunctions(
|
|
script,
|
|
["url_host", "is_loopback_http_host", "is_remote_plain_http"],
|
|
`
|
|
is_remote_plain_http "http://192.168.1.20:8642"
|
|
is_remote_plain_http "http://hermes-gateway.local:8642"
|
|
is_remote_plain_http "http://127.example.com:8642"
|
|
is_remote_plain_http "http://localhost.evil:8642"
|
|
! is_remote_plain_http "https://192.168.1.20:8642"
|
|
! is_remote_plain_http "http://127.0.0.1:8642"
|
|
! is_remote_plain_http "http://127.44.55.66:8642"
|
|
! is_remote_plain_http "http://localhost:8642"
|
|
! is_remote_plain_http "http://[::1]:8642"
|
|
[[ "$(url_host "http://[::1]:8642/health")" == "::1" ]]
|
|
[[ "$(url_host "http://127.example.com:8642/health")" == "127.example.com" ]]
|
|
`,
|
|
);
|
|
assertSuccess(result, `${path.basename(script)} URL helpers`);
|
|
}
|
|
});
|
|
|
|
test("join helper normalizes trailing slashes for URL comparisons", () => {
|
|
const result = runBashFunctions(
|
|
joinScript,
|
|
["strip_trailing_slash"],
|
|
`
|
|
[[ "$(strip_trailing_slash "http://127.0.0.1:8642///")" == "http://127.0.0.1:8642" ]]
|
|
[[ "$(strip_trailing_slash "https://gateway.example.com/")" == "https://gateway.example.com" ]]
|
|
[[ "$(strip_trailing_slash "https://gateway.example.com/path/")" == "https://gateway.example.com/path" ]]
|
|
`,
|
|
);
|
|
assertSuccess(result, "strip_trailing_slash");
|
|
});
|