Repository navigation
refactor(server): move the agent catalog route and type into their own slice - #1690
Conversation
A unit-lane test through a real createServer, given a stand-in shell-agent locator (createServer's shellAgents option) and herdr's agent manifests stubbed, with PATH pointed at a temp folder, so it runs without herdr or the PC's own agents: herdr's agents plus Oh My Pi and Claude Code, the shell agents the locator finds, each one's label and installed flag, sorted by label; herdr's own error passes through, and a non-GET is refused.
…n slice The next feature slice out of server/index.ts and shared/protocol.ts (plan: .omo/plans/feature-slices-plan.md). GET /api/agents moves, unchanged and with the on-demand login PATH lookup PR #1597 gave it, into handleAgentsRequest in server/agents-routes.ts with AGENT_LABELS, the label table only it used. It is called at the same place in the dispatch order and given the server's own shell-agent locator, which launches use too. AgentKind moves into shared/agents.ts together with its doc comment, which sat on another declaration in protocol.ts; protocol.ts re-exports the type, so every importer compiles unchanged.
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info
📝 Summary
Merge Risk: ⚪ Minimal · up to
|
|
Merge-pass review (maintainer-approved merge). CodeRabbit had no actionable comments; a code-review agent also reviewed 3004b87: APPROVE, no blockers. Behaviour is identical.
One locator.
Type move. Tests.
No closing keyword before another PR number in the title, body or commits. |
…1694) The next feature slice out of `server/index.ts` and `shared/protocol.ts`, after integrations (#1686), plugins (#1687), background tasks (#1688) and the agent catalog (#1690): the plan route and its types move into their own files. Behaviour, path, status codes and messages stay the same. The plan is `.omo/plans/feature-slices-plan.md` in the maintainer's workspace. This PR moves responsibility, so it is **not move-only**. ## Two commits: the check first, then the move 1. **`test(server): pin GET /api/pane/plan before it moves`** adds `server/plan-routes.test.ts`. - **Why it is needed:** the existing route coverage is live only: `api.contract.test.ts` (missing pane, wrong method) and `claude-session.contract.test.ts` (a Claude Code pane's plan). The plan readers have unit tests (`session-plan.test.ts`, `session-plan-readers.test.ts`). - **How it runs without herdr, in the unit lane:** a real `createServer({ port: 0, hostname: "127.0.0.1", stateDir: mkdtempSync(…), … })`, with `sessionSnapshot` stubbed through `spyOn(herdr, "sessionSnapshot")`. - **What it pins:** - a POST answers `400 method_not_allowed`, and a request without `pane_id` answers `400 missing_pane_id`; - a pane herdr does not have, and a pane that keeps no plan, both answer 200 `{ plan: null }` with a valid `server_time`; - when herdr does not answer the snapshot, the route still answers 200 `{ plan: null }` once its 1-second bound (`within(1000, …)`) runs out. That makes this test take about a second. On unchanged code it gives **3 pass, 0 fail**. 2. **`refactor(server): move the plan route and types into their own slice`** - **Moved:** the branch, unchanged, into `handlePlanRequest(request, url, pathname, { omo, claudeAgents, plans }): Promise<Response | null>` in the new `server/plan-routes.ts`. This is the nullable route pattern of the earlier slices. - **The trackers stay the core's:** `index.ts` passes the core's own `omo` (`OmoStatus`), `claudeAgents` (`ClaudeSubagentStatus`) and `plans` (`SessionPlans`). The route's type allows only the methods it calls: `apply`; `ensure`; and `known`, `ensure`, `planOf`. It constructs nothing, so there is one tracker each as before and startup order does not change. - **Moved:** `PlanStep` and `PanePlan`, verbatim with their doc comments, into the new `shared/plans.ts` (types only). - **Stays in `protocol.ts`:** `PlanSummary`, because the session snapshot's pane enrichment and the `pane-status` WebSocket message both carry it; a re-export would add nothing there. Also a type re-export of `PlanStep` and `PanePlan`, so `server/session-plan.ts`, `server/session-plan-reader.ts`, `server/claude-session.contract.test.ts`, `src/lib/api.ts`, `src/lib/plan.ts` and its test, `BackgroundTasks.tsx` and `site/demo/transport.ts` compile unchanged. - **Stays in `index.ts`:** one call at the same place in the dispatch order, after the background tasks route and before session history. The now-unused `within`, `sessionSnapshot`, `HerdrPane` and `PanePlan` imports leave. ## Checks - **After the move:** `HERDR_TEST_MODE=unit bun test server/plan-routes.test.ts server/tasks-routes.test.ts server/session-plan.test.ts server/session-plan-readers.test.ts src/lib/plan.test.ts server/startup-order.test.ts` gives **41 pass, 0 fail**. The pinning test is unchanged between the two commits. - **`--color-moved` on the move commit:** `git diff --color-moved=plain --color-moved-ws=allow-indentation-change HEAD~1 HEAD -- server shared` shows 102 lines as moved: the branch (one indent level shallower in its new file) and both types. The 23 other lines are: - in `index.ts`: - the shortened protocol import; - the dropped `within` and `sessionSnapshot` imports; - the new `plan-routes.ts` import; - the 2-line call. - in the new route file: - its 3-line header; - 7 imports; - the `PlanTrackers` type with its comment; - the function's doc comment and signature; - `return null`. - in `protocol.ts`: the re-export line. - **Client imports:** `bun run typecheck` passes on both tsconfigs. No file in `src/` or `site/` imports `shared/plans.ts`. `shared/plans.ts` has no import and no value export. - **Sizes:** `server/index.ts` goes from 724 to 704 lines and `shared/protocol.ts` from 1,404 to 1,381. The new modules are 41 and 24 lines. - **Risks checked:** - Import cycles: none new. The route imports `claude-subagents.ts`, `herdr/client.ts` and `http.ts`, plus types only from `omo-status.ts` and `session-plan.ts`. None of them reaches `index.ts`, and nothing comes from `core/`. - Initialization order: unchanged. - `bun run check fast`: passes (unit 6156 pass, 0 fail, 12 skip in 439 files, 8 at a time, 57.9s). - CI's integration lane runs the `api.contract.test.ts` and `claude-session.contract.test.ts` plan cases against an isolated live herdr. ## Overlapping open PRs Open PRs that touch these files: #1652, #1598, #1442 and #1427. I checked each diff for the moved lines and for `PlanStep` and `PanePlan`: - #1652, #1598 and #1442 change neither. - #1427 changes an import line that names `PanePlan` and `PlanStep`. It imports them from `protocol.ts`, so the line still resolves through the re-export. No changelog fragment: users see no change.
…#1696) The last inline feature slice out of `server/index.ts` and `shared/protocol.ts`, after integrations (#1686), plugins (#1687), background tasks (#1688), the agent catalog (#1690) and plans (#1694): the file routes and their types move into their own files. Behaviour, paths, status codes, headers and messages stay the same. The plan is `.omo/plans/feature-slices-plan.md` in the maintainer's workspace. This PR moves responsibility, so it is **not move-only**. ## Two commits: the check first, then the move 1. **`test(server): pin the file routes before they move`** adds `server/file-routes.test.ts`. - **Why it is needed:** the existing route coverage is mostly live: `page-media.contract.test.ts`, `route-envelope.contract.test.ts` and `device-access.contract.test.ts`. The helpers have unit tests (`file-view.test.ts`, `project-favicon.test.ts`, `files.test.ts`). In the unit lane, only `open-access.test.ts` reaches a file route, and only for the watching-device refusal. - **How it runs without herdr, in the unit lane:** a real `createServer({ port: 0, hostname: "127.0.0.1", stateDir: mkdtempSync(…), … })` reading a temp project folder, with `paneGet` stubbed through `spyOn(herdr, "paneGet")` where a pane is involved. - **What it pins:** - **Methods and other sites:** - a POST answers `400 method_not_allowed`, and HEAD is allowed; - another site's `no-cors` read answers `403 cross_site`, while a top-level navigation is served. - **A file by its absolute path:** - `/api/fs/stat` answers its name, kind and size; - `/api/fs/file` answers its bytes, `inline` by default and `attachment` with `download=1`; - a missing file answers `404 not_found`. - **A relative path in a pane's folder:** with `pane_id`, a relative path is found in the folder herdr reports for that pane. When herdr cannot say that folder, the relative path is `404 not_found`, but an absolute path is still served. - **The project icon:** `/api/fs/favicon` without `root` answers `400 missing_root`. A folder with `public/favicon.ico` answers that icon, and a folder without one answers `{ icon: null }`. - **Page media:** an address never given out answers `404 not_found`, and a POST answers `400 method_not_allowed`. On unchanged code it gives **5 pass, 0 fail**. 2. **`refactor(server): move the file routes and types into their own slice`** - **Moved:** both branches, unchanged, into `handleFileRequest(request, url, pathname, requester): Promise<Response | null>` in the new `server/file-routes.ts`: - `/api/fs/stat`, `/api/fs/file` and `/api/fs/favicon`; - `/api/fs/page-media/:media_id`. - **Moved with them:** `claudeTempFolder`, which only the file read used. - **Who asks:** the access gate in `index.ts` already worked out who asks: `bridgeAuthorized`, `requestHost`, `forwarded`, `client` and `access`. The route gets those values as they are (`FileRequester`), because a page's media plays only for the client and device that rendered it. Nothing is computed again. - **Shared state stays where it is:** the page-media registry stays in `file-view.ts`. Sign-out and device revocation still call `forgetPageMedia` from `index.ts`. - **Moved:** `FileKind`, `FileInfo` and `ProjectFavicon`, verbatim with their doc comments, into the new `shared/files.ts` (types only). - **Stays in `index.ts`:** one call at the same place in the dispatch order, after the agent catalog and before the workspace routes. Every gate before it is untouched, including the watching-device refusal of file reads. The imports only these routes used leave `index.ts`: `paneContext`, `resolveAgent`, `claudePaneSession`, `claudeSessionTempDir`, `findProjectFavicon`, `paneGet`, `isSecureRequest`, the file-view helpers except `forgetPageMedia`, and `ProjectFavicon`. - **Stays in `protocol.ts`:** a type re-export of the three names, so every importer compiles unchanged. ## Checks - **After the move:** `HERDR_TEST_MODE=unit bun test server/file-routes.test.ts server/file-view.test.ts server/project-favicon.test.ts server/files.test.ts server/open-access.test.ts server/startup-order.test.ts` gives ****71 pass, 0 fail****. The pinning test is unchanged between the two commits. - **`--color-moved` on the move commit:** `git diff --color-moved=plain --color-moved-ws=allow-indentation-change HEAD~1 HEAD -- server shared` shows 168 lines as moved: both branches (one indent level shallower in their new file), `claudeTempFolder` and the three types. The 26 other lines are: - in `index.ts`: - the shortened protocol, `auth.ts` and `file-view.ts` imports (each before and after); - the new `file-routes.ts` import; - the dropped `paneGet` import line; - the 2-line call. - in the new route file: - its 4-line header; - the 6 imports that did not move with the code; - the `FileRequester` type with its comment; - the function's doc comment and signature; - `return null`. - in `protocol.ts`: the re-export line. The imports only the moved code used (`paneContext`/`resolveAgent`, `claudePaneSession`, `claudeSessionTempDir`, `findProjectFavicon`) show as moved from `index.ts` into the route file. - **Client imports:** `bun run typecheck` passes on both tsconfigs. No file in `src/` or `site/` imports `shared/files.ts`. `shared/files.ts` has no import and no value export. - **Sizes:** `server/index.ts` goes from 704 to 657 lines and `shared/protocol.ts` from 1,381 to 1,353. The new modules are 69 and 29 lines. - **Risks checked:** - Import cycles: none new. The route imports `access.ts` (type only), `auth.ts`, `claude-store.ts`, `conversation.ts`, `file-view.ts`, `herdr/client.ts`, `http.ts`, `pane-context.ts` and `project-favicon.ts`. These were all already imported by `index.ts`, and none of them imports `index.ts`. - Initialization order: unchanged. No module state moves. - `bun run check fast`: passes (unit 6161 pass, 0 fail, 12 skip in 440 files, 8 at a time, 57.4s). - CI's integration lane runs `page-media.contract.test.ts`, `route-envelope.contract.test.ts` and `device-access.contract.test.ts` against an isolated live herdr. ## Overlapping open PRs Open PRs that touch these files: #1652, #1598, #1442 and #1427. I checked each diff for the moved lines, the page-media names and the three file types: - #1652, #1442 and #1427 change none of them. - #1598 changes the `bridgePath` list in `index.ts`, which names `/api/fs/`. That list stays in `index.ts`, and this PR does not touch it. No changelog fragment: users see no change.
…1698) A test-only follow-up to the background tasks slice (#1688) and the agent catalog slice (#1690). In their code reviews, the reviewer broke the moved routes on purpose, one change at a time, to see whether the route tests would notice. Three of those breakages left every test passing. This PR adds what those three cases need. No production file changes. ## `server/tasks-routes.test.ts` (#1688 review, point 3) The test that calls the route directly with an OmO session now also: - writes a `dag_1.json` workflow record for that session under the project's `.omo/senpi-task/dag/runs`, and asserts `runs` is `[["dag_1", "Bug-fix round", "running"]]` (id, name, status). Before, the fixture had no workflow, so `runs` was `[]` either way, and returning `runs: []` from the OmO branch went unnoticed; - asserts `server_time` on the OmO answer parses as a date. Before, it was checked only on the non-OmO answer, so dropping it from the OmO branch went unnoticed. ## `server/agents-routes.test.ts` (#1690 review, L1 and the surviving sort mutation) - **Sort order:** the stubbed herdr manifests now also offer `cmd` (label "Command Code") and `copilot` (label "GitHub Copilot"). Sorted by label, they land after `codex` and after `gjc`; sorted by kind, `cmd` comes before `codex` and `copilot` before `gjc`. Sorting by kind instead of label now fails the test. - **Error mapping:** a plain error from herdr's agent manifests now pins `500 internal_error` without the error's own text, next to the existing `HerdrError` → 502 case. ## Checks - `HERDR_TEST_MODE=unit bun test server/tasks-routes.test.ts server/agents-routes.test.ts`: **6 pass, 0 fail**. - The three breakages from the reviews each fail a test now. I made each change, ran the two test files, then restored the code: | Breakage | Before this PR | Now | | --- | --- | --- | | OmO branch answers `runs: []` | all tests pass | 1 fail | | OmO branch answers without `server_time` | all tests pass | 1 fail | | `/api/agents` sorted by kind only | all tests pass | 1 fail | - `bun run typecheck`: passes. - `bun run check fast`: passes (unit 6161 pass, 0 fail, 12 skip in 440 files, 8 at a time, 57.5s). Test-only: no change in `server/` outside the two test files, nor in `src/` or `shared/`. No changelog fragment: users see no change.
The next feature slice out of
server/index.tsandshared/protocol.ts, after integrations (#1686), plugins (#1687) and background tasks (#1688): the agent catalog route and its type move into their own files. Behaviour, path, status codes and messages stay the same. The plan is.omo/plans/feature-slices-plan.mdin the maintainer's workspace.This slice waited for PR #1597 (merged as 86e0643), which changed this same
/api/agentsbranch. The refactor brief puts a bug fix first and the move after it. The branch moves here exactly as PR #1597 left it, including its on-demand login PATH lookup through the server's shell-agent locator.This PR moves responsibility, so it is not move-only.
Two commits: the check first, then the move
test(server): pin GET /api/agents before it movesaddsserver/agents-routes.test.ts.api.contract.test.ts(fallbacks, PATH, sort), which needs a live isolated herdr.server/shell-agent.test.tscovers the locator but not the route.createServer({ port: 0, hostname: "127.0.0.1", stateDir: mkdtempSync(…), …, shellAgents }), given a stand-in locator throughcreateServer's ownshellAgentsoption;agentManifestsstubbed withspyOn(herdr, "agentManifests");PATHpointed at a temp folder that holds only acodexexecutable, and restored after each test.codex,pi,someagent) are offered, plus Oh My Pi and Claude Code always;gjc) is offered and the one it does not find (omo) is not, and the locator is asked about both;installedflag: true forcodexon PATH and forgjc, which the locator found, false for the rest;400 method_not_allowed.On unchanged code it gives 2 pass, 0 fail.
refactor(server): move the agent catalog route and type into their own slicehandleAgentsRequest(request, pathname, shellAgents): Promise<Response | null>in the newserver/agents-routes.ts, the nullable route pattern of the earlier slices.AGENT_LABELS, which only this branch used.index.tspasses its ownshellAgents, the one launches use too. The route's type allows onlyexecutable, so nothing is constructed, the locator'sstop()stays with the server, and startup order does not change.AgentKind, into the newshared/agents.ts(types only), together with its doc comment ("GET /api/agents: one agent kind herdr can start …"). That comment sat a few declarations away inprotocol.ts, above the directory listing type. This is the one line that changes place for a reason other than the move, so the comment now documents the type it describes.index.ts: one call at the same place in the dispatch order, after the auth, device, update and diagnostics routes and before/api/fs/*. The now-unusedagentManifests,SHELL_AGENTSandAgentKindimports leave.protocol.ts: a type re-export ofAgentKind, soserver/api.contract.test.ts,src/lib/api.ts,AgentPicker.tsx,NewSessionDialog.tsx,SessionHistory.tsxandWorktreeDialog.tsxcompile unchanged.Checks
HERDR_TEST_MODE=unit bun test server/agents-routes.test.ts server/shell-agent.test.ts src/lib/agentRoster.test.ts server/tasks-routes.test.ts server/startup-order.test.tsgives 26 pass, 0 fail. The pinning test is unchanged between the two commits.--color-movedon the move commit:git diff --color-moved=plain --color-moved-ws=allow-indentation-change HEAD~1 HEAD -- server sharedshows 106 lines as moved: the branch (one indent level shallower in its new file), the label table,AgentKindand its comment. The 21 other lines are:index.ts:shell-agent.tsimport withoutSHELL_AGENTS;agents-routes.tsimport;agentManifestsimport line;return null.protocol.ts: the re-export line.bun run typecheckpasses on both tsconfigs. No file insrc/orsite/importsshared/agents.ts.shared/agents.tshas no import and no value export.server/index.tsgoes from 763 to 724 lines andshared/protocol.tsfrom 1,410 to 1,404. The new modules are 55 and 7 lines.herdr/client.ts,http.tsandshell-agent.ts, none of which reachesindex.ts.AGENT_LABELSis a constant, and the locator is created bycreateServeras before.bun run check fast: passes (unit 6153 pass, 0 fail, 12 skip in 438 files, 8 at a time, 57.5s).api.contract.test.tsagent cases against an isolated live herdr.Overlapping open PRs
Open PRs that touch these files: #1598 and #1442 (
index.tsandprotocol.ts), and #1652 and #1427 (protocol.ts). Each diff was checked for the moved lines and forAgentKind, and none of them changes either one:bridgePathlist inindex.ts. That list names/api/agents, but it stays inindex.tsand this PR does not touch it.server/api.contract.test.tsthat namesAgentKind. That import still resolves through the re-export inprotocol.ts.No changelog fragment: users see no change.