| 1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204 |
- /**
- * End-to-end exerciser for the legacy Hono instance routes and the Effect HttpApi routes.
- *
- * The goal is not to be a normal unit test file. This is a route-coverage and parity
- * harness we can run while deleting Hono: every public route should eventually have a
- * small scenario that proves the Effect route decodes requests, uses the right instance
- * context, mutates storage when expected, and returns a compatible response shape.
- *
- * The script intentionally isolates `OPENCODE_DB` before importing modules that touch
- * storage. Scenarios may create/delete sessions and reset the database after each run,
- * so this must never point at a developer's real session database.
- *
- * DSL shape:
- * - `http.get/post/...` starts a scenario for one OpenAPI route key.
- * - `.seeded(...)` creates typed per-scenario state using Effect helpers on `ctx`.
- * - `.at(...)` builds the request from that typed state.
- * - `.json(...)` / `.jsonEffect(...)` assert response shape and optional side effects.
- * - `.mutating()` tells parity mode to run Effect and Hono in separate isolated contexts
- * so destructive routes compare equivalent fresh setups instead of sharing one DB.
- */
- import { Effect } from "effect"
- import { OpenApi } from "effect/unstable/httpapi"
- import { TestLLMServer } from "../../lib/llm-server"
- import path from "path"
- import { array, boolean, check, isRecord, message, object, stable } from "./assertions"
- import { controlledPtyInput, http, route } from "./dsl"
- import {
- cleanupExercisePaths,
- exerciseConfigDirectory,
- exerciseDataDirectory,
- exerciseDatabasePath,
- exerciseGlobalRoot,
- } from "./environment"
- import { color, printHeader, printResults } from "./report"
- import { coverageResult, matches, parseOptions, routeKey, routeKeys } from "./routing"
- import { runScenario } from "./runner"
- import { runtime } from "./runtime"
- import { type Scenario } from "./types"
- void (await import("@opencode-ai/core/util/log")).init({ print: false })
- const scenarios: Scenario[] = [
- http
- .get("/global/health", "global.health")
- .global()
- .json(200, (body) => {
- object(body)
- check(body.healthy === true, "server should report healthy")
- }),
- http
- .get("/global/event", "global.event")
- .global()
- .stream()
- .status(
- 200,
- (_ctx, result) =>
- Effect.sync(() => {
- check(result.contentType.includes("text/event-stream"), "global event should be an SSE stream")
- check(result.text.includes("server.connected"), "global event should emit initial connection event")
- }),
- "status",
- ),
- http.get("/global/config", "global.config.get").global().json(),
- http
- .patch("/global/config", "global.config.update")
- .global()
- .seeded(() =>
- Effect.promise(() =>
- Bun.write(
- path.join(exerciseConfigDirectory, "opencode.jsonc"),
- JSON.stringify({ username: "httpapi-global" }, null, 2),
- ),
- ),
- )
- .at(() => ({ path: "/global/config", body: { username: "httpapi-global" } }))
- .jsonEffect(
- 200,
- (body) =>
- Effect.gen(function* () {
- object(body)
- check(body.username === "httpapi-global", "global config update should return patched config")
- const text = yield* Effect.promise(() =>
- Bun.file(path.join(exerciseConfigDirectory, "opencode.jsonc")).text(),
- )
- check(text.includes('"username": "httpapi-global"'), "global config update should write isolated config file")
- }),
- "status",
- ),
- http
- .post("/global/dispose", "global.dispose")
- .global()
- .mutating()
- .json(
- 200,
- (body) => {
- check(body === true, "global dispose should return true")
- },
- "status",
- ),
- http.get("/path", "path.get").json(200, (body, ctx) => {
- object(body)
- check(body.directory === ctx.directory, "directory should resolve from x-opencode-directory")
- check(body.worktree === ctx.directory, "worktree should resolve from x-opencode-directory")
- }),
- http.get("/vcs", "vcs.get").json(),
- http
- .get("/vcs/diff", "vcs.diff")
- .at((ctx) => ({ path: "/vcs/diff?mode=git", headers: ctx.headers() }))
- .json(200, array),
- http.get("/command", "command.list").json(200, array, "status"),
- http.get("/agent", "app.agents").json(200, array, "status"),
- http.get("/skill", "app.skills").json(200, array, "status"),
- http.get("/lsp", "lsp.status").json(200, array),
- http.get("/formatter", "formatter.status").json(200, array),
- http.get("/config", "config.get").json(200, undefined, "status"),
- http
- .patch("/config", "config.update")
- .mutating()
- .at((ctx) => ({ path: "/config", headers: ctx.headers(), body: { username: "httpapi-local" } }))
- .json(
- 200,
- (body) => {
- object(body)
- check(body.username === "httpapi-local", "local config update should return patched config")
- },
- "status",
- ),
- http
- .patch("/config", "config.update.invalid")
- .at((ctx) => ({ path: "/config", headers: ctx.headers(), body: { username: 1 } }))
- .status(400),
- http.get("/config/providers", "config.providers").json(),
- http.get("/project", "project.list").json(200, array, "status"),
- http.get("/project/current", "project.current").json(
- 200,
- (body, ctx) => {
- object(body)
- check(body.worktree === ctx.directory, "current project should resolve from scenario directory")
- },
- "status",
- ),
- http
- .patch("/project/{projectID}", "project.update")
- .mutating()
- .seeded((ctx) => ctx.project())
- .at((ctx) => ({
- path: route("/project/{projectID}", { projectID: ctx.state.id }),
- headers: ctx.headers(),
- body: { name: "HTTP API Project", commands: { start: "bun --version" } },
- }))
- .json(
- 200,
- (body) => {
- object(body)
- check(body.name === "HTTP API Project", "project update should return patched name")
- check(
- isRecord(body.commands) && body.commands.start === "bun --version",
- "project update should return patched command",
- )
- },
- "status",
- ),
- http
- .post("/project/git/init", "project.initGit")
- .mutating()
- .inProject({ git: false })
- .json(
- 200,
- (body, ctx) => {
- object(body)
- check(body.worktree === ctx.directory, "git init should return current project")
- check(body.vcs === "git", "git init should mark the project as git-backed")
- },
- "status",
- ),
- http.get("/provider", "provider.list").json(),
- http.get("/provider/auth", "provider.auth").json(),
- http
- .post("/provider/{providerID}/oauth/authorize", "provider.oauth.authorize")
- .at((ctx) => ({
- path: route("/provider/{providerID}/oauth/authorize", { providerID: "httpapi" }),
- headers: ctx.headers(),
- body: { method: "bad" },
- }))
- .status(400),
- http
- .post("/provider/{providerID}/oauth/callback", "provider.oauth.callback")
- .at((ctx) => ({
- path: route("/provider/{providerID}/oauth/callback", { providerID: "httpapi" }),
- headers: ctx.headers(),
- body: { method: "bad" },
- }))
- .status(400),
- http.get("/permission", "permission.list").json(200, array),
- http
- .post("/permission/{requestID}/reply", "permission.reply.invalid")
- .at((ctx) => ({
- path: route("/permission/{requestID}/reply", { requestID: "per_httpapi" }),
- headers: ctx.headers(),
- body: { reply: "bad" },
- }))
- .status(400),
- http
- .post("/permission/{requestID}/reply", "permission.reply")
- .at((ctx) => ({
- path: route("/permission/{requestID}/reply", { requestID: "per_httpapi" }),
- headers: ctx.headers(),
- body: { reply: "once" },
- }))
- .json(200, (body) => {
- check(body === true, "permission reply should return true even when request is no longer pending")
- }),
- http.get("/question", "question.list").json(200, array),
- http
- .post("/question/{requestID}/reply", "question.reply.invalid")
- .at((ctx) => ({
- path: route("/question/{requestID}/reply", { requestID: "que_httpapi_reply" }),
- headers: ctx.headers(),
- body: { answers: "Yes" },
- }))
- .status(400),
- http
- .post("/question/{requestID}/reply", "question.reply")
- .at((ctx) => ({
- path: route("/question/{requestID}/reply", { requestID: "que_httpapi_reply" }),
- headers: ctx.headers(),
- body: { answers: [["Yes"]] },
- }))
- .json(200, (body) => {
- check(body === true, "question reply should return true even when request is no longer pending")
- }),
- http
- .post("/question/{requestID}/reject", "question.reject")
- .at((ctx) => ({
- path: route("/question/{requestID}/reject", { requestID: "que_httpapi_reject" }),
- headers: ctx.headers(),
- }))
- .json(200, (body) => {
- check(body === true, "question reject should return true even when request is no longer pending")
- }),
- http
- .get("/file", "file.list")
- .seeded((ctx) => ctx.file("hello.txt", "hello\n"))
- .at((ctx) => ({ path: `/file?${new URLSearchParams({ path: "." })}`, headers: ctx.headers() }))
- .json(200, array),
- http
- .get("/file/content", "file.read")
- .seeded((ctx) => ctx.file("hello.txt", "hello\n"))
- .at((ctx) => ({ path: `/file/content?${new URLSearchParams({ path: "hello.txt" })}`, headers: ctx.headers() }))
- .json(200, (body) => {
- object(body)
- check(body.content === "hello", `content should match seeded file: ${JSON.stringify(body)}`)
- }),
- http
- .get("/file/content", "file.read.missing")
- .at((ctx) => ({ path: `/file/content?${new URLSearchParams({ path: "missing.txt" })}`, headers: ctx.headers() }))
- .json(200, (body) => {
- object(body)
- check(body.type === "text" && body.content === "", "missing file content should return an empty text result")
- }),
- http.get("/file/status", "file.status").json(200, array),
- http
- .get("/find", "find.text")
- .seeded((ctx) => ctx.file("hello.txt", "hello\n"))
- .at((ctx) => ({ path: `/find?${new URLSearchParams({ pattern: "hello" })}`, headers: ctx.headers() }))
- .json(200, array),
- http
- .get("/find/file", "find.files")
- .seeded((ctx) => ctx.file("hello.txt", "hello\n"))
- .at((ctx) => ({
- path: `/find/file?${new URLSearchParams({ query: "hello", dirs: "false" })}`,
- headers: ctx.headers(),
- }))
- .json(200, array),
- http
- .get("/find/symbol", "find.symbols")
- .seeded((ctx) => ctx.file("hello.ts", "export const hello = 1\n"))
- .at((ctx) => ({ path: `/find/symbol?${new URLSearchParams({ query: "hello" })}`, headers: ctx.headers() }))
- .json(200, array),
- http
- .get("/event", "event.stream")
- .stream()
- .status(
- 200,
- (_ctx, result) =>
- Effect.sync(() => {
- check(result.contentType.includes("text/event-stream"), "event should be an SSE stream")
- check(result.text.includes("server.connected"), "event should emit initial connection event")
- }),
- "status",
- ),
- http.get("/mcp", "mcp.status").json(),
- http
- .post("/mcp", "mcp.add")
- .mutating()
- .at((ctx) => ({
- path: "/mcp",
- headers: ctx.headers(),
- body: { name: "httpapi-disabled", config: { type: "local", command: ["bun", "--version"], enabled: false } },
- }))
- .json(
- 200,
- (body) => {
- object(body)
- object(body["httpapi-disabled"])
- check(body["httpapi-disabled"].status === "disabled", "disabled MCP server should be added without spawning")
- },
- "status",
- ),
- http
- .post("/mcp", "mcp.add.invalid")
- .at((ctx) => ({
- path: "/mcp",
- headers: ctx.headers(),
- body: { name: "httpapi-invalid", config: { type: "invalid" } },
- }))
- .status(400),
- http
- .post("/mcp/{name}/auth", "mcp.auth.start")
- .at((ctx) => ({ path: route("/mcp/{name}/auth", { name: "httpapi-missing" }), headers: ctx.headers() }))
- .json(
- 400,
- (body) => {
- object(body)
- check(typeof body.error === "string", "unsupported MCP OAuth response should include error")
- },
- "status",
- ),
- http
- .delete("/mcp/{name}/auth", "mcp.auth.remove")
- .mutating()
- .at((ctx) => ({ path: route("/mcp/{name}/auth", { name: "httpapi-missing" }), headers: ctx.headers() }))
- .json(200, (body) => {
- object(body)
- check(body.success === true, "MCP auth removal should return success")
- }),
- http
- .post("/mcp/{name}/auth/authenticate", "mcp.auth.authenticate")
- .at((ctx) => ({
- path: route("/mcp/{name}/auth/authenticate", { name: "httpapi-missing" }),
- headers: ctx.headers(),
- }))
- .json(
- 400,
- (body) => {
- object(body)
- check(typeof body.error === "string", "unsupported MCP OAuth authenticate response should include error")
- },
- "status",
- ),
- http
- .post("/mcp/{name}/auth/callback", "mcp.auth.callback")
- .at((ctx) => ({
- path: route("/mcp/{name}/auth/callback", { name: "httpapi-missing" }),
- headers: ctx.headers(),
- body: { code: 1 },
- }))
- .status(400),
- http
- .post("/mcp/{name}/connect", "mcp.connect")
- .mutating()
- .at((ctx) => ({ path: route("/mcp/{name}/connect", { name: "httpapi-missing" }), headers: ctx.headers() }))
- .json(200, (body) => {
- check(body === true, "missing MCP connect should remain a no-op success")
- }),
- http
- .post("/mcp/{name}/disconnect", "mcp.disconnect")
- .mutating()
- .at((ctx) => ({ path: route("/mcp/{name}/disconnect", { name: "httpapi-missing" }), headers: ctx.headers() }))
- .json(200, (body) => {
- check(body === true, "missing MCP disconnect should remain a no-op success")
- }),
- http.get("/pty/shells", "pty.shells").json(200, array),
- http.get("/pty", "pty.list").json(200, array),
- http
- .post("/pty", "pty.create")
- .mutating()
- .at((ctx) => ({ path: "/pty", headers: ctx.headers(), body: controlledPtyInput("HTTP API PTY") }))
- .json(
- 200,
- (body, ctx) => {
- object(body)
- check(body.title === "HTTP API PTY", "PTY create should return requested title")
- check(body.command === "/bin/sh", "PTY create should use controlled shell command")
- check(body.cwd === ctx.directory, "PTY create should default cwd to scenario directory")
- },
- "status",
- ),
- http
- .post("/pty", "pty.create.invalid")
- .at((ctx) => ({ path: "/pty", headers: ctx.headers(), body: { command: 1 } }))
- .status(400),
- http
- .get("/pty/{ptyID}", "pty.get")
- .at((ctx) => ({ path: route("/pty/{ptyID}", { ptyID: "pty_httpapi_missing" }), headers: ctx.headers() }))
- .status(404),
- http
- .put("/pty/{ptyID}", "pty.update")
- .mutating()
- .at((ctx) => ({
- path: route("/pty/{ptyID}", { ptyID: "pty_httpapi_missing" }),
- headers: ctx.headers(),
- body: { size: { rows: 0, cols: 0 } },
- }))
- .status(400),
- http
- .delete("/pty/{ptyID}", "pty.remove")
- .mutating()
- .at((ctx) => ({ path: route("/pty/{ptyID}", { ptyID: "pty_httpapi_missing" }), headers: ctx.headers() }))
- .json(200, (body) => {
- check(body === true, "PTY remove should return true")
- }),
- http
- .get("/pty/{ptyID}/connect", "pty.connect")
- .at((ctx) => ({ path: route("/pty/{ptyID}/connect", { ptyID: "pty_httpapi_missing" }), headers: ctx.headers() }))
- .status(404, undefined, "none"),
- http.get("/experimental/console", "experimental.console.get").json(),
- http.get("/experimental/console/orgs", "experimental.console.listOrgs").json(),
- http
- .post("/experimental/console/switch", "experimental.console.switchOrg")
- .at((ctx) => ({
- path: "/experimental/console/switch",
- headers: ctx.headers(),
- body: { accountID: "httpapi-account", orgID: "httpapi-org" },
- }))
- .status(400, undefined, "none"),
- http.get("/experimental/workspace/adapter", "experimental.workspace.adapter.list").json(200, array),
- http.get("/experimental/workspace", "experimental.workspace.list").json(200, array),
- http.get("/experimental/workspace/status", "experimental.workspace.status").json(200, array),
- http
- .post("/experimental/workspace", "experimental.workspace.create")
- .at((ctx) => ({ path: "/experimental/workspace", headers: ctx.headers(), body: {} }))
- .status(400),
- http
- .delete("/experimental/workspace/{id}", "experimental.workspace.remove")
- .mutating()
- .at((ctx) => ({
- path: route("/experimental/workspace/{id}", { id: "wrk_httpapi_missing" }),
- headers: ctx.headers(),
- }))
- .status(200),
- http
- .post("/experimental/workspace/warp", "experimental.workspace.warp")
- .at((ctx) => ({
- path: "/experimental/workspace/warp",
- headers: ctx.headers(),
- body: {},
- }))
- .status(400),
- http
- .get("/experimental/tool", "tool.list")
- .at((ctx) => ({
- path: `/experimental/tool?${new URLSearchParams({ provider: "opencode", model: "test" })}`,
- headers: ctx.headers(),
- }))
- .json(200, array, "status"),
- http.get("/experimental/tool/ids", "tool.ids").json(200, array),
- http.get("/experimental/worktree", "worktree.list").json(200, array),
- http
- .post("/experimental/worktree", "worktree.create")
- .mutating()
- .at((ctx) => ({ path: "/experimental/worktree", headers: ctx.headers(), body: { name: "api-dsl" } }))
- .jsonEffect(
- 200,
- (body, ctx) =>
- Effect.gen(function* () {
- object(body)
- check(typeof body.directory === "string", "created worktree should include directory")
- yield* ctx.worktreeRemove(body.directory)
- }),
- "status",
- ),
- http
- .post("/experimental/worktree", "worktree.create.invalid")
- .at((ctx) => ({ path: "/experimental/worktree", headers: ctx.headers(), body: { name: 1 } }))
- .status(400),
- http
- .delete("/experimental/worktree", "worktree.remove")
- .mutating()
- .seeded((ctx) => ctx.worktree({ name: "api-remove" }))
- .at((ctx) => ({ path: "/experimental/worktree", headers: ctx.headers(), body: { directory: ctx.state.directory } }))
- .json(200, (body) => {
- check(body === true, "worktree remove should return true")
- }),
- http
- .post("/experimental/worktree/reset", "worktree.reset")
- .mutating()
- .seeded((ctx) => ctx.worktree({ name: "api-reset" }))
- .at((ctx) => ({
- path: "/experimental/worktree/reset",
- headers: ctx.headers(),
- body: { directory: ctx.state.directory },
- }))
- .jsonEffect(200, (body, ctx) =>
- Effect.gen(function* () {
- check(body === true, "worktree reset should return true")
- yield* ctx.worktreeRemove(ctx.state.directory)
- }),
- ),
- http.get("/experimental/session", "experimental.session.list").json(200, array),
- http.get("/experimental/resource", "experimental.resource.list").json(),
- http
- .post("/sync/history", "sync.history.list")
- .at((ctx) => ({ path: "/sync/history", headers: ctx.headers(), body: {} }))
- .json(200, array),
- http
- .post("/sync/replay", "sync.replay")
- .at((ctx) => ({ path: "/sync/replay", headers: ctx.headers(), body: { directory: ctx.directory, events: [] } }))
- .status(400),
- http
- .post("/sync/start", "sync.start")
- .mutating()
- .preserveDatabase()
- .json(200, (body) => {
- check(body === true, "sync start should return true when no workspace sessions exist")
- }),
- http
- .post("/instance/dispose", "instance.dispose")
- .mutating()
- .json(200, (body) => {
- check(body === true, "instance dispose should return true")
- }),
- http
- .post("/log", "app.log")
- .global()
- .at(() => ({ path: "/log", body: { service: "httpapi-exercise", level: "info", message: "route coverage" } }))
- .json(200, (body) => {
- check(body === true, "log route should return true")
- }),
- http
- .put("/auth/{providerID}", "auth.set")
- .global()
- .at(() => ({ path: route("/auth/{providerID}", { providerID: "test" }), body: { type: "api", key: "test-key" } }))
- .jsonEffect(200, (body) =>
- Effect.gen(function* () {
- check(body === true, "auth set should return true")
- const auth = yield* Effect.promise(() => Bun.file(path.join(exerciseDataDirectory, "auth.json")).json())
- object(auth)
- check(isRecord(auth.test) && auth.test.key === "test-key", "auth set should write isolated auth file")
- }),
- ),
- http
- .delete("/auth/{providerID}", "auth.remove")
- .global()
- .seeded(() =>
- Effect.promise(() =>
- Bun.write(
- path.join(exerciseDataDirectory, "auth.json"),
- JSON.stringify({ test: { type: "api", key: "remove-me" } }),
- ),
- ),
- )
- .at(() => ({ path: route("/auth/{providerID}", { providerID: "test" }) }))
- .jsonEffect(200, (body) =>
- Effect.gen(function* () {
- check(body === true, "auth remove should return true")
- const auth = yield* Effect.promise(() => Bun.file(path.join(exerciseDataDirectory, "auth.json")).json())
- object(auth)
- check(auth.test === undefined, "auth remove should delete provider from isolated auth file")
- }),
- ),
- http
- .get("/session", "session.list")
- .seeded((ctx) => ctx.session({ title: "List me" }))
- .at((ctx) => ({ path: "/session?roots=true", headers: ctx.headers() }))
- .json(200, (body, ctx) => {
- array(body)
- check(
- body.some((item) => isRecord(item) && item.id === ctx.state.id && item.title === "List me"),
- "seeded session should be listed",
- )
- }),
- http
- .get("/session/status", "session.status")
- .seeded((ctx) => ctx.session({ title: "Status session" }))
- .json(200, object),
- http
- .post("/session", "session.create")
- .mutating()
- .at((ctx) => ({ path: "/session", headers: ctx.headers(), body: { title: "Created session" } }))
- .json(
- 200,
- (body, ctx) => {
- object(body)
- check(body.title === "Created session", "created session should use requested title")
- check(body.directory === ctx.directory, "created session should use scenario directory")
- },
- "status",
- ),
- http
- .get("/session/{sessionID}", "session.get")
- .seeded((ctx) => ctx.session({ title: "Get me" }))
- .at((ctx) => ({ path: route("/session/{sessionID}", { sessionID: ctx.state.id }), headers: ctx.headers() }))
- .json(200, (body, ctx) => {
- object(body)
- check(body.id === ctx.state.id, "should return requested session")
- check(body.title === "Get me", "should preserve seeded title")
- }),
- http
- .get("/session/{sessionID}", "session.get.missing")
- .at((ctx) => ({
- path: route("/session/{sessionID}", { sessionID: "ses_httpapi_missing" }),
- headers: ctx.headers(),
- }))
- .status(404),
- http
- .patch("/session/{sessionID}", "session.update")
- .mutating()
- .seeded((ctx) => ctx.session({ title: "Before rename" }))
- .at((ctx) => ({
- path: route("/session/{sessionID}", { sessionID: ctx.state.id }),
- headers: ctx.headers(),
- body: { title: "After rename" },
- }))
- .json(
- 200,
- (body) => {
- object(body)
- check(body.title === "After rename", "updated session should use new title")
- },
- "status",
- ),
- http
- .patch("/session/{sessionID}", "session.update.invalid")
- .mutating()
- .at((ctx) => ({
- path: route("/session/{sessionID}", { sessionID: "ses_httpapi_missing" }),
- headers: ctx.headers(),
- body: { title: 1 },
- }))
- .status(400),
- http
- .delete("/session/{sessionID}", "session.delete")
- .mutating()
- .seeded((ctx) => ctx.session({ title: "Delete me" }))
- .at((ctx) => ({ path: route("/session/{sessionID}", { sessionID: ctx.state.id }), headers: ctx.headers() }))
- .jsonEffect(200, (body, ctx) =>
- Effect.gen(function* () {
- check(body === true, "delete should return true")
- check((yield* ctx.sessionGet(ctx.state.id)) === undefined, "deleted session should not remain in storage")
- }),
- ),
- http
- .get("/session/{sessionID}/children", "session.children")
- .seeded((ctx) =>
- Effect.gen(function* () {
- const parent = yield* ctx.session({ title: "Parent" })
- const child = yield* ctx.session({ title: "Child", parentID: parent.id })
- return { parent, child }
- }),
- )
- .at((ctx) => ({
- path: route("/session/{sessionID}/children", { sessionID: ctx.state.parent.id }),
- headers: ctx.headers(),
- }))
- .json(200, (body, ctx) => {
- array(body)
- check(
- body.some((item) => isRecord(item) && item.id === ctx.state.child.id && item.parentID === ctx.state.parent.id),
- "children should include seeded child",
- )
- }),
- http
- .get("/session/{sessionID}/todo", "session.todo")
- .seeded((ctx) =>
- Effect.gen(function* () {
- const session = yield* ctx.session({ title: "Todo session" })
- const todos = [{ content: "cover session todo", status: "pending", priority: "high" }]
- yield* ctx.todos(session.id, todos)
- return { session, todos }
- }),
- )
- .at((ctx) => ({
- path: route("/session/{sessionID}/todo", { sessionID: ctx.state.session.id }),
- headers: ctx.headers(),
- }))
- .json(200, (body, ctx) => {
- check(stable(body) === stable(ctx.state.todos), "todos should match seeded state")
- }),
- http
- .get("/session/{sessionID}/diff", "session.diff")
- .seeded((ctx) => ctx.session({ title: "Diff session" }))
- .at((ctx) => ({ path: route("/session/{sessionID}/diff", { sessionID: ctx.state.id }), headers: ctx.headers() }))
- .json(200, array),
- http
- .get("/session/{sessionID}/message", "session.messages")
- .seeded((ctx) => ctx.session({ title: "Messages session" }))
- .at((ctx) => ({ path: route("/session/{sessionID}/message", { sessionID: ctx.state.id }), headers: ctx.headers() }))
- .json(200, (body) => {
- array(body)
- check(body.length === 0, "new session should have no messages")
- }),
- http
- .get("/session/{sessionID}/message/{messageID}", "session.message")
- .seeded((ctx) =>
- Effect.gen(function* () {
- const session = yield* ctx.session({ title: "Message get session" })
- const message = yield* ctx.message(session.id, { text: "read me" })
- return { session, message }
- }),
- )
- .at((ctx) => ({
- path: route("/session/{sessionID}/message/{messageID}", {
- sessionID: ctx.state.session.id,
- messageID: ctx.state.message.info.id,
- }),
- headers: ctx.headers(),
- }))
- .json(200, (body, ctx) => {
- object(body)
- check(isRecord(body.info) && body.info.id === ctx.state.message.info.id, "should return requested message")
- check(
- Array.isArray(body.parts) && body.parts.some((part) => isRecord(part) && part.id === ctx.state.message.part.id),
- "message should include seeded part",
- )
- }),
- http
- .patch("/session/{sessionID}/message/{messageID}/part/{partID}", "part.update")
- .mutating()
- .seeded((ctx) =>
- Effect.gen(function* () {
- const session = yield* ctx.session({ title: "Part update session" })
- const message = yield* ctx.message(session.id, { text: "before" })
- return { session, message }
- }),
- )
- .at((ctx) => ({
- path: route("/session/{sessionID}/message/{messageID}/part/{partID}", {
- sessionID: ctx.state.session.id,
- messageID: ctx.state.message.info.id,
- partID: ctx.state.message.part.id,
- }),
- headers: ctx.headers(),
- body: { ...ctx.state.message.part, text: "after" },
- }))
- .json(
- 200,
- (body) => {
- object(body)
- check(body.type === "text" && body.text === "after", "updated part should be returned")
- },
- "status",
- ),
- http
- .delete("/session/{sessionID}/message/{messageID}/part/{partID}", "part.delete")
- .mutating()
- .seeded((ctx) =>
- Effect.gen(function* () {
- const session = yield* ctx.session({ title: "Part delete session" })
- const message = yield* ctx.message(session.id, { text: "delete part" })
- return { session, message }
- }),
- )
- .at((ctx) => ({
- path: route("/session/{sessionID}/message/{messageID}/part/{partID}", {
- sessionID: ctx.state.session.id,
- messageID: ctx.state.message.info.id,
- partID: ctx.state.message.part.id,
- }),
- headers: ctx.headers(),
- }))
- .jsonEffect(200, (body, ctx) =>
- Effect.gen(function* () {
- check(body === true, "delete part should return true")
- const messages = yield* ctx.messages(ctx.state.session.id)
- check(messages[0]?.parts.length === 0, "deleted part should not remain on message")
- }),
- ),
- http
- .delete("/session/{sessionID}/message/{messageID}", "session.deleteMessage")
- .mutating()
- .seeded((ctx) =>
- Effect.gen(function* () {
- const session = yield* ctx.session({ title: "Message delete session" })
- const message = yield* ctx.message(session.id, { text: "delete message" })
- return { session, message }
- }),
- )
- .at((ctx) => ({
- path: route("/session/{sessionID}/message/{messageID}", {
- sessionID: ctx.state.session.id,
- messageID: ctx.state.message.info.id,
- }),
- headers: ctx.headers(),
- }))
- .jsonEffect(200, (body, ctx) =>
- Effect.gen(function* () {
- check(body === true, "delete message should return true")
- check((yield* ctx.messages(ctx.state.session.id)).length === 0, "deleted message should not remain")
- }),
- ),
- http
- .post("/session/{sessionID}/fork", "session.fork")
- .mutating()
- .seeded((ctx) => ctx.session({ title: "Fork source" }))
- .at((ctx) => ({
- path: route("/session/{sessionID}/fork", { sessionID: ctx.state.id }),
- headers: ctx.headers(),
- body: {},
- }))
- .json(
- 200,
- (body) => {
- object(body)
- check(typeof body.id === "string", "fork should return a session")
- },
- "status",
- ),
- http
- .post("/session/{sessionID}/abort", "session.abort")
- .mutating()
- .seeded((ctx) => ctx.session({ title: "Abort session" }))
- .at((ctx) => ({ path: route("/session/{sessionID}/abort", { sessionID: ctx.state.id }), headers: ctx.headers() }))
- .json(200, (body) => {
- check(body === true, "abort should return true")
- }),
- http
- .post("/session/{sessionID}/abort", "session.abort.missing")
- .at((ctx) => ({
- path: route("/session/{sessionID}/abort", { sessionID: "ses_httpapi_missing" }),
- headers: ctx.headers(),
- }))
- .json(200, (body) => {
- check(body === true, "missing session abort should remain a no-op success")
- }),
- http
- .post("/session/{sessionID}/init", "session.init")
- .preserveDatabase()
- .withLlm()
- .seeded((ctx) =>
- Effect.gen(function* () {
- const session = yield* ctx.session({ title: "Init session" })
- const message = yield* ctx.message(session.id, { text: "initialize" })
- yield* ctx.llmText("initialized")
- yield* ctx.llmText("initialized")
- return { session, message }
- }),
- )
- .at((ctx) => ({
- path: route("/session/{sessionID}/init", { sessionID: ctx.state.session.id }),
- headers: ctx.headers(),
- body: { providerID: "test", modelID: "test-model", messageID: ctx.state.message.info.id },
- }))
- .jsonEffect(200, (body, ctx) =>
- Effect.gen(function* () {
- check(body === true, "init should return true")
- yield* ctx.llmWait(1)
- }),
- ),
- http
- .post("/session/{sessionID}/message", "session.prompt")
- .preserveDatabase()
- .withLlm()
- .seeded((ctx) =>
- Effect.gen(function* () {
- const session = yield* ctx.session({ title: "LLM prompt session" })
- yield* ctx.llmText("fake assistant")
- yield* ctx.llmText("fake assistant")
- return session
- }),
- )
- .at((ctx) => ({
- path: route("/session/{sessionID}/message", { sessionID: ctx.state.id }),
- headers: ctx.headers(),
- body: {
- agent: "build",
- model: { providerID: "test", modelID: "test-model" },
- parts: [{ type: "text", text: "hello llm" }],
- },
- }))
- .jsonEffect(
- 200,
- (body, ctx) =>
- Effect.gen(function* () {
- object(body)
- check(isRecord(body.info) && body.info.role === "assistant", "prompt should return assistant message")
- check(
- Array.isArray(body.parts) && body.parts.some((part) => isRecord(part) && part.text === "fake assistant"),
- "assistant message should use fake LLM text",
- )
- yield* ctx.llmWait(1)
- }),
- "status",
- ),
- http
- .post("/session/{sessionID}/prompt_async", "session.prompt_async")
- .preserveDatabase()
- .withLlm()
- .seeded((ctx) =>
- Effect.gen(function* () {
- const session = yield* ctx.session({ title: "Async prompt session" })
- yield* ctx.llmText("fake async assistant")
- yield* ctx.llmText("fake async assistant")
- return session
- }),
- )
- .at((ctx) => ({
- path: route("/session/{sessionID}/prompt_async", { sessionID: ctx.state.id }),
- headers: ctx.headers(),
- body: {
- agent: "build",
- model: { providerID: "test", modelID: "test-model" },
- parts: [{ type: "text", text: "hello async" }],
- },
- }))
- .status(204, (ctx) =>
- Effect.gen(function* () {
- yield* ctx.llmWait(1)
- }),
- ),
- http
- .post("/session/{sessionID}/command", "session.command")
- .preserveDatabase()
- .withLlm()
- .seeded((ctx) =>
- Effect.gen(function* () {
- const session = yield* ctx.session({ title: "Command session" })
- yield* ctx.llmText("command done")
- yield* ctx.llmText("command done")
- return session
- }),
- )
- .at((ctx) => ({
- path: route("/session/{sessionID}/command", { sessionID: ctx.state.id }),
- headers: ctx.headers(),
- body: { command: "init", arguments: "", model: "test/test-model" },
- }))
- .jsonEffect(
- 200,
- (body, ctx) =>
- Effect.gen(function* () {
- object(body)
- check(isRecord(body.info) && body.info.role === "assistant", "command should return assistant message")
- yield* ctx.llmWait(1)
- }),
- "status",
- ),
- http
- .post("/session/{sessionID}/shell", "session.shell")
- .preserveDatabase()
- .mutating()
- .seeded((ctx) => ctx.session({ title: "Shell session" }))
- .at((ctx) => ({
- path: route("/session/{sessionID}/shell", { sessionID: ctx.state.id }),
- headers: ctx.headers(),
- body: { agent: "build", model: { providerID: "test", modelID: "test-model" }, command: "printf shell-ok" },
- }))
- .json(
- 200,
- (body) => {
- object(body)
- check(isRecord(body.info) && body.info.role === "assistant", "shell should return assistant message")
- check(
- Array.isArray(body.parts) && body.parts.some((part) => isRecord(part) && part.type === "tool"),
- "shell should return a tool part",
- )
- },
- "status",
- ),
- http
- .post("/session/{sessionID}/summarize", "session.summarize")
- .preserveDatabase()
- .withLlm()
- .seeded((ctx) =>
- Effect.gen(function* () {
- const session = yield* ctx.session({ title: "Summarize session" })
- yield* ctx.message(session.id, { text: "summarize this work" })
- const summary = [
- "## Goal",
- "- Exercise session summarize.",
- "",
- "## Constraints & Preferences",
- "- Use fake LLM.",
- "",
- "## Progress",
- "### Done",
- "- Summary generated.",
- "",
- "### In Progress",
- "- (none)",
- "",
- "### Blocked",
- "- (none)",
- "",
- "## Key Decisions",
- "- Keep route local.",
- "",
- "## Next Steps",
- "- (none)",
- "",
- "## Critical Context",
- "- Test fixture.",
- "",
- "## Relevant Files",
- "- test/server/httpapi-exercise/index.ts: scenario",
- ].join("\n")
- yield* ctx.llmText(summary)
- yield* ctx.llmText(summary)
- return session
- }),
- )
- .at((ctx) => ({
- path: route("/session/{sessionID}/summarize", { sessionID: ctx.state.id }),
- headers: ctx.headers(),
- body: { providerID: "test", modelID: "test-model", auto: false },
- }))
- .jsonEffect(
- 200,
- (body, ctx) =>
- Effect.gen(function* () {
- check(body === true, "summarize should return true")
- const messages = yield* ctx.messages(ctx.state.id)
- check(
- messages.some((message) => message.info.role === "assistant" && message.info.summary === true),
- "summarize should create a summary assistant message",
- )
- yield* ctx.llmWait(1)
- }),
- "status",
- ),
- http
- .post("/session/{sessionID}/revert", "session.revert")
- .mutating()
- .seeded((ctx) =>
- Effect.gen(function* () {
- const session = yield* ctx.session({ title: "Revert session" })
- const message = yield* ctx.message(session.id, { text: "revert me" })
- return { session, message }
- }),
- )
- .at((ctx) => ({
- path: route("/session/{sessionID}/revert", { sessionID: ctx.state.session.id }),
- headers: ctx.headers(),
- body: { messageID: ctx.state.message.info.id },
- }))
- .json(
- 200,
- (body, ctx) => {
- object(body)
- check(body.id === ctx.state.session.id, "revert should return the session")
- check(
- isRecord(body.revert) && body.revert.messageID === ctx.state.message.info.id,
- "revert should record reverted message",
- )
- },
- "status",
- ),
- http
- .post("/session/{sessionID}/unrevert", "session.unrevert")
- .mutating()
- .seeded((ctx) => ctx.session({ title: "Unrevert session" }))
- .at((ctx) => ({
- path: route("/session/{sessionID}/unrevert", { sessionID: ctx.state.id }),
- headers: ctx.headers(),
- }))
- .json(
- 200,
- (body, ctx) => {
- object(body)
- check(body.id === ctx.state.id, "unrevert should return the session")
- },
- "status",
- ),
- http
- .post("/session/{sessionID}/permissions/{permissionID}", "permission.respond")
- .seeded((ctx) => ctx.session({ title: "Deprecated permission session" }))
- .at((ctx) => ({
- path: route("/session/{sessionID}/permissions/{permissionID}", {
- sessionID: ctx.state.id,
- permissionID: "per_httpapi_deprecated",
- }),
- headers: ctx.headers(),
- body: { response: "once" },
- }))
- .json(200, (body) => {
- check(body === true, "deprecated permission response should return true")
- }),
- http
- .post("/session/{sessionID}/share", "session.share")
- .mutating()
- .seeded((ctx) => ctx.session({ title: "Share session" }))
- .at((ctx) => ({ path: route("/session/{sessionID}/share", { sessionID: ctx.state.id }), headers: ctx.headers() }))
- .json(
- 200,
- (body, ctx) => {
- object(body)
- check(body.id === ctx.state.id, "share should return the session")
- },
- "status",
- ),
- http
- .delete("/session/{sessionID}/share", "session.unshare")
- .mutating()
- .seeded((ctx) => ctx.session({ title: "Unshare session" }))
- .at((ctx) => ({ path: route("/session/{sessionID}/share", { sessionID: ctx.state.id }), headers: ctx.headers() }))
- .json(
- 200,
- (body, ctx) => {
- object(body)
- check(body.id === ctx.state.id, "unshare should return the session")
- },
- "status",
- ),
- http
- .post("/tui/append-prompt", "tui.appendPrompt")
- .at((ctx) => ({ path: "/tui/append-prompt", headers: ctx.headers(), body: { text: "hello" } }))
- .json(200, boolean, "status"),
- http
- .post("/tui/select-session", "tui.selectSession.invalid")
- .at((ctx) => ({ path: "/tui/select-session", headers: ctx.headers(), body: { sessionID: "invalid" } }))
- .status(400),
- http.post("/tui/open-help", "tui.openHelp").json(200, boolean, "status"),
- http.post("/tui/open-sessions", "tui.openSessions").json(200, boolean, "status"),
- http.post("/tui/open-themes", "tui.openThemes").json(200, boolean, "status"),
- http.post("/tui/open-models", "tui.openModels").json(200, boolean, "status"),
- http.post("/tui/submit-prompt", "tui.submitPrompt").json(200, boolean, "status"),
- http.post("/tui/clear-prompt", "tui.clearPrompt").json(200, boolean, "status"),
- http
- .post("/tui/execute-command", "tui.executeCommand")
- .at((ctx) => ({ path: "/tui/execute-command", headers: ctx.headers(), body: { command: "agent_cycle" } }))
- .json(200, boolean, "status"),
- http
- .post("/tui/show-toast", "tui.showToast")
- .at((ctx) => ({
- path: "/tui/show-toast",
- headers: ctx.headers(),
- body: { title: "Exercise", message: "covered", variant: "info", duration: 1000 },
- }))
- .json(200, boolean, "status"),
- http
- .post("/tui/publish", "tui.publish")
- .at((ctx) => ({
- path: "/tui/publish",
- headers: ctx.headers(),
- body: { type: "tui.prompt.append", properties: { text: "published" } },
- }))
- .json(200, boolean, "status"),
- http
- .post("/tui/select-session", "tui.selectSession")
- .seeded((ctx) => ctx.session({ title: "TUI select" }))
- .at((ctx) => ({ path: "/tui/select-session", headers: ctx.headers(), body: { sessionID: ctx.state.id } }))
- .json(200, boolean, "status"),
- http
- .post("/tui/control/response", "tui.control.response")
- .at((ctx) => ({ path: "/tui/control/response", headers: ctx.headers(), body: { ok: true } }))
- .json(200, boolean, "status"),
- http
- .get("/tui/control/next", "tui.control.next")
- .mutating()
- .seeded((ctx) => ctx.tuiRequest({ path: "/tui/exercise", body: { text: "queued" } }))
- .json(
- 200,
- (body) => {
- object(body)
- check(body.path === "/tui/exercise", "control next should return queued path")
- object(body.body)
- check(body.body.text === "queued", "control next should return queued body")
- },
- "status",
- ),
- http
- .post("/global/upgrade", "global.upgrade")
- .global()
- .at(() => ({ path: "/global/upgrade", body: { target: 1 } }))
- .status(400),
- ]
- const main = Effect.gen(function* () {
- yield* Effect.addFinalizer(() => cleanupExercisePaths)
- const options = parseOptions(Bun.argv.slice(2))
- const modules = yield* Effect.promise(() => runtime())
- const effectRoutes = routeKeys(OpenApi.fromApi(modules.PublicApi))
- const honoRoutes = routeKeys(yield* Effect.promise(() => modules.Server.openapiHono()))
- const selected = scenarios.filter((scenario) => matches(options, scenario))
- const missing = effectRoutes.filter((route) => !scenarios.some((scenario) => route === routeKey(scenario)))
- const extra = scenarios.filter((scenario) => !effectRoutes.includes(routeKey(scenario)))
- printHeader(options, effectRoutes, honoRoutes, selected, missing, extra, {
- database: exerciseDatabasePath,
- global: exerciseGlobalRoot,
- })
- const results =
- options.mode === "coverage"
- ? selected.map(coverageResult)
- : yield* Effect.forEach(selected, runScenario(options), { concurrency: 1 })
- printResults(results, missing, extra)
- if (results.some((result) => result.status === "fail"))
- return yield* Effect.fail(new Error("one or more scenarios failed"))
- if (options.failOnSkip && results.some((result) => result.status === "skip"))
- return yield* Effect.fail(new Error("one or more scenarios are skipped"))
- if (options.failOnMissing && missing.length > 0)
- return yield* Effect.fail(new Error("one or more routes have no scenario"))
- return undefined
- })
- Effect.runPromise(main.pipe(Effect.provide(TestLLMServer.layer), Effect.scoped)).then(
- () => process.exit(0),
- (error: unknown) => {
- console.error(`${color.red}${message(error)}${color.reset}`)
- process.exit(1)
- },
- )
|