* feat(core): add PreflightContext + optional preflight() to plugin interfaces Foundation for PR 2 of the ao spawn refactor: lets plugins own their own prerequisites instead of the CLI hardcoding 'if runtime === tmux check tmux' / 'if tracker === github check gh auth' switches. PreflightContext describes intent (willClaimExistingPR, role) rather than CLI flag names, so plugins never learn about flags. New flags map to new intent fields only when a plugin actually needs them. Adds preflight?(ctx) as an optional method on Runtime, Agent, Workspace, Tracker, SCM. Backwards-compatible: existing plugins keep working unchanged. Subsequent commits move checkTmux into runtime-tmux and checkGhAuth into the github plugins, then update spawn.ts to iterate selected plugins instead of switching on plugin names. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com> * feat(plugins): implement preflight() in runtime-tmux + tracker-github + scm-github Each plugin now owns its own prerequisite checks (tmux binary, gh auth) behind the optional PluginModule preflight() contract added in the previous commit. The CLI no longer needs to know which plugin needs which tool — it just iterates the selected plugins. - runtime-tmux: checks 'tmux -V' and throws with platform-appropriate install hint (brew / apt / dnf / WSL) - tracker-github: checks 'gh --version' and 'gh auth status' unconditionally (tracker is exercised on every spawn that has an issueId AND on lifecycle polling for issue closure) - scm-github: same gh auth checks but only when the spawn will exercise PR-write paths — gates on context.intent.willClaimExistingPR Subsequent commit refactors the CLI to iterate plugins instead of hardcoded 'if runtime === tmux' switches. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com> * refactor(cli): make ao spawn iterate plugin preflight, collapse project resolution Three small changes bundled because they all touch spawn.ts: 1. Plugin-iterating preflight: replaces the hardcoded 'if runtime === tmux check tmux' / 'if tracker === github check gh auth' switches in runSpawnPreflight with a 4-line loop that walks the selected plugins and calls each one's optional preflight(). Plugin internals are no longer leaked into the CLI; new plugins only need to declare their own preflight. 2. Project-resolution collapse: the prefix/no-prefix and issue/no-issue paths previously had three near-duplicate code blocks each with its own try/catch around autoDetectProject. Replaced by one resolveProjectAndIssue() helper that uses resolveSpawnTarget's fallback parameter — caller wraps in a single try/catch. 3. Micro-deletes: drop the unused 'return session.id' in spawnSession (callers already ignore it; the SESSION=<id> stdout line is the scriptable contract). Drop checkTmux/checkGhAuth from lib/preflight.ts (now in their respective plugins) along with their orphaned tests. LOC: roughly net-zero. Wins are structural — adding runtime-podman / tracker-jira / scm-bitbucket no longer requires editing spawn.ts. Pre-existing start.test.ts 'stop command' failures are unrelated (verified on upstream/main bare). Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com> * perf(plugins): dedupe gh-auth check across tracker-github + scm-github Address greptile P2 on PR #1622: when a project has both tracker: github and scm: github with --claim-pr, both plugin preflights ran 'gh --version' + 'gh auth status' independently — 4 execs where 2 suffice, and two identical error messages on failure. Add memoizeAsync(key, fn) to core (process-scoped Promise cache) and have both github plugins share the key 'gh-cli-auth'. Second caller hits the in-flight (or resolved) promise — zero extra subprocess overhead, one error on failure. Caches both successes and rejections: failed checks should never re-run within a process (cache dies with the CLI, user fixes the underlying issue and re-invokes). 5 unit tests for memoizeAsync covering: single-fire dedup, value identity, distinct keys, rejection caching, concurrent in-flight dedup. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com> * refactor(spawn): collect-all preflight + per-plugin tests + key-namespacing docs Address self-review feedback on PR #1622: 1. **Collect-all preflight** (spawn.ts): runSpawnPreflight previously aborted at the first plugin's failure, so a user with multiple broken prereqs (tmux missing AND gh logged out) had to fix-and-retry to discover the second one. Now collects every plugin's error and reports them together ("2 preflight checks failed:\n 1. ...\n 2. ..."). Single-failure path is unchanged — that error throws as-is without the wrapper. Test added: 'collects every plugin's preflight failure into one combined error'. 2. **Drop redundant workspace literal fallback** (spawn.ts): DefaultPluginsSchema in core/config.ts applies .default("worktree") to workspace, same as runtime/agent. The literal '?? "worktree"' was asymmetric defensive theater — dropped to match the runtime/agent form. 3. **memoizeAsync key-namespacing convention** (process-cache.ts): Added a JSDoc section documenting that two callers using the same key get shared state (intentional for cross-cutting checks like gh-cli-auth, dangerous for plugin-internal caching). Recommends namespacing plugin-internal keys as 'plugin-name:thing'. 4. **Per-plugin preflight unit tests**: - runtime-tmux: tmux-present resolves; tmux-missing throws with platform-specific install hint (verified per-platform branch) - tracker-github: happy path, gh-not-installed, gh-not-authenticated - scm-github: no-op when willClaimExistingPR=false (zero gh calls), full check when true, plus install/auth failure branches Process cache cleared in beforeEach so each test starts fresh. Required exporting _clearProcessCacheForTests from core/index.ts (matches existing _testUtils pattern in gh-trace.ts). Pre-existing start.test.ts 'stop command' failures unchanged (verified on bare upstream/main). Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com> * fix(test): collapse duplicate @aoagents/ao-core import in tracker-github test eslint no-duplicate-imports caught it on CI — combined the value and type-only imports into one statement. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com> --------- Co-authored-by: Claude Opus 4.7 <noreply@anthropic.com> |
||
|---|---|---|
| .. | ||
| __tests__ | ||
| src | ||
| CHANGELOG.md | ||
| README.md | ||
| package.json | ||
| rollup.config.ts | ||
| tsconfig.build.json | ||
| tsconfig.json | ||
| vitest.config.ts | ||
README.md
@aoagents/ao-core
Core services, types, and configuration for the Agent Orchestrator system.
What's Here
src/types.ts— All TypeScript interfaces (Runtime, Agent, Workspace, Tracker, SCM, Notifier, Terminal, Session, events)src/services/— Core services (SessionManager, LifecycleManager, PluginRegistry)src/config.ts— Configuration loading + Zod schemassrc/utils/— Shared utilities (shell escaping, metadata parsing, etc.)
Key Files
src/types.ts — The Source of Truth
Every interface the system uses is defined here. If you're working on any part of the orchestrator, start by reading this file.
Main interfaces:
Runtime— where sessions execute (tmux, docker, k8s)Agent— AI coding tool adapter (claude-code, codex, aider)Workspace— code isolation (worktree, clone)Tracker— issue tracking (GitHub Issues, Linear)SCM— PR/CI/reviews (GitHub, GitLab)Notifier— push notifications (desktop, Slack, webhook)Terminal— human interaction UI (iTerm2, web)Session— running agent instance (state, metadata, handles)OrchestratorEvent— events emitted by lifecycle managerPluginModule— what every plugin exports
src/services/session-manager.ts — Session CRUD
Handles session lifecycle:
spawn(config)— create new session (workspace + runtime + agent)list(projectId?)— list all sessionsget(sessionId)— get session detailskill(sessionId)— terminate sessioncleanup(projectId?)— kill completed/merged sessionssend(sessionId, message)— send message to agent
Data flow in spawn():
- Load project config
- Validate issue exists via
Tracker.getIssue()(if issueId provided, fails-fast if not found) - Reserve session ID
- Determine branch name
- Create workspace via
Workspace.create() - Generate prompt via
Tracker.generatePrompt() - Build layered worker prompt via
buildPrompt()intosystemPrompt+taskPrompt - Persist
systemPromptFilefor the session and, for OpenCode workers, writeOPENCODE_CONFIG - Build launch command via
Agent.getLaunchCommand() - Create runtime session via
Runtime.create() - Run
Agent.postLaunchSetup()(optional) - Write metadata file
- Return Session object
Note: If issue validation fails (not found, auth error), spawn fails before creating any resources (no workspace, no runtime, no session ID). This prevents spawning sessions with broken issue references.
Worker sessions keep persistent instructions in the prompt file. OpenCode workers consume that file through OPENCODE_CONFIG, while OpenCode orchestrators continue to project their system prompt into workspace AGENTS.md.
src/services/lifecycle-manager.ts — State Machine + Reactions
Polls sessions, detects state changes, triggers reactions:
State machine:
spawning → working → pr_open → ci_failed/review_pending/approved → mergeable → merged
Reactions:
ci-failed→ send fix prompt to agentchanges-requested→ send review comments to agentapproved-and-green→ notify human (or auto-merge)agent-stuck→ notify human
Polling loop:
- For each session: check agent activity state (
Agent.getActivityState()) - If PR exists: check CI status (
SCM.getCISummary()), review state (SCM.getReviewDecision()) - Update session status based on state
- Trigger reactions if state changed
- Emit events
src/services/plugin-registry.ts — Plugin Discovery + Loading
Loads plugins and provides access to them:
register(plugin, config?)— register a plugin instanceget<T>(slot, name)— get plugin by slot + namelist(slot)— list all plugins for a slotloadBuiltins(config?)— load built-in plugins (runtime-tmux, agent-claude-code, etc.)loadFromConfig(config)— load built-ins today; external plugin descriptors are the marketplace extension point
Built-in plugins (loaded by default):
- runtime-tmux, runtime-process
- agent-claude-code, agent-codex, agent-aider, agent-cursor, agent-kimicode, agent-opencode
- workspace-worktree, workspace-clone
- tracker-github, tracker-linear, tracker-gitlab
- scm-github, scm-gitlab
- notifier-desktop, notifier-discord, notifier-slack, notifier-composio, notifier-openclaw, notifier-webhook
- terminal-iterm2, terminal-web
src/config.ts — Configuration Loading
Loads and validates agent-orchestrator.yaml:
Main config sections:
- Runtime data paths are auto-derived from the config location under
~/.agent-orchestrator/{hash}-{projectId}/ port— web dashboard port (default 3000, set different values for multiple projects)terminalPort— terminal WebSocket port (auto-detected if not set)directTerminalPort— direct terminal WebSocket port (auto-detected if not set)defaults— default plugins (runtime, agent, workspace, notifiers)plugins— installer-managed external plugin descriptors (registry, npm, or local)projects— per-project config (repo, path, branch, symlinks, reactions, agentRules)notifiers— notification channel config (Slack webhooks, etc.)notificationRouting— which notifiers get which priority eventsreactions— auto-response config (ci-failed, changes-requested, approved-and-green, etc.)
Zod schemas validate all config at load time.
Common Tasks
Adding a Field to Session
- Edit
src/types.ts→Sessioninterface - Edit
src/services/session-manager.ts→ initialize field inspawn() - Rebuild:
pnpm --filter @aoagents/ao-core build
Adding an Event Type
- Edit
src/types.ts→EventTypeunion - Emit the event:
eventEmitter.emit()in relevant service - Add reaction handler (optional):
src/services/lifecycle-manager.ts
Adding a Reaction
- Edit
src/services/lifecycle-manager.ts→ add handler function - Wire it up in the polling loop
- Add config schema in
src/config.tsif new reaction type
Feedback Tools (v1)
@aoagents/ao-core exports two structured feedback tool contracts:
bug_reportimprovement_suggestion
Both share the same required input fields:
titlebodyevidence(array of strings)sessionsourceconfidence(0..1)
Example:
import { FEEDBACK_TOOL_NAMES, FeedbackReportStore, getFeedbackReportsDir } from "@aoagents/ao-core";
const reportsDir = getFeedbackReportsDir(configPath, projectPath);
const store = new FeedbackReportStore(reportsDir);
const saved = store.persist(FEEDBACK_TOOL_NAMES.BUG_REPORT, {
title: "SSO login loop",
body: "Google SSO redirects back to /login repeatedly.",
evidence: ["trace_id=abc123", "screenshot: login-loop.png"],
session: "ao-22",
source: "agent",
confidence: 0.84,
});
Storage format:
- Reports are persisted under
~/.agent-orchestrator/{hash}-{projectId}/feedback-reports - Each report is a typed key=value file (
report_<timestamp>_<id>.kv) for easy inspection - A deterministic dedupe key (
sha256, 16 hex chars) is generated from normalized tool+content
Migration notes:
- No migration needed for existing AO installs
- The
feedback-reportsdirectory is created lazily on first persisted report
Testing
# Run all core tests
pnpm --filter @aoagents/ao-core test
# Run in watch mode
pnpm --filter @aoagents/ao-core test -- --watch
# Run specific test
pnpm --filter @aoagents/ao-core test -- session-manager.test.ts
Tests are in src/__tests__/:
session-manager.test.ts— session CRUD, spawn, cleanuplifecycle-manager.test.ts— state machine, reactionsplugin-registry.test.ts— plugin loading, resolutiontmux.test.ts— tmux utility functions (not a plugin test)prompt-builder.test.ts— prompt generation utilities
Building
# Build core
pnpm --filter @aoagents/ao-core build
# Typecheck
pnpm --filter @aoagents/ao-core typecheck
This package is a dependency of all other packages. Build it first if working on the codebase.
Architecture Notes
Why flat metadata files?
- Debuggability:
cat ~/.agent-orchestrator/<hash>-my-app/sessions/app-3shows full state - No database dependency (survives crashes, easy to inspect)
- Backwards-compatible with bash script orchestrator
Why polling instead of webhooks?
- Simpler (no webhook setup, no ngrok for local dev)
- Works offline (CI/review state is fetched, not pushed)
- Survives orchestrator restarts (no missed events)
Why plugin slots?
- Swappability: use tmux locally, docker in CI, k8s in prod
- Testability: mock plugins for tests
- Extensibility: users can add custom plugins (e.g., company-specific notifier)