mirror of
https://github.com/Ark0N/Codeman.git
synced 2026-10-05 06:59:42 +02:00
Codeman maintainer
b451b3851e
Maintainer merge-time fixes for the MCP server sync (opt-in mcpSyncEnabled, synced, default OFF).
M1, parse errors echoed config text (secrets included) into the HTTP response and Settings:
smol-toml's TomlError carries a code frame of the offending lines and V8's JSON "Unexpected
token" errors quote source. Both catch sites now go through describeMcpSyncError(): a parse
failure is reported by line/column only ("not valid TOML (line 3, column 21)", "not valid
JSON"), an errno failure by Node's own message (code, syscall, path), the module's own
messages via a McpConfigError class, anything else as "unexpected error". Tests put a secret
on the broken line (TOML, both JSON message shapes, and a write refused at the re-parse that
would have quoted a copied server's env) and assert it is absent from the result and from the
route's response body; they fail against the old code.
M2, CODEX_HOME / CLAUDE_CONFIG_DIR / XDG_CONFIG_HOME were ignored, so a sync could create a
file the CLI never reads and report success: new optional registry field
capabilities.mcpConfig.relocation { envVar, path } (registry data, no id branch; schema
reuses the env-name and no-traversal path rules). Declared for claude (CLAUDE_CONFIG_DIR,
checked in the 2.1.289 binary), codex (CODEX_HOME), opencode (XDG_CONFIG_HOME) and gemini
(GEMINI_CLI_HOME, gemini-cli paths.ts); antigravity follows $HOME only (agy 1.1.12 has no
relocation var). Resolved from the server process env at call time: absolute moves the file,
empty means unset, anything else reports the target with the new status "skipped" plus the
reason and writes nothing. Dedupe is now by resolved file. When a caller overrides `home`
without passing `env`, process.env is not consulted, and the route tests clear those vars so
a CI runner's XDG_CONFIG_HOME can never aim a write outside the temp HOME.
M3, feature undocumented: CLAUDE.md Key Patterns paragraph (opt-in, admin-only, additive
only, backups, re-parse validation, 0600 for copied secrets, names-only responses with
position-only parse errors, capabilities.mcpConfig and relocation), a Settings-Reference row
in the wiki, and docs/cli-registry.md + docs/api-reference.md updated for relocation, the
"skipped" status and the error policy.
Nits:
- N1 Preview/Sync before Save: the UI remembers the saved value on open and says "Save
settings to turn MCP sync on first" instead of calling the routes; the 403 message also
says to turn it on and save.
- N2 non-admins in multi-user mode: _applyMcpSyncAdminGate() hides the whole MCP group, called
from applyMcpSyncVisibility() and the codeman:me event like the CLI-management gate.
- N3 scope chip says "synced".
- N4 "(1 servers)" pluralised; the unsupported list only names installed CLIs (route test
pins it with a per-test installed set).
- N5 McpSyncResult / McpSyncTargetResult moved to src/types/mcp-sync.ts (barrel export); only
the route imported them, so no churn.
Verified with an isolated instance (throwaway HOME, own instance and tmux socket) and
Playwright: chip, save-first message, preview rendering and the admin gate.
Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
77 lines
4.8 KiB
TypeScript
77 lines
4.8 KiB
TypeScript
/**
|
|
* @fileoverview Barrel re-export for all Codeman type definitions.
|
|
*
|
|
* The type system is split into 13 domain modules for maintainability.
|
|
* Import from `'./types'` (or `'./types/index.js'`) to access any type:
|
|
*
|
|
* ```ts
|
|
* import type { SessionState, AppState, RespawnConfig } from './types';
|
|
* import { createErrorResponse, ApiErrorCode } from './types';
|
|
* ```
|
|
*
|
|
* ## Domain modules
|
|
*
|
|
* | Module | Key exports | Persistence / API |
|
|
* |--------------|-----------------------------------------------------------------------|-------------------------------------------------|
|
|
* | common | Disposable, BufferConfig, CleanupRegistration, NiceConfig, ProcessStats | In-memory only |
|
|
* | session | SessionState, SessionConfig, SessionStatus, SessionMode, ClaudeMode, OpenCodeConfig | `~/.codeman/state.json` → `GET /api/sessions` |
|
|
* | task | TaskDefinition, TaskState, TaskStatus | `~/.codeman/state.json` → `GET /api/tasks` |
|
|
* | app-state | AppState, AppConfig, GlobalStats, TokenStats, DEFAULT_CONFIG | `~/.codeman/state.json` → `GET /api/status` |
|
|
* | respawn | RespawnConfig, RespawnPreset, RespawnCycleMetrics, RalphLoopHealthScore, TimingHistory | Per-session in state.json → `GET /api/sessions/:id/respawn` |
|
|
* | ralph | RalphTrackerState, RalphTodoItem, CircuitBreakerStatus, RalphStatusBlock, RalphSessionState | Per-session → `GET /api/sessions/:id/ralph-state` |
|
|
* | api | ApiResponse, ApiErrorCode, HookEventType, CaseInfo, createErrorResponse, getErrorMessage | Used by all route handlers |
|
|
* | lifecycle | LifecycleEntry, LifecycleEventType | `~/.codeman/session-lifecycle.jsonl` (append-only) |
|
|
* | run-summary | RunSummary, RunSummaryEvent, RunSummaryStats | In-memory → `GET /api/sessions/:id/run-summary` |
|
|
* | tools | ActiveBashTool, ImageDetectedEvent | In-memory, broadcast via SSE |
|
|
* | teams | TeamConfig, TeamMember, TeamTask, InboxMessage, PaneInfo | `~/.claude/teams/`, `~/.claude/tasks/` → `GET /api/teams` |
|
|
* | push | PushSubscriptionRecord, VapidKeys, WebhookConfig, WebhookStatus, WebhookResult | `~/.codeman/push-keys.json`, `~/.codeman/push-subscriptions.json`, `~/.codeman/webhook.json` |
|
|
* | plan | PlanItem, PlanTaskStatus, TddPhase | In-memory → `GET /api/sessions/:id/plan/tasks` |
|
|
* | orchestrator | OrchestratorState, OrchestratorPlan, OrchestratorConfig, OrchestratorPersistState | `~/.codeman/state.json` → `GET /api/orchestrator/status` |
|
|
* | mcp-sync | McpSyncResult, McpSyncTargetResult | Other CLIs' own config files → `GET`/`POST /api/mcp-sync` |
|
|
*
|
|
* ## Cross-domain relationship map
|
|
*
|
|
* ```
|
|
* AppState (app-state)
|
|
* ├── sessions: Record<id, SessionState> ← session domain
|
|
* │ ├── respawnConfig?: RespawnConfig ← respawn domain (per-session settings)
|
|
* │ ├── ralphEnabled?: boolean ← toggles ralph tracking
|
|
* │ └── id ← referenced by:
|
|
* │ ├── RalphSessionState.sessionId ← ralph domain
|
|
* │ ├── RunSummary.sessionId ← run-summary domain
|
|
* │ ├── ActiveBashTool.sessionId ← tools domain
|
|
* │ ├── RespawnCycleMetrics.sessionId ← respawn domain
|
|
* │ └── TeamConfig.leadSessionId ← teams domain
|
|
* ├── tasks: Record<id, TaskState> ← task domain
|
|
* │ └── assignedSessionId → SessionState.id
|
|
* ├── ralphLoop: RalphLoopState ← ralph domain (global loop state)
|
|
* └── config: AppConfig
|
|
* └── respawn: RespawnConfig ← respawn domain (global defaults)
|
|
*
|
|
* RalphLoopHealthScore (respawn)
|
|
* └── components.circuitBreaker ← derived from CircuitBreakerStatus (ralph)
|
|
* ```
|
|
*/
|
|
|
|
export * from './common.js';
|
|
export * from './session.js';
|
|
export * from './task.js';
|
|
export * from './app-state.js';
|
|
export * from './respawn.js';
|
|
export * from './ralph.js';
|
|
export * from './api.js';
|
|
export * from './lifecycle.js';
|
|
export * from './run-summary.js';
|
|
export * from './tools.js';
|
|
export * from './teams.js';
|
|
export * from './push.js';
|
|
export * from './plan.js';
|
|
export * from './orchestrator.js';
|
|
export * from './update.js';
|
|
export * from './workflow-run.js';
|
|
export * from './search.js';
|
|
export * from './user.js';
|
|
export * from './webview.js';
|
|
export * from './intent.js';
|
|
export * from './mcp-sync.js';
|