agaltsovav/opencode
1
0
Fork 0
Code Issues Pull Requests Actions 99 Packages Projects Releases Wiki Activity

refactor(pty): remove async facade exports (#22305)

Browse Source
This commit is contained in:
Kit Langton
2026-04-13 11:47:05 -04:00
committed by GitHub
parent 3644581b55
commit 6825b0bbc7
5 changed files with 235 additions and 193 deletions
Download Patch File Download Diff File Expand all files Collapse all files
packages/opencode/src/pty/index.ts
-31
View File
@@ -1,7 +1,6 @@
import { BusEvent } from "@/bus/bus-event" import { BusEvent } from "@/bus/bus-event"
import { Bus } from "@/bus" import { Bus } from "@/bus"
import { InstanceState } from "@/effect/instance-state" import { InstanceState } from "@/effect/instance-state"
import { makeRuntime } from "@/effect/run-service"
import { Instance } from "@/project/instance" import { Instance } from "@/project/instance"
import type { Proc } from "#pty" import type { Proc } from "#pty"
import z from "zod" import z from "zod"
@@ -361,34 +360,4 @@ export namespace Pty {
) )
export const defaultLayer = layer.pipe(Layer.provide(Bus.layer), Layer.provide(Plugin.defaultLayer)) export const defaultLayer = layer.pipe(Layer.provide(Bus.layer), Layer.provide(Plugin.defaultLayer))
const { runPromise } = makeRuntime(Service, defaultLayer)
export async function list() {
return runPromise((svc) => svc.list())
}
export async function get(id: PtyID) {
return runPromise((svc) => svc.get(id))
}
export async function write(id: PtyID, data: string) {
return runPromise((svc) => svc.write(id, data))
}
export async function connect(id: PtyID, ws: Socket, cursor?: number) {
return runPromise((svc) => svc.connect(id, ws, cursor))
}
export async function create(input: CreateInput) {
return runPromise((svc) => svc.create(input))
}
export async function update(id: PtyID, input: UpdateInput) {
return runPromise((svc) => svc.update(id, input))
}
export async function remove(id: PtyID) {
return runPromise((svc) => svc.remove(id))
}
} }
packages/opencode/src/server/instance/pty.ts
+56 -8
View File
@@ -1,7 +1,9 @@
import { Hono, type MiddlewareHandler } from "hono" import { Hono, type MiddlewareHandler } from "hono"
import { describeRoute, validator, resolver } from "hono-openapi" import { describeRoute, validator, resolver } from "hono-openapi"
import type { UpgradeWebSocket } from "hono/ws" import type { UpgradeWebSocket } from "hono/ws"
import { Effect } from "effect"
import z from "zod" import z from "zod"
import { AppRuntime } from "@/effect/app-runtime"
import { Pty } from "@/pty" import { Pty } from "@/pty"
import { PtyID } from "@/pty/schema" import { PtyID } from "@/pty/schema"
import { NotFoundError } from "../../storage/db" import { NotFoundError } from "../../storage/db"
@@ -27,7 +29,14 @@ export function PtyRoutes(upgradeWebSocket: UpgradeWebSocket) {
}, },
}), }),
async (c) => { async (c) => {
return c.json(await Pty.list()) return c.json(
await AppRuntime.runPromise(
Effect.gen(function* () {
const pty = yield* Pty.Service
return yield* pty.list()
}),
),
)
}, },
) )
.post( .post(
@@ -50,7 +59,12 @@ export function PtyRoutes(upgradeWebSocket: UpgradeWebSocket) {
}), }),
validator("json", Pty.CreateInput), validator("json", Pty.CreateInput),
async (c) => { async (c) => {
const info = await Pty.create(c.req.valid("json")) const info = await AppRuntime.runPromise(
Effect.gen(function* () {
const pty = yield* Pty.Service
return yield* pty.create(c.req.valid("json"))
}),
)
return c.json(info) return c.json(info)
}, },
) )
@@ -74,7 +88,12 @@ export function PtyRoutes(upgradeWebSocket: UpgradeWebSocket) {
}), }),
validator("param", z.object({ ptyID: PtyID.zod })), validator("param", z.object({ ptyID: PtyID.zod })),
async (c) => { async (c) => {
const info = await Pty.get(c.req.valid("param").ptyID) const info = await AppRuntime.runPromise(
Effect.gen(function* () {
const pty = yield* Pty.Service
return yield* pty.get(c.req.valid("param").ptyID)
}),
)
if (!info) { if (!info) {
throw new NotFoundError({ message: "Session not found" }) throw new NotFoundError({ message: "Session not found" })
} }
@@ -102,7 +121,12 @@ export function PtyRoutes(upgradeWebSocket: UpgradeWebSocket) {
validator("param", z.object({ ptyID: PtyID.zod })), validator("param", z.object({ ptyID: PtyID.zod })),
validator("json", Pty.UpdateInput), validator("json", Pty.UpdateInput),
async (c) => { async (c) => {
const info = await Pty.update(c.req.valid("param").ptyID, c.req.valid("json")) const info = await AppRuntime.runPromise(
Effect.gen(function* () {
const pty = yield* Pty.Service
return yield* pty.update(c.req.valid("param").ptyID, c.req.valid("json"))
}),
)
return c.json(info) return c.json(info)
}, },
) )
@@ -126,7 +150,12 @@ export function PtyRoutes(upgradeWebSocket: UpgradeWebSocket) {
}), }),
validator("param", z.object({ ptyID: PtyID.zod })), validator("param", z.object({ ptyID: PtyID.zod })),
async (c) => { async (c) => {
await Pty.remove(c.req.valid("param").ptyID) await AppRuntime.runPromise(
Effect.gen(function* () {
const pty = yield* Pty.Service
yield* pty.remove(c.req.valid("param").ptyID)
}),
)
return c.json(true) return c.json(true)
}, },
) )
@@ -150,6 +179,11 @@ export function PtyRoutes(upgradeWebSocket: UpgradeWebSocket) {
}), }),
validator("param", z.object({ ptyID: PtyID.zod })), validator("param", z.object({ ptyID: PtyID.zod })),
upgradeWebSocket(async (c) => { upgradeWebSocket(async (c) => {
type Handler = {
onMessage: (message: string | ArrayBuffer) => void
onClose: () => void
}
const id = PtyID.zod.parse(c.req.param("ptyID")) const id = PtyID.zod.parse(c.req.param("ptyID"))
const cursor = (() => { const cursor = (() => {
const value = c.req.query("cursor") const value = c.req.query("cursor")
@@ -158,8 +192,17 @@ export function PtyRoutes(upgradeWebSocket: UpgradeWebSocket) {
if (!Number.isSafeInteger(parsed) || parsed < -1) return if (!Number.isSafeInteger(parsed) || parsed < -1) return
return parsed return parsed
})() })()
let handler: Awaited<ReturnType<typeof Pty.connect>> let handler: Handler | undefined
if (!(await Pty.get(id))) throw new Error("Session not found") if (
!(await AppRuntime.runPromise(
Effect.gen(function* () {
const pty = yield* Pty.Service
return yield* pty.get(id)
}),
))
) {
throw new Error("Session not found")
}
type Socket = { type Socket = {
readyState: number readyState: number
@@ -185,7 +228,12 @@ export function PtyRoutes(upgradeWebSocket: UpgradeWebSocket) {
ws.close() ws.close()
return return
} }
handler = await Pty.connect(id, socket, cursor) handler = await AppRuntime.runPromise(
Effect.gen(function* () {
const pty = yield* Pty.Service
return yield* pty.connect(id, socket, cursor)
}),
)
ready = true ready = true
for (const msg of pending) handler?.onMessage(msg) for (const msg of pending) handler?.onMessage(msg)
pending.length = 0 pending.length = 0
packages/opencode/test/pty/pty-output-isolation.test.ts
+99 -94
View File
@@ -1,4 +1,6 @@
import { describe, expect, test } from "bun:test" import { describe, expect, test } from "bun:test"
import { AppRuntime } from "../../src/effect/app-runtime"
import { Effect } from "effect"
import { Instance } from "../../src/project/instance" import { Instance } from "../../src/project/instance"
import { Pty } from "../../src/pty" import { Pty } from "../../src/pty"
import { tmpdir } from "../fixture/fixture" import { tmpdir } from "../fixture/fixture"
@@ -10,48 +12,48 @@ describe("pty", () => {
await Instance.provide({ await Instance.provide({
directory: dir.path, directory: dir.path,
fn: async () => { fn: () =>
const a = await Pty.create({ command: "cat", title: "a" }) AppRuntime.runPromise(
const b = await Pty.create({ command: "cat", title: "b" }) Effect.gen(function* () {
try { const pty = yield* Pty.Service
const outA: string[] = [] const a = yield* pty.create({ command: "cat", title: "a" })
const outB: string[] = [] const b = yield* pty.create({ command: "cat", title: "b" })
try {
const outA: string[] = []
const outB: string[] = []
const ws = { const ws = {
readyState: 1, readyState: 1,
data: { events: { connection: "a" } }, data: { events: { connection: "a" } },
send: (data: unknown) => { send: (data: unknown) => {
outA.push(typeof data === "string" ? data : Buffer.from(data as Uint8Array).toString("utf8")) outA.push(typeof data === "string" ? data : Buffer.from(data as Uint8Array).toString("utf8"))
}, },
close: () => { close: () => {
// no-op (simulate abrupt drop) // no-op (simulate abrupt drop)
}, },
} }
// Connect "a" first with ws. yield* pty.connect(a.id, ws as any)
Pty.connect(a.id, ws as any)
// Now "reuse" the same ws object for another connection. ws.data = { events: { connection: "b" } }
ws.data = { events: { connection: "b" } } ws.send = (data: unknown) => {
ws.send = (data: unknown) => { outB.push(typeof data === "string" ? data : Buffer.from(data as Uint8Array).toString("utf8"))
outB.push(typeof data === "string" ? data : Buffer.from(data as Uint8Array).toString("utf8")) }
} yield* pty.connect(b.id, ws as any)
Pty.connect(b.id, ws as any)
// Clear connect metadata writes. outA.length = 0
outA.length = 0 outB.length = 0
outB.length = 0
// Output from a must never show up in b. yield* pty.write(a.id, "AAA\n")
Pty.write(a.id, "AAA\n") yield* Effect.promise(() => sleep(100))
await sleep(100)
expect(outB.join("")).not.toContain("AAA") expect(outB.join("")).not.toContain("AAA")
} finally { } finally {
await Pty.remove(a.id) yield* pty.remove(a.id)
await Pty.remove(b.id) yield* pty.remove(b.id)
} }
}, }),
),
}) })
}) })
@@ -60,42 +62,43 @@ describe("pty", () => {
await Instance.provide({ await Instance.provide({
directory: dir.path, directory: dir.path,
fn: async () => { fn: () =>
const a = await Pty.create({ command: "cat", title: "a" }) AppRuntime.runPromise(
try { Effect.gen(function* () {
const outA: string[] = [] const pty = yield* Pty.Service
const outB: string[] = [] const a = yield* pty.create({ command: "cat", title: "a" })
try {
const outA: string[] = []
const outB: string[] = []
const ws = { const ws = {
readyState: 1, readyState: 1,
data: { events: { connection: "a" } }, data: { events: { connection: "a" } },
send: (data: unknown) => { send: (data: unknown) => {
outA.push(typeof data === "string" ? data : Buffer.from(data as Uint8Array).toString("utf8")) outA.push(typeof data === "string" ? data : Buffer.from(data as Uint8Array).toString("utf8"))
}, },
close: () => { close: () => {
// no-op (simulate abrupt drop) // no-op (simulate abrupt drop)
}, },
} }
// Connect "a" first. yield* pty.connect(a.id, ws as any)
Pty.connect(a.id, ws as any) outA.length = 0
outA.length = 0
// Simulate Bun reusing the same websocket object for another ws.data = { events: { connection: "b" } }
// connection before the next onOpen calls Pty.connect. ws.send = (data: unknown) => {
ws.data = { events: { connection: "b" } } outB.push(typeof data === "string" ? data : Buffer.from(data as Uint8Array).toString("utf8"))
ws.send = (data: unknown) => { }
outB.push(typeof data === "string" ? data : Buffer.from(data as Uint8Array).toString("utf8"))
}
Pty.write(a.id, "AAA\n") yield* pty.write(a.id, "AAA\n")
await sleep(100) yield* Effect.promise(() => sleep(100))
expect(outB.join("")).not.toContain("AAA") expect(outB.join("")).not.toContain("AAA")
} finally { } finally {
await Pty.remove(a.id) yield* pty.remove(a.id)
} }
}, }),
),
}) })
}) })
@@ -104,38 +107,40 @@ describe("pty", () => {
await Instance.provide({ await Instance.provide({
directory: dir.path, directory: dir.path,
fn: async () => { fn: () =>
const a = await Pty.create({ command: "cat", title: "a" }) AppRuntime.runPromise(
try { Effect.gen(function* () {
const out: string[] = [] const pty = yield* Pty.Service
const a = yield* pty.create({ command: "cat", title: "a" })
try {
const out: string[] = []
const ctx = { connId: 1 } const ctx = { connId: 1 }
const ws = { const ws = {
readyState: 1, readyState: 1,
data: ctx, data: ctx,
send: (data: unknown) => { send: (data: unknown) => {
out.push(typeof data === "string" ? data : Buffer.from(data as Uint8Array).toString("utf8")) out.push(typeof data === "string" ? data : Buffer.from(data as Uint8Array).toString("utf8"))
}, },
close: () => { close: () => {
// no-op // no-op
}, },
} }
Pty.connect(a.id, ws as any) yield* pty.connect(a.id, ws as any)
out.length = 0 out.length = 0
// Mutating fields on ws.data should not look like a new ctx.connId = 2
// connection lifecycle when the object identity stays stable.
ctx.connId = 2
Pty.write(a.id, "AAA\n") yield* pty.write(a.id, "AAA\n")
await sleep(100) yield* Effect.promise(() => sleep(100))
expect(out.join("")).toContain("AAA") expect(out.join("")).toContain("AAA")
} finally { } finally {
await Pty.remove(a.id) yield* pty.remove(a.id)
} }
}, }),
),
}) })
}) })
}) })
packages/opencode/test/pty/pty-session.test.ts
+54 -44
View File
@@ -1,5 +1,7 @@
import { describe, expect, test } from "bun:test" import { describe, expect, test } from "bun:test"
import { AppRuntime } from "../../src/effect/app-runtime"
import { Bus } from "../../src/bus" import { Bus } from "../../src/bus"
import { Effect } from "effect"
import { Instance } from "../../src/project/instance" import { Instance } from "../../src/project/instance"
import { Pty } from "../../src/pty" import { Pty } from "../../src/pty"
import type { PtyID } from "../../src/pty/schema" import type { PtyID } from "../../src/pty/schema"
@@ -27,33 +29,37 @@ describe("pty", () => {
await Instance.provide({ await Instance.provide({
directory: dir.path, directory: dir.path,
fn: async () => { fn: () =>
const log: Array<{ type: "created" | "exited" | "deleted"; id: PtyID }> = [] AppRuntime.runPromise(
const off = [ Effect.gen(function* () {
Bus.subscribe(Pty.Event.Created, (evt) => log.push({ type: "created", id: evt.properties.info.id })), const pty = yield* Pty.Service
Bus.subscribe(Pty.Event.Exited, (evt) => log.push({ type: "exited", id: evt.properties.id })), const log: Array<{ type: "created" | "exited" | "deleted"; id: PtyID }> = []
Bus.subscribe(Pty.Event.Deleted, (evt) => log.push({ type: "deleted", id: evt.properties.id })), const off = [
] Bus.subscribe(Pty.Event.Created, (evt) => log.push({ type: "created", id: evt.properties.info.id })),
Bus.subscribe(Pty.Event.Exited, (evt) => log.push({ type: "exited", id: evt.properties.id })),
Bus.subscribe(Pty.Event.Deleted, (evt) => log.push({ type: "deleted", id: evt.properties.id })),
]
let id: PtyID | undefined let id: PtyID | undefined
try { try {
const info = await Pty.create({ const info = yield* pty.create({
command: "/usr/bin/env", command: "/usr/bin/env",
args: ["sh", "-c", "sleep 0.1"], args: ["sh", "-c", "sleep 0.1"],
title: "sleep", title: "sleep",
}) })
id = info.id id = info.id
await wait(() => pick(log, id!).includes("exited")) yield* Effect.promise(() => wait(() => pick(log, id!).includes("exited")))
await Pty.remove(id) yield* pty.remove(id)
await wait(() => pick(log, id!).length >= 3) yield* Effect.promise(() => wait(() => pick(log, id!).length >= 3))
expect(pick(log, id!)).toEqual(["created", "exited", "deleted"]) expect(pick(log, id!)).toEqual(["created", "exited", "deleted"])
} finally { } finally {
off.forEach((x) => x()) off.forEach((x) => x())
if (id) await Pty.remove(id) if (id) yield* pty.remove(id)
} }
}, }),
),
}) })
}) })
@@ -64,29 +70,33 @@ describe("pty", () => {
await Instance.provide({ await Instance.provide({
directory: dir.path, directory: dir.path,
fn: async () => { fn: () =>
const log: Array<{ type: "created" | "exited" | "deleted"; id: PtyID }> = [] AppRuntime.runPromise(
const off = [ Effect.gen(function* () {
Bus.subscribe(Pty.Event.Created, (evt) => log.push({ type: "created", id: evt.properties.info.id })), const pty = yield* Pty.Service
Bus.subscribe(Pty.Event.Exited, (evt) => log.push({ type: "exited", id: evt.properties.id })), const log: Array<{ type: "created" | "exited" | "deleted"; id: PtyID }> = []
Bus.subscribe(Pty.Event.Deleted, (evt) => log.push({ type: "deleted", id: evt.properties.id })), const off = [
] Bus.subscribe(Pty.Event.Created, (evt) => log.push({ type: "created", id: evt.properties.info.id })),
Bus.subscribe(Pty.Event.Exited, (evt) => log.push({ type: "exited", id: evt.properties.id })),
Bus.subscribe(Pty.Event.Deleted, (evt) => log.push({ type: "deleted", id: evt.properties.id })),
]
let id: PtyID | undefined let id: PtyID | undefined
try { try {
const info = await Pty.create({ command: "/bin/sh", title: "sh" }) const info = yield* pty.create({ command: "/bin/sh", title: "sh" })
id = info.id id = info.id
await sleep(100) yield* Effect.promise(() => sleep(100))
await Pty.remove(id) yield* pty.remove(id)
await wait(() => pick(log, id!).length >= 3) yield* Effect.promise(() => wait(() => pick(log, id!).length >= 3))
expect(pick(log, id!)).toEqual(["created", "exited", "deleted"]) expect(pick(log, id!)).toEqual(["created", "exited", "deleted"])
} finally { } finally {
off.forEach((x) => x()) off.forEach((x) => x())
if (id) await Pty.remove(id) if (id) yield* pty.remove(id)
} }
}, }),
),
}) })
}) })
}) })
packages/opencode/test/pty/pty-shell.test.ts
+26 -16
View File
@@ -1,4 +1,6 @@
import { describe, expect, test } from "bun:test" import { describe, expect, test } from "bun:test"
import { AppRuntime } from "../../src/effect/app-runtime"
import { Effect } from "effect"
import { Instance } from "../../src/project/instance" import { Instance } from "../../src/project/instance"
import { Pty } from "../../src/pty" import { Pty } from "../../src/pty"
import { Shell } from "../../src/shell/shell" import { Shell } from "../../src/shell/shell"
@@ -17,14 +19,18 @@ describe("pty shell args", () => {
await using dir = await tmpdir() await using dir = await tmpdir()
await Instance.provide({ await Instance.provide({
directory: dir.path, directory: dir.path,
fn: async () => { fn: () =>
const info = await Pty.create({ command: ps, title: "pwsh" }) AppRuntime.runPromise(
try { Effect.gen(function* () {
expect(info.args).toEqual([]) const pty = yield* Pty.Service
} finally { const info = yield* pty.create({ command: ps, title: "pwsh" })
await Pty.remove(info.id) try {
} expect(info.args).toEqual([])
}, } finally {
yield* pty.remove(info.id)
}
}),
),
}) })
}, },
{ timeout: 30000 }, { timeout: 30000 },
@@ -43,14 +49,18 @@ describe("pty shell args", () => {
await using dir = await tmpdir() await using dir = await tmpdir()
await Instance.provide({ await Instance.provide({
directory: dir.path, directory: dir.path,
fn: async () => { fn: () =>
const info = await Pty.create({ command: bash, title: "bash" }) AppRuntime.runPromise(
try { Effect.gen(function* () {
expect(info.args).toEqual(["-l"]) const pty = yield* Pty.Service
} finally { const info = yield* pty.create({ command: bash, title: "bash" })
await Pty.remove(info.id) try {
} expect(info.args).toEqual(["-l"])
}, } finally {
yield* pty.remove(info.id)
}
}),
),
}) })
}, },
{ timeout: 30000 }, { timeout: 30000 },