refactor(core): canonicalize pty service (#32182)
This commit is contained in:
Shoubhit Dash
@@ -757,6 +757,44 @@ const scenarios: Scenario[] = [
|
||||
.seeded((ctx) => ctx.file("hello.txt", "hello\n"))
|
||||
.at((ctx) => ({ path: "/api/fs/find?query=hello&type=file", headers: ctx.headers() }))
|
||||
.json(200, locationData(array)),
|
||||
http.protected.get("/api/pty", "v2.pty.list").json(200, locationData(array)),
|
||||
http.protected
|
||||
.post("/api/pty", "v2.pty.create")
|
||||
.mutating()
|
||||
.at((ctx) => ({ path: "/api/pty", headers: ctx.headers(), body: controlledPtyInput("HTTP API V2 PTY") }))
|
||||
.json(200, locationData(object)),
|
||||
http.protected
|
||||
.get("/api/pty/{ptyID}", "v2.pty.get")
|
||||
.at((ctx) => ({ path: route("/api/pty/{ptyID}", { ptyID: "pty_httpapi_missing" }), headers: ctx.headers() }))
|
||||
.json(404, object, "status"),
|
||||
http.protected
|
||||
.put("/api/pty/{ptyID}", "v2.pty.update")
|
||||
.mutating()
|
||||
.at((ctx) => ({
|
||||
path: route("/api/pty/{ptyID}", { ptyID: "pty_httpapi_missing" }),
|
||||
headers: ctx.headers(),
|
||||
body: { title: "missing" },
|
||||
}))
|
||||
.json(404, object, "status"),
|
||||
http.protected
|
||||
.delete("/api/pty/{ptyID}", "v2.pty.remove")
|
||||
.mutating()
|
||||
.at((ctx) => ({ path: route("/api/pty/{ptyID}", { ptyID: "pty_httpapi_missing" }), headers: ctx.headers() }))
|
||||
.json(404, object, "status"),
|
||||
http.protected
|
||||
.post("/api/pty/{ptyID}/connect-token", "v2.pty.connectToken")
|
||||
.at((ctx) => ({
|
||||
path: route("/api/pty/{ptyID}/connect-token", { ptyID: "pty_httpapi_missing" }),
|
||||
headers: { ...ctx.headers(), "x-opencode-ticket": "1" },
|
||||
}))
|
||||
.json(404, object, "status"),
|
||||
http.protected
|
||||
.get("/api/pty/{ptyID}/connect", "v2.pty.connect")
|
||||
.at((ctx) => ({
|
||||
path: route("/api/pty/{ptyID}/connect", { ptyID: "pty_httpapi_missing" }),
|
||||
headers: ctx.headers(),
|
||||
}))
|
||||
.status(404, undefined, "none"),
|
||||
http.protected.get("/api/reference", "v2.reference.list").json(200, object),
|
||||
http.protected
|
||||
.get("/api/provider/{providerID}", "v2.provider.get")
|
||||
|
||||
@@ -136,6 +136,33 @@ describe("pty HttpApi bridge", () => {
|
||||
})
|
||||
})
|
||||
|
||||
testPty("hides exited sessions on the legacy surface", async () => {
|
||||
await using tmp = await tmpdir({ git: true, config: { formatter: false, lsp: false } })
|
||||
const headers = { "x-opencode-directory": tmp.path }
|
||||
const created = await app().request(PtyPaths.create, {
|
||||
method: "POST",
|
||||
headers: { ...headers, "content-type": "application/json" },
|
||||
body: JSON.stringify({ command: "/usr/bin/env", args: ["sh", "-c", "exit 0"] }),
|
||||
})
|
||||
expect(created.status).toBe(200)
|
||||
const info = await created.json()
|
||||
|
||||
// Exited sessions are retained by core for the canonical surface, but the legacy
|
||||
// routes preserve pre-retention behavior: exited sessions are invisible here.
|
||||
const deadline = Date.now() + 5_000
|
||||
while (Date.now() < deadline) {
|
||||
const found = await app().request(PtyPaths.get.replace(":ptyID", info.id), { headers })
|
||||
if (found.status === 404) break
|
||||
await new Promise((resolve) => setTimeout(resolve, 50))
|
||||
}
|
||||
const found = await app().request(PtyPaths.get.replace(":ptyID", info.id), { headers })
|
||||
expect(found.status).toBe(404)
|
||||
|
||||
const list = await app().request(PtyPaths.list, { headers })
|
||||
expect(list.status).toBe(200)
|
||||
expect(await list.json()).toEqual([])
|
||||
})
|
||||
|
||||
testPty("disposes PTY sessions with their legacy instance", async () => {
|
||||
await using tmp = await tmpdir({ git: true, config: { formatter: false, lsp: false } })
|
||||
const headers = { "x-opencode-directory": tmp.path }
|
||||
|
||||
@@ -0,0 +1,171 @@
|
||||
import { afterEach, describe, expect, test } from "bun:test"
|
||||
import { Context, Config as EffectConfig, Effect, Layer, Queue, Schema } from "effect"
|
||||
import { NodeHttpServer, NodeServices } from "@effect/platform-node"
|
||||
import { HttpClient, HttpClientRequest, HttpRouter, HttpServer } from "effect/unstable/http"
|
||||
import * as Socket from "effect/unstable/socket/Socket"
|
||||
import { Location } from "@opencode-ai/core/location"
|
||||
import { Pty } from "@opencode-ai/core/pty"
|
||||
import { PtyTicket } from "@opencode-ai/core/pty/ticket"
|
||||
import { HttpApiApp } from "../../src/server/routes/instance/httpapi/server"
|
||||
import { resetDatabase } from "../fixture/db"
|
||||
import { disposeAllInstances, tmpdir, tmpdirScoped } from "../fixture/fixture"
|
||||
import { testEffect } from "../lib/effect"
|
||||
|
||||
const context = Context.empty() as Context.Context<unknown>
|
||||
const testPty = process.platform === "win32" ? test.skip : test
|
||||
|
||||
function request(route: string, directory: string, init: RequestInit = {}) {
|
||||
const headers = new Headers(init.headers)
|
||||
headers.set("x-opencode-directory", directory)
|
||||
return HttpApiApp.webHandler().handler(
|
||||
new Request(`http://localhost${route}`, {
|
||||
...init,
|
||||
headers,
|
||||
}),
|
||||
context,
|
||||
)
|
||||
}
|
||||
|
||||
const testStateLayer = Layer.effectDiscard(
|
||||
Effect.gen(function* () {
|
||||
yield* Effect.promise(() => resetDatabase())
|
||||
yield* Effect.addFinalizer(() => Effect.promise(() => resetDatabase()))
|
||||
}),
|
||||
)
|
||||
|
||||
const servedRoutes: Layer.Layer<never, EffectConfig.ConfigError, HttpServer.HttpServer> = HttpRouter.serve(
|
||||
HttpApiApp.routes,
|
||||
{ disableListenLog: true, disableLogger: true },
|
||||
)
|
||||
|
||||
const effectIt = testEffect(
|
||||
Layer.mergeAll(
|
||||
testStateLayer,
|
||||
Socket.layerWebSocketConstructorGlobal,
|
||||
servedRoutes.pipe(
|
||||
Layer.provide(Socket.layerWebSocketConstructorGlobal),
|
||||
Layer.provideMerge(NodeHttpServer.layerTest),
|
||||
Layer.provideMerge(NodeServices.layer),
|
||||
),
|
||||
),
|
||||
)
|
||||
|
||||
const directoryHeader = (dir: string) => HttpClientRequest.setHeader("x-opencode-directory", dir)
|
||||
|
||||
const serverUrl = () => HttpServer.HttpServer.use((server) => Effect.succeed(HttpServer.formatAddress(server.address)))
|
||||
|
||||
afterEach(async () => {
|
||||
await disposeAllInstances()
|
||||
await resetDatabase()
|
||||
})
|
||||
|
||||
describe("v2 pty HttpApi", () => {
|
||||
testPty("serves location-wrapped PTY routes and retains exited sessions", async () => {
|
||||
await using tmp = await tmpdir({ git: true, config: { formatter: false, lsp: false } })
|
||||
|
||||
const empty = await request("/api/pty", tmp.path)
|
||||
expect(empty.status).toBe(200)
|
||||
expect(Schema.decodeUnknownSync(Location.response(Schema.Array(Pty.Info)))(await empty.json()).data).toEqual([])
|
||||
|
||||
const created = await request("/api/pty", tmp.path, {
|
||||
method: "POST",
|
||||
headers: { "content-type": "application/json" },
|
||||
body: JSON.stringify({ command: "/usr/bin/env", args: ["sh", "-c", "exit 4"], title: "v2" }),
|
||||
})
|
||||
expect(created.status).toBe(200)
|
||||
const body = Schema.decodeUnknownSync(Location.response(Pty.Info))(await created.json())
|
||||
expect(String(body.location.directory)).toBe(tmp.path)
|
||||
expect(body.data.title).toBe("v2")
|
||||
|
||||
// The canonical surface keeps exited sessions observable with their exit code.
|
||||
const deadline = Date.now() + 5_000
|
||||
let info: { status: string; exitCode?: number } | undefined
|
||||
while (Date.now() < deadline) {
|
||||
const found = await request(`/api/pty/${body.data.id}`, tmp.path)
|
||||
expect(found.status).toBe(200)
|
||||
info = Schema.decodeUnknownSync(Location.response(Pty.Info))(await found.json()).data
|
||||
if (info.status === "exited") break
|
||||
await new Promise((resolve) => setTimeout(resolve, 50))
|
||||
}
|
||||
expect(info).toMatchObject({ status: "exited", exitCode: 4 })
|
||||
|
||||
const removed = await request(`/api/pty/${body.data.id}`, tmp.path, { method: "DELETE" })
|
||||
expect(removed.status).toBe(204)
|
||||
|
||||
const missing = await request(`/api/pty/${body.data.id}`, tmp.path)
|
||||
expect(missing.status).toBe(404)
|
||||
expect(await missing.json()).toMatchObject({ _tag: "PtyNotFoundError", ptyID: body.data.id })
|
||||
})
|
||||
|
||||
testPty("rejects connect tokens without the CSRF header and connects with a valid ticket", async () => {
|
||||
await using tmp = await tmpdir({ git: true, config: { formatter: false, lsp: false } })
|
||||
const created = await request("/api/pty", tmp.path, {
|
||||
method: "POST",
|
||||
headers: { "content-type": "application/json" },
|
||||
body: JSON.stringify({ command: "/usr/bin/env", args: ["sh", "-c", "sleep 5"] }),
|
||||
})
|
||||
expect(created.status).toBe(200)
|
||||
const info = Schema.decodeUnknownSync(Location.response(Pty.Info))(await created.json()).data
|
||||
|
||||
try {
|
||||
const forbidden = await request(`/api/pty/${info.id}/connect-token`, tmp.path, { method: "POST" })
|
||||
expect(forbidden.status).toBe(403)
|
||||
expect(await forbidden.json()).toMatchObject({ _tag: "ForbiddenError" })
|
||||
|
||||
const token = await request(`/api/pty/${info.id}/connect-token`, tmp.path, {
|
||||
method: "POST",
|
||||
headers: { "x-opencode-ticket": "1" },
|
||||
})
|
||||
expect(token.status).toBe(200)
|
||||
const ticket = Schema.decodeUnknownSync(Location.response(PtyTicket.ConnectToken))(await token.json()).data.ticket
|
||||
expect(ticket).toBeTruthy()
|
||||
|
||||
const invalid = await request(`/api/pty/${info.id}/connect?ticket=not-a-ticket`, tmp.path)
|
||||
expect(invalid.status).toBe(403)
|
||||
} finally {
|
||||
await request(`/api/pty/${info.id}`, tmp.path, { method: "DELETE" })
|
||||
}
|
||||
})
|
||||
;(process.platform === "win32" ? effectIt.live.skip : effectIt.live)(
|
||||
"serves PTY websocket output and input through the canonical route",
|
||||
() =>
|
||||
Effect.gen(function* () {
|
||||
const dir = yield* tmpdirScoped({ git: true, config: { formatter: false, lsp: false } })
|
||||
const created = yield* HttpClientRequest.post("/api/pty").pipe(
|
||||
directoryHeader(dir),
|
||||
HttpClientRequest.bodyJson({ command: "/bin/cat", title: "v2-websocket" }),
|
||||
Effect.flatMap(HttpClient.execute),
|
||||
)
|
||||
expect(created.status).toBe(200)
|
||||
const body = yield* Schema.decodeUnknownEffect(Location.response(Pty.Info))(yield* created.json)
|
||||
const info = body.data
|
||||
|
||||
const socket = yield* Socket.makeWebSocket(
|
||||
`${(yield* serverUrl()).replace(/^http/, "ws")}/api/pty/${info.id}/connect?cursor=-1&location[directory]=${encodeURIComponent(dir)}`,
|
||||
{ closeCodeIsError: () => false },
|
||||
)
|
||||
const messages = yield* Queue.unbounded<string>()
|
||||
yield* socket
|
||||
.runRaw((message) =>
|
||||
Queue.offer(messages, typeof message === "string" ? message : new TextDecoder().decode(message)),
|
||||
)
|
||||
.pipe(Effect.catch(() => Effect.void))
|
||||
.pipe(Effect.forkScoped)
|
||||
const write = yield* socket.writer
|
||||
|
||||
const takeUntil = (expected: string, seen = ""): Effect.Effect<string, unknown> =>
|
||||
Effect.gen(function* () {
|
||||
const next = seen + (yield* Queue.take(messages).pipe(Effect.timeout("5 seconds")))
|
||||
if (next.includes(expected)) return next
|
||||
return yield* takeUntil(expected, next)
|
||||
})
|
||||
|
||||
yield* write("ping-v2\n")
|
||||
expect(yield* takeUntil("ping-v2")).toContain("ping-v2")
|
||||
yield* write(new Socket.CloseEvent(1000, "done")).pipe(Effect.catch(() => Effect.void))
|
||||
|
||||
const removed = yield* HttpClientRequest.delete(`/api/pty/${info.id}`).pipe(directoryHeader(dir), HttpClient.execute)
|
||||
expect(removed.status).toBe(204)
|
||||
}),
|
||||
)
|
||||
})
|
||||
Reference in New Issue
Block a user