mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-10-24 18:19:05 +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>
271 lines
10 KiB
TypeScript
271 lines
10 KiB
TypeScript
import type { UIAdapterModule } from "./types";
|
|
import { acpxLocalUIAdapter } from "./acpx-local";
|
|
import { claudeLocalUIAdapter } from "./claude-local";
|
|
import { codexLocalUIAdapter } from "./codex-local";
|
|
import { cursorCloudUIAdapter } from "./cursor-cloud";
|
|
import { cursorLocalUIAdapter } from "./cursor";
|
|
import { geminiLocalUIAdapter } from "./gemini-local";
|
|
import { grokLocalUIAdapter } from "./grok-local";
|
|
import { hermesGatewayUIAdapter } from "./hermes-gateway";
|
|
import { hermesLocalUIAdapter } from "./hermes-local";
|
|
import { openCodeLocalUIAdapter } from "./opencode-local";
|
|
import { piLocalUIAdapter } from "./pi-local";
|
|
import { openClawGatewayUIAdapter } from "./openclaw-gateway";
|
|
import { processUIAdapter } from "./process";
|
|
import { httpUIAdapter } from "./http";
|
|
import { loadDynamicParser, invalidateDynamicParser, setDynamicParserResultNotifier } from "./dynamic-loader";
|
|
import { SchemaConfigFields, buildSchemaAdapterConfig } from "./schema-config-fields";
|
|
|
|
const uiAdapters: UIAdapterModule[] = [];
|
|
const adaptersByType = new Map<string, UIAdapterModule>();
|
|
|
|
// Types registered at module load time — allowed to be overridden by
|
|
// external adapters that ship their own ui-parser.js via the server.
|
|
const builtinTypes = new Set<string>();
|
|
|
|
// Original builtin adapters stored for restoration when external overrides
|
|
// are deactivated or removed.
|
|
const builtinAdaptersByType = new Map<string, UIAdapterModule>();
|
|
|
|
// Tracks which builtin types currently have an active external override.
|
|
const activeExternalOverrides = new Set<string>();
|
|
|
|
// Generation counter to discard stale dynamic parser loads. When an override
|
|
// is deactivated while a load is in-flight, the generation is bumped and the
|
|
// stale result is discarded in its .then() handler.
|
|
const overrideGeneration = new Map<string, number>();
|
|
|
|
// Subscriber list — components can register to be notified when adapters change
|
|
// (e.g., when a dynamic parser replaces a placeholder).
|
|
const adapterChangeListeners = new Set<() => void>();
|
|
|
|
/** Subscribe to adapter registry changes. Returns unsubscribe function. */
|
|
export function onAdapterChange(fn: () => void): () => void {
|
|
adapterChangeListeners.add(fn);
|
|
return () => adapterChangeListeners.delete(fn);
|
|
}
|
|
|
|
function notifyAdapterChange(): void {
|
|
for (const fn of adapterChangeListeners) fn();
|
|
}
|
|
|
|
setDynamicParserResultNotifier(notifyAdapterChange);
|
|
|
|
function registerBuiltInUIAdapters() {
|
|
for (const adapter of [
|
|
acpxLocalUIAdapter,
|
|
claudeLocalUIAdapter,
|
|
codexLocalUIAdapter,
|
|
cursorCloudUIAdapter,
|
|
geminiLocalUIAdapter,
|
|
grokLocalUIAdapter,
|
|
hermesGatewayUIAdapter,
|
|
hermesLocalUIAdapter,
|
|
openCodeLocalUIAdapter,
|
|
piLocalUIAdapter,
|
|
cursorLocalUIAdapter,
|
|
openClawGatewayUIAdapter,
|
|
processUIAdapter,
|
|
httpUIAdapter,
|
|
]) {
|
|
builtinTypes.add(adapter.type);
|
|
builtinAdaptersByType.set(adapter.type, adapter);
|
|
registerUIAdapter(adapter);
|
|
}
|
|
}
|
|
|
|
export function registerUIAdapter(adapter: UIAdapterModule): void {
|
|
const existingIndex = uiAdapters.findIndex((entry) => entry.type === adapter.type);
|
|
if (existingIndex >= 0) {
|
|
uiAdapters.splice(existingIndex, 1, adapter);
|
|
} else {
|
|
uiAdapters.push(adapter);
|
|
}
|
|
adaptersByType.set(adapter.type, adapter);
|
|
notifyAdapterChange();
|
|
}
|
|
|
|
export function unregisterUIAdapter(type: string): void {
|
|
if (type === processUIAdapter.type || type === httpUIAdapter.type) return;
|
|
const existingIndex = uiAdapters.findIndex((entry) => entry.type === type);
|
|
if (existingIndex >= 0) {
|
|
uiAdapters.splice(existingIndex, 1);
|
|
}
|
|
adaptersByType.delete(type);
|
|
}
|
|
|
|
export function findUIAdapter(type: string): UIAdapterModule | null {
|
|
return adaptersByType.get(type) ?? null;
|
|
}
|
|
|
|
registerBuiltInUIAdapters();
|
|
|
|
export function getUIAdapter(type: string): UIAdapterModule {
|
|
const builtIn = adaptersByType.get(type);
|
|
|
|
if (!builtIn) {
|
|
let loadStarted = false;
|
|
return {
|
|
type,
|
|
label: type,
|
|
parseStdoutLine: (line: string, ts: string) => {
|
|
if (!loadStarted) {
|
|
loadStarted = true;
|
|
loadDynamicParser(type).then((parserModule) => {
|
|
if (parserModule) {
|
|
registerUIAdapter({
|
|
type,
|
|
label: type,
|
|
parseStdoutLine: parserModule.parseStdoutLine,
|
|
createStdoutParser: parserModule.createStdoutParser,
|
|
ConfigFields: SchemaConfigFields,
|
|
buildAdapterConfig: buildSchemaAdapterConfig,
|
|
});
|
|
}
|
|
});
|
|
}
|
|
return processUIAdapter.parseStdoutLine(line, ts);
|
|
},
|
|
ConfigFields: SchemaConfigFields,
|
|
buildAdapterConfig: buildSchemaAdapterConfig,
|
|
};
|
|
}
|
|
|
|
return builtIn;
|
|
}
|
|
|
|
/**
|
|
* Keep the UI adapter registry in sync with the server's adapter list.
|
|
*
|
|
* Two concerns:
|
|
*
|
|
* 1. **Builtin overrides** — when an external adapter ships a ui-parser.js for a
|
|
* builtin type, the external parser takes priority. When the external is
|
|
* disabled or removed the original builtin parser is restored transparently.
|
|
* A generation counter guards against stale loads that resolve after the
|
|
* override has been torn down.
|
|
*
|
|
* 2. **Non-builtin externals** — register a bridge adapter that lazily loads the
|
|
* dynamic parser on first stdout line, falling back to the generic process
|
|
* adapter. Once the parser resolves the bridge is replaced.
|
|
*/
|
|
export function syncExternalAdapters(
|
|
serverAdapters: {
|
|
type: string;
|
|
label: string;
|
|
disabled?: boolean;
|
|
/** When true, the external override for a builtin type is client-side paused. */
|
|
overrideDisabled?: boolean;
|
|
}[],
|
|
): void {
|
|
const enabledExternalTypes = new Set(
|
|
serverAdapters.filter((a) => !a.disabled && !a.overrideDisabled).map((a) => a.type),
|
|
);
|
|
const allExternalTypes = new Set(
|
|
serverAdapters.map((a) => a.type),
|
|
);
|
|
|
|
// ── Builtin override lifecycle ──────────────────────────────────────────
|
|
|
|
for (const builtinType of builtinTypes) {
|
|
const originalBuiltin = builtinAdaptersByType.get(builtinType);
|
|
if (!originalBuiltin) continue;
|
|
|
|
const hasExternal = allExternalTypes.has(builtinType);
|
|
const externalEnabled = enabledExternalTypes.has(builtinType);
|
|
const wasOverridden = activeExternalOverrides.has(builtinType);
|
|
|
|
if (hasExternal && externalEnabled && !wasOverridden) {
|
|
// Activate: external just became active → replace builtin with bridge.
|
|
activeExternalOverrides.add(builtinType);
|
|
|
|
const gen = (overrideGeneration.get(builtinType) ?? 0) + 1;
|
|
overrideGeneration.set(builtinType, gen);
|
|
|
|
let loadStarted = false;
|
|
const fallbackParser = originalBuiltin.parseStdoutLine;
|
|
const externalEntry = serverAdapters.find((a) => a.type === builtinType);
|
|
const label = externalEntry?.label ?? builtinType;
|
|
|
|
registerUIAdapter({
|
|
type: builtinType,
|
|
label,
|
|
parseStdoutLine: (line: string, ts: string) => {
|
|
if (!loadStarted) {
|
|
loadStarted = true;
|
|
loadDynamicParser(builtinType).then((parserModule) => {
|
|
// Discard if the override was torn down while the load was in-flight.
|
|
if (parserModule && overrideGeneration.get(builtinType) === gen) {
|
|
registerUIAdapter({
|
|
type: builtinType,
|
|
label,
|
|
parseStdoutLine: parserModule.parseStdoutLine,
|
|
createStdoutParser: parserModule.createStdoutParser,
|
|
ConfigFields: originalBuiltin.ConfigFields,
|
|
buildAdapterConfig: originalBuiltin.buildAdapterConfig,
|
|
});
|
|
}
|
|
});
|
|
}
|
|
return fallbackParser(line, ts);
|
|
},
|
|
ConfigFields: originalBuiltin.ConfigFields,
|
|
buildAdapterConfig: originalBuiltin.buildAdapterConfig,
|
|
});
|
|
} else if ((!hasExternal || !externalEnabled) && wasOverridden) {
|
|
// Deactivate: external disabled or removed → restore builtin.
|
|
activeExternalOverrides.delete(builtinType);
|
|
overrideGeneration.delete(builtinType);
|
|
invalidateDynamicParser(builtinType);
|
|
registerUIAdapter(originalBuiltin);
|
|
}
|
|
}
|
|
|
|
// ── Non-builtin externals ───────────────────────────────────────────────
|
|
|
|
for (const { type, label } of serverAdapters) {
|
|
if (builtinTypes.has(type)) continue; // handled above
|
|
|
|
const existing = adaptersByType.get(type);
|
|
|
|
// If this type already has an externally-loaded dynamic parser, skip —
|
|
// it was loaded from disk on a previous sync. Only re-trigger loading
|
|
// when the server returns a new external adapter that hasn't been loaded yet.
|
|
if (existing && existing !== processUIAdapter) continue;
|
|
|
|
let loadStarted = false;
|
|
// Use the existing built-in parser as fallback (if any) so we don't
|
|
// regress to the generic process parser while the dynamic one loads.
|
|
const fallbackParser = existing?.parseStdoutLine ?? processUIAdapter.parseStdoutLine;
|
|
|
|
registerUIAdapter({
|
|
type,
|
|
label,
|
|
parseStdoutLine: (line: string, ts: string) => {
|
|
if (!loadStarted) {
|
|
loadStarted = true;
|
|
loadDynamicParser(type).then((parserModule) => {
|
|
if (parserModule) {
|
|
registerUIAdapter({
|
|
type,
|
|
label,
|
|
parseStdoutLine: parserModule.parseStdoutLine,
|
|
createStdoutParser: parserModule.createStdoutParser,
|
|
ConfigFields: existing?.ConfigFields ?? SchemaConfigFields,
|
|
buildAdapterConfig: existing?.buildAdapterConfig ?? buildSchemaAdapterConfig,
|
|
});
|
|
}
|
|
});
|
|
}
|
|
return fallbackParser(line, ts);
|
|
},
|
|
ConfigFields: existing?.ConfigFields ?? SchemaConfigFields,
|
|
buildAdapterConfig: existing?.buildAdapterConfig ?? buildSchemaAdapterConfig,
|
|
});
|
|
}
|
|
}
|
|
|
|
export function listUIAdapters(): UIAdapterModule[] {
|
|
return [...uiAdapters];
|
|
}
|