mirror of
https://github.com/anomalyco/opencode.git
synced 2026-07-28 13:46:15 +00:00
Compare commits
2
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
d304812b0c | ||
|
|
78797fb9b2 |
@@ -1,17 +1,57 @@
|
||||
# @opencode-ai/client
|
||||
|
||||
Private generation target for clients derived directly from OpenCode's authoritative Effect `HttpApi`.
|
||||
Promise and Effect clients derived from OpenCode's authoritative Effect `HttpApi`, plus handwritten Node transports.
|
||||
|
||||
## Entrypoints
|
||||
|
||||
- `@opencode-ai/client`: zero-Effect Promise client using `fetch`.
|
||||
- `@opencode-ai/client/node`: Promise client plus Node-hosted browser attachments.
|
||||
- `@opencode-ai/client/effect`: rich Effect network client using an environment-provided `HttpClient`.
|
||||
|
||||
The generated surface includes every standard HTTP group from Server's concrete API. The build compiler reads `@opencode-ai/server/api`; the generated Effect runtime imports a client-local projection built from Protocol, with a generation-equivalence test preventing transport drift. Custom transports such as the PTY WebSocket connection remain outside the generic HTTP client. Run `bun run generate` after changing the contract and `bun run check:generated` to detect committed-output drift.
|
||||
|
||||
The Effect entrypoint uses canonical decoded values such as `Session.ID`, `Location.Ref`, and `Prompt`. These datatypes come from the lightweight `@opencode-ai/schema` package and are re-exported so callers depend only on the client surface. Protocol owns endpoint construction and middleware placement; Server supplies the concrete middleware keys used by the build-time API.
|
||||
|
||||
The Promise root remains structural and has no Core or Effect runtime dependency. `/effect` depends only on Effect, Schema, and Protocol and is browser-bundle safe. Bundle-boundary tests enforce both import graphs.
|
||||
The Promise root remains structural and has no Core, Effect, Schema, Protocol, or WebSocket runtime dependency. `/node` adds Effect, Schema, Protocol, and `ws`, but never Core or Server. `/effect` depends only on Effect, Schema, and Protocol and is browser-bundle safe. Bundle-boundary tests enforce these import graphs.
|
||||
|
||||
## Node browser attachments
|
||||
|
||||
The Node entrypoint owns the control connection, Session lease, authenticated proxy, and network tunnels. Consumers provide a browser adapter once with `BrowserDriver.define`; normal attachment calls only provide a Session ID and that descriptor.
|
||||
|
||||
```ts
|
||||
import { BrowserDriver, BrowserDriverError, OpenCode } from "@opencode-ai/client/node"
|
||||
|
||||
const driver = BrowserDriver.define(async ({ proxy, signal }) => {
|
||||
const browser = await launchBrowser({ proxy, signal })
|
||||
return {
|
||||
resource: browser,
|
||||
state: () => browser.state(),
|
||||
subscribe: (listener) => browser.subscribe(listener),
|
||||
execute: async (command, options) => {
|
||||
try {
|
||||
return await browser.execute(command, options)
|
||||
} catch (cause) {
|
||||
throw new BrowserDriverError("internal", "Browser command failed", { cause })
|
||||
}
|
||||
},
|
||||
dispose: () => browser.close(),
|
||||
}
|
||||
})
|
||||
|
||||
const client = OpenCode.make({
|
||||
baseUrl: "https://opencode.example",
|
||||
headers: { authorization: `Basic ${credentials}` },
|
||||
})
|
||||
const attachment = await client.browser.attach({ sessionID, driver })
|
||||
|
||||
await attachment.close()
|
||||
```
|
||||
|
||||
`attach` resolves only after the server acknowledges the exact Session lease. Each attachment has its own proxy and driver resource; `close()` and `Symbol.asyncDispose` are idempotent. A single Node client multiplexes up to 16 distinct Sessions over one lazily opened control WebSocket.
|
||||
|
||||
Driver factories should return after configuring their resource rather than await a proxied navigation: tunnel dialing is deliberately held behind the first lease acknowledgement, which is published after the driver supplies its initial state.
|
||||
|
||||
`BrowserDriver` descriptors are structural factory functions, so adapters remain compatible across duplicate client package instances. The Node entrypoint also re-exports canonical `Browser` contracts. Throw `BrowserDriverError` for typed command failures; structurally equivalent errors are accepted only when their `code` is a valid `Browser.ErrorCode`.
|
||||
|
||||
Effect consumers construct canonical decoded inputs:
|
||||
|
||||
|
||||
@@ -17,6 +17,7 @@
|
||||
],
|
||||
"exports": {
|
||||
".": "./src/promise/index.ts",
|
||||
"./node": "./src/node/index.ts",
|
||||
"./promise": "./src/promise/index.ts",
|
||||
"./promise/api": "./src/promise/api.ts",
|
||||
"./service": "./src/promise/service.ts",
|
||||
@@ -28,12 +29,14 @@
|
||||
"build": "bun run script/build-package.ts",
|
||||
"generate": "bun run script/build.ts",
|
||||
"check:generated": "bun run generate && git diff --exit-code -- src/promise/generated src/effect/generated src/effect/api",
|
||||
"test": "bun test --timeout 5000",
|
||||
"typecheck": "tsgo --noEmit"
|
||||
"test": "bun test --timeout 5000 && bun run test:node-package",
|
||||
"test:node-package": "bun test ./test/node/package-smoke.ts --timeout 60000",
|
||||
"typecheck": "tsgo --noEmit && tsgo -p test/types/tsconfig.json --noEmit && tsgo -p test/types/tsconfig.nodenext.json --noEmit"
|
||||
},
|
||||
"dependencies": {
|
||||
"@opencode-ai/schema": "workspace:*",
|
||||
"@opencode-ai/protocol": "workspace:*"
|
||||
"@opencode-ai/protocol": "workspace:*",
|
||||
"ws": "8.21.0"
|
||||
},
|
||||
"peerDependencies": {
|
||||
"effect": "4.0.0-beta.101"
|
||||
@@ -48,6 +51,7 @@
|
||||
"@opencode-ai/httpapi-codegen": "workspace:*",
|
||||
"@tsconfig/bun": "catalog:",
|
||||
"@types/bun": "catalog:",
|
||||
"@types/ws": "8.18.1",
|
||||
"@typescript/native-preview": "catalog:",
|
||||
"effect": "catalog:"
|
||||
}
|
||||
|
||||
@@ -7,3 +7,4 @@ process.chdir(fileURLToPath(new URL("..", import.meta.url)))
|
||||
|
||||
await $`rm -rf dist`
|
||||
await $`bun tsc -p tsconfig.build.json`
|
||||
await $`bun build src/node/index.ts --outfile dist/node/index.js --target=node --format=esm --packages=external`
|
||||
|
||||
@@ -3,7 +3,7 @@ import { Effect, Stream, Schema } from "effect"
|
||||
import { Sse } from "effect/unstable/encoding"
|
||||
import { HttpClientError } from "effect/unstable/http"
|
||||
import { HttpApiClient } from "effect/unstable/httpapi"
|
||||
import { ClientApi } from "../../contract"
|
||||
import { ClientApi } from "../../contract.js"
|
||||
import type {
|
||||
Endpoint0_0Output,
|
||||
Endpoint0_1Input,
|
||||
@@ -218,7 +218,7 @@ import type {
|
||||
Endpoint27_1Input,
|
||||
Endpoint27_1Output,
|
||||
} from "../api/api.js"
|
||||
import { ClientError } from "./client-error"
|
||||
import { ClientError } from "./client-error.js"
|
||||
|
||||
type RawClient = HttpApiClient.ForApi<typeof ClientApi>
|
||||
|
||||
|
||||
@@ -1,2 +1,2 @@
|
||||
export { ClientError } from "./client-error"
|
||||
export * as OpenCode from "./client"
|
||||
export { ClientError } from "./client-error.js"
|
||||
export * as OpenCode from "./client.js"
|
||||
|
||||
@@ -0,0 +1,639 @@
|
||||
import { BrowserControlProtocol } from "@opencode-ai/protocol/browser-control"
|
||||
import { BROWSER_CONTROL_PROTOCOL } from "@opencode-ai/protocol/groups/browser"
|
||||
import { Browser } from "@opencode-ai/schema/browser"
|
||||
import { BrowserControl } from "@opencode-ai/schema/browser-control"
|
||||
import { Session } from "@opencode-ai/schema/session"
|
||||
import { Effect, Schema } from "effect"
|
||||
import WebSocket from "ws"
|
||||
import type { ClientOptions } from "../../promise/generated/client.js"
|
||||
import {
|
||||
browserDriverFactory,
|
||||
type BrowserDriver,
|
||||
type BrowserDriverContext,
|
||||
type BrowserDriverInstance,
|
||||
type BrowserProxy,
|
||||
} from "./driver.js"
|
||||
import { createBrowserProxy } from "./proxy.js"
|
||||
import { openBrowserTunnel, type BrowserTunnelEndpoint } from "./tunnel.js"
|
||||
|
||||
export interface BrowserAttachOptions<Resource> {
|
||||
readonly sessionID: string
|
||||
readonly driver: BrowserDriver<Resource>
|
||||
readonly signal?: AbortSignal
|
||||
}
|
||||
|
||||
export interface BrowserAttachment<Resource> extends AsyncDisposable {
|
||||
readonly resource: Resource
|
||||
readonly close: () => Promise<void>
|
||||
}
|
||||
|
||||
export interface BrowserClient {
|
||||
readonly attach: <Resource>(options: BrowserAttachOptions<Resource>) => Promise<BrowserAttachment<Resource>>
|
||||
}
|
||||
|
||||
type ProxyServer = Awaited<ReturnType<typeof createBrowserProxy>>
|
||||
|
||||
type AttachmentRecord = {
|
||||
readonly sessionID: Session.ID
|
||||
readonly leaseID: Browser.LeaseID
|
||||
readonly abort: AbortController
|
||||
readonly setup: Promise<void>
|
||||
readonly finishSetup: () => void
|
||||
readonly externalSignal?: AbortSignal
|
||||
externalAbort?: () => void
|
||||
active: boolean
|
||||
closed: boolean
|
||||
state?: Browser.State
|
||||
execute?: BrowserDriverInstance<unknown>["execute"]
|
||||
dispose?: BrowserDriverInstance<unknown>["dispose"]
|
||||
unsubscribe?: () => void
|
||||
proxy?: ProxyServer
|
||||
closing?: Promise<void>
|
||||
}
|
||||
|
||||
type ActiveAttachment = AttachmentRecord & {
|
||||
readonly active: true
|
||||
readonly state: Browser.State
|
||||
readonly execute: BrowserDriverInstance<unknown>["execute"]
|
||||
}
|
||||
|
||||
type Waiter = {
|
||||
readonly key: string
|
||||
readonly signal: AbortSignal
|
||||
readonly resolve: () => void
|
||||
readonly reject: (error: Error) => void
|
||||
readonly abort: () => void
|
||||
}
|
||||
|
||||
/** Creates the Node-only browser host attached to one immutable server endpoint. */
|
||||
export function createBrowserClient(options: ClientOptions): BrowserClient {
|
||||
const control = new BrowserClientControl(endpoint(options))
|
||||
return { attach: (input) => control.attach(input) }
|
||||
}
|
||||
|
||||
class BrowserClientControl {
|
||||
private readonly records = new Map<Session.ID, AttachmentRecord>()
|
||||
private readonly requests = new Map<
|
||||
BrowserControl.RequestID,
|
||||
{ readonly leaseID: Browser.LeaseID; readonly abort: AbortController }
|
||||
>()
|
||||
private readonly waiters = new Set<Waiter>()
|
||||
private socket?: WebSocket
|
||||
private retry?: ReturnType<typeof setTimeout>
|
||||
private retryAttempt = 0
|
||||
private revision = 0
|
||||
private ready = false
|
||||
private opening?: Promise<void>
|
||||
private openingAbort?: AbortController
|
||||
private synced?: string
|
||||
private syncing?: { readonly revision: number; readonly snapshot: string; readonly leases: Set<string> }
|
||||
private syncedLeases = new Set<string>()
|
||||
private inbound = Promise.resolve()
|
||||
private failing = false
|
||||
|
||||
constructor(private readonly server: BrowserTunnelEndpoint) {}
|
||||
|
||||
async attach<Resource>(input: BrowserAttachOptions<Resource>): Promise<BrowserAttachment<Resource>> {
|
||||
if (!Schema.is(Session.ID)(input.sessionID)) throw new TypeError("Browser attachment requires a valid Session ID")
|
||||
if (input.signal?.aborted) throw abortError(input.signal, "Browser attachment was aborted")
|
||||
const sessionID = Session.ID.make(input.sessionID)
|
||||
if (this.records.has(sessionID)) throw new Error(`Browser is already attached to Session ${sessionID}`)
|
||||
if (this.records.size >= 16) throw new Error("A Node client cannot attach more than 16 browser Sessions")
|
||||
|
||||
let finishSetup!: () => void
|
||||
const setup = new Promise<void>((resolve) => {
|
||||
finishSetup = resolve
|
||||
})
|
||||
const record: AttachmentRecord = {
|
||||
sessionID,
|
||||
leaseID: Browser.LeaseID.create(),
|
||||
abort: new AbortController(),
|
||||
setup,
|
||||
finishSetup,
|
||||
externalSignal: input.signal,
|
||||
active: false,
|
||||
closed: false,
|
||||
}
|
||||
this.records.set(sessionID, record)
|
||||
record.externalAbort = () => {
|
||||
void this.close(record, abortError(input.signal, "Browser attachment was aborted")).catch(() => undefined)
|
||||
}
|
||||
input.signal?.addEventListener("abort", record.externalAbort, { once: true })
|
||||
|
||||
try {
|
||||
record.proxy = await createBrowserProxy({
|
||||
connect: async (target, signal) => {
|
||||
await this.waitForAttachment(record, signal)
|
||||
const tunnelSignal = AbortSignal.any([signal, record.abort.signal])
|
||||
if (tunnelSignal.aborted) throw abortError(tunnelSignal, "Browser tunnel was aborted")
|
||||
return openBrowserTunnel({
|
||||
endpoint: this.server,
|
||||
sessionID: record.sessionID,
|
||||
leaseID: record.leaseID,
|
||||
target,
|
||||
signal: tunnelSignal,
|
||||
})
|
||||
},
|
||||
})
|
||||
this.requireOpen(record)
|
||||
|
||||
const instance = await createDriver(
|
||||
input.driver,
|
||||
{ proxy: exposedProxy(record.proxy), signal: record.abort.signal },
|
||||
record.abort.signal,
|
||||
)
|
||||
if (instance !== null && typeof instance === "object" && typeof instance.dispose === "function") {
|
||||
record.dispose = () => instance.dispose()
|
||||
}
|
||||
if (
|
||||
instance === null ||
|
||||
typeof instance !== "object" ||
|
||||
typeof instance.state !== "function" ||
|
||||
typeof instance.subscribe !== "function" ||
|
||||
typeof instance.execute !== "function" ||
|
||||
typeof instance.dispose !== "function"
|
||||
) {
|
||||
throw new TypeError("Browser driver factory returned an invalid driver instance")
|
||||
}
|
||||
record.execute = (command, options) => instance.execute(command, options)
|
||||
|
||||
let receivedState = false
|
||||
record.unsubscribe = instance.subscribe((state) => {
|
||||
if (record.closed) return
|
||||
const next = contractState(state)
|
||||
if (!next) {
|
||||
void this.close(record, new TypeError("Browser driver published an invalid state")).catch(() => undefined)
|
||||
return
|
||||
}
|
||||
receivedState = true
|
||||
record.state = next
|
||||
if (record.active) this.changed()
|
||||
})
|
||||
if (typeof record.unsubscribe !== "function") {
|
||||
throw new TypeError("Browser driver subscribe must return an unsubscribe function")
|
||||
}
|
||||
const initial = contractState(instance.state())
|
||||
if (!initial) throw new TypeError("Browser driver returned an invalid initial state")
|
||||
if (!receivedState) record.state = initial
|
||||
this.requireOpen(record)
|
||||
|
||||
record.active = true
|
||||
this.changed()
|
||||
record.finishSetup()
|
||||
await this.waitForAttachment(record, record.abort.signal)
|
||||
this.requireOpen(record)
|
||||
|
||||
const close = () => this.close(record)
|
||||
return Object.freeze({
|
||||
resource: instance.resource,
|
||||
close,
|
||||
[Symbol.asyncDispose]: close,
|
||||
})
|
||||
} catch (error) {
|
||||
record.finishSetup()
|
||||
await this.close(record).catch(() => undefined)
|
||||
throw error
|
||||
}
|
||||
}
|
||||
|
||||
private close(record: AttachmentRecord, reason = new Error("Browser attachment was closed")) {
|
||||
if (!record.closed) {
|
||||
record.closed = true
|
||||
record.active = false
|
||||
if (this.records.get(record.sessionID) === record) this.records.delete(record.sessionID)
|
||||
record.abort.abort(reason)
|
||||
this.syncedLeases.delete(attachmentKey(record.sessionID, record.leaseID))
|
||||
this.rejectAttachmentWaiters(record, reason)
|
||||
this.abortRequests(record.leaseID)
|
||||
this.changed()
|
||||
}
|
||||
if (record.closing) return record.closing
|
||||
record.closing = record.setup.then(async () => {
|
||||
if (record.externalAbort) record.externalSignal?.removeEventListener("abort", record.externalAbort)
|
||||
const unsubscribe = await cleanup(() => record.unsubscribe?.())
|
||||
const dispose = await cleanup(() => record.dispose?.())
|
||||
const proxy = await cleanup(() => record.proxy?.close())
|
||||
const failure = [unsubscribe, dispose, proxy].find(
|
||||
(result): result is { readonly ok: false; readonly error: unknown } => !result.ok,
|
||||
)
|
||||
if (failure) throw failure.error
|
||||
})
|
||||
return record.closing
|
||||
}
|
||||
|
||||
private requireOpen(record: AttachmentRecord) {
|
||||
if (!record.closed && !record.abort.signal.aborted) return
|
||||
throw abortError(record.abort.signal, "Browser attachment was closed")
|
||||
}
|
||||
|
||||
private changed() {
|
||||
if (this.failing) return
|
||||
if (this.attachments().length === 0) {
|
||||
this.stopControl()
|
||||
return
|
||||
}
|
||||
this.connect()
|
||||
this.publish()
|
||||
}
|
||||
|
||||
private attachments() {
|
||||
return [...this.records.values()].filter(
|
||||
(record): record is ActiveAttachment =>
|
||||
record.active && record.state !== undefined && record.execute !== undefined && !record.closed,
|
||||
)
|
||||
}
|
||||
|
||||
private connect() {
|
||||
if (this.socket || this.retry || this.opening || this.attachments().length === 0) return
|
||||
const abort = new AbortController()
|
||||
this.openingAbort = abort
|
||||
this.opening = this.open(abort.signal)
|
||||
.catch((error) => this.failControl(error instanceof Error ? error : new Error(String(error))))
|
||||
.finally(() => {
|
||||
if (this.openingAbort !== abort) return
|
||||
this.openingAbort = undefined
|
||||
this.opening = undefined
|
||||
})
|
||||
}
|
||||
|
||||
private async open(lifetime: AbortSignal) {
|
||||
if (process.versions.bun) {
|
||||
// TODO: Remove the HTTP auth probe once Bun exposes ws upgrade responses.
|
||||
// https://github.com/oven-sh/bun/issues/5951
|
||||
const signal = AbortSignal.any([lifetime, AbortSignal.timeout(10_000)])
|
||||
const response = await (this.server.fetch ?? globalThis.fetch)(new URL("/api/health", this.server.url), {
|
||||
headers: this.server.authorization ? { Authorization: this.server.authorization } : undefined,
|
||||
signal,
|
||||
}).catch(() => undefined)
|
||||
if (lifetime.aborted) return
|
||||
if (!response) {
|
||||
this.scheduleReconnect()
|
||||
return
|
||||
}
|
||||
if (response.status === 401 || response.status === 403) {
|
||||
this.failControl(new Error(`Browser control connection was rejected with HTTP ${response.status}`))
|
||||
return
|
||||
}
|
||||
}
|
||||
if (this.socket || this.retry || this.attachments().length === 0) return
|
||||
const socket = new WebSocket(controlURL(this.server), BROWSER_CONTROL_PROTOCOL, {
|
||||
...(this.server.authorization ? { headers: { Authorization: this.server.authorization } } : {}),
|
||||
handshakeTimeout: 10_000,
|
||||
maxPayload: BrowserControlProtocol.MaxMessageBytes,
|
||||
perMessageDeflate: false,
|
||||
followRedirects: false,
|
||||
})
|
||||
this.socket = socket
|
||||
socket.on("message", (data, binary) => {
|
||||
if (socket !== this.socket) return
|
||||
this.inbound = this.inbound.then(
|
||||
() => this.receive(socket, data, binary),
|
||||
() => this.receive(socket, data, binary),
|
||||
)
|
||||
})
|
||||
socket.on("error", (error) => {
|
||||
if (socket !== this.socket) return
|
||||
const status = /^Unexpected server response: (401|403|426)$/.exec(error.message)?.[1]
|
||||
if (status) this.failControl(new Error(`Browser control connection was rejected with HTTP ${status}`))
|
||||
})
|
||||
if (!process.versions.bun) {
|
||||
socket.on("unexpected-response", (_request, response) => {
|
||||
response.resume()
|
||||
if (socket !== this.socket) return
|
||||
if (response.statusCode === 401 || response.statusCode === 403 || response.statusCode === 426) {
|
||||
this.failControl(new Error(`Browser control connection was rejected with HTTP ${response.statusCode}`))
|
||||
return
|
||||
}
|
||||
socket.terminate()
|
||||
})
|
||||
}
|
||||
socket.on("close", (code, reason) => {
|
||||
if (socket !== this.socket) return
|
||||
if (code === 1002 || code === 1007 || code === 1009) {
|
||||
this.failControl(controlCloseError(code, reason))
|
||||
return
|
||||
}
|
||||
this.socket = undefined
|
||||
this.resetConnection()
|
||||
this.scheduleReconnect()
|
||||
})
|
||||
}
|
||||
|
||||
private async receive(socket: WebSocket, data: WebSocket.RawData, binary: boolean) {
|
||||
if (binary) return this.protocolError(socket)
|
||||
const decoded = await Effect.runPromise(BrowserControlProtocol.decodeFromServer(rawData(data))).catch(
|
||||
() => undefined,
|
||||
)
|
||||
if (!decoded || socket !== this.socket) return this.protocolError(socket)
|
||||
if (decoded.type === "browser.control.ready") {
|
||||
if (this.ready) return this.protocolError(socket)
|
||||
this.ready = true
|
||||
this.publish()
|
||||
return
|
||||
}
|
||||
if (!this.ready) return this.protocolError(socket)
|
||||
if (decoded.type === "browser.control.synced") {
|
||||
if (!this.syncing || this.syncing.revision !== decoded.revision) return this.protocolError(socket)
|
||||
this.synced = this.syncing.snapshot
|
||||
this.syncedLeases = this.syncing.leases
|
||||
this.syncing = undefined
|
||||
this.retryAttempt = 0
|
||||
this.resolveWaiters()
|
||||
this.publish()
|
||||
return
|
||||
}
|
||||
if (decoded.type === "browser.control.cancel") {
|
||||
const request = this.requests.get(decoded.requestID)
|
||||
if (!request) return
|
||||
if (request.leaseID !== decoded.leaseID) return this.protocolError(socket)
|
||||
this.requests.delete(decoded.requestID)
|
||||
request.abort.abort(new Error("Browser command was cancelled"))
|
||||
return
|
||||
}
|
||||
void this.request(socket, decoded)
|
||||
}
|
||||
|
||||
private publish() {
|
||||
const socket = this.socket
|
||||
if (!socket || socket.readyState !== WebSocket.OPEN || !this.ready || this.syncing) return
|
||||
const attachments = this.attachments().map((record) => ({
|
||||
sessionID: record.sessionID,
|
||||
leaseID: record.leaseID,
|
||||
state: record.state,
|
||||
}))
|
||||
const snapshot = JSON.stringify(attachments)
|
||||
if (snapshot === this.synced) return
|
||||
const revision = this.revision++
|
||||
this.syncing = {
|
||||
revision,
|
||||
snapshot,
|
||||
leases: new Set(attachments.map((attachment) => attachmentKey(attachment.sessionID, attachment.leaseID))),
|
||||
}
|
||||
this.send(socket, { type: "browser.control.sync", revision, attachments })
|
||||
}
|
||||
|
||||
private async request(socket: WebSocket, message: BrowserControl.Request) {
|
||||
if (this.requests.has(message.requestID)) return this.protocolError(socket)
|
||||
const record = this.records.get(message.sessionID)
|
||||
if (!record?.active || record.closed || record.leaseID !== message.leaseID || !record.execute) {
|
||||
this.send(socket, {
|
||||
type: "browser.control.response",
|
||||
requestID: message.requestID,
|
||||
leaseID: message.leaseID,
|
||||
outcome: { type: "failure", code: "not_attached", message: "The browser attachment is no longer available." },
|
||||
})
|
||||
return
|
||||
}
|
||||
|
||||
const abort = new AbortController()
|
||||
this.requests.set(message.requestID, { leaseID: message.leaseID, abort })
|
||||
const outcome = await Promise.resolve()
|
||||
.then(() => record.execute?.(message.command, { signal: abort.signal }))
|
||||
.then(
|
||||
(result): Browser.Outcome => {
|
||||
if (!Schema.is(Browser.Result)(result) || result.type !== message.command.type) {
|
||||
return { type: "failure", code: "protocol", message: "Browser driver returned an invalid command result." }
|
||||
}
|
||||
return { type: "success", result }
|
||||
},
|
||||
(error): Browser.Outcome => driverFailure(error),
|
||||
)
|
||||
if (this.requests.get(message.requestID)?.abort !== abort) return
|
||||
this.requests.delete(message.requestID)
|
||||
if (socket !== this.socket) return
|
||||
this.send(socket, {
|
||||
type: "browser.control.response",
|
||||
requestID: message.requestID,
|
||||
leaseID: message.leaseID,
|
||||
outcome,
|
||||
})
|
||||
if (outcome.type === "success") {
|
||||
const state = contractState(outcome.result.state)
|
||||
if (state) {
|
||||
record.state = state
|
||||
this.changed()
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
private send(socket: WebSocket, message: BrowserControl.FromDesktop) {
|
||||
if (socket !== this.socket || socket.readyState !== WebSocket.OPEN) return
|
||||
socket.send(BrowserControlProtocol.encodeFromDesktop(message), (error) => {
|
||||
if (error && socket === this.socket) socket.terminate()
|
||||
})
|
||||
}
|
||||
|
||||
private protocolError(socket: WebSocket) {
|
||||
if (socket.readyState === WebSocket.OPEN) socket.close(1002, "Invalid browser control message")
|
||||
else socket.terminate()
|
||||
}
|
||||
|
||||
private waitForAttachment(record: AttachmentRecord, signal: AbortSignal) {
|
||||
const key = attachmentKey(record.sessionID, record.leaseID)
|
||||
if (record.closed || this.records.get(record.sessionID) !== record) {
|
||||
return Promise.reject(new Error("Browser attachment is no longer available"))
|
||||
}
|
||||
if (record.active && this.syncedLeases.has(key)) return Promise.resolve()
|
||||
if (signal.aborted) return Promise.reject(abortError(signal, "Browser attachment wait was aborted"))
|
||||
return new Promise<void>((resolve, reject) => {
|
||||
const waiter: Waiter = {
|
||||
key,
|
||||
signal,
|
||||
resolve,
|
||||
reject,
|
||||
abort: () => {
|
||||
this.waiters.delete(waiter)
|
||||
reject(abortError(signal, "Browser attachment wait was aborted"))
|
||||
},
|
||||
}
|
||||
signal.addEventListener("abort", waiter.abort, { once: true })
|
||||
this.waiters.add(waiter)
|
||||
})
|
||||
}
|
||||
|
||||
private resolveWaiters() {
|
||||
for (const waiter of this.waiters) {
|
||||
if (!this.syncedLeases.has(waiter.key)) continue
|
||||
const record = [...this.records.values()].find(
|
||||
(item) => !item.closed && item.active && attachmentKey(item.sessionID, item.leaseID) === waiter.key,
|
||||
)
|
||||
if (!record) continue
|
||||
this.waiters.delete(waiter)
|
||||
waiter.signal.removeEventListener("abort", waiter.abort)
|
||||
waiter.resolve()
|
||||
}
|
||||
}
|
||||
|
||||
private rejectAttachmentWaiters(record: AttachmentRecord, error: Error) {
|
||||
const key = attachmentKey(record.sessionID, record.leaseID)
|
||||
for (const waiter of this.waiters) {
|
||||
if (waiter.key !== key) continue
|
||||
this.waiters.delete(waiter)
|
||||
waiter.signal.removeEventListener("abort", waiter.abort)
|
||||
waiter.reject(error)
|
||||
}
|
||||
}
|
||||
|
||||
private abortRequests(leaseID?: Browser.LeaseID) {
|
||||
for (const [requestID, request] of this.requests) {
|
||||
if (leaseID && request.leaseID !== leaseID) continue
|
||||
this.requests.delete(requestID)
|
||||
request.abort.abort(new Error("Browser command was aborted"))
|
||||
}
|
||||
}
|
||||
|
||||
private stopControl() {
|
||||
this.openingAbort?.abort()
|
||||
this.openingAbort = undefined
|
||||
this.opening = undefined
|
||||
if (this.retry) clearTimeout(this.retry)
|
||||
this.retry = undefined
|
||||
const socket = this.socket
|
||||
this.socket = undefined
|
||||
this.resetConnection()
|
||||
socket?.terminate()
|
||||
}
|
||||
|
||||
private failControl(error: Error) {
|
||||
this.failing = true
|
||||
this.stopControl()
|
||||
this.retryAttempt = 0
|
||||
const records = [...this.records.values()]
|
||||
records.forEach((record) => {
|
||||
void this.close(record, error).catch(() => undefined)
|
||||
})
|
||||
this.failing = false
|
||||
}
|
||||
|
||||
private resetConnection() {
|
||||
this.ready = false
|
||||
this.synced = undefined
|
||||
this.syncedLeases.clear()
|
||||
this.syncing = undefined
|
||||
this.revision = 0
|
||||
this.abortRequests()
|
||||
}
|
||||
|
||||
private scheduleReconnect() {
|
||||
if (this.retry || this.attachments().length === 0) return
|
||||
const delay = Math.min(5_000, 100 * 2 ** this.retryAttempt++)
|
||||
this.retry = setTimeout(() => {
|
||||
this.retry = undefined
|
||||
this.connect()
|
||||
}, delay)
|
||||
this.retry.unref()
|
||||
}
|
||||
}
|
||||
|
||||
function createDriver<Resource>(driver: BrowserDriver<Resource>, context: BrowserDriverContext, signal: AbortSignal) {
|
||||
const creating = Promise.resolve().then(() => browserDriverFactory(driver)(context))
|
||||
return new Promise<BrowserDriverInstance<Resource>>((resolve, reject) => {
|
||||
let settled = false
|
||||
const abort = () => {
|
||||
if (settled) return
|
||||
settled = true
|
||||
signal.removeEventListener("abort", abort)
|
||||
reject(abortError(signal, "Browser driver creation was aborted"))
|
||||
}
|
||||
signal.addEventListener("abort", abort, { once: true })
|
||||
creating.then(
|
||||
(instance) => {
|
||||
if (settled) {
|
||||
void disposeLateDriver(instance)
|
||||
return
|
||||
}
|
||||
settled = true
|
||||
signal.removeEventListener("abort", abort)
|
||||
resolve(instance)
|
||||
},
|
||||
(error) => {
|
||||
if (settled) return
|
||||
settled = true
|
||||
signal.removeEventListener("abort", abort)
|
||||
reject(error)
|
||||
},
|
||||
)
|
||||
if (signal.aborted) abort()
|
||||
})
|
||||
}
|
||||
|
||||
async function disposeLateDriver(instance: unknown) {
|
||||
if (instance === null || typeof instance !== "object" || !("dispose" in instance)) return
|
||||
const dispose = instance.dispose
|
||||
if (typeof dispose !== "function") return
|
||||
await Promise.resolve()
|
||||
.then(() => dispose.call(instance))
|
||||
.catch(() => undefined)
|
||||
}
|
||||
|
||||
function cleanup(task: () => unknown) {
|
||||
return Promise.resolve()
|
||||
.then(task)
|
||||
.then(
|
||||
() => ({ ok: true as const }),
|
||||
(error: unknown) => ({ ok: false as const, error }),
|
||||
)
|
||||
}
|
||||
|
||||
function exposedProxy(proxy: ProxyServer): BrowserProxy {
|
||||
return Object.freeze({
|
||||
url: proxy.url,
|
||||
host: proxy.host,
|
||||
port: proxy.port,
|
||||
credentials: Object.freeze({ ...proxy.credentials }),
|
||||
certificateFingerprint: proxy.certificateFingerprint,
|
||||
})
|
||||
}
|
||||
|
||||
function contractState(state: Browser.State) {
|
||||
if (!Schema.is(Browser.State)(state)) return undefined
|
||||
return Object.freeze({ ...state })
|
||||
}
|
||||
|
||||
function driverFailure(error: unknown): Browser.Failure {
|
||||
return {
|
||||
type: "failure",
|
||||
code:
|
||||
error !== null && typeof error === "object" && "code" in error && Schema.is(Browser.ErrorCode)(error.code)
|
||||
? error.code
|
||||
: "internal",
|
||||
message: (error instanceof Error ? error.message : String(error)).slice(0, 1_024),
|
||||
}
|
||||
}
|
||||
|
||||
function endpoint(options: ClientOptions): BrowserTunnelEndpoint {
|
||||
const url = new URL(options.baseUrl)
|
||||
if ((url.protocol !== "http:" && url.protocol !== "https:") || url.username || url.password) {
|
||||
throw new TypeError("Browser server endpoint must be an HTTP URL without embedded credentials")
|
||||
}
|
||||
const authorization = new Headers(options.headers).get("authorization") ?? undefined
|
||||
return Object.freeze({ url: url.href, ...(authorization ? { authorization } : {}), fetch: options.fetch })
|
||||
}
|
||||
|
||||
function controlURL(endpoint: BrowserTunnelEndpoint) {
|
||||
const url = new URL(endpoint.url)
|
||||
url.protocol = url.protocol === "https:" ? "wss:" : "ws:"
|
||||
url.pathname = "/api/browser/control"
|
||||
url.search = ""
|
||||
url.hash = ""
|
||||
return url
|
||||
}
|
||||
|
||||
function attachmentKey(sessionID: string, leaseID: Browser.LeaseID) {
|
||||
return `${sessionID}\0${leaseID}`
|
||||
}
|
||||
|
||||
function abortError(signal: AbortSignal | undefined, message: string) {
|
||||
return signal?.reason instanceof Error ? signal.reason : new Error(message)
|
||||
}
|
||||
|
||||
function controlCloseError(code: number, reason: Buffer) {
|
||||
const detail = reason.toString("utf8").slice(0, 256)
|
||||
return new Error(`Browser control connection closed with fatal code ${code}${detail ? `: ${detail}` : ""}`)
|
||||
}
|
||||
|
||||
function rawData(data: WebSocket.RawData) {
|
||||
if (data instanceof ArrayBuffer) return new Uint8Array(data)
|
||||
if (Array.isArray(data)) return new Uint8Array(Buffer.concat(data))
|
||||
return new Uint8Array(data.buffer, data.byteOffset, data.byteLength)
|
||||
}
|
||||
@@ -0,0 +1,58 @@
|
||||
import type { Browser } from "@opencode-ai/schema/browser"
|
||||
|
||||
/** Connection details for the attachment's private authenticated proxy. */
|
||||
export interface BrowserProxy {
|
||||
readonly url: string
|
||||
readonly host: string
|
||||
readonly port: number
|
||||
readonly credentials: {
|
||||
readonly username: string
|
||||
readonly password: string
|
||||
}
|
||||
readonly certificateFingerprint: string
|
||||
}
|
||||
|
||||
export interface BrowserDriverContext {
|
||||
readonly proxy: BrowserProxy
|
||||
readonly signal: AbortSignal
|
||||
}
|
||||
|
||||
export interface BrowserDriverInstance<Resource> {
|
||||
readonly resource: Resource
|
||||
readonly state: () => Browser.State
|
||||
readonly subscribe: (listener: (state: Browser.State) => void) => () => void
|
||||
readonly execute: (command: Browser.Command, options: { readonly signal: AbortSignal }) => Promise<Browser.Result>
|
||||
readonly dispose: () => Promise<void> | void
|
||||
}
|
||||
|
||||
export type BrowserDriverFactory<Resource> = (
|
||||
context: BrowserDriverContext,
|
||||
) => Promise<BrowserDriverInstance<Resource>> | BrowserDriverInstance<Resource>
|
||||
|
||||
/** Error returned to the server when a browser adapter cannot execute a command. */
|
||||
export class BrowserDriverError extends Error {
|
||||
override readonly name = "BrowserDriverError"
|
||||
|
||||
constructor(
|
||||
readonly code: Browser.ErrorCode,
|
||||
message: string,
|
||||
options?: ErrorOptions,
|
||||
) {
|
||||
super(message, options)
|
||||
}
|
||||
}
|
||||
|
||||
/** Structural adapter descriptor, represented by its factory function. */
|
||||
export type BrowserDriver<Resource> = BrowserDriverFactory<Resource>
|
||||
|
||||
export const BrowserDriver = {
|
||||
define<Resource>(create: BrowserDriverFactory<Resource>): BrowserDriver<Resource> {
|
||||
if (typeof create !== "function") throw new TypeError("Browser driver factory must be a function")
|
||||
return Object.freeze(create)
|
||||
},
|
||||
}
|
||||
|
||||
export function browserDriverFactory<Resource>(driver: BrowserDriver<Resource>) {
|
||||
if (typeof driver !== "function") throw new TypeError("Browser driver must be a factory function")
|
||||
return driver
|
||||
}
|
||||
@@ -0,0 +1,118 @@
|
||||
import { createHash, createSign, generateKeyPairSync, randomBytes } from "node:crypto"
|
||||
|
||||
// Certificate construction follows VS Code's MIT-licensed tunnel proxy implementation.
|
||||
// Copyright (c) Microsoft Corporation.
|
||||
|
||||
/** Creates the ephemeral certificate pinned by the browser proxy's host. */
|
||||
export function createBrowserProxyCertificate(hostname: string) {
|
||||
const keys = generateKeyPairSync("ec", {
|
||||
namedCurve: "prime256v1",
|
||||
publicKeyEncoding: { type: "spki", format: "pem" },
|
||||
privateKeyEncoding: { type: "pkcs8", format: "pem" },
|
||||
})
|
||||
const certificate = createCertificate(keys.privateKey, keys.publicKey, hostname)
|
||||
const fingerprint = `sha256/${createHash("sha256").update(pemToDer(certificate)).digest("base64")}`
|
||||
return { key: keys.privateKey, certificate, fingerprint }
|
||||
}
|
||||
|
||||
function createCertificate(privateKey: string, publicKey: string, hostname: string) {
|
||||
const serial = randomBytes(8)
|
||||
serial[0] &= 0x7f
|
||||
if (serial.every((byte) => byte === 0)) serial[serial.length - 1] = 1
|
||||
const now = new Date(Date.now() - 60_000)
|
||||
const expires = new Date(now)
|
||||
expires.setUTCFullYear(expires.getUTCFullYear() + 1)
|
||||
const name = sequence([set([sequence([oid(Buffer.from([0x55, 0x04, 0x03])), utf8("OpenCode Browser Proxy")])])])
|
||||
const signatureAlgorithm = sequence([oid(Buffer.from([0x2a, 0x86, 0x48, 0xce, 0x3d, 0x04, 0x03, 0x02]))])
|
||||
const extensions = Buffer.concat([
|
||||
Buffer.from([0xa3]),
|
||||
lengthPrefix(
|
||||
sequence([
|
||||
sequence([
|
||||
oid(Buffer.from([0x55, 0x1d, 0x11])),
|
||||
octetString(
|
||||
sequence([tagged(0x82, Buffer.from(hostname, "ascii")), tagged(0x87, Buffer.from([127, 0, 0, 1]))]),
|
||||
),
|
||||
]),
|
||||
]),
|
||||
),
|
||||
])
|
||||
const body = sequence([
|
||||
Buffer.from([0xa0, 0x03, 0x02, 0x01, 0x02]),
|
||||
integer(serial),
|
||||
signatureAlgorithm,
|
||||
name,
|
||||
sequence([time(now), time(expires)]),
|
||||
name,
|
||||
pemToDer(publicKey),
|
||||
extensions,
|
||||
])
|
||||
const signer = createSign("SHA256")
|
||||
signer.update(body)
|
||||
const signature = signer.sign(privateKey)
|
||||
const certificate = sequence([
|
||||
body,
|
||||
signatureAlgorithm,
|
||||
Buffer.concat([Buffer.from([0x03]), length(signature.length + 1), Buffer.from([0]), signature]),
|
||||
])
|
||||
const encoded = certificate
|
||||
.toString("base64")
|
||||
.match(/.{1,64}/g)
|
||||
?.join("\n")
|
||||
if (!encoded) throw new Error("Failed to encode browser proxy certificate")
|
||||
return `-----BEGIN CERTIFICATE-----\n${encoded}\n-----END CERTIFICATE-----\n`
|
||||
}
|
||||
|
||||
function pemToDer(pem: string) {
|
||||
return Buffer.from(pem.replace(/-----[A-Z ]+-----/g, "").replaceAll(/\s/g, ""), "base64")
|
||||
}
|
||||
|
||||
function length(value: number) {
|
||||
if (value < 0x80) return Buffer.from([value])
|
||||
if (value < 0x100) return Buffer.from([0x81, value])
|
||||
if (value < 0x10000) return Buffer.from([0x82, value >> 8, value & 0xff])
|
||||
if (value < 0x1000000) return Buffer.from([0x83, value >> 16, (value >> 8) & 0xff, value & 0xff])
|
||||
throw new RangeError(`ASN.1 value is too large: ${value}`)
|
||||
}
|
||||
|
||||
function lengthPrefix(value: Buffer) {
|
||||
return Buffer.concat([length(value.length), value])
|
||||
}
|
||||
|
||||
function tagged(tag: number, value: Buffer) {
|
||||
return Buffer.concat([Buffer.from([tag]), lengthPrefix(value)])
|
||||
}
|
||||
|
||||
function sequence(items: ReadonlyArray<Buffer>) {
|
||||
return tagged(0x30, Buffer.concat(items))
|
||||
}
|
||||
|
||||
function set(items: ReadonlyArray<Buffer>) {
|
||||
return tagged(0x31, Buffer.concat(items))
|
||||
}
|
||||
|
||||
function integer(value: Buffer) {
|
||||
const first = value.findIndex(
|
||||
(byte, index) => byte !== 0 || index === value.length - 1 || (value[index + 1] & 0x80) !== 0,
|
||||
)
|
||||
const canonical = value.subarray(first < 0 ? value.length - 1 : first)
|
||||
return tagged(0x02, canonical[0] & 0x80 ? Buffer.concat([Buffer.from([0]), canonical]) : canonical)
|
||||
}
|
||||
|
||||
function oid(value: Buffer) {
|
||||
return tagged(0x06, value)
|
||||
}
|
||||
|
||||
function utf8(value: string) {
|
||||
return tagged(0x0c, Buffer.from(value, "utf8"))
|
||||
}
|
||||
|
||||
function octetString(value: Buffer) {
|
||||
return tagged(0x04, value)
|
||||
}
|
||||
|
||||
function time(value: Date) {
|
||||
const encoded = value.toISOString().replaceAll(/[-:T]/g, "")
|
||||
if (value.getUTCFullYear() < 2050) return tagged(0x17, Buffer.from(encoded.slice(2, 14) + "Z", "ascii"))
|
||||
return tagged(0x18, Buffer.from(encoded.slice(0, 14) + "Z", "ascii"))
|
||||
}
|
||||
@@ -0,0 +1,410 @@
|
||||
import { BrowserTunnel } from "@opencode-ai/schema/browser-tunnel"
|
||||
import { randomBytes, timingSafeEqual } from "node:crypto"
|
||||
import { once } from "node:events"
|
||||
import { Agent, request, type IncomingHttpHeaders, type IncomingMessage, type ServerResponse } from "node:http"
|
||||
import { createServer } from "node:https"
|
||||
import { Duplex } from "node:stream"
|
||||
import { createBrowserProxyCertificate } from "./proxy-certificate.js"
|
||||
|
||||
export type BrowserProxyConnector = (target: BrowserTunnel.Target, signal: AbortSignal) => Promise<Duplex>
|
||||
|
||||
/** Starts an authenticated TLS forward proxy whose target sockets can only come from the tunnel connector. */
|
||||
export async function createBrowserProxy(input: { readonly connect: BrowserProxyConnector }) {
|
||||
const candidate = `opencode-${randomBytes(16).toString("hex")}.localhost`
|
||||
const certificate = createBrowserProxyCertificate(candidate)
|
||||
const username = randomBytes(16).toString("hex")
|
||||
const password = randomBytes(32).toString("hex")
|
||||
const expectedAuthorization = Buffer.from(`Basic ${Buffer.from(`${username}:${password}`).toString("base64")}`)
|
||||
const clients = new Set<Duplex>()
|
||||
const tunnels = new Set<Duplex>()
|
||||
const pending = new Set<AbortController>()
|
||||
const limiter = connectionLimiter(6, 64)
|
||||
let closed = false
|
||||
|
||||
const connect = async (target: BrowserTunnel.Target, signal?: AbortSignal) => {
|
||||
if (closed) throw new Error("Browser proxy is closed")
|
||||
const abort = new AbortController()
|
||||
const cancel = () => abort.abort(signal?.reason)
|
||||
const done = () => {
|
||||
pending.delete(abort)
|
||||
signal?.removeEventListener("abort", cancel)
|
||||
}
|
||||
signal?.addEventListener("abort", cancel, { once: true })
|
||||
if (signal?.aborted) cancel()
|
||||
pending.add(abort)
|
||||
return limiter
|
||||
.run(() => input.connect(target, abort.signal), abort.signal)
|
||||
.then(
|
||||
(tunnel) => {
|
||||
done()
|
||||
if (closed || abort.signal.aborted) {
|
||||
tunnel.destroy()
|
||||
throw abort.signal.reason ?? new Error("Browser proxy is closed")
|
||||
}
|
||||
tunnels.add(tunnel)
|
||||
tunnel.once("close", () => tunnels.delete(tunnel))
|
||||
tunnel.on("error", () => tunnel.destroy())
|
||||
return tunnel
|
||||
},
|
||||
(error) => {
|
||||
done()
|
||||
throw error
|
||||
},
|
||||
)
|
||||
}
|
||||
|
||||
const authorized = (header: string | undefined) => {
|
||||
if (!header) return false
|
||||
const actual = Buffer.from(header)
|
||||
return actual.length === expectedAuthorization.length && timingSafeEqual(actual, expectedAuthorization)
|
||||
}
|
||||
|
||||
const server = createServer(
|
||||
{ key: certificate.key, cert: certificate.certificate, allowHalfOpen: true, maxHeaderSize: 64 * 1_024 },
|
||||
(incoming, response) => {
|
||||
void forward(incoming, response, connect, authorized).catch(() => response.destroy())
|
||||
},
|
||||
)
|
||||
server.requestTimeout = 30_000
|
||||
server.headersTimeout = 10_000
|
||||
server.keepAliveTimeout = 5_000
|
||||
server.maxRequestsPerSocket = 1_000
|
||||
server.on("connection", (socket) => {
|
||||
clients.add(socket)
|
||||
socket.once("close", () => clients.delete(socket))
|
||||
})
|
||||
server.on("connect", (incoming, socket, head) => {
|
||||
clients.add(socket)
|
||||
socket.once("close", () => clients.delete(socket))
|
||||
let established = false
|
||||
void (async () => {
|
||||
if (!authorized(singleHeader(incoming.headers["proxy-authorization"]))) {
|
||||
socket.end(
|
||||
'HTTP/1.1 407 Proxy Authentication Required\r\nProxy-Authenticate: Basic realm="OpenCode Browser Proxy"\r\nContent-Length: 0\r\nConnection: close\r\n\r\n',
|
||||
)
|
||||
return
|
||||
}
|
||||
const parsed = authority(incoming.url ?? "", 443)
|
||||
if (!parsed) {
|
||||
socket.end("HTTP/1.1 400 Bad Request\r\nContent-Length: 0\r\nConnection: close\r\n\r\n")
|
||||
return
|
||||
}
|
||||
const abort = new AbortController()
|
||||
let tunnel: Duplex | undefined
|
||||
const buffered: Uint8Array[] = head.byteLength ? [head] : []
|
||||
let bufferedBytes = head.byteLength
|
||||
const cancel = () => {
|
||||
abort.abort(new Error("Browser proxy client closed during tunnel setup"))
|
||||
tunnel?.destroy()
|
||||
}
|
||||
const onReadable = () => {
|
||||
while (true) {
|
||||
const data: unknown = socket.read()
|
||||
if (data === null) break
|
||||
if (!(data instanceof Uint8Array)) {
|
||||
cancel()
|
||||
socket.destroy()
|
||||
return
|
||||
}
|
||||
bufferedBytes += data.byteLength
|
||||
if (bufferedBytes > 256 * 1_024) {
|
||||
cancel()
|
||||
socket.destroy()
|
||||
return
|
||||
}
|
||||
buffered.push(data)
|
||||
}
|
||||
if (socket.readableEnded) cancel()
|
||||
}
|
||||
incoming.once("aborted", cancel)
|
||||
incoming.once("error", cancel)
|
||||
socket.once("close", cancel)
|
||||
socket.once("end", cancel)
|
||||
socket.once("error", cancel)
|
||||
socket.on("readable", onReadable)
|
||||
socket.pause()
|
||||
tunnel = await connect(target(parsed.host, parsed.port), abort.signal)
|
||||
onReadable()
|
||||
if (socket.destroyed || socket.readableEnded || abort.signal.aborted) {
|
||||
socket.off("readable", onReadable)
|
||||
tunnel.destroy()
|
||||
return
|
||||
}
|
||||
socket.write("HTTP/1.1 200 Connection Established\r\n\r\n")
|
||||
established = true
|
||||
for (const data of buffered) {
|
||||
if (!tunnel.write(data)) await once(tunnel, "drain", { signal: abort.signal })
|
||||
}
|
||||
socket.off("readable", onReadable)
|
||||
bridge(socket, tunnel)
|
||||
incoming.off("aborted", cancel)
|
||||
incoming.off("error", cancel)
|
||||
socket.off("close", cancel)
|
||||
socket.off("end", cancel)
|
||||
socket.off("error", cancel)
|
||||
socket.resume()
|
||||
})().catch(() => {
|
||||
if (socket.destroyed) return
|
||||
if (established) {
|
||||
socket.destroy()
|
||||
return
|
||||
}
|
||||
socket.end("HTTP/1.1 502 Bad Gateway\r\nContent-Length: 0\r\nConnection: close\r\n\r\n")
|
||||
})
|
||||
})
|
||||
server.on("error", () => undefined)
|
||||
server.on("clientError", (_error, socket) => {
|
||||
if (!socket.destroyed) socket.end("HTTP/1.1 400 Bad Request\r\nConnection: close\r\n\r\n")
|
||||
})
|
||||
|
||||
await new Promise<void>((resolve, reject) => {
|
||||
const onError = (error: Error) => {
|
||||
server.off("listening", onListening)
|
||||
reject(error)
|
||||
}
|
||||
const onListening = () => {
|
||||
server.off("error", onError)
|
||||
resolve()
|
||||
}
|
||||
server.once("error", onError)
|
||||
server.once("listening", onListening)
|
||||
server.listen(0, "127.0.0.1")
|
||||
})
|
||||
const address = server.address()
|
||||
if (!address || typeof address === "string") {
|
||||
server.close()
|
||||
throw new Error("Browser proxy did not bind a TCP address")
|
||||
}
|
||||
const host = candidate
|
||||
let closing: Promise<void> | undefined
|
||||
|
||||
return {
|
||||
url: `https://${host}:${address.port}`,
|
||||
host,
|
||||
port: address.port,
|
||||
credentials: { username, password },
|
||||
certificateFingerprint: certificate.fingerprint,
|
||||
close() {
|
||||
if (closing) return closing
|
||||
closed = true
|
||||
pending.forEach((abort) => abort.abort())
|
||||
pending.clear()
|
||||
limiter.close()
|
||||
tunnels.forEach((tunnel) => tunnel.destroy())
|
||||
tunnels.clear()
|
||||
clients.forEach((client) => client.destroy())
|
||||
clients.clear()
|
||||
closing = new Promise<void>((resolve) => server.close(() => resolve()))
|
||||
return closing
|
||||
},
|
||||
}
|
||||
}
|
||||
|
||||
async function forward(
|
||||
incoming: IncomingMessage,
|
||||
response: ServerResponse,
|
||||
connect: (target: BrowserTunnel.Target, signal?: AbortSignal) => Promise<Duplex>,
|
||||
authorized: (header: string | undefined) => boolean,
|
||||
) {
|
||||
if (!authorized(singleHeader(incoming.headers["proxy-authorization"]))) {
|
||||
response.writeHead(407, { "Proxy-Authenticate": 'Basic realm="OpenCode Browser Proxy"' })
|
||||
response.end()
|
||||
return
|
||||
}
|
||||
const url = (() => {
|
||||
try {
|
||||
return new URL(incoming.url ?? "")
|
||||
} catch {
|
||||
return undefined
|
||||
}
|
||||
})()
|
||||
if (!url || url.protocol !== "http:" || !url.hostname || url.username || url.password) {
|
||||
response.writeHead(400)
|
||||
response.end()
|
||||
return
|
||||
}
|
||||
const port = url.port ? Number(url.port) : 80
|
||||
const abort = new AbortController()
|
||||
let tunnel: Duplex | undefined
|
||||
let agent: Agent | undefined
|
||||
const cancel = () => {
|
||||
abort.abort(new Error("Browser proxy downstream closed"))
|
||||
tunnel?.destroy()
|
||||
}
|
||||
incoming.once("aborted", cancel)
|
||||
incoming.once("error", cancel)
|
||||
incoming.socket.once("close", cancel)
|
||||
incoming.socket.once("end", cancel)
|
||||
incoming.socket.once("error", cancel)
|
||||
response.once("close", cancel)
|
||||
response.once("error", cancel)
|
||||
try {
|
||||
tunnel = await connect(target(normalizeHostname(url.hostname), port), abort.signal)
|
||||
const headers = forwardedHeaders(incoming.headers)
|
||||
headers.host = url.host
|
||||
headers.connection = "close"
|
||||
const connection = tunnel
|
||||
agent = new Agent({ keepAlive: false, maxSockets: 1, noDelay: false })
|
||||
agent.createConnection = () => connection
|
||||
await new Promise<void>((resolve, reject) => {
|
||||
const upstream = request(
|
||||
{
|
||||
agent,
|
||||
hostname: url.hostname,
|
||||
port,
|
||||
path: `${url.pathname}${url.search}`,
|
||||
method: incoming.method,
|
||||
headers,
|
||||
maxHeaderSize: 64 * 1_024,
|
||||
signal: abort.signal,
|
||||
},
|
||||
(result) => {
|
||||
const headers = forwardedHeaders(result.headers)
|
||||
headers.connection = "close"
|
||||
response.writeHead(result.statusCode ?? 502, result.statusMessage, headers)
|
||||
result.once("error", reject)
|
||||
result.once("aborted", () => reject(new Error("Browser proxy target response was aborted")))
|
||||
result.once("end", resolve)
|
||||
result.pipe(response)
|
||||
},
|
||||
)
|
||||
upstream.once("continue", () => response.writeContinue())
|
||||
upstream.once("error", reject)
|
||||
incoming.pipe(upstream)
|
||||
})
|
||||
} finally {
|
||||
incoming.off("aborted", cancel)
|
||||
incoming.off("error", cancel)
|
||||
incoming.socket.off("close", cancel)
|
||||
incoming.socket.off("end", cancel)
|
||||
incoming.socket.off("error", cancel)
|
||||
response.off("close", cancel)
|
||||
response.off("error", cancel)
|
||||
agent?.destroy()
|
||||
tunnel?.destroy()
|
||||
}
|
||||
}
|
||||
|
||||
function forwardedHeaders(input: IncomingHttpHeaders) {
|
||||
const headers = { ...input }
|
||||
const named = singleHeader(headers.connection)
|
||||
?.split(",")
|
||||
.map((value) => value.trim().toLowerCase())
|
||||
.filter(Boolean)
|
||||
named?.forEach((name) => delete headers[name])
|
||||
;[
|
||||
"connection",
|
||||
"keep-alive",
|
||||
"proxy-authenticate",
|
||||
"proxy-authorization",
|
||||
"proxy-connection",
|
||||
"te",
|
||||
"trailer",
|
||||
"transfer-encoding",
|
||||
"upgrade",
|
||||
].forEach((name) => delete headers[name])
|
||||
return headers
|
||||
}
|
||||
|
||||
function bridge(client: Duplex, tunnel: Duplex) {
|
||||
client.on("error", () => tunnel.destroy())
|
||||
tunnel.on("error", () => client.destroy())
|
||||
client.on("close", () => {
|
||||
if (!tunnel.destroyed) tunnel.destroy()
|
||||
})
|
||||
tunnel.on("close", () => {
|
||||
if (!client.destroyed) client.destroy()
|
||||
})
|
||||
client.pipe(tunnel)
|
||||
tunnel.pipe(client)
|
||||
}
|
||||
|
||||
function authority(value: string, defaultPort: number) {
|
||||
const bracket = /^\[([^\]]+)](?::([0-9]+))?$/.exec(value)
|
||||
if (bracket) return validAuthority(bracket[1], bracket[2], defaultPort)
|
||||
if (value.includes("[")) return undefined
|
||||
const separator = value.lastIndexOf(":")
|
||||
if (separator < 0) return validAuthority(value, undefined, defaultPort)
|
||||
if (value.slice(0, separator).includes(":")) return undefined
|
||||
return validAuthority(value.slice(0, separator), value.slice(separator + 1), defaultPort)
|
||||
}
|
||||
|
||||
function validAuthority(host: string, value: string | undefined, defaultPort: number) {
|
||||
if (!host || (value !== undefined && !/^[0-9]+$/.test(value))) return undefined
|
||||
const port = value === undefined ? defaultPort : Number(value)
|
||||
if (!Number.isSafeInteger(port) || port < 1 || port > 65_535) return undefined
|
||||
try {
|
||||
return { host: BrowserTunnel.Host.make(host), port: BrowserTunnel.Port.make(port) }
|
||||
} catch {
|
||||
return undefined
|
||||
}
|
||||
}
|
||||
|
||||
function target(host: string, port: number): BrowserTunnel.Target {
|
||||
return { host: BrowserTunnel.Host.make(host), port: BrowserTunnel.Port.make(port) }
|
||||
}
|
||||
|
||||
function normalizeHostname(hostname: string) {
|
||||
return hostname.startsWith("[") && hostname.endsWith("]") ? hostname.slice(1, -1) : hostname
|
||||
}
|
||||
|
||||
function singleHeader(value: string | ReadonlyArray<string> | undefined) {
|
||||
return typeof value === "string" ? value : undefined
|
||||
}
|
||||
|
||||
function connectionLimiter(limit: number, capacity: number) {
|
||||
const queue: Array<() => void> = []
|
||||
let active = 0
|
||||
let closed = false
|
||||
const drain = (): void => {
|
||||
if (active >= limit) return
|
||||
const start = queue.shift()
|
||||
if (!start) return
|
||||
start()
|
||||
drain()
|
||||
}
|
||||
return {
|
||||
run<Result>(task: () => Promise<Result>, signal: AbortSignal) {
|
||||
return new Promise<Result>((resolve, reject) => {
|
||||
if (closed || signal.aborted) {
|
||||
reject(signal.reason ?? new Error("Browser proxy connection was cancelled"))
|
||||
return
|
||||
}
|
||||
if (active >= limit && queue.length >= capacity) {
|
||||
reject(new Error("Browser proxy connection queue is full"))
|
||||
return
|
||||
}
|
||||
const start = () => {
|
||||
signal.removeEventListener("abort", cancel)
|
||||
if (closed || signal.aborted) {
|
||||
reject(signal.reason ?? new Error("Browser proxy connection was cancelled"))
|
||||
return
|
||||
}
|
||||
active++
|
||||
void Promise.resolve()
|
||||
.then(task)
|
||||
.then(resolve, reject)
|
||||
.finally(() => {
|
||||
active--
|
||||
drain()
|
||||
})
|
||||
}
|
||||
const cancel = () => {
|
||||
const index = queue.indexOf(start)
|
||||
if (index === -1) return
|
||||
queue.splice(index, 1)
|
||||
reject(signal.reason ?? new Error("Browser proxy connection was cancelled"))
|
||||
}
|
||||
if (active < limit) start()
|
||||
else {
|
||||
signal.addEventListener("abort", cancel, { once: true })
|
||||
queue.push(start)
|
||||
}
|
||||
})
|
||||
},
|
||||
close() {
|
||||
closed = true
|
||||
queue.splice(0).forEach((start) => start())
|
||||
},
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,389 @@
|
||||
import { BrowserTunnelProtocol } from "@opencode-ai/protocol/browser-tunnel"
|
||||
import { BROWSER_TUNNEL_PROTOCOL } from "@opencode-ai/protocol/groups/browser"
|
||||
import { Browser } from "@opencode-ai/schema/browser"
|
||||
import { BrowserTunnel } from "@opencode-ai/schema/browser-tunnel"
|
||||
import { Session } from "@opencode-ai/schema/session"
|
||||
import { Effect, Schema } from "effect"
|
||||
import { Duplex } from "node:stream"
|
||||
import WebSocket from "ws"
|
||||
|
||||
export type BrowserTunnelEndpoint = {
|
||||
readonly url: string
|
||||
readonly authorization?: string
|
||||
readonly fetch?: typeof globalThis.fetch
|
||||
}
|
||||
|
||||
export type BrowserTunnelOpen = {
|
||||
readonly endpoint: BrowserTunnelEndpoint
|
||||
readonly sessionID: Session.ID
|
||||
readonly leaseID: Browser.LeaseID
|
||||
readonly target: BrowserTunnel.Target
|
||||
readonly signal?: AbortSignal
|
||||
}
|
||||
|
||||
export class BrowserTunnelError extends Error {
|
||||
constructor(
|
||||
readonly code: BrowserTunnel.OpenErrorCode | BrowserTunnel.ResetCode | "transport",
|
||||
message: string,
|
||||
) {
|
||||
super(message)
|
||||
this.name = "BrowserTunnelError"
|
||||
}
|
||||
}
|
||||
|
||||
/** Opens one flow-controlled WebSocket tunnel and exposes it as a single TCP-like stream. */
|
||||
export async function openBrowserTunnel(input: BrowserTunnelOpen): Promise<Duplex> {
|
||||
const tunnel = new BrowserTunnelStream(input)
|
||||
await tunnel.opened
|
||||
return tunnel
|
||||
}
|
||||
|
||||
class BrowserTunnelStream extends Duplex {
|
||||
readonly opened: Promise<void>
|
||||
readonly connecting = false
|
||||
private resolveOpened!: () => void
|
||||
private rejectOpened!: (error: Error) => void
|
||||
private readonly socket: WebSocket
|
||||
private readonly signal?: AbortSignal
|
||||
private state: "ready" | "opening" | "open" | "closed" = "ready"
|
||||
private inbound = Promise.resolve()
|
||||
private timer?: ReturnType<typeof setTimeout>
|
||||
private sendWindowBytes = 0
|
||||
private sendWindowFrames = 0
|
||||
private readonly outstanding: number[] = []
|
||||
private activeWrite?: { readonly data: Buffer; offset: number; readonly callback: (error?: Error | null) => void }
|
||||
private sending = false
|
||||
private receiveWindowBytes = BrowserTunnelProtocol.InitialWindowBytes
|
||||
private receiveWindowFrames = BrowserTunnelProtocol.InitialFrameWindow
|
||||
private heldWindowBytes = 0
|
||||
private heldWindowFrames = 0
|
||||
private paused = false
|
||||
private localEnded = false
|
||||
private remoteEnded = false
|
||||
private remoteReset = false
|
||||
private resetCode: BrowserTunnel.ResetCode = "cancelled"
|
||||
|
||||
constructor(input: BrowserTunnelOpen) {
|
||||
super({
|
||||
allowHalfOpen: true,
|
||||
readableHighWaterMark: BrowserTunnelProtocol.InitialWindowBytes,
|
||||
writableHighWaterMark: BrowserTunnelProtocol.InitialWindowBytes,
|
||||
})
|
||||
this.opened = new Promise<void>((resolve, reject) => {
|
||||
this.resolveOpened = resolve
|
||||
this.rejectOpened = reject
|
||||
})
|
||||
this.on("error", () => undefined)
|
||||
this.signal = input.signal
|
||||
this.socket = new WebSocket(endpointURL(input.endpoint), BROWSER_TUNNEL_PROTOCOL, {
|
||||
...(input.endpoint.authorization ? { headers: { Authorization: input.endpoint.authorization } } : {}),
|
||||
handshakeTimeout: 10_000,
|
||||
maxPayload: Math.max(BrowserTunnelProtocol.MaxDataBytes, BrowserTunnelProtocol.MaxControlBytes) + 1,
|
||||
perMessageDeflate: false,
|
||||
followRedirects: false,
|
||||
})
|
||||
this.timer = setTimeout(
|
||||
() => this.fail(new BrowserTunnelError("transport", "Browser tunnel handshake timed out.")),
|
||||
15_000,
|
||||
)
|
||||
this.timer.unref()
|
||||
this.socket.on("message", (data, binary) => {
|
||||
this.socket.pause()
|
||||
const processing = this.inbound.then(
|
||||
() => this.receive(input, data, binary),
|
||||
() => this.receive(input, data, binary),
|
||||
)
|
||||
this.inbound = processing
|
||||
void processing.then(
|
||||
() => {
|
||||
if (this.inbound === processing && !this.paused && this.socket.readyState === WebSocket.OPEN) {
|
||||
this.socket.resume()
|
||||
}
|
||||
},
|
||||
(error) =>
|
||||
this.fail(new BrowserTunnelError("transport", error instanceof Error ? error.message : String(error))),
|
||||
)
|
||||
})
|
||||
this.socket.on("error", (error) => this.fail(new BrowserTunnelError("transport", error.message)))
|
||||
this.socket.on("close", (code, reason) => {
|
||||
if (this.state === "closed") return
|
||||
if (this.localEnded && this.remoteEnded) {
|
||||
this.state = "closed"
|
||||
this.destroy()
|
||||
return
|
||||
}
|
||||
this.fail(new BrowserTunnelError("transport", `Browser tunnel closed (${code}): ${reason.toString()}`))
|
||||
})
|
||||
this.signal?.addEventListener("abort", this.onAbort, { once: true })
|
||||
if (this.signal?.aborted) this.onAbort()
|
||||
}
|
||||
|
||||
override _read() {
|
||||
if (!this.paused) return
|
||||
this.paused = false
|
||||
this.releaseReceiveWindow()
|
||||
if (this.socket.readyState === WebSocket.OPEN) this.socket.resume()
|
||||
}
|
||||
|
||||
override _write(chunk: Buffer | string, encoding: BufferEncoding, callback: (error?: Error | null) => void) {
|
||||
const data = typeof chunk === "string" ? Buffer.from(chunk, encoding) : chunk
|
||||
if (this.state !== "open" || this.localEnded) {
|
||||
callback(new BrowserTunnelError("transport", "Browser tunnel is not writable."))
|
||||
return
|
||||
}
|
||||
if (data.byteLength === 0) {
|
||||
callback()
|
||||
return
|
||||
}
|
||||
this.activeWrite = { data, offset: 0, callback }
|
||||
this.pumpWrite()
|
||||
}
|
||||
|
||||
override _final(callback: (error?: Error | null) => void) {
|
||||
if (this.state !== "open" || this.localEnded) {
|
||||
callback(new BrowserTunnelError("transport", "Browser tunnel is not writable."))
|
||||
return
|
||||
}
|
||||
this.send(BrowserTunnelProtocol.encodeFromDesktop({ type: "browser.tunnel.end" }), (error) => {
|
||||
if (error) {
|
||||
callback(error)
|
||||
this.fail(new BrowserTunnelError("transport", error.message))
|
||||
return
|
||||
}
|
||||
this.localEnded = true
|
||||
callback()
|
||||
this.finish()
|
||||
})
|
||||
}
|
||||
|
||||
override _destroy(error: Error | null, callback: (error?: Error | null) => void) {
|
||||
if (this.timer) clearTimeout(this.timer)
|
||||
this.signal?.removeEventListener("abort", this.onAbort)
|
||||
if (this.state === "closed") {
|
||||
callback(error)
|
||||
return
|
||||
}
|
||||
const opened = this.state === "open"
|
||||
this.state = "closed"
|
||||
const pending = this.activeWrite
|
||||
this.activeWrite = undefined
|
||||
pending?.callback(error ?? new BrowserTunnelError("cancelled", "Browser tunnel was closed."))
|
||||
if (
|
||||
!opened ||
|
||||
this.remoteReset ||
|
||||
this.socket.readyState !== WebSocket.OPEN ||
|
||||
(this.localEnded && this.remoteEnded)
|
||||
) {
|
||||
this.socket.terminate()
|
||||
callback(error)
|
||||
return
|
||||
}
|
||||
this.socket.send(
|
||||
BrowserTunnelProtocol.encodeFromDesktop({ type: "browser.tunnel.reset", code: this.resetCode }),
|
||||
{ binary: true },
|
||||
() => {
|
||||
this.socket.close(1000)
|
||||
},
|
||||
)
|
||||
const terminate = setTimeout(() => this.socket.terminate(), 1_000)
|
||||
terminate.unref()
|
||||
callback(error)
|
||||
}
|
||||
|
||||
setKeepAlive() {
|
||||
return this
|
||||
}
|
||||
|
||||
setNoDelay() {
|
||||
return this
|
||||
}
|
||||
|
||||
setTimeout(_timeout: number, callback?: () => void) {
|
||||
if (callback) this.once("timeout", callback)
|
||||
return this
|
||||
}
|
||||
|
||||
ref() {
|
||||
return this
|
||||
}
|
||||
|
||||
unref() {
|
||||
return this
|
||||
}
|
||||
|
||||
private async receive(input: BrowserTunnelOpen, data: WebSocket.RawData, binary: boolean) {
|
||||
if (!binary) return this.protocolFailure("Browser tunnel frames must be binary.")
|
||||
const frame = await Effect.runPromise(BrowserTunnelProtocol.decodeFromServer(rawData(data))).catch(() => undefined)
|
||||
if (!frame || this.state === "closed") return this.protocolFailure("Browser tunnel frame is invalid.")
|
||||
if (frame.type === "data") {
|
||||
if (this.state !== "open" || this.remoteEnded) return this.protocolFailure("Unexpected browser tunnel data.")
|
||||
if (frame.data.byteLength > this.receiveWindowBytes || this.receiveWindowFrames === 0) {
|
||||
return this.protocolFailure("Browser tunnel receive window was exceeded.")
|
||||
}
|
||||
this.receiveWindowBytes -= frame.data.byteLength
|
||||
this.receiveWindowFrames--
|
||||
this.heldWindowBytes += frame.data.byteLength
|
||||
this.heldWindowFrames++
|
||||
if (!this.push(frame.data)) {
|
||||
this.paused = true
|
||||
return
|
||||
}
|
||||
this.releaseReceiveWindow()
|
||||
return
|
||||
}
|
||||
const message = frame.message
|
||||
if (message.type === "browser.tunnel.ready") {
|
||||
if (this.state !== "ready") return this.protocolFailure("Browser tunnel sent duplicate ready.")
|
||||
this.state = "opening"
|
||||
this.send(
|
||||
BrowserTunnelProtocol.encodeFromDesktop({
|
||||
type: "browser.tunnel.open",
|
||||
sessionID: input.sessionID,
|
||||
leaseID: input.leaseID,
|
||||
target: input.target,
|
||||
receiveWindow: BrowserTunnel.WindowSize.make(BrowserTunnelProtocol.InitialWindowBytes),
|
||||
receiveFrames: BrowserTunnel.FrameWindow.make(BrowserTunnelProtocol.InitialFrameWindow),
|
||||
}),
|
||||
(error) => {
|
||||
if (error) this.fail(new BrowserTunnelError("transport", error.message))
|
||||
},
|
||||
)
|
||||
return
|
||||
}
|
||||
if (message.type === "browser.tunnel.opened") {
|
||||
if (this.state !== "opening") return this.protocolFailure("Unexpected browser tunnel opened message.")
|
||||
this.state = "open"
|
||||
this.sendWindowBytes = message.receiveWindow
|
||||
this.sendWindowFrames = message.receiveFrames
|
||||
if (this.timer) clearTimeout(this.timer)
|
||||
this.resolveOpened()
|
||||
this.pumpWrite()
|
||||
return
|
||||
}
|
||||
if (message.type === "browser.tunnel.rejected") {
|
||||
if (this.state !== "opening") return this.protocolFailure("Unexpected browser tunnel rejection.")
|
||||
this.fail(new BrowserTunnelError(message.code, message.message))
|
||||
return
|
||||
}
|
||||
if (message.type === "browser.tunnel.window") {
|
||||
if (this.state !== "open" || message.frames > this.outstanding.length) {
|
||||
return this.protocolFailure("Unexpected browser tunnel window update.")
|
||||
}
|
||||
const bytes = this.outstanding.slice(0, message.frames).reduce((total, size) => total + size, 0)
|
||||
if (bytes !== message.bytes)
|
||||
return this.protocolFailure("Browser tunnel window update does not match sent frames.")
|
||||
this.outstanding.splice(0, message.frames)
|
||||
this.sendWindowBytes += message.bytes
|
||||
this.sendWindowFrames += message.frames
|
||||
this.pumpWrite()
|
||||
return
|
||||
}
|
||||
if (message.type === "browser.tunnel.end") {
|
||||
if (this.state !== "open" || this.remoteEnded) return this.protocolFailure("Unexpected browser tunnel end.")
|
||||
this.remoteEnded = true
|
||||
this.push(null)
|
||||
this.finish()
|
||||
return
|
||||
}
|
||||
this.remoteReset = true
|
||||
this.fail(new BrowserTunnelError(message.code, `Browser tunnel was reset: ${message.code}`))
|
||||
}
|
||||
|
||||
private pumpWrite() {
|
||||
const write = this.activeWrite
|
||||
if (!write || this.sending || this.state !== "open") return
|
||||
if (this.sendWindowBytes === 0 || this.sendWindowFrames === 0) return
|
||||
const size = Math.min(
|
||||
BrowserTunnelProtocol.MaxDataBytes,
|
||||
this.sendWindowBytes,
|
||||
write.data.byteLength - write.offset,
|
||||
)
|
||||
this.sendWindowBytes -= size
|
||||
this.sendWindowFrames--
|
||||
this.outstanding.push(size)
|
||||
this.sending = true
|
||||
this.send(BrowserTunnelProtocol.data(write.data.subarray(write.offset, write.offset + size)), (error) => {
|
||||
this.sending = false
|
||||
if (this.activeWrite !== write) return
|
||||
if (error) {
|
||||
this.activeWrite = undefined
|
||||
write.callback(error)
|
||||
this.fail(new BrowserTunnelError("transport", error.message))
|
||||
return
|
||||
}
|
||||
write.offset += size
|
||||
if (write.offset === write.data.byteLength) {
|
||||
this.activeWrite = undefined
|
||||
write.callback()
|
||||
return
|
||||
}
|
||||
this.pumpWrite()
|
||||
})
|
||||
}
|
||||
|
||||
private releaseReceiveWindow() {
|
||||
if (this.heldWindowFrames === 0 || this.state !== "open") return
|
||||
const bytes = this.heldWindowBytes
|
||||
const frames = this.heldWindowFrames
|
||||
this.heldWindowBytes = 0
|
||||
this.heldWindowFrames = 0
|
||||
this.receiveWindowBytes += bytes
|
||||
this.receiveWindowFrames += frames
|
||||
this.send(
|
||||
BrowserTunnelProtocol.encodeFromDesktop({
|
||||
type: "browser.tunnel.window",
|
||||
bytes: BrowserTunnel.WindowBytes.make(bytes),
|
||||
frames: BrowserTunnel.FrameWindow.make(frames),
|
||||
}),
|
||||
(error) => {
|
||||
if (error) this.fail(new BrowserTunnelError("transport", error.message))
|
||||
},
|
||||
)
|
||||
}
|
||||
|
||||
private send(frame: Uint8Array, callback: (error?: Error) => void) {
|
||||
if (this.socket.readyState !== WebSocket.OPEN) {
|
||||
callback(new Error("Browser tunnel WebSocket is not open."))
|
||||
return
|
||||
}
|
||||
this.socket.send(frame, { binary: true }, callback)
|
||||
}
|
||||
|
||||
private protocolFailure(message: string) {
|
||||
this.fail(new BrowserTunnelError("protocol_error", message))
|
||||
}
|
||||
|
||||
private fail(error: BrowserTunnelError) {
|
||||
if (this.state === "closed") return
|
||||
if (Schema.is(BrowserTunnel.ResetCode)(error.code)) this.resetCode = error.code
|
||||
if (this.state !== "open") this.rejectOpened(error)
|
||||
this.destroy(error)
|
||||
}
|
||||
|
||||
private finish() {
|
||||
if (!this.localEnded || !this.remoteEnded || this.socket.readyState !== WebSocket.OPEN) return
|
||||
this.socket.close(1000)
|
||||
}
|
||||
|
||||
private readonly onAbort = () => {
|
||||
this.fail(new BrowserTunnelError("cancelled", "Browser tunnel was cancelled."))
|
||||
}
|
||||
}
|
||||
|
||||
function endpointURL(endpoint: BrowserTunnelEndpoint) {
|
||||
const url = new URL(endpoint.url)
|
||||
if ((url.protocol !== "http:" && url.protocol !== "https:") || url.username || url.password) {
|
||||
throw new TypeError("Browser server endpoint must be an HTTP URL without embedded credentials")
|
||||
}
|
||||
url.protocol = url.protocol === "https:" ? "wss:" : "ws:"
|
||||
url.pathname = "/api/browser/tunnel"
|
||||
url.search = ""
|
||||
url.hash = ""
|
||||
return url
|
||||
}
|
||||
|
||||
function rawData(data: WebSocket.RawData) {
|
||||
if (data instanceof ArrayBuffer) return new Uint8Array(data)
|
||||
if (Array.isArray(data)) return new Uint8Array(Buffer.concat(data))
|
||||
return new Uint8Array(data.buffer, data.byteOffset, data.byteLength)
|
||||
}
|
||||
@@ -0,0 +1,13 @@
|
||||
import { OpenCode } from "../promise/generated/index.js"
|
||||
import { createBrowserClient } from "./browser/client.js"
|
||||
|
||||
export type ClientOptions = OpenCode.ClientOptions
|
||||
export type RequestOptions = OpenCode.RequestOptions
|
||||
|
||||
/** Creates the Promise client with Node-only browser attachment support. */
|
||||
export function make(options: ClientOptions) {
|
||||
return {
|
||||
...OpenCode.make(options),
|
||||
browser: createBrowserClient(options),
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,28 @@
|
||||
export { ClientError, type ClientErrorReason } from "../promise/generated/client-error.js"
|
||||
export * from "../promise/generated/types.js"
|
||||
export type {
|
||||
AgentApi,
|
||||
CatalogApi,
|
||||
CommandApi,
|
||||
EventApi,
|
||||
IntegrationApi,
|
||||
ModelApi,
|
||||
PluginApi,
|
||||
ProviderApi,
|
||||
ReferenceApi,
|
||||
WebSearchApi,
|
||||
SessionApi,
|
||||
SkillApi,
|
||||
} from "../promise/api.js"
|
||||
export * as OpenCode from "./client.js"
|
||||
export { Browser } from "@opencode-ai/schema/browser"
|
||||
export { BrowserDriver, BrowserDriverError } from "./browser/driver.js"
|
||||
export type {
|
||||
BrowserDriverContext,
|
||||
BrowserDriverFactory,
|
||||
BrowserDriverInstance,
|
||||
BrowserProxy,
|
||||
} from "./browser/driver.js"
|
||||
export type { BrowserAttachment, BrowserAttachOptions, BrowserClient } from "./browser/client.js"
|
||||
export type { EventSubscribeOutput as OpenCodeEvent } from "../promise/generated/types.js"
|
||||
export type OpenCodeClient = ReturnType<typeof import("./client.js").make>
|
||||
@@ -213,8 +213,8 @@ import type {
|
||||
WebsearchProvidersOutput,
|
||||
WebsearchQueryInput,
|
||||
WebsearchQueryOutput,
|
||||
} from "./types"
|
||||
import { ClientError } from "./client-error"
|
||||
} from "./types.js"
|
||||
import { ClientError } from "./client-error.js"
|
||||
|
||||
export interface ClientOptions {
|
||||
readonly baseUrl: string
|
||||
|
||||
@@ -1,3 +1,3 @@
|
||||
export { ClientError, type ClientErrorReason } from "./client-error"
|
||||
export * as OpenCode from "./client"
|
||||
export * from "./types"
|
||||
export { ClientError, type ClientErrorReason } from "./client-error.js"
|
||||
export * as OpenCode from "./client.js"
|
||||
export * from "./types.js"
|
||||
|
||||
@@ -5,6 +5,7 @@ import { join, resolve, sep } from "node:path"
|
||||
|
||||
const directory = resolve(import.meta.dir, "..")
|
||||
const effect = realpathSync(resolve(import.meta.dir, "../node_modules/effect"))
|
||||
const ws = realpathSync(resolve(import.meta.dir, "../node_modules/ws"))
|
||||
const schema = resolve(import.meta.dir, "../../schema")
|
||||
const protocol = resolve(import.meta.dir, "../../protocol")
|
||||
const core = resolve(import.meta.dir, "../../core")
|
||||
@@ -17,6 +18,7 @@ describe("public import boundaries", () => {
|
||||
expect(within(root, effect)).toEqual([])
|
||||
expect(within(root, schema)).toEqual([])
|
||||
expect(within(root, protocol)).toEqual([])
|
||||
expect(within(root, ws)).toEqual([])
|
||||
expect(within(root, core)).toEqual([])
|
||||
expect(within(root, server)).toEqual([])
|
||||
|
||||
@@ -28,6 +30,15 @@ describe("public import boundaries", () => {
|
||||
expect(within(network, core)).toEqual([])
|
||||
expect(within(network, server)).toEqual([])
|
||||
|
||||
const node = await bundleInputs("@opencode-ai/client/node", "node")
|
||||
|
||||
expect(within(node, effect).length).toBeGreaterThan(0)
|
||||
expect(within(node, schema).length).toBeGreaterThan(0)
|
||||
expect(within(node, protocol).length).toBeGreaterThan(0)
|
||||
expect(within(node, ws).length).toBeGreaterThan(0)
|
||||
expect(within(node, core)).toEqual([])
|
||||
expect(within(node, server)).toEqual([])
|
||||
|
||||
const promiseService = await bundleInputs("@opencode-ai/client/service", "bun")
|
||||
|
||||
expect(within(promiseService, effect)).toEqual([])
|
||||
@@ -45,7 +56,7 @@ describe("public import boundaries", () => {
|
||||
})
|
||||
})
|
||||
|
||||
async function bundleInputs(specifier: string, target: "browser" | "bun") {
|
||||
async function bundleInputs(specifier: string, target: "browser" | "bun" | "node") {
|
||||
const temporary = await mkdtemp(join(import.meta.dir, ".import-boundary-"))
|
||||
const entrypoint = join(temporary, "index.ts")
|
||||
const metafile = join(temporary, "meta.json")
|
||||
|
||||
@@ -0,0 +1,856 @@
|
||||
import { BrowserControlProtocol } from "@opencode-ai/protocol/browser-control"
|
||||
import { BrowserTunnelProtocol } from "@opencode-ai/protocol/browser-tunnel"
|
||||
import { BROWSER_CONTROL_PROTOCOL, BROWSER_TUNNEL_PROTOCOL } from "@opencode-ai/protocol/groups/browser"
|
||||
import { BrowserControl } from "@opencode-ai/schema/browser-control"
|
||||
import { BrowserTunnel } from "@opencode-ai/schema/browser-tunnel"
|
||||
import { Session } from "@opencode-ai/schema/session"
|
||||
import { describe, expect, test } from "bun:test"
|
||||
import { Effect } from "effect"
|
||||
import { once } from "node:events"
|
||||
import { createServer } from "node:http"
|
||||
import { connect, type TLSSocket } from "node:tls"
|
||||
import WebSocket, { WebSocketServer } from "ws"
|
||||
import {
|
||||
Browser,
|
||||
BrowserDriver,
|
||||
BrowserDriverError,
|
||||
OpenCode,
|
||||
type BrowserDriverContext,
|
||||
type BrowserDriverInstance,
|
||||
type BrowserProxy,
|
||||
} from "@opencode-ai/client/node"
|
||||
|
||||
const initialState: Browser.State = {
|
||||
url: "https://example.com/",
|
||||
title: "Example",
|
||||
loading: false,
|
||||
canGoBack: false,
|
||||
canGoForward: false,
|
||||
generation: 1,
|
||||
}
|
||||
|
||||
describe("Node browser client", () => {
|
||||
test("rejects authentication failures on Bun without unsupported ws response events", async () => {
|
||||
const server = await controlServer("Basic expected")
|
||||
const adapter = driver("unauthorized")
|
||||
const client = OpenCode.make({ baseUrl: server.url })
|
||||
|
||||
try {
|
||||
const result = await Promise.race([
|
||||
rejected(client.browser.attach({ sessionID: "ses_node_unauthorized", driver: adapter.descriptor })),
|
||||
Bun.sleep(1_000).then(() => new Error("Authentication rejection timed out")),
|
||||
])
|
||||
expect(result.message).toContain("HTTP 401")
|
||||
expect(server.authorizations).toEqual([undefined])
|
||||
expect(adapter.disposeCount).toBe(1)
|
||||
} finally {
|
||||
await server.close()
|
||||
}
|
||||
})
|
||||
|
||||
test("cancels a pending Bun authentication probe when attachment setup is aborted", async () => {
|
||||
const abort = new AbortController()
|
||||
const adapter = driver("preflight")
|
||||
let resolveStarted!: () => void
|
||||
const started = new Promise<void>((resolve) => {
|
||||
resolveStarted = resolve
|
||||
})
|
||||
let cancelled = false
|
||||
const fetch: typeof globalThis.fetch = (_input, init) =>
|
||||
new Promise<Response>((_resolve, reject) => {
|
||||
resolveStarted()
|
||||
const signal = init?.signal
|
||||
if (!signal) return reject(new Error("Missing preflight signal"))
|
||||
const stop = () => {
|
||||
cancelled = true
|
||||
reject(signal.reason)
|
||||
}
|
||||
signal.addEventListener("abort", stop, { once: true })
|
||||
if (signal.aborted) stop()
|
||||
})
|
||||
const client = OpenCode.make({ baseUrl: "http://127.0.0.1:1", fetch })
|
||||
const attaching = client.browser.attach({
|
||||
sessionID: "ses_node_preflight_abort",
|
||||
driver: adapter.descriptor,
|
||||
signal: abort.signal,
|
||||
})
|
||||
|
||||
await started
|
||||
const reason = new Error("stop preflight")
|
||||
abort.abort(reason)
|
||||
expect(await rejected(attaching)).toBe(reason)
|
||||
expect(cancelled).toBe(true)
|
||||
expect(adapter.disposeCount).toBe(1)
|
||||
})
|
||||
|
||||
test("keeps constructor authentication immutable and waits for the lease sync acknowledgement", async () => {
|
||||
const authorization = `Basic ${Buffer.from("opencode:secret").toString("base64")}`
|
||||
const server = await controlServer(authorization)
|
||||
const headers = new Headers({ authorization })
|
||||
const adapter = driver("first")
|
||||
const client = OpenCode.make({ baseUrl: server.url, headers })
|
||||
headers.set("authorization", "Basic changed")
|
||||
|
||||
try {
|
||||
expect(client.session).toBeDefined()
|
||||
expect(client.browser.attach).toBeFunction()
|
||||
let settled = false
|
||||
expect(adapter.descriptor).toBe(adapter.factory)
|
||||
const attaching = client.browser.attach({ sessionID: "ses_node_barrier", driver: adapter.factory })
|
||||
void attaching.then(() => {
|
||||
settled = true
|
||||
})
|
||||
const socket = await server.nextConnection()
|
||||
const next = controlReader(socket)
|
||||
|
||||
expect(server.authorizations).toEqual([authorization])
|
||||
socket.send(BrowserControlProtocol.encodeFromServer({ type: "browser.control.ready" }))
|
||||
const sync = await next()
|
||||
if (sync.type !== "browser.control.sync") throw new Error("Expected browser control sync")
|
||||
expect(sync.attachments).toHaveLength(1)
|
||||
expect(sync.attachments[0]?.sessionID).toBe("ses_node_barrier")
|
||||
expect(sync.attachments[0]?.leaseID.startsWith("brl_")).toBe(true)
|
||||
expect(adapter.proxy?.url.startsWith("https://")).toBe(true)
|
||||
expect(adapter.proxy?.credentials.username).toBeTruthy()
|
||||
await Bun.sleep(10)
|
||||
expect(settled).toBe(false)
|
||||
|
||||
if (!adapter.proxy) throw new Error("Browser proxy is unavailable")
|
||||
const proxyConnection = connectProxy(adapter.proxy, "target.example:443")
|
||||
await Bun.sleep(10)
|
||||
expect(server.tunnelConnections).toBe(0)
|
||||
|
||||
socket.send(BrowserControlProtocol.encodeFromServer({ type: "browser.control.synced", revision: sync.revision }))
|
||||
const attachment = await attaching
|
||||
expect(attachment.resource).toEqual({ name: "first" })
|
||||
|
||||
const tunnel = await server.nextTunnelConnection()
|
||||
const nextTunnel = tunnelReader(tunnel)
|
||||
tunnel.send(BrowserTunnelProtocol.encodeFromServer({ type: "browser.tunnel.ready" }), { binary: true })
|
||||
const open = await nextTunnel()
|
||||
expect(open).toMatchObject({
|
||||
type: "control",
|
||||
message: {
|
||||
type: "browser.tunnel.open",
|
||||
sessionID: "ses_node_barrier",
|
||||
leaseID: sync.attachments[0]?.leaseID,
|
||||
target: { host: "target.example", port: 443 },
|
||||
},
|
||||
})
|
||||
tunnel.send(
|
||||
BrowserTunnelProtocol.encodeFromServer({
|
||||
type: "browser.tunnel.opened",
|
||||
receiveWindow: BrowserTunnel.WindowSize.make(BrowserTunnelProtocol.InitialWindowBytes),
|
||||
receiveFrames: BrowserTunnel.FrameWindow.make(BrowserTunnelProtocol.InitialFrameWindow),
|
||||
}),
|
||||
{ binary: true },
|
||||
)
|
||||
const connected = await proxyConnection
|
||||
expect(connected.response.startsWith("HTTP/1.1 200 Connection Established")).toBe(true)
|
||||
connected.socket.destroy()
|
||||
|
||||
const closed = once(socket, "close")
|
||||
await attachment.close()
|
||||
await closed
|
||||
expect(adapter.disposeCount).toBe(1)
|
||||
expect(adapter.unsubscribeCount).toBe(1)
|
||||
} finally {
|
||||
await server.close()
|
||||
}
|
||||
})
|
||||
|
||||
test("multiplexes Sessions, coalesces state, routes requests and cancellation, and preserves siblings", async () => {
|
||||
const server = await controlServer()
|
||||
const client = OpenCode.make({ baseUrl: server.url })
|
||||
const first = driver("first")
|
||||
const second = driver("second")
|
||||
|
||||
try {
|
||||
const attachingFirst = client.browser.attach({ sessionID: "ses_node_first", driver: first.descriptor })
|
||||
const socket = await server.nextConnection()
|
||||
const next = controlReader(socket)
|
||||
socket.send(BrowserControlProtocol.encodeFromServer({ type: "browser.control.ready" }))
|
||||
const firstSync = await nextSync(next)
|
||||
socket.send(
|
||||
BrowserControlProtocol.encodeFromServer({ type: "browser.control.synced", revision: firstSync.revision }),
|
||||
)
|
||||
const firstAttachment = await attachingFirst
|
||||
|
||||
const attachingSecond = client.browser.attach({ sessionID: "ses_node_second", driver: second.descriptor })
|
||||
const secondSync = await nextSync(next)
|
||||
expect(secondSync.attachments.map((attachment) => attachment.sessionID)).toEqual([
|
||||
"ses_node_first",
|
||||
"ses_node_second",
|
||||
])
|
||||
socket.send(
|
||||
BrowserControlProtocol.encodeFromServer({ type: "browser.control.synced", revision: secondSync.revision }),
|
||||
)
|
||||
const secondAttachment = await attachingSecond
|
||||
expect(server.connections).toBe(1)
|
||||
|
||||
second.setState({ ...initialState, title: "Intermediate" })
|
||||
const pendingState = await nextSync(next)
|
||||
second.setState({ ...initialState, title: "Latest" })
|
||||
socket.send(
|
||||
BrowserControlProtocol.encodeFromServer({ type: "browser.control.synced", revision: pendingState.revision }),
|
||||
)
|
||||
const latestState = await nextSync(next)
|
||||
expect(
|
||||
latestState.attachments.find((attachment) => attachment.sessionID === "ses_node_second")?.state.title,
|
||||
).toBe("Latest")
|
||||
socket.send(
|
||||
BrowserControlProtocol.encodeFromServer({ type: "browser.control.synced", revision: latestState.revision }),
|
||||
)
|
||||
|
||||
const secondLease = secondSync.attachments.find(
|
||||
(attachment) => attachment.sessionID === "ses_node_second",
|
||||
)?.leaseID
|
||||
if (!secondLease) throw new Error("Second browser lease is unavailable")
|
||||
const requestID = BrowserControl.RequestID.create()
|
||||
socket.send(
|
||||
BrowserControlProtocol.encodeFromServer({
|
||||
type: "browser.control.request",
|
||||
requestID,
|
||||
sessionID: Session.ID.make("ses_node_second"),
|
||||
leaseID: secondLease,
|
||||
command: { type: "snapshot", generation: 1 },
|
||||
}),
|
||||
)
|
||||
expect(await next()).toMatchObject({
|
||||
type: "browser.control.response",
|
||||
requestID,
|
||||
outcome: { type: "success", result: { type: "snapshot", content: "second" } },
|
||||
})
|
||||
|
||||
const commandState = { ...initialState, title: "Updated by command", generation: 2 }
|
||||
second.setExecute(async () => ({ type: "navigate", state: commandState }))
|
||||
const stateRequestID = BrowserControl.RequestID.create()
|
||||
socket.send(
|
||||
BrowserControlProtocol.encodeFromServer({
|
||||
type: "browser.control.request",
|
||||
requestID: stateRequestID,
|
||||
sessionID: Session.ID.make("ses_node_second"),
|
||||
leaseID: secondLease,
|
||||
command: { type: "navigate", url: "https://updated.example/", generation: 1 },
|
||||
}),
|
||||
)
|
||||
expect(await next()).toMatchObject({
|
||||
type: "browser.control.response",
|
||||
requestID: stateRequestID,
|
||||
outcome: { type: "success", result: { state: { title: "Updated by command" } } },
|
||||
})
|
||||
const commandStateSync = await nextSync(next)
|
||||
expect(
|
||||
commandStateSync.attachments.find((attachment) => attachment.sessionID === "ses_node_second")?.state,
|
||||
).toEqual(commandState)
|
||||
socket.send(
|
||||
BrowserControlProtocol.encodeFromServer({
|
||||
type: "browser.control.synced",
|
||||
revision: commandStateSync.revision,
|
||||
}),
|
||||
)
|
||||
|
||||
second.setExecute(async () => ({ type: "click", state: initialState }))
|
||||
const invalidID = BrowserControl.RequestID.create()
|
||||
socket.send(
|
||||
BrowserControlProtocol.encodeFromServer({
|
||||
type: "browser.control.request",
|
||||
requestID: invalidID,
|
||||
sessionID: Session.ID.make("ses_node_second"),
|
||||
leaseID: secondLease,
|
||||
command: { type: "snapshot", generation: 1 },
|
||||
}),
|
||||
)
|
||||
expect(await next()).toMatchObject({
|
||||
type: "browser.control.response",
|
||||
requestID: invalidID,
|
||||
outcome: { type: "failure", code: "protocol" },
|
||||
})
|
||||
|
||||
second.setExecute(async () => {
|
||||
throw new BrowserDriverError("stale_ref", "The reference is stale")
|
||||
})
|
||||
const errorID = BrowserControl.RequestID.create()
|
||||
socket.send(
|
||||
BrowserControlProtocol.encodeFromServer({
|
||||
type: "browser.control.request",
|
||||
requestID: errorID,
|
||||
sessionID: Session.ID.make("ses_node_second"),
|
||||
leaseID: secondLease,
|
||||
command: { type: "click", ref: Browser.Ref.make("e1"), generation: 1 },
|
||||
}),
|
||||
)
|
||||
expect(await next()).toMatchObject({
|
||||
type: "browser.control.response",
|
||||
requestID: errorID,
|
||||
outcome: { type: "failure", code: "stale_ref", message: "The reference is stale" },
|
||||
})
|
||||
|
||||
second.setExecute(async () => {
|
||||
throw Object.assign(new Error("Invalid adapter code"), { code: "not_a_browser_error" })
|
||||
})
|
||||
const unsafeErrorID = BrowserControl.RequestID.create()
|
||||
socket.send(
|
||||
BrowserControlProtocol.encodeFromServer({
|
||||
type: "browser.control.request",
|
||||
requestID: unsafeErrorID,
|
||||
sessionID: Session.ID.make("ses_node_second"),
|
||||
leaseID: secondLease,
|
||||
command: { type: "snapshot", generation: 2 },
|
||||
}),
|
||||
)
|
||||
expect(await next()).toMatchObject({
|
||||
type: "browser.control.response",
|
||||
requestID: unsafeErrorID,
|
||||
outcome: { type: "failure", code: "internal", message: "Invalid adapter code" },
|
||||
})
|
||||
|
||||
let resolveStarted!: () => void
|
||||
let resolveCancelled!: () => void
|
||||
const started = new Promise<void>((resolve) => {
|
||||
resolveStarted = resolve
|
||||
})
|
||||
const cancelled = new Promise<void>((resolve) => {
|
||||
resolveCancelled = resolve
|
||||
})
|
||||
second.setExecute(
|
||||
(_command, options) =>
|
||||
new Promise<Browser.Result>((_, reject) => {
|
||||
resolveStarted()
|
||||
options.signal.addEventListener(
|
||||
"abort",
|
||||
() => {
|
||||
resolveCancelled()
|
||||
reject(Object.assign(new Error("cancelled"), { code: "aborted" }))
|
||||
},
|
||||
{ once: true },
|
||||
)
|
||||
}),
|
||||
)
|
||||
const cancelID = BrowserControl.RequestID.create()
|
||||
socket.send(
|
||||
BrowserControlProtocol.encodeFromServer({
|
||||
type: "browser.control.request",
|
||||
requestID: cancelID,
|
||||
sessionID: Session.ID.make("ses_node_second"),
|
||||
leaseID: secondLease,
|
||||
command: { type: "click", ref: Browser.Ref.make("e1"), generation: 1 },
|
||||
}),
|
||||
)
|
||||
await started
|
||||
socket.send(
|
||||
BrowserControlProtocol.encodeFromServer({
|
||||
type: "browser.control.cancel",
|
||||
requestID: cancelID,
|
||||
leaseID: secondLease,
|
||||
}),
|
||||
)
|
||||
await cancelled
|
||||
|
||||
await firstAttachment.close()
|
||||
const detached = await nextSync(next)
|
||||
expect(detached.attachments).toHaveLength(1)
|
||||
expect(detached.attachments[0]?.sessionID).toBe("ses_node_second")
|
||||
socket.send(
|
||||
BrowserControlProtocol.encodeFromServer({ type: "browser.control.synced", revision: detached.revision }),
|
||||
)
|
||||
expect(server.connections).toBe(1)
|
||||
expect(second.disposeCount).toBe(0)
|
||||
|
||||
const closed = once(socket, "close")
|
||||
await secondAttachment.close()
|
||||
await closed
|
||||
expect(first.disposeCount).toBe(1)
|
||||
expect(second.disposeCount).toBe(1)
|
||||
} finally {
|
||||
await server.close()
|
||||
}
|
||||
})
|
||||
|
||||
test("reconnects and republishes the complete attachment snapshot", async () => {
|
||||
const server = await controlServer()
|
||||
const client = OpenCode.make({ baseUrl: server.url })
|
||||
const adapter = driver("reconnect")
|
||||
|
||||
try {
|
||||
const attaching = client.browser.attach({ sessionID: "ses_node_reconnect", driver: adapter.descriptor })
|
||||
const original = await server.nextConnection()
|
||||
const nextOriginal = controlReader(original)
|
||||
original.send(BrowserControlProtocol.encodeFromServer({ type: "browser.control.ready" }))
|
||||
const initial = await nextSync(nextOriginal)
|
||||
original.send(
|
||||
BrowserControlProtocol.encodeFromServer({ type: "browser.control.synced", revision: initial.revision }),
|
||||
)
|
||||
const attachment = await attaching
|
||||
original.terminate()
|
||||
|
||||
const replacement = await server.nextConnection()
|
||||
const nextReplacement = controlReader(replacement)
|
||||
replacement.send(BrowserControlProtocol.encodeFromServer({ type: "browser.control.ready" }))
|
||||
const republished = await nextSync(nextReplacement)
|
||||
expect(republished.attachments).toEqual(initial.attachments)
|
||||
replacement.send(
|
||||
BrowserControlProtocol.encodeFromServer({ type: "browser.control.synced", revision: republished.revision }),
|
||||
)
|
||||
expect(server.connections).toBe(2)
|
||||
|
||||
const closed = once(replacement, "close")
|
||||
await attachment.close()
|
||||
await closed
|
||||
} finally {
|
||||
await server.close()
|
||||
}
|
||||
})
|
||||
|
||||
test("rejects duplicate Sessions and aborts setup while close remains idempotent", async () => {
|
||||
const server = await controlServer()
|
||||
const client = OpenCode.make({ baseUrl: server.url })
|
||||
const adapter = driver("owner")
|
||||
|
||||
try {
|
||||
const invalid = driver("invalid")
|
||||
expect(
|
||||
(await rejected(client.browser.attach({ sessionID: "invalid", driver: invalid.descriptor }))).message,
|
||||
).toContain("valid Session ID")
|
||||
expect(invalid.createCount).toBe(0)
|
||||
|
||||
const attaching = client.browser.attach({ sessionID: "ses_node_owner", driver: adapter.descriptor })
|
||||
const socket = await server.nextConnection()
|
||||
const next = controlReader(socket)
|
||||
socket.send(BrowserControlProtocol.encodeFromServer({ type: "browser.control.ready" }))
|
||||
const sync = await nextSync(next)
|
||||
socket.send(BrowserControlProtocol.encodeFromServer({ type: "browser.control.synced", revision: sync.revision }))
|
||||
const attachment = await attaching
|
||||
|
||||
const duplicate = driver("duplicate")
|
||||
expect(
|
||||
(await rejected(client.browser.attach({ sessionID: "ses_node_owner", driver: duplicate.descriptor }))).message,
|
||||
).toContain("already attached")
|
||||
expect(duplicate.createCount).toBe(0)
|
||||
|
||||
const closed = once(socket, "close")
|
||||
await Promise.all([attachment.close(), attachment.close(), attachment[Symbol.asyncDispose]()])
|
||||
await closed
|
||||
expect(adapter.disposeCount).toBe(1)
|
||||
expect(adapter.unsubscribeCount).toBe(1)
|
||||
|
||||
const abort = new AbortController()
|
||||
const abortedAdapter = driver("aborted")
|
||||
const aborted = client.browser.attach({
|
||||
sessionID: "ses_node_aborted",
|
||||
driver: abortedAdapter.descriptor,
|
||||
signal: abort.signal,
|
||||
})
|
||||
const abortSocket = await server.nextConnection()
|
||||
const nextAbort = controlReader(abortSocket)
|
||||
abortSocket.send(BrowserControlProtocol.encodeFromServer({ type: "browser.control.ready" }))
|
||||
await nextSync(nextAbort)
|
||||
const reason = new Error("stop attaching")
|
||||
const abortClosed = once(abortSocket, "close")
|
||||
abort.abort(reason)
|
||||
expect(await rejected(aborted)).toBe(reason)
|
||||
await abortClosed
|
||||
expect(abortedAdapter.disposeCount).toBe(1)
|
||||
expect(abortedAdapter.signal?.aborted).toBe(true)
|
||||
|
||||
const alreadyAborted = new AbortController()
|
||||
alreadyAborted.abort(reason)
|
||||
const unused = driver("unused")
|
||||
expect(
|
||||
await rejected(
|
||||
client.browser.attach({
|
||||
sessionID: "ses_node_unused",
|
||||
driver: unused.descriptor,
|
||||
signal: alreadyAborted.signal,
|
||||
}),
|
||||
),
|
||||
).toBe(reason)
|
||||
expect(unused.createCount).toBe(0)
|
||||
} finally {
|
||||
await server.close()
|
||||
}
|
||||
})
|
||||
|
||||
test("fails pending attachments on fatal control closes without reconnecting", async () => {
|
||||
const server = await controlServer()
|
||||
const client = OpenCode.make({ baseUrl: server.url })
|
||||
const adapter = driver("fatal")
|
||||
|
||||
try {
|
||||
const attaching = client.browser.attach({ sessionID: "ses_node_fatal", driver: adapter.descriptor })
|
||||
const socket = await server.nextConnection()
|
||||
const next = controlReader(socket)
|
||||
socket.send(BrowserControlProtocol.encodeFromServer({ type: "browser.control.ready" }))
|
||||
await nextSync(next)
|
||||
const closed = once(socket, "close")
|
||||
socket.close(1002, "invalid control state")
|
||||
|
||||
expect((await rejected(attaching)).message).toContain("fatal code 1002")
|
||||
await closed
|
||||
await Bun.sleep(250)
|
||||
expect(server.connections).toBe(1)
|
||||
expect(adapter.disposeCount).toBe(1)
|
||||
expect(adapter.signal?.aborted).toBe(true)
|
||||
} finally {
|
||||
await server.close()
|
||||
}
|
||||
})
|
||||
|
||||
test("aborts non-cooperative driver creation and disposes a late instance", async () => {
|
||||
const server = await controlServer()
|
||||
const client = OpenCode.make({ baseUrl: server.url })
|
||||
const abort = new AbortController()
|
||||
let resolveStarted!: () => void
|
||||
let resolveFactory!: (instance: BrowserDriverInstance<{ readonly name: string }>) => void
|
||||
let resolveDisposed!: () => void
|
||||
const started = new Promise<void>((resolve) => {
|
||||
resolveStarted = resolve
|
||||
})
|
||||
const disposed = new Promise<void>((resolve) => {
|
||||
resolveDisposed = resolve
|
||||
})
|
||||
const factory = () => {
|
||||
resolveStarted()
|
||||
return new Promise<BrowserDriverInstance<{ readonly name: string }>>((resolve) => {
|
||||
resolveFactory = resolve
|
||||
})
|
||||
}
|
||||
|
||||
try {
|
||||
const attaching = client.browser.attach({
|
||||
sessionID: "ses_node_blocked_factory",
|
||||
driver: factory,
|
||||
signal: abort.signal,
|
||||
})
|
||||
await started
|
||||
const reason = new Error("abort blocked factory")
|
||||
abort.abort(reason)
|
||||
expect(
|
||||
await rejected(
|
||||
Promise.race([
|
||||
attaching,
|
||||
Bun.sleep(250).then(() => {
|
||||
throw new Error("Browser attachment did not abort promptly")
|
||||
}),
|
||||
]),
|
||||
),
|
||||
).toBe(reason)
|
||||
|
||||
resolveFactory({
|
||||
resource: { name: "late" },
|
||||
state: () => initialState,
|
||||
subscribe: () => () => undefined,
|
||||
execute: async () => ({
|
||||
type: "snapshot",
|
||||
state: initialState,
|
||||
format: "opencode.semantic.v1",
|
||||
content: "late",
|
||||
}),
|
||||
dispose: () => resolveDisposed(),
|
||||
})
|
||||
await disposed
|
||||
expect(server.authorizations).toEqual([])
|
||||
} finally {
|
||||
await server.close()
|
||||
}
|
||||
})
|
||||
|
||||
test("cleans up in reverse acquisition order and surfaces the first error", async () => {
|
||||
const server = await controlServer()
|
||||
const client = OpenCode.make({ baseUrl: server.url })
|
||||
const first = new Error("unsubscribe failed")
|
||||
const second = new Error("dispose failed")
|
||||
const order: string[] = []
|
||||
let proxy: BrowserProxy | undefined
|
||||
let proxyOpenDuringDispose = false
|
||||
const descriptor = BrowserDriver.define((context) => {
|
||||
proxy = context.proxy
|
||||
return {
|
||||
resource: context.proxy,
|
||||
state: () => initialState,
|
||||
subscribe: () => () => {
|
||||
order.push("unsubscribe")
|
||||
throw first
|
||||
},
|
||||
execute: async () => ({
|
||||
type: "snapshot",
|
||||
state: initialState,
|
||||
format: "opencode.semantic.v1",
|
||||
content: "cleanup",
|
||||
}),
|
||||
dispose: async () => {
|
||||
order.push("dispose")
|
||||
proxyOpenDuringDispose = await proxyAvailable(context.proxy)
|
||||
throw second
|
||||
},
|
||||
}
|
||||
})
|
||||
|
||||
try {
|
||||
const attaching = client.browser.attach({ sessionID: "ses_node_cleanup", driver: descriptor })
|
||||
const socket = await server.nextConnection()
|
||||
const next = controlReader(socket)
|
||||
socket.send(BrowserControlProtocol.encodeFromServer({ type: "browser.control.ready" }))
|
||||
const sync = await nextSync(next)
|
||||
socket.send(BrowserControlProtocol.encodeFromServer({ type: "browser.control.synced", revision: sync.revision }))
|
||||
const attachment = await attaching
|
||||
|
||||
expect(await rejected(attachment.close())).toBe(first)
|
||||
expect(await rejected(attachment.close())).toBe(first)
|
||||
expect(order).toEqual(["unsubscribe", "dispose"])
|
||||
expect(proxyOpenDuringDispose).toBe(true)
|
||||
if (!proxy) throw new Error("Browser proxy is unavailable")
|
||||
expect(await proxyAvailable(proxy)).toBe(false)
|
||||
} finally {
|
||||
await server.close()
|
||||
}
|
||||
})
|
||||
})
|
||||
|
||||
type Execute = BrowserDriverInstance<unknown>["execute"]
|
||||
|
||||
function driver(name: string) {
|
||||
let current = initialState
|
||||
let execute: Execute = async () => ({
|
||||
type: "snapshot",
|
||||
state: current,
|
||||
format: "opencode.semantic.v1",
|
||||
content: name,
|
||||
})
|
||||
let proxy: BrowserProxy | undefined
|
||||
let signal: AbortSignal | undefined
|
||||
let createCount = 0
|
||||
let disposeCount = 0
|
||||
let unsubscribeCount = 0
|
||||
const listeners = new Set<(state: Browser.State) => void>()
|
||||
const factory = ({ proxy: nextProxy, signal: nextSignal }: BrowserDriverContext) => {
|
||||
createCount++
|
||||
proxy = nextProxy
|
||||
signal = nextSignal
|
||||
return {
|
||||
resource: { name },
|
||||
state: () => current,
|
||||
subscribe(listener) {
|
||||
listeners.add(listener)
|
||||
return () => {
|
||||
if (listeners.delete(listener)) unsubscribeCount++
|
||||
}
|
||||
},
|
||||
execute: (command, options) => execute(command, options),
|
||||
dispose() {
|
||||
disposeCount++
|
||||
},
|
||||
}
|
||||
}
|
||||
const descriptor = BrowserDriver.define(factory)
|
||||
return {
|
||||
factory,
|
||||
descriptor,
|
||||
get proxy() {
|
||||
return proxy
|
||||
},
|
||||
get signal() {
|
||||
return signal
|
||||
},
|
||||
get createCount() {
|
||||
return createCount
|
||||
},
|
||||
get disposeCount() {
|
||||
return disposeCount
|
||||
},
|
||||
get unsubscribeCount() {
|
||||
return unsubscribeCount
|
||||
},
|
||||
setState(state: Browser.State) {
|
||||
current = state
|
||||
listeners.forEach((listener) => listener(state))
|
||||
},
|
||||
setExecute(next: Execute) {
|
||||
execute = next
|
||||
},
|
||||
}
|
||||
}
|
||||
|
||||
async function rejected(promise: Promise<unknown>) {
|
||||
return promise.then(
|
||||
() => new Error("Expected operation to reject"),
|
||||
(error) => (error instanceof Error ? error : new Error(String(error))),
|
||||
)
|
||||
}
|
||||
|
||||
async function nextSync(next: () => Promise<BrowserControl.FromDesktop>) {
|
||||
const message = await next()
|
||||
if (message.type !== "browser.control.sync") throw new Error("Expected browser control sync")
|
||||
return message
|
||||
}
|
||||
|
||||
async function controlServer(authorization?: string) {
|
||||
const http = createServer((request, response) => {
|
||||
response.statusCode = request.headers.authorization === authorization ? 200 : 401
|
||||
response.end()
|
||||
})
|
||||
const webSockets = new WebSocketServer({ noServer: true })
|
||||
const tunnels = new WebSocketServer({ noServer: true })
|
||||
const waiting: Array<(socket: WebSocket) => void> = []
|
||||
const queued: WebSocket[] = []
|
||||
const tunnelWaiting: Array<(socket: WebSocket) => void> = []
|
||||
const tunnelQueued: WebSocket[] = []
|
||||
const authorizations: Array<string | undefined> = []
|
||||
let connections = 0
|
||||
let tunnelConnections = 0
|
||||
webSockets.on("connection", (socket) => {
|
||||
connections++
|
||||
const resolve = waiting.shift()
|
||||
if (resolve) resolve(socket)
|
||||
else queued.push(socket)
|
||||
})
|
||||
tunnels.on("connection", (socket) => {
|
||||
tunnelConnections++
|
||||
const resolve = tunnelWaiting.shift()
|
||||
if (resolve) resolve(socket)
|
||||
else tunnelQueued.push(socket)
|
||||
})
|
||||
http.on("upgrade", (request, socket, head) => {
|
||||
authorizations.push(request.headers.authorization)
|
||||
if (request.headers.authorization !== authorization) {
|
||||
socket.end("HTTP/1.1 401 Unauthorized\r\n\r\n")
|
||||
return
|
||||
}
|
||||
if (
|
||||
request.url === "/api/browser/control" &&
|
||||
request.headers["sec-websocket-protocol"] === BROWSER_CONTROL_PROTOCOL
|
||||
) {
|
||||
webSockets.handleUpgrade(request, socket, head, (webSocket) => webSockets.emit("connection", webSocket, request))
|
||||
return
|
||||
}
|
||||
if (
|
||||
request.url === "/api/browser/tunnel" &&
|
||||
request.headers["sec-websocket-protocol"] === BROWSER_TUNNEL_PROTOCOL
|
||||
) {
|
||||
tunnels.handleUpgrade(request, socket, head, (webSocket) => tunnels.emit("connection", webSocket, request))
|
||||
return
|
||||
}
|
||||
socket.end("HTTP/1.1 401 Unauthorized\r\n\r\n")
|
||||
})
|
||||
await new Promise<void>((resolve) => http.listen(0, "127.0.0.1", resolve))
|
||||
const address = http.address()
|
||||
if (address === null || typeof address === "string") throw new Error("Browser control server did not bind TCP")
|
||||
return {
|
||||
authorizations,
|
||||
get connections() {
|
||||
return connections
|
||||
},
|
||||
get tunnelConnections() {
|
||||
return tunnelConnections
|
||||
},
|
||||
url: `http://127.0.0.1:${address.port}`,
|
||||
nextConnection() {
|
||||
const socket = queued.shift()
|
||||
if (socket) return Promise.resolve(socket)
|
||||
return new Promise<WebSocket>((resolve) => waiting.push(resolve))
|
||||
},
|
||||
nextTunnelConnection() {
|
||||
const socket = tunnelQueued.shift()
|
||||
if (socket) return Promise.resolve(socket)
|
||||
return new Promise<WebSocket>((resolve) => tunnelWaiting.push(resolve))
|
||||
},
|
||||
async close() {
|
||||
webSockets.clients.forEach((socket) => socket.terminate())
|
||||
tunnels.clients.forEach((socket) => socket.terminate())
|
||||
webSockets.close()
|
||||
tunnels.close()
|
||||
http.closeAllConnections()
|
||||
http.close()
|
||||
await Bun.sleep(10)
|
||||
},
|
||||
}
|
||||
}
|
||||
|
||||
function proxyAvailable(proxy: BrowserProxy) {
|
||||
return new Promise<boolean>((resolve) => {
|
||||
const socket = connect({
|
||||
host: "127.0.0.1",
|
||||
port: proxy.port,
|
||||
servername: proxy.host,
|
||||
rejectUnauthorized: false,
|
||||
})
|
||||
let settled = false
|
||||
const finish = (available: boolean) => {
|
||||
if (settled) return
|
||||
settled = true
|
||||
clearTimeout(timeout)
|
||||
socket.destroy()
|
||||
resolve(available)
|
||||
}
|
||||
const timeout = setTimeout(() => finish(false), 250)
|
||||
timeout.unref()
|
||||
socket.once("secureConnect", () => finish(true))
|
||||
socket.once("error", () => finish(false))
|
||||
})
|
||||
}
|
||||
|
||||
function connectProxy(proxy: BrowserProxy, authority: string) {
|
||||
return new Promise<{ readonly socket: TLSSocket; readonly response: string }>((resolve, reject) => {
|
||||
const socket = connect(
|
||||
{
|
||||
host: "127.0.0.1",
|
||||
port: proxy.port,
|
||||
servername: proxy.host,
|
||||
rejectUnauthorized: false,
|
||||
},
|
||||
() => {
|
||||
socket.write(
|
||||
`CONNECT ${authority} HTTP/1.1\r\nHost: ${authority}\r\nProxy-Authorization: Basic ${Buffer.from(`${proxy.credentials.username}:${proxy.credentials.password}`).toString("base64")}\r\n\r\n`,
|
||||
)
|
||||
},
|
||||
)
|
||||
let response = ""
|
||||
socket.on("error", () => undefined)
|
||||
socket.once("error", reject)
|
||||
socket.on("data", (data) => {
|
||||
response += data.toString()
|
||||
if (!response.includes("\r\n\r\n")) return
|
||||
resolve({ socket, response })
|
||||
})
|
||||
})
|
||||
}
|
||||
|
||||
function tunnelReader(socket: WebSocket) {
|
||||
const queued: WebSocket.RawData[] = []
|
||||
const waiting: Array<(data: WebSocket.RawData) => void> = []
|
||||
socket.on("message", (data, binary) => {
|
||||
if (!binary) throw new Error("Expected a binary browser tunnel frame")
|
||||
const resolve = waiting.shift()
|
||||
if (resolve) resolve(data)
|
||||
else queued.push(data)
|
||||
})
|
||||
return async () => {
|
||||
const data = queued.shift() ?? (await new Promise<WebSocket.RawData>((resolve) => waiting.push(resolve)))
|
||||
return Effect.runPromise(BrowserTunnelProtocol.decodeFromDesktop(rawData(data)))
|
||||
}
|
||||
}
|
||||
|
||||
function controlReader(socket: WebSocket) {
|
||||
const queued: Array<{ readonly data: WebSocket.RawData; readonly binary: boolean }> = []
|
||||
const waiting: Array<(message: { readonly data: WebSocket.RawData; readonly binary: boolean }) => void> = []
|
||||
socket.on("message", (data, binary) => {
|
||||
const resolve = waiting.shift()
|
||||
if (resolve) resolve({ data, binary })
|
||||
else queued.push({ data, binary })
|
||||
})
|
||||
return async () => {
|
||||
const message =
|
||||
queued.shift() ??
|
||||
(await new Promise<{ readonly data: WebSocket.RawData; readonly binary: boolean }>((resolve) =>
|
||||
waiting.push(resolve),
|
||||
))
|
||||
if (message.binary) throw new Error("Expected a text browser control message")
|
||||
return Effect.runPromise(BrowserControlProtocol.decodeFromDesktop(rawData(message.data)))
|
||||
}
|
||||
}
|
||||
|
||||
function rawData(data: WebSocket.RawData) {
|
||||
if (data instanceof ArrayBuffer) return new Uint8Array(data)
|
||||
if (Array.isArray(data)) return new Uint8Array(Buffer.concat(data))
|
||||
return new Uint8Array(data.buffer, data.byteOffset, data.byteLength)
|
||||
}
|
||||
@@ -0,0 +1,164 @@
|
||||
import { expect, test } from "bun:test"
|
||||
import { mkdir, mkdtemp, rm } from "node:fs/promises"
|
||||
import { join, relative, resolve } from "node:path"
|
||||
import { pathToFileURL } from "node:url"
|
||||
|
||||
const directory = resolve(import.meta.dir, "../..")
|
||||
|
||||
test("built Node entrypoint imports in Node and treats HTTP authentication rejection as fatal", async () => {
|
||||
await buildClient()
|
||||
const output = await Bun.file(join(directory, "dist/node/index.js")).text()
|
||||
expect(output).not.toMatch(/(?:from\s+|import\s*)["']\.\.?\//)
|
||||
|
||||
const temporary = await mkdtemp(join(import.meta.dir, ".node-package-"))
|
||||
try {
|
||||
await Bun.write(join(temporary, "index.mjs"), output)
|
||||
await stageWorkspaceDependencies(temporary)
|
||||
const child = Bun.spawn(
|
||||
["node", "--input-type=module", "-e", nodeScenario(pathToFileURL(join(temporary, "index.mjs")).href)],
|
||||
{ cwd: temporary, stdout: "pipe", stderr: "pipe" },
|
||||
)
|
||||
const [exitCode, stdout, stderr] = await Promise.all([
|
||||
child.exited,
|
||||
new Response(child.stdout).text(),
|
||||
new Response(child.stderr).text(),
|
||||
])
|
||||
if (exitCode !== 0) throw new Error(stderr || stdout)
|
||||
expect(stdout.trim()).toBe("ok")
|
||||
} finally {
|
||||
await rm(temporary, { recursive: true, force: true })
|
||||
}
|
||||
}, 60_000)
|
||||
|
||||
async function buildClient() {
|
||||
const child = Bun.spawn([process.execPath, "run", "build"], {
|
||||
cwd: directory,
|
||||
stdout: "pipe",
|
||||
stderr: "pipe",
|
||||
})
|
||||
const [exitCode, stdout, stderr] = await Promise.all([
|
||||
child.exited,
|
||||
new Response(child.stdout).text(),
|
||||
new Response(child.stderr).text(),
|
||||
])
|
||||
if (exitCode !== 0) throw new Error(stdout + stderr)
|
||||
}
|
||||
|
||||
async function stageWorkspaceDependencies(temporary: string) {
|
||||
const schema = join(temporary, "node_modules/@opencode-ai/schema")
|
||||
const protocol = join(temporary, "node_modules/@opencode-ai/protocol")
|
||||
await Promise.all([mkdir(schema, { recursive: true }), mkdir(protocol, { recursive: true })])
|
||||
|
||||
const schemaEntry = join(temporary, "schema.ts")
|
||||
const protocolEntry = join(temporary, "protocol.ts")
|
||||
await Promise.all([
|
||||
Bun.write(
|
||||
schemaEntry,
|
||||
[
|
||||
`export { Browser } from ${JSON.stringify(importPath(temporary, resolve(directory, "../schema/src/browser.ts")))}`,
|
||||
`export { BrowserControl } from ${JSON.stringify(importPath(temporary, resolve(directory, "../schema/src/browser-control.ts")))}`,
|
||||
`export { BrowserTunnel } from ${JSON.stringify(importPath(temporary, resolve(directory, "../schema/src/browser-tunnel.ts")))}`,
|
||||
`export { Session } from ${JSON.stringify(importPath(temporary, resolve(directory, "../schema/src/session.ts")))}`,
|
||||
].join("\n"),
|
||||
),
|
||||
Bun.write(
|
||||
protocolEntry,
|
||||
[
|
||||
`export { BrowserControlProtocol } from ${JSON.stringify(importPath(temporary, resolve(directory, "../protocol/src/browser-control.ts")))}`,
|
||||
`export { BrowserTunnelProtocol } from ${JSON.stringify(importPath(temporary, resolve(directory, "../protocol/src/browser-tunnel.ts")))}`,
|
||||
`export { BROWSER_CONTROL_PROTOCOL, BROWSER_TUNNEL_PROTOCOL } from ${JSON.stringify(importPath(temporary, resolve(directory, "../protocol/src/groups/browser.ts")))}`,
|
||||
].join("\n"),
|
||||
),
|
||||
])
|
||||
const [schemaBuild, protocolBuild] = await Promise.all([
|
||||
Bun.build({
|
||||
entrypoints: [schemaEntry],
|
||||
outdir: schema,
|
||||
naming: "index.js",
|
||||
target: "node",
|
||||
format: "esm",
|
||||
packages: "bundle",
|
||||
}),
|
||||
Bun.build({
|
||||
entrypoints: [protocolEntry],
|
||||
outdir: protocol,
|
||||
naming: "index.js",
|
||||
target: "node",
|
||||
format: "esm",
|
||||
packages: "bundle",
|
||||
}),
|
||||
])
|
||||
if (!schemaBuild.success) throw new Error(schemaBuild.logs.map((log) => log.message).join("\n"))
|
||||
if (!protocolBuild.success) throw new Error(protocolBuild.logs.map((log) => log.message).join("\n"))
|
||||
await Promise.all([
|
||||
Bun.write(
|
||||
join(schema, "package.json"),
|
||||
JSON.stringify({
|
||||
type: "module",
|
||||
exports: {
|
||||
"./browser": "./index.js",
|
||||
"./browser-control": "./index.js",
|
||||
"./browser-tunnel": "./index.js",
|
||||
"./session": "./index.js",
|
||||
},
|
||||
}),
|
||||
),
|
||||
Bun.write(
|
||||
join(protocol, "package.json"),
|
||||
JSON.stringify({
|
||||
type: "module",
|
||||
exports: {
|
||||
"./browser-control": "./index.js",
|
||||
"./browser-tunnel": "./index.js",
|
||||
"./groups/browser": "./index.js",
|
||||
},
|
||||
}),
|
||||
),
|
||||
])
|
||||
}
|
||||
|
||||
function importPath(from: string, to: string) {
|
||||
const path = relative(from, to).replaceAll("\\", "/")
|
||||
return path.startsWith(".") ? path : `./${path}`
|
||||
}
|
||||
|
||||
function nodeScenario(moduleURL: string) {
|
||||
return `import { createServer } from "node:http"
|
||||
const sdk = await import(${JSON.stringify(moduleURL)})
|
||||
if (typeof sdk.OpenCode.make !== "function") throw new Error("Missing OpenCode.make")
|
||||
if (typeof sdk.BrowserDriver.define !== "function") throw new Error("Missing BrowserDriver.define")
|
||||
if (typeof sdk.BrowserDriverError !== "function") throw new Error("Missing BrowserDriverError")
|
||||
if (!sdk.Browser.State) throw new Error("Missing canonical Browser export")
|
||||
|
||||
let upgrades = 0
|
||||
const server = createServer()
|
||||
server.on("upgrade", (_request, socket) => {
|
||||
upgrades++
|
||||
socket.end("HTTP/1.1 401 Unauthorized\\r\\nContent-Length: 0\\r\\nConnection: close\\r\\n\\r\\n")
|
||||
})
|
||||
await new Promise((resolve) => server.listen(0, "127.0.0.1", resolve))
|
||||
const address = server.address()
|
||||
if (!address || typeof address === "string") throw new Error("Server did not bind")
|
||||
let disposed = 0
|
||||
const driver = () => ({
|
||||
resource: undefined,
|
||||
state: () => ({ url: "about:blank", title: "", loading: false, canGoBack: false, canGoForward: false, generation: 0 }),
|
||||
subscribe: () => () => undefined,
|
||||
execute: async () => { throw new sdk.BrowserDriverError("internal", "unavailable") },
|
||||
dispose: () => { disposed++ },
|
||||
})
|
||||
const client = sdk.OpenCode.make({ baseUrl: \`http://127.0.0.1:\${address.port}\` })
|
||||
const error = await Promise.race([
|
||||
client.browser.attach({ sessionID: "ses_node_auth_rejection", driver }).then(
|
||||
() => new Error("Expected authentication rejection"),
|
||||
(cause) => cause,
|
||||
),
|
||||
new Promise((resolve) => setTimeout(() => resolve(new Error("Authentication rejection timed out")), 2_000)),
|
||||
])
|
||||
await new Promise((resolve) => setTimeout(resolve, 250))
|
||||
await new Promise((resolve) => server.close(resolve))
|
||||
if (!(error instanceof Error) || !error.message.includes("HTTP 401")) throw error
|
||||
if (upgrades !== 1) throw new Error(\`Expected one upgrade, received \${upgrades}\`)
|
||||
if (disposed !== 1) throw new Error(\`Expected one driver disposal, received \${disposed}\`)
|
||||
console.log("ok")`
|
||||
}
|
||||
@@ -0,0 +1,22 @@
|
||||
import { createHash, X509Certificate } from "node:crypto"
|
||||
import { createSecureContext } from "node:tls"
|
||||
import { describe, expect, test } from "bun:test"
|
||||
import { createBrowserProxyCertificate } from "../../src/node/browser/proxy-certificate"
|
||||
|
||||
describe("browser proxy certificate", () => {
|
||||
test("creates a unique valid certificate pinned to its loopback names", () => {
|
||||
const hostname = "opencode-test.localhost"
|
||||
const first = createBrowserProxyCertificate(hostname)
|
||||
const second = createBrowserProxyCertificate(hostname)
|
||||
const certificate = new X509Certificate(first.certificate)
|
||||
const fingerprint = createHash("sha256").update(certificate.raw).digest("base64")
|
||||
|
||||
expect(first.key.startsWith("-----BEGIN PRIVATE KEY-----")).toBe(true)
|
||||
expect(first.certificate.startsWith("-----BEGIN CERTIFICATE-----")).toBe(true)
|
||||
expect(first.fingerprint).toBe(`sha256/${fingerprint}`)
|
||||
expect(certificate.subjectAltName).toContain(`DNS:${hostname}`)
|
||||
expect(certificate.subjectAltName).toContain("IP Address:127.0.0.1")
|
||||
expect(first.fingerprint).not.toBe(second.fingerprint)
|
||||
expect(() => createSecureContext({ key: first.key, cert: first.certificate })).not.toThrow()
|
||||
})
|
||||
})
|
||||
@@ -0,0 +1,452 @@
|
||||
import { createHash } from "node:crypto"
|
||||
import { once } from "node:events"
|
||||
import { mkdtemp, rm } from "node:fs/promises"
|
||||
import { createServer } from "node:http"
|
||||
import { Socket } from "node:net"
|
||||
import { tmpdir } from "node:os"
|
||||
import { join } from "node:path"
|
||||
import { Duplex } from "node:stream"
|
||||
import { connect, type TLSSocket } from "node:tls"
|
||||
import { pathToFileURL } from "node:url"
|
||||
import { describe, expect, test } from "bun:test"
|
||||
import { createBrowserProxy } from "../../src/node/browser/proxy"
|
||||
|
||||
describe("browser proxy", () => {
|
||||
test("forwards authenticated CONNECT streams without directly dialing the target", async () => {
|
||||
let directConnections = 0
|
||||
const decoy = createServer((_incoming, response) => response.end("DIRECT DIAL"))
|
||||
decoy.on("connection", () => directConnections++)
|
||||
await new Promise<void>((resolve) => decoy.listen(0, "127.0.0.1", resolve))
|
||||
const decoyAddress = decoy.address()
|
||||
if (decoyAddress === null || typeof decoyAddress === "string") throw new Error("decoy server did not bind TCP")
|
||||
const target = createServer((incoming, response) => response.end(`TARGET ${incoming.method} ${incoming.url}`))
|
||||
await new Promise<void>((resolve) => target.listen(0, "127.0.0.1", resolve))
|
||||
const targetAddress = target.address()
|
||||
if (targetAddress === null || typeof targetAddress === "string") throw new Error("target server did not bind TCP")
|
||||
const opened: Array<{ host: string; port: number }> = []
|
||||
const proxy = await createBrowserProxy({
|
||||
connect: async (destination, signal) => {
|
||||
opened.push(destination)
|
||||
const socket = new Socket({ allowHalfOpen: true })
|
||||
const abort = () => socket.destroy(new Error("cancelled"))
|
||||
signal.addEventListener("abort", abort, { once: true })
|
||||
socket.once("close", () => signal.removeEventListener("abort", abort))
|
||||
// Emulate the server-side tunnel dial. The local decoy must never receive a connection.
|
||||
socket.connect(targetAddress.port, "127.0.0.1")
|
||||
await once(socket, "connect")
|
||||
return socket
|
||||
},
|
||||
})
|
||||
try {
|
||||
const tunnel = await proxyConnect(proxy, `127.0.0.1:${decoyAddress.port}`)
|
||||
expect(tunnel.status).toBe(200)
|
||||
tunnel.socket.write(
|
||||
`GET /connected HTTP/1.1\r\nHost: 127.0.0.1:${decoyAddress.port}\r\nConnection: close\r\n\r\n`,
|
||||
)
|
||||
const response = await readAll(tunnel.socket, tunnel.leftover)
|
||||
expect(response).toContain("TARGET GET /connected")
|
||||
expect(opened).toEqual([{ host: "127.0.0.1", port: decoyAddress.port }])
|
||||
|
||||
const certificate = await peerCertificate(proxy)
|
||||
expect(`sha256/${createHash("sha256").update(certificate).digest("base64")}`).toBe(proxy.certificateFingerprint)
|
||||
expect(directConnections).toBe(0)
|
||||
} finally {
|
||||
await proxy.close()
|
||||
await Promise.all([
|
||||
new Promise<void>((resolve) => target.close(() => resolve())),
|
||||
new Promise<void>((resolve) => decoy.close(() => resolve())),
|
||||
])
|
||||
}
|
||||
})
|
||||
|
||||
test("forwards absolute-form HTTP with Node framing and closes held-open targets", async () => {
|
||||
expect(await nodeAbsoluteFormScenario()).toEqual({
|
||||
unauthorized: { status: 407, body: "" },
|
||||
forwarded: { status: 200, body: "TARGET GET /absolute?q=1" },
|
||||
posted: { status: 200, body: "TARGET POST /post request body" },
|
||||
chunked: { status: 200, body: "TARGET CHUNKED" },
|
||||
held: { status: 200, body: "ok" },
|
||||
opened: 4,
|
||||
destinationsCorrect: true,
|
||||
directConnections: 0,
|
||||
heldDestroyed: true,
|
||||
})
|
||||
})
|
||||
|
||||
test("limits concurrent tunnel setup to six connections", async () => {
|
||||
let active = 0
|
||||
let maximum = 0
|
||||
let started = 0
|
||||
const releases: Array<() => void> = []
|
||||
const proxy = await createBrowserProxy({
|
||||
connect: (_destination, signal) =>
|
||||
new Promise<Duplex>((resolve, reject) => {
|
||||
active++
|
||||
started++
|
||||
maximum = Math.max(maximum, active)
|
||||
const finish = (result: () => void) => {
|
||||
signal.removeEventListener("abort", abort)
|
||||
active--
|
||||
result()
|
||||
}
|
||||
const abort = () => finish(() => reject(new Error("cancelled")))
|
||||
signal.addEventListener("abort", abort, { once: true })
|
||||
releases.push(() =>
|
||||
finish(() =>
|
||||
resolve(
|
||||
new Duplex({
|
||||
read() {},
|
||||
write(_chunk, _encoding, callback) {
|
||||
callback()
|
||||
},
|
||||
}),
|
||||
),
|
||||
),
|
||||
)
|
||||
}),
|
||||
})
|
||||
const connections = Array.from({ length: 7 }, () =>
|
||||
proxyConnect(proxy, "target.example:443").then(
|
||||
(result) => result.socket.destroy(),
|
||||
() => undefined,
|
||||
),
|
||||
)
|
||||
try {
|
||||
await waitFor(() => started === 6)
|
||||
expect(maximum).toBe(6)
|
||||
expect(started).toBe(6)
|
||||
|
||||
releases.shift()?.()
|
||||
await waitFor(() => started === 7)
|
||||
expect(maximum).toBe(6)
|
||||
} finally {
|
||||
await proxy.close()
|
||||
await Promise.all(connections)
|
||||
}
|
||||
})
|
||||
|
||||
test("aborts pending CONNECT setup when the downstream client closes", async () => {
|
||||
let aborted = false
|
||||
let resolveStarted!: () => void
|
||||
const started = new Promise<void>((resolve) => {
|
||||
resolveStarted = resolve
|
||||
})
|
||||
const proxy = await createBrowserProxy({
|
||||
connect: (_destination, signal) =>
|
||||
new Promise<Duplex>((_resolve, reject) => {
|
||||
resolveStarted()
|
||||
const abort = () => {
|
||||
aborted = true
|
||||
reject(new Error("cancelled"))
|
||||
}
|
||||
signal.addEventListener("abort", abort, { once: true })
|
||||
if (signal.aborted) abort()
|
||||
}),
|
||||
})
|
||||
const socket = proxyClient(
|
||||
proxy,
|
||||
`CONNECT target.example:443 HTTP/1.1\r\nHost: target.example:443\r\nProxy-Authorization: ${authorization(proxy)}\r\n\r\n`,
|
||||
)
|
||||
try {
|
||||
await started
|
||||
socket.destroy()
|
||||
await waitFor(() => aborted)
|
||||
} finally {
|
||||
socket.destroy()
|
||||
await proxy.close()
|
||||
}
|
||||
})
|
||||
|
||||
test("aborts pending absolute-form setup when the downstream client closes", async () => {
|
||||
let aborted = false
|
||||
let resolveStarted!: () => void
|
||||
const started = new Promise<void>((resolve) => {
|
||||
resolveStarted = resolve
|
||||
})
|
||||
const proxy = await createBrowserProxy({
|
||||
connect: (_destination, signal) =>
|
||||
new Promise<Duplex>((_resolve, reject) => {
|
||||
resolveStarted()
|
||||
const abort = () => {
|
||||
aborted = true
|
||||
reject(new Error("cancelled"))
|
||||
}
|
||||
signal.addEventListener("abort", abort, { once: true })
|
||||
if (signal.aborted) abort()
|
||||
}),
|
||||
})
|
||||
const socket = proxyClient(
|
||||
proxy,
|
||||
`GET http://target.example/pending HTTP/1.1\r\nHost: target.example\r\nProxy-Authorization: ${authorization(proxy)}\r\n\r\n`,
|
||||
)
|
||||
try {
|
||||
await started
|
||||
socket.destroy()
|
||||
await waitFor(() => aborted)
|
||||
} finally {
|
||||
socket.destroy()
|
||||
await proxy.close()
|
||||
}
|
||||
})
|
||||
|
||||
test("closes absolute-form requests when the target tunnel cannot connect", async () => {
|
||||
const proxy = await createBrowserProxy({ connect: () => Promise.reject(new Error("target unavailable")) })
|
||||
const socket = proxyClient(
|
||||
proxy,
|
||||
`GET http://target.example/unavailable HTTP/1.1\r\nHost: target.example\r\nProxy-Authorization: ${authorization(proxy)}\r\n\r\n`,
|
||||
)
|
||||
const chunks: Buffer[] = []
|
||||
socket.on("data", (chunk) => chunks.push(chunk))
|
||||
try {
|
||||
await once(socket, "close")
|
||||
expect(Buffer.concat(chunks).toString()).not.toContain("502 Bad Gateway")
|
||||
} finally {
|
||||
socket.destroy()
|
||||
await proxy.close()
|
||||
}
|
||||
})
|
||||
})
|
||||
|
||||
type ProxyInfo = Awaited<ReturnType<typeof createBrowserProxy>>
|
||||
|
||||
function authorization(proxy: ProxyInfo) {
|
||||
return `Basic ${Buffer.from(`${proxy.credentials.username}:${proxy.credentials.password}`).toString("base64")}`
|
||||
}
|
||||
|
||||
function proxyClient(proxy: ProxyInfo, request: string) {
|
||||
const socket = connect(
|
||||
{
|
||||
host: "127.0.0.1",
|
||||
port: proxy.port,
|
||||
servername: proxy.host.endsWith(".localhost") ? proxy.host : undefined,
|
||||
rejectUnauthorized: false,
|
||||
},
|
||||
() => socket.write(request),
|
||||
)
|
||||
socket.on("error", () => undefined)
|
||||
return socket
|
||||
}
|
||||
|
||||
async function nodeAbsoluteFormScenario() {
|
||||
const directory = await mkdtemp(join(tmpdir(), "opencode-browser-proxy-"))
|
||||
try {
|
||||
const built = await Bun.build({
|
||||
entrypoints: [join(import.meta.dir, "../../src/node/browser/proxy.ts")],
|
||||
outdir: directory,
|
||||
naming: "browser-proxy.mjs",
|
||||
target: "node",
|
||||
format: "esm",
|
||||
})
|
||||
if (!built.success) throw new Error(built.logs.map((log) => log.message).join("\n"))
|
||||
const output = built.outputs[0]
|
||||
if (!output) throw new Error("Browser proxy Node bundle was not emitted")
|
||||
const child = Bun.spawn(
|
||||
["node", "--input-type=module", "-e", absoluteFormScenario(pathToFileURL(output.path).href)],
|
||||
{ stdout: "pipe", stderr: "pipe" },
|
||||
)
|
||||
const [code, stdout, stderr] = await Promise.all([
|
||||
child.exited,
|
||||
new Response(child.stdout).text(),
|
||||
new Response(child.stderr).text(),
|
||||
])
|
||||
if (code !== 0) throw new Error(stderr || stdout)
|
||||
const result: unknown = JSON.parse(stdout)
|
||||
return result
|
||||
} finally {
|
||||
await rm(directory, { recursive: true, force: true })
|
||||
}
|
||||
}
|
||||
|
||||
function absoluteFormScenario(moduleURL: string) {
|
||||
return `import { createBrowserProxy } from ${JSON.stringify(moduleURL)}
|
||||
import { once } from "node:events"
|
||||
import { Agent, createServer, request } from "node:http"
|
||||
import { Socket } from "node:net"
|
||||
import { Duplex } from "node:stream"
|
||||
import { connect } from "node:tls"
|
||||
|
||||
const proxyRequest = async (proxy, path, authenticated, options = {}) => {
|
||||
const socket = await new Promise((resolve, reject) => {
|
||||
const socket = connect({ host: "127.0.0.1", port: proxy.port, servername: proxy.host, rejectUnauthorized: false }, () => resolve(socket))
|
||||
socket.once("error", reject)
|
||||
})
|
||||
const agent = new Agent({ keepAlive: false, maxSockets: 1, noDelay: false })
|
||||
agent.createConnection = () => socket
|
||||
const body = Buffer.from(options.body ?? "")
|
||||
try {
|
||||
return await new Promise((resolve, reject) => {
|
||||
const incoming = request({
|
||||
agent,
|
||||
hostname: proxy.host,
|
||||
path,
|
||||
method: options.method ?? "GET",
|
||||
headers: {
|
||||
connection: "close",
|
||||
...(authenticated ? { "proxy-authorization": "Basic " + Buffer.from(proxy.credentials.username + ":" + proxy.credentials.password).toString("base64") } : {}),
|
||||
...(options.chunked ? { "transfer-encoding": "chunked" } : { "content-length": body.byteLength.toString() }),
|
||||
},
|
||||
}, (response) => {
|
||||
const chunks = []
|
||||
response.on("data", (chunk) => chunks.push(chunk))
|
||||
response.once("end", () => resolve({ status: response.statusCode ?? 0, body: Buffer.concat(chunks).toString() }))
|
||||
})
|
||||
incoming.once("error", reject)
|
||||
incoming.end(body)
|
||||
})
|
||||
} finally {
|
||||
agent.destroy()
|
||||
socket.destroy()
|
||||
}
|
||||
}
|
||||
|
||||
let directConnections = 0
|
||||
const decoy = createServer((_incoming, response) => response.end("DIRECT DIAL"))
|
||||
decoy.on("connection", () => directConnections++)
|
||||
decoy.listen(0, "127.0.0.1")
|
||||
await once(decoy, "listening")
|
||||
const decoyAddress = decoy.address()
|
||||
if (!decoyAddress || typeof decoyAddress === "string") throw new Error("decoy server did not bind TCP")
|
||||
|
||||
const targetServer = createServer((incoming, response) => {
|
||||
const chunks = []
|
||||
incoming.on("data", (chunk) => chunks.push(chunk))
|
||||
incoming.on("end", () => {
|
||||
response.writeHead(200, { "content-type": "text/plain" })
|
||||
if (incoming.url === "/chunked") {
|
||||
response.write("TARGET ")
|
||||
response.end("CHUNKED")
|
||||
return
|
||||
}
|
||||
const body = Buffer.concat(chunks).toString()
|
||||
response.end("TARGET " + incoming.method + " " + incoming.url + (body ? " " + body : ""))
|
||||
})
|
||||
})
|
||||
targetServer.listen(0, "127.0.0.1")
|
||||
await once(targetServer, "listening")
|
||||
const targetAddress = targetServer.address()
|
||||
if (!targetAddress || typeof targetAddress === "string") throw new Error("target server did not bind TCP")
|
||||
|
||||
const opened = []
|
||||
let held
|
||||
const proxy = await createBrowserProxy({
|
||||
connect: async (destination, signal) => {
|
||||
opened.push(destination)
|
||||
if (destination.host === "held.example") {
|
||||
let responded = false
|
||||
held = new Duplex({
|
||||
read() {},
|
||||
write(chunk, _encoding, callback) {
|
||||
if (!responded && Buffer.from(chunk).includes(Buffer.from("\\r\\n\\r\\n"))) {
|
||||
responded = true
|
||||
this.push(Buffer.from("HTTP/1.1 200 OK\\r\\nContent-Length: 2\\r\\n\\r\\nok"))
|
||||
}
|
||||
callback()
|
||||
},
|
||||
})
|
||||
return held
|
||||
}
|
||||
const socket = new Socket({ allowHalfOpen: true })
|
||||
const abort = () => socket.destroy(new Error("cancelled"))
|
||||
signal.addEventListener("abort", abort, { once: true })
|
||||
socket.once("close", () => signal.removeEventListener("abort", abort))
|
||||
socket.connect(targetAddress.port, "127.0.0.1")
|
||||
await once(socket, "connect")
|
||||
return socket
|
||||
},
|
||||
})
|
||||
|
||||
try {
|
||||
const base = "http://127.0.0.1:" + decoyAddress.port
|
||||
const unauthorized = await proxyRequest(proxy, base + "/private", false)
|
||||
const forwarded = await proxyRequest(proxy, base + "/absolute?q=1", true)
|
||||
const posted = await proxyRequest(proxy, base + "/post", true, { method: "POST", body: "request body", chunked: true })
|
||||
const chunked = await proxyRequest(proxy, base + "/chunked", true)
|
||||
const heldResult = await proxyRequest(proxy, "http://held.example/held-open", true)
|
||||
await new Promise((resolve) => setImmediate(resolve))
|
||||
console.log(JSON.stringify({
|
||||
unauthorized,
|
||||
forwarded,
|
||||
posted,
|
||||
chunked,
|
||||
held: heldResult,
|
||||
opened: opened.length,
|
||||
destinationsCorrect: opened.slice(0, 3).every((item) => item.host === "127.0.0.1" && item.port === decoyAddress.port) && opened[3]?.host === "held.example" && opened[3]?.port === 80,
|
||||
directConnections,
|
||||
heldDestroyed: held?.destroyed === true,
|
||||
}))
|
||||
} finally {
|
||||
await proxy.close()
|
||||
targetServer.closeAllConnections()
|
||||
decoy.closeAllConnections()
|
||||
await Promise.all([new Promise((resolve) => targetServer.close(resolve)), new Promise((resolve) => decoy.close(resolve))])
|
||||
}`
|
||||
}
|
||||
|
||||
function proxyConnect(proxy: ProxyInfo, destination: string) {
|
||||
return new Promise<{ status: number; socket: TLSSocket; leftover: Buffer }>((resolve, reject) => {
|
||||
const socket = connect(
|
||||
{
|
||||
host: "127.0.0.1",
|
||||
port: proxy.port,
|
||||
servername: proxy.host.endsWith(".localhost") ? proxy.host : undefined,
|
||||
rejectUnauthorized: false,
|
||||
},
|
||||
() => {
|
||||
socket.write(
|
||||
`CONNECT ${destination} HTTP/1.1\r\nHost: ${destination}\r\nProxy-Authorization: ${authorization(proxy)}\r\n\r\n`,
|
||||
)
|
||||
},
|
||||
)
|
||||
let buffered = Buffer.alloc(0)
|
||||
let settled = false
|
||||
const onData = (chunk: Buffer) => {
|
||||
buffered = Buffer.concat([buffered, chunk])
|
||||
const end = buffered.indexOf("\r\n\r\n")
|
||||
if (end < 0) return
|
||||
socket.off("data", onData)
|
||||
const status = Number(buffered.toString("ascii", 0, end).split(" ", 2)[1])
|
||||
settled = true
|
||||
resolve({ status, socket, leftover: buffered.subarray(end + 4) })
|
||||
}
|
||||
socket.on("data", onData)
|
||||
socket.once("error", reject)
|
||||
socket.once("close", () => {
|
||||
if (!settled) reject(new Error("Browser proxy connection closed before responding"))
|
||||
})
|
||||
})
|
||||
}
|
||||
|
||||
function readAll(socket: TLSSocket, initial: Buffer) {
|
||||
return new Promise<string>((resolve, reject) => {
|
||||
const chunks = [initial]
|
||||
socket.on("data", (chunk) => chunks.push(chunk))
|
||||
socket.on("end", () => resolve(Buffer.concat(chunks).toString()))
|
||||
socket.once("error", reject)
|
||||
})
|
||||
}
|
||||
|
||||
function peerCertificate(proxy: ProxyInfo) {
|
||||
return new Promise<Buffer>((resolve, reject) => {
|
||||
const socket = connect(
|
||||
{
|
||||
host: "127.0.0.1",
|
||||
port: proxy.port,
|
||||
servername: proxy.host.endsWith(".localhost") ? proxy.host : undefined,
|
||||
rejectUnauthorized: false,
|
||||
},
|
||||
() => {
|
||||
resolve(socket.getPeerCertificate().raw)
|
||||
socket.end()
|
||||
},
|
||||
)
|
||||
socket.once("error", reject)
|
||||
})
|
||||
}
|
||||
|
||||
async function waitFor(check: () => boolean) {
|
||||
for (let attempt = 0; attempt < 100; attempt++) {
|
||||
if (check()) return
|
||||
await Bun.sleep(5)
|
||||
}
|
||||
throw new Error("Timed out waiting for browser proxy test condition")
|
||||
}
|
||||
@@ -0,0 +1,208 @@
|
||||
import { BrowserTunnelProtocol } from "@opencode-ai/protocol/browser-tunnel"
|
||||
import { BROWSER_TUNNEL_PROTOCOL } from "@opencode-ai/protocol/groups/browser"
|
||||
import { Browser } from "@opencode-ai/schema/browser"
|
||||
import { BrowserTunnel } from "@opencode-ai/schema/browser-tunnel"
|
||||
import { Session } from "@opencode-ai/schema/session"
|
||||
import { describe, expect, test } from "bun:test"
|
||||
import { Effect } from "effect"
|
||||
import { once } from "node:events"
|
||||
import { createServer } from "node:http"
|
||||
import WebSocket, { WebSocketServer } from "ws"
|
||||
import { BrowserTunnelError, openBrowserTunnel } from "../../src/node/browser/tunnel"
|
||||
|
||||
const sessionID = Session.ID.make("ses_client_tunnel")
|
||||
const leaseID = Browser.LeaseID.make("brl_clienttunnel")
|
||||
|
||||
describe("browser tunnel", () => {
|
||||
test("enforces byte and frame windows and preserves both half-closes", async () => {
|
||||
const server = await tunnelServer()
|
||||
try {
|
||||
const opening = openBrowserTunnel({
|
||||
endpoint: server.endpoint,
|
||||
sessionID,
|
||||
leaseID,
|
||||
target: { host: BrowserTunnel.Host.make("target.example"), port: BrowserTunnel.Port.make(443) },
|
||||
})
|
||||
const socket = await server.connected
|
||||
const next = frameReader(socket)
|
||||
socket.send(BrowserTunnelProtocol.encodeFromServer({ type: "browser.tunnel.ready" }), { binary: true })
|
||||
const open = await next()
|
||||
expect(open).toMatchObject({
|
||||
type: "control",
|
||||
message: {
|
||||
type: "browser.tunnel.open",
|
||||
sessionID,
|
||||
leaseID,
|
||||
target: { host: "target.example", port: 443 },
|
||||
},
|
||||
})
|
||||
socket.send(
|
||||
BrowserTunnelProtocol.encodeFromServer({
|
||||
type: "browser.tunnel.opened",
|
||||
receiveWindow: BrowserTunnel.WindowSize.make(BrowserTunnelProtocol.InitialWindowBytes),
|
||||
receiveFrames: BrowserTunnel.FrameWindow.make(BrowserTunnelProtocol.InitialFrameWindow),
|
||||
}),
|
||||
{ binary: true },
|
||||
)
|
||||
const tunnel = await opening
|
||||
|
||||
let writeSettled = false
|
||||
const writing = new Promise<void>((resolve, reject) => {
|
||||
tunnel.write(Buffer.alloc(BrowserTunnelProtocol.InitialWindowBytes + 1, 7), (error) => {
|
||||
writeSettled = true
|
||||
if (error) reject(error)
|
||||
else resolve()
|
||||
})
|
||||
})
|
||||
const sent = []
|
||||
for (let index = 0; index < 4; index++) sent.push(await next())
|
||||
expect(sent.every((frame) => frame.type === "data" && frame.data.byteLength === 64 * 1_024)).toBe(true)
|
||||
await Bun.sleep(25)
|
||||
expect(writeSettled).toBe(false)
|
||||
|
||||
socket.send(
|
||||
BrowserTunnelProtocol.encodeFromServer({
|
||||
type: "browser.tunnel.window",
|
||||
bytes: BrowserTunnel.WindowBytes.make(64 * 1_024),
|
||||
frames: BrowserTunnel.FrameWindow.make(1),
|
||||
}),
|
||||
{ binary: true },
|
||||
)
|
||||
const final = await next()
|
||||
expect(final.type === "data" && final.data.byteLength).toBe(1)
|
||||
await writing
|
||||
|
||||
const received = once(tunnel, "data")
|
||||
socket.send(BrowserTunnelProtocol.data(Buffer.from("from server")), { binary: true })
|
||||
expect(Buffer.from((await received)[0]).toString()).toBe("from server")
|
||||
expect(await next()).toEqual({
|
||||
type: "control",
|
||||
message: {
|
||||
type: "browser.tunnel.window",
|
||||
bytes: Buffer.byteLength("from server"),
|
||||
frames: 1,
|
||||
},
|
||||
})
|
||||
|
||||
const localEnd = next()
|
||||
tunnel.end()
|
||||
expect(await localEnd).toEqual({ type: "control", message: { type: "browser.tunnel.end" } })
|
||||
const remoteEnd = once(tunnel, "end")
|
||||
socket.send(BrowserTunnelProtocol.encodeFromServer({ type: "browser.tunnel.end" }), { binary: true })
|
||||
await remoteEnd
|
||||
} finally {
|
||||
await server.close()
|
||||
}
|
||||
})
|
||||
|
||||
test("rejects window credit that does not exactly match complete frames", async () => {
|
||||
const server = await tunnelServer()
|
||||
try {
|
||||
const opening = openBrowserTunnel({
|
||||
endpoint: server.endpoint,
|
||||
sessionID,
|
||||
leaseID,
|
||||
target: { host: BrowserTunnel.Host.make("target.example"), port: BrowserTunnel.Port.make(80) },
|
||||
})
|
||||
const socket = await server.connected
|
||||
const next = frameReader(socket)
|
||||
socket.send(BrowserTunnelProtocol.encodeFromServer({ type: "browser.tunnel.ready" }), { binary: true })
|
||||
await next()
|
||||
socket.send(
|
||||
BrowserTunnelProtocol.encodeFromServer({
|
||||
type: "browser.tunnel.opened",
|
||||
receiveWindow: BrowserTunnel.WindowSize.make(BrowserTunnelProtocol.InitialWindowBytes),
|
||||
receiveFrames: BrowserTunnel.FrameWindow.make(BrowserTunnelProtocol.InitialFrameWindow),
|
||||
}),
|
||||
{ binary: true },
|
||||
)
|
||||
const tunnel = await opening
|
||||
await new Promise<void>((resolve, reject) =>
|
||||
tunnel.write(Buffer.from("frame"), (error) => (error ? reject(error) : resolve())),
|
||||
)
|
||||
await next()
|
||||
const failed = once(tunnel, "error")
|
||||
socket.send(
|
||||
BrowserTunnelProtocol.encodeFromServer({
|
||||
type: "browser.tunnel.window",
|
||||
bytes: BrowserTunnel.WindowBytes.make(4),
|
||||
frames: BrowserTunnel.FrameWindow.make(1),
|
||||
}),
|
||||
{ binary: true },
|
||||
)
|
||||
const error = (await failed)[0]
|
||||
if (!(error instanceof BrowserTunnelError)) throw new Error("expected browser tunnel error")
|
||||
expect(error.code).toBe("protocol_error")
|
||||
expect(await next()).toEqual({
|
||||
type: "control",
|
||||
message: { type: "browser.tunnel.reset", code: "protocol_error" },
|
||||
})
|
||||
} finally {
|
||||
await server.close()
|
||||
}
|
||||
})
|
||||
})
|
||||
|
||||
async function tunnelServer() {
|
||||
const authorization = `Basic ${Buffer.from("opencode:secret").toString("base64")}`
|
||||
const http = createServer()
|
||||
const webSockets = new WebSocketServer({ noServer: true })
|
||||
let resolveConnected!: (socket: WebSocket) => void
|
||||
const connected = new Promise<WebSocket>((resolve) => {
|
||||
resolveConnected = resolve
|
||||
})
|
||||
webSockets.once("connection", resolveConnected)
|
||||
http.on("upgrade", (request, socket, head) => {
|
||||
if (
|
||||
request.url !== "/api/browser/tunnel" ||
|
||||
request.headers.authorization !== authorization ||
|
||||
request.headers["sec-websocket-protocol"] !== BROWSER_TUNNEL_PROTOCOL
|
||||
) {
|
||||
socket.end("HTTP/1.1 401 Unauthorized\r\n\r\n")
|
||||
return
|
||||
}
|
||||
webSockets.handleUpgrade(request, socket, head, (webSocket) => webSockets.emit("connection", webSocket, request))
|
||||
})
|
||||
await new Promise<void>((resolve) => http.listen(0, "127.0.0.1", resolve))
|
||||
const address = http.address()
|
||||
if (address === null || typeof address === "string") throw new Error("browser tunnel server did not bind TCP")
|
||||
return {
|
||||
connected,
|
||||
endpoint: {
|
||||
url: `http://127.0.0.1:${address.port}`,
|
||||
authorization,
|
||||
},
|
||||
async close() {
|
||||
webSockets.clients.forEach((socket) => socket.terminate())
|
||||
webSockets.close()
|
||||
http.closeAllConnections()
|
||||
http.close()
|
||||
await Bun.sleep(10)
|
||||
},
|
||||
}
|
||||
}
|
||||
|
||||
function frameReader(socket: WebSocket) {
|
||||
const queued: Array<{ readonly data: WebSocket.RawData; readonly binary: boolean }> = []
|
||||
const waiting: Array<(message: { readonly data: WebSocket.RawData; readonly binary: boolean }) => void> = []
|
||||
socket.on("message", (data, binary) => {
|
||||
const resolve = waiting.shift()
|
||||
if (resolve) resolve({ data, binary })
|
||||
else queued.push({ data, binary })
|
||||
})
|
||||
return async () => {
|
||||
const message =
|
||||
queued.shift() ??
|
||||
(await new Promise<{ readonly data: WebSocket.RawData; readonly binary: boolean }>((resolve) =>
|
||||
waiting.push(resolve),
|
||||
))
|
||||
if (!message.binary) throw new Error("Expected a binary browser tunnel frame")
|
||||
return Effect.runPromise(BrowserTunnelProtocol.decodeFromDesktop(rawData(message.data)))
|
||||
}
|
||||
}
|
||||
|
||||
function rawData(data: WebSocket.RawData) {
|
||||
if (data instanceof ArrayBuffer) return new Uint8Array(data)
|
||||
if (Array.isArray(data)) return new Uint8Array(Buffer.concat(data))
|
||||
return new Uint8Array(data.buffer, data.byteOffset, data.byteLength)
|
||||
}
|
||||
@@ -0,0 +1,29 @@
|
||||
import { Browser, BrowserDriver, BrowserDriverError, OpenCode, type BrowserAttachment } from "@opencode-ai/client/node"
|
||||
|
||||
const state: Browser.State = {
|
||||
url: "about:blank",
|
||||
title: "",
|
||||
loading: false,
|
||||
canGoBack: false,
|
||||
canGoForward: false,
|
||||
generation: 0,
|
||||
}
|
||||
|
||||
const factory: BrowserDriver<{ readonly proxyURL: string }> = (context) => ({
|
||||
resource: { proxyURL: context.proxy.url },
|
||||
state: () => state,
|
||||
subscribe: () => () => undefined,
|
||||
execute: async (_command, options) => {
|
||||
throw new BrowserDriverError(options.signal.aborted ? "aborted" : "internal", "Command unavailable")
|
||||
},
|
||||
dispose: () => undefined,
|
||||
})
|
||||
const driver = BrowserDriver.define(factory)
|
||||
|
||||
declare const client: ReturnType<typeof OpenCode.make>
|
||||
const attachment: Promise<BrowserAttachment<{ readonly proxyURL: string }>> = client.browser.attach({
|
||||
sessionID: "ses_type_fixture",
|
||||
driver,
|
||||
})
|
||||
|
||||
void attachment
|
||||
@@ -0,0 +1,8 @@
|
||||
{
|
||||
"$schema": "https://json.schemastore.org/tsconfig",
|
||||
"extends": "../../tsconfig.json",
|
||||
"compilerOptions": {
|
||||
"noEmit": true
|
||||
},
|
||||
"include": ["node-consumer.ts"]
|
||||
}
|
||||
@@ -0,0 +1,10 @@
|
||||
{
|
||||
"$schema": "https://json.schemastore.org/tsconfig",
|
||||
"extends": "../../tsconfig.json",
|
||||
"compilerOptions": {
|
||||
"module": "NodeNext",
|
||||
"moduleResolution": "NodeNext",
|
||||
"noEmit": true
|
||||
},
|
||||
"include": ["node-consumer.ts"]
|
||||
}
|
||||
@@ -351,7 +351,7 @@ export function emitPromise(
|
||||
{
|
||||
path: "index.ts",
|
||||
content:
|
||||
'export { ClientError, type ClientErrorReason } from "./client-error"\nexport * as OpenCode from "./client"\nexport * from "./types"\n',
|
||||
'export { ClientError, type ClientErrorReason } from "./client-error.js"\nexport * as OpenCode from "./client.js"\nexport * from "./types.js"\n',
|
||||
},
|
||||
],
|
||||
}
|
||||
@@ -371,7 +371,9 @@ function renderEffectShape(
|
||||
.map((field) => {
|
||||
const schema = effectInputSchema(endpoint, field)
|
||||
if (schema === undefined) {
|
||||
throw new GenerationError({ reason: `Missing Effect input schema: ${endpoint.group}.${endpoint.endpoint.identifier}.${field.name}` })
|
||||
throw new GenerationError({
|
||||
reason: `Missing Effect input schema: ${endpoint.group}.${endpoint.endpoint.identifier}.${field.name}`,
|
||||
})
|
||||
}
|
||||
return `readonly ${JSON.stringify(field.name)}${field.optional ? "?" : ""}: ${effectType(schema, references, imports)}`
|
||||
})
|
||||
@@ -453,11 +455,7 @@ function effectTypeReferences(input: ReadonlyArray<EffectTypeReference>) {
|
||||
return { names, asts, brands }
|
||||
}
|
||||
|
||||
function effectType(
|
||||
schema: Schema.Top,
|
||||
references: ReturnType<typeof effectTypeReferences>,
|
||||
imports: Set<string>,
|
||||
) {
|
||||
function effectType(schema: Schema.Top, references: ReturnType<typeof effectTypeReferences>, imports: Set<string>) {
|
||||
const projected = Schema.toType(schema)
|
||||
const direct = references.asts.get(schema.ast) ?? references.asts.get(projected.ast)
|
||||
if (direct !== undefined) {
|
||||
@@ -595,7 +593,7 @@ function renderEffectFiles(groups: ReadonlyArray<Group>): Output["files"] {
|
||||
{ path: "client.ts", content: renderClient(groups) },
|
||||
{
|
||||
path: "index.ts",
|
||||
content: 'export { ClientError } from "./client-error"\nexport * as OpenCode from "./client"\n',
|
||||
content: 'export { ClientError } from "./client-error.js"\nexport * as OpenCode from "./client.js"\n',
|
||||
},
|
||||
]
|
||||
}
|
||||
@@ -713,7 +711,7 @@ function renderImportedEffectFiles(
|
||||
{ path: "client.ts", content: client },
|
||||
{
|
||||
path: "index.ts",
|
||||
content: 'export { ClientError } from "./client-error"\nexport * as OpenCode from "./client"\n',
|
||||
content: 'export { ClientError } from "./client-error.js"\nexport * as OpenCode from "./client.js"\n',
|
||||
},
|
||||
]
|
||||
}
|
||||
@@ -1313,7 +1311,13 @@ export function write(
|
||||
output.files,
|
||||
(file) =>
|
||||
Effect.tryPromise({
|
||||
try: () => format(file.content, { filepath: file.path, parser: "typescript", semi: false, printWidth: 120 }),
|
||||
try: () =>
|
||||
format(withJsExtensions(file.content), {
|
||||
filepath: file.path,
|
||||
parser: "typescript",
|
||||
semi: false,
|
||||
printWidth: 120,
|
||||
}),
|
||||
catch: (error) => new GenerationError({ reason: `Failed to format ${file.path}: ${String(error)}` }),
|
||||
}).pipe(Effect.flatMap((content) => fs.writeFileString(join(directory, file.path), content))),
|
||||
{ concurrency: 8, discard: true },
|
||||
@@ -1322,6 +1326,16 @@ export function write(
|
||||
})
|
||||
}
|
||||
|
||||
function withJsExtensions(content: string) {
|
||||
return content
|
||||
.replaceAll(/(from ")(\.\.?\/[^"\n]+)(")/g, (_match, start: string, path: string, end: string) =>
|
||||
/\.[cm]?[jt]sx?$/.test(path) ? `${start}${path}${end}` : `${start}${path}.js${end}`,
|
||||
)
|
||||
.replaceAll(/(import\(")(\.\.?\/[^"\n]+)("\))/g, (_match, start: string, path: string, end: string) =>
|
||||
/\.[cm]?[jt]sx?$/.test(path) ? `${start}${path}${end}` : `${start}${path}.js${end}`,
|
||||
)
|
||||
}
|
||||
|
||||
function isSafeOutputPath(path: string) {
|
||||
return path !== manifestName && !isAbsolute(path) && path !== "." && path !== ".." && !/[\\/]/.test(path)
|
||||
}
|
||||
|
||||
@@ -1,2 +1,2 @@
|
||||
export { ClientError } from "./client-error"
|
||||
export * as OpenCode from "./client"
|
||||
export { ClientError } from "./client-error.js"
|
||||
export * as OpenCode from "./client.js"
|
||||
|
||||
@@ -8,14 +8,14 @@ describe("HttpApiCodegen.write", () => {
|
||||
const writes: Array<{ readonly path: string; readonly content: string }> = []
|
||||
const output: Output = {
|
||||
operations: [],
|
||||
files: [{ path: "session.ts", content: "export const session = {}" }],
|
||||
files: [{ path: "session.ts", content: 'export { session } from "../../session-data"' }],
|
||||
}
|
||||
|
||||
return Effect.gen(function* () {
|
||||
yield* write(output, "/generated")
|
||||
|
||||
expect(writes).toEqual([
|
||||
{ path: "/generated/session.ts", content: "export const session = {}\n" },
|
||||
{ path: "/generated/session.ts", content: 'export { session } from "../../session-data.js"\n' },
|
||||
{ path: "/generated/.httpapi-codegen.json", content: '[\n "session.ts"\n]\n' },
|
||||
])
|
||||
}).pipe(
|
||||
|
||||
+250
-68
@@ -160,6 +160,134 @@
|
||||
"summary": "Get server information"
|
||||
}
|
||||
},
|
||||
"/api/browser/control": {
|
||||
"get": {
|
||||
"tags": [
|
||||
"browser"
|
||||
],
|
||||
"operationId": "v2.browser.control.connect",
|
||||
"parameters": [],
|
||||
"security": [],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Success",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"type": "boolean"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"400": {
|
||||
"description": "InvalidRequestError",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/InvalidRequestError"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"401": {
|
||||
"description": "UnauthorizedError",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/UnauthorizedError"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"403": {
|
||||
"description": "WebSocket Origin is not allowed."
|
||||
},
|
||||
"409": {
|
||||
"description": "ConflictError",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/ConflictError"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"426": {
|
||||
"description": "WebSocket subprotocol opencode.browser.control.v1 is required."
|
||||
}
|
||||
},
|
||||
"description": "Establish an authenticated WebSocket carrying Session-scoped browser attachments and semantic browser commands.",
|
||||
"summary": "Connect desktop browser host",
|
||||
"x-websocket": true,
|
||||
"x-websocket-subprotocol": "opencode.browser.control.v1",
|
||||
"x-websocket-incoming": "BrowserControl.FromDesktop",
|
||||
"x-websocket-outgoing": "BrowserControl.FromServer"
|
||||
}
|
||||
},
|
||||
"/api/browser/tunnel": {
|
||||
"get": {
|
||||
"tags": [
|
||||
"browser"
|
||||
],
|
||||
"operationId": "v2.browser.tunnel.connect",
|
||||
"parameters": [],
|
||||
"security": [],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Success",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"type": "boolean"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"400": {
|
||||
"description": "InvalidRequestError",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/InvalidRequestError"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"401": {
|
||||
"description": "UnauthorizedError",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/UnauthorizedError"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"403": {
|
||||
"description": "WebSocket Origin is not allowed."
|
||||
},
|
||||
"426": {
|
||||
"description": "WebSocket subprotocol opencode.browser.tunnel.v1 is required."
|
||||
},
|
||||
"503": {
|
||||
"description": "ServiceUnavailableError",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/ServiceUnavailableError"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"description": "Establish an authenticated WebSocket carrying one TCP stream dialed from the OpenCode server.",
|
||||
"summary": "Open browser network tunnel",
|
||||
"x-websocket": true,
|
||||
"x-websocket-subprotocol": "opencode.browser.tunnel.v1",
|
||||
"x-websocket-incoming": "BrowserTunnel.FromDesktop and binary DATA frames",
|
||||
"x-websocket-outgoing": "BrowserTunnel.FromServer and binary DATA frames"
|
||||
}
|
||||
},
|
||||
"/api/location": {
|
||||
"get": {
|
||||
"tags": [
|
||||
@@ -12012,6 +12140,64 @@
|
||||
],
|
||||
"additionalProperties": false
|
||||
},
|
||||
"ConflictError": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"_tag": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"ConflictError"
|
||||
]
|
||||
},
|
||||
"message": {
|
||||
"type": "string"
|
||||
},
|
||||
"resource": {
|
||||
"anyOf": [
|
||||
{
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"type": "null"
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"_tag",
|
||||
"message"
|
||||
],
|
||||
"additionalProperties": false
|
||||
},
|
||||
"ServiceUnavailableError": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"_tag": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"ServiceUnavailableError"
|
||||
]
|
||||
},
|
||||
"message": {
|
||||
"type": "string"
|
||||
},
|
||||
"service": {
|
||||
"anyOf": [
|
||||
{
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"type": "null"
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"_tag",
|
||||
"message"
|
||||
],
|
||||
"additionalProperties": false
|
||||
},
|
||||
"Location.Info": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
@@ -12838,35 +13024,6 @@
|
||||
],
|
||||
"additionalProperties": false
|
||||
},
|
||||
"ConflictError": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"_tag": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"ConflictError"
|
||||
]
|
||||
},
|
||||
"message": {
|
||||
"type": "string"
|
||||
},
|
||||
"resource": {
|
||||
"anyOf": [
|
||||
{
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"type": "null"
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"_tag",
|
||||
"message"
|
||||
],
|
||||
"additionalProperties": false
|
||||
},
|
||||
"CommandNotFoundError": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
@@ -13058,35 +13215,6 @@
|
||||
],
|
||||
"additionalProperties": false
|
||||
},
|
||||
"ServiceUnavailableError": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"_tag": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"ServiceUnavailableError"
|
||||
]
|
||||
},
|
||||
"message": {
|
||||
"type": "string"
|
||||
},
|
||||
"service": {
|
||||
"anyOf": [
|
||||
{
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"type": "null"
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"_tag",
|
||||
"message"
|
||||
],
|
||||
"additionalProperties": false
|
||||
},
|
||||
"SessionBusyError": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
@@ -13705,7 +13833,14 @@
|
||||
"type": "string"
|
||||
},
|
||||
"name": {
|
||||
"type": "string"
|
||||
"anyOf": [
|
||||
{
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"type": "null"
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
@@ -13715,7 +13850,7 @@
|
||||
],
|
||||
"additionalProperties": false
|
||||
},
|
||||
"LLM.ToolContent": {
|
||||
"Tool.Content": {
|
||||
"anyOf": [
|
||||
{
|
||||
"$ref": "#/components/schemas/Tool.TextContent"
|
||||
@@ -13741,12 +13876,12 @@
|
||||
"type": "array",
|
||||
"prefixItems": [
|
||||
{
|
||||
"$ref": "#/components/schemas/LLM.ToolContent"
|
||||
"$ref": "#/components/schemas/Tool.Content"
|
||||
}
|
||||
],
|
||||
"minItems": 1,
|
||||
"items": {
|
||||
"$ref": "#/components/schemas/LLM.ToolContent"
|
||||
"$ref": "#/components/schemas/Tool.Content"
|
||||
}
|
||||
},
|
||||
"metadata": {
|
||||
@@ -13795,12 +13930,12 @@
|
||||
"type": "array",
|
||||
"prefixItems": [
|
||||
{
|
||||
"$ref": "#/components/schemas/LLM.ToolContent"
|
||||
"$ref": "#/components/schemas/Tool.Content"
|
||||
}
|
||||
],
|
||||
"minItems": 1,
|
||||
"items": {
|
||||
"$ref": "#/components/schemas/LLM.ToolContent"
|
||||
"$ref": "#/components/schemas/Tool.Content"
|
||||
}
|
||||
},
|
||||
"metadata": {
|
||||
@@ -17114,6 +17249,49 @@
|
||||
],
|
||||
"additionalProperties": false
|
||||
},
|
||||
"Tool.FileContent1": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"type": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"file"
|
||||
]
|
||||
},
|
||||
"uri": {
|
||||
"type": "string"
|
||||
},
|
||||
"mime": {
|
||||
"type": "string"
|
||||
},
|
||||
"name": {
|
||||
"anyOf": [
|
||||
{
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"type": "null"
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"type",
|
||||
"uri",
|
||||
"mime"
|
||||
],
|
||||
"additionalProperties": false
|
||||
},
|
||||
"Tool.Content1": {
|
||||
"anyOf": [
|
||||
{
|
||||
"$ref": "#/components/schemas/Tool.TextContent"
|
||||
},
|
||||
{
|
||||
"$ref": "#/components/schemas/Tool.FileContent1"
|
||||
}
|
||||
]
|
||||
},
|
||||
"Session.Message.ProviderState8": {
|
||||
"type": "object"
|
||||
},
|
||||
@@ -17197,12 +17375,12 @@
|
||||
"type": "array",
|
||||
"prefixItems": [
|
||||
{
|
||||
"$ref": "#/components/schemas/LLM.ToolContent"
|
||||
"$ref": "#/components/schemas/Tool.Content1"
|
||||
}
|
||||
],
|
||||
"minItems": 1,
|
||||
"items": {
|
||||
"$ref": "#/components/schemas/LLM.ToolContent"
|
||||
"$ref": "#/components/schemas/Tool.Content1"
|
||||
}
|
||||
},
|
||||
"metadata": {
|
||||
@@ -17320,12 +17498,12 @@
|
||||
"type": "array",
|
||||
"prefixItems": [
|
||||
{
|
||||
"$ref": "#/components/schemas/LLM.ToolContent"
|
||||
"$ref": "#/components/schemas/Tool.Content1"
|
||||
}
|
||||
],
|
||||
"minItems": 1,
|
||||
"items": {
|
||||
"$ref": "#/components/schemas/LLM.ToolContent"
|
||||
"$ref": "#/components/schemas/Tool.Content1"
|
||||
}
|
||||
},
|
||||
"metadata": {
|
||||
@@ -29135,6 +29313,10 @@
|
||||
{
|
||||
"name": "server"
|
||||
},
|
||||
{
|
||||
"name": "browser",
|
||||
"description": "Desktop browser host control and server-network tunnel routes."
|
||||
},
|
||||
{
|
||||
"name": "location"
|
||||
},
|
||||
|
||||
@@ -14,6 +14,7 @@ import { SkillGroup } from "./groups/skill.js"
|
||||
import { EventGroup, makeEventGroup } from "./groups/event.js"
|
||||
import type { Definition } from "@opencode-ai/schema/event"
|
||||
import { AgentGroup } from "./groups/agent.js"
|
||||
import { BrowserGroup } from "./groups/browser.js"
|
||||
import { PluginGroup } from "./groups/plugin.js"
|
||||
import { HealthGroup } from "./groups/health.js"
|
||||
import { ServerGroup } from "./groups/server.js"
|
||||
@@ -85,6 +86,7 @@ type ApiGroups<
|
||||
| typeof HealthGroup
|
||||
| typeof ServerGroup
|
||||
| typeof DebugGroup
|
||||
| typeof BrowserGroup
|
||||
| LocationGroups<LocationId>
|
||||
| FormGroups<LocationId, LocationService, FormLocationId, FormLocationService>
|
||||
| SessionGroups<SessionLocationId, SessionLocationService>
|
||||
@@ -146,6 +148,7 @@ const makeApiFromGroup = <
|
||||
HttpApi.make("server")
|
||||
.add(HealthGroup)
|
||||
.add(ServerGroup)
|
||||
.add(BrowserGroup)
|
||||
.add(LocationGroup.middleware(locationMiddleware))
|
||||
.add(AgentGroup.middleware(locationMiddleware))
|
||||
.add(PluginGroup.middleware(locationMiddleware))
|
||||
|
||||
@@ -38,6 +38,7 @@ export const groupNames = {
|
||||
"server.debug": "debug",
|
||||
"server.location": "location",
|
||||
"server.agent": "agent",
|
||||
"server.browser": "browser",
|
||||
"server.plugin": "plugin",
|
||||
"server.session": "session",
|
||||
"server.message": "message",
|
||||
@@ -63,5 +64,16 @@ export const groupNames = {
|
||||
"server.vcs": "vcs",
|
||||
} as const
|
||||
|
||||
export const promiseOmitEndpoints = new Set(["pty.connect", "pty.connectToken"])
|
||||
export const effectOmitEndpoints = new Set(["fs.read", "pty.connect", "pty.connectToken"])
|
||||
export const promiseOmitEndpoints = new Set([
|
||||
"browser.control.connect",
|
||||
"browser.tunnel.connect",
|
||||
"pty.connect",
|
||||
"pty.connectToken",
|
||||
])
|
||||
export const effectOmitEndpoints = new Set([
|
||||
"browser.control.connect",
|
||||
"browser.tunnel.connect",
|
||||
"fs.read",
|
||||
"pty.connect",
|
||||
"pty.connectToken",
|
||||
])
|
||||
|
||||
@@ -0,0 +1,24 @@
|
||||
export * as BrowserClose from "./browser-close"
|
||||
|
||||
import type { BrowserHost } from "@opencode-ai/core/browser-host"
|
||||
|
||||
export const Code = {
|
||||
Normal: 1000,
|
||||
GoingAway: 1001,
|
||||
ProtocolError: 1002,
|
||||
InvalidPayload: 1007,
|
||||
MessageTooLarge: 1009,
|
||||
InternalError: 1011,
|
||||
Restart: 1012,
|
||||
TryAgainLater: 1013,
|
||||
UpstreamError: 1014,
|
||||
} as const
|
||||
|
||||
export function control(reason: BrowserHost.CloseReason) {
|
||||
if (reason === "disconnected") return Code.GoingAway
|
||||
if (reason === "protocol_error") return Code.ProtocolError
|
||||
if (reason === "message_too_large") return Code.MessageTooLarge
|
||||
if (reason === "overloaded") return Code.TryAgainLater
|
||||
if (reason === "restart") return Code.Restart
|
||||
return Code.InternalError
|
||||
}
|
||||
@@ -0,0 +1,119 @@
|
||||
export * as BrowserControlConnection from "./browser-control-connection"
|
||||
|
||||
import { BrowserHost } from "@opencode-ai/core/browser-host"
|
||||
import { BrowserControlProtocol } from "@opencode-ai/protocol/browser-control"
|
||||
import { BrowserControl } from "@opencode-ai/schema/browser-control"
|
||||
import { Cause, Effect, Queue, Ref, Stream } from "effect"
|
||||
import { Socket } from "effect/unstable/socket"
|
||||
import { BrowserClose } from "./browser-close"
|
||||
|
||||
const InboundCapacity = 64
|
||||
const OutboundCapacity = 64
|
||||
const InboundBytes = BrowserControlProtocol.MaxMessageBytes * 2
|
||||
const encoder = new TextEncoder()
|
||||
|
||||
type Inbound = {
|
||||
readonly message: BrowserControl.FromDesktop
|
||||
readonly bytes: number
|
||||
}
|
||||
|
||||
export const make = Effect.fn("BrowserControlConnection.make")(function* (
|
||||
socket: Socket.Socket,
|
||||
opened: Effect.Effect<void> = Effect.void,
|
||||
) {
|
||||
const inbound = yield* Queue.dropping<Inbound, BrowserHost.ConnectionError>(InboundCapacity)
|
||||
const outbound = yield* Queue.dropping<string | Socket.CloseEvent>(OutboundCapacity)
|
||||
const inboundBytes = yield* Ref.make(0)
|
||||
const write = yield* socket.writer
|
||||
|
||||
const fail = (kind: BrowserHost.ConnectionError["kind"], message: string, cause?: unknown) =>
|
||||
Effect.sync(() => {
|
||||
Queue.failCauseUnsafe(inbound, Cause.fail(new BrowserHost.ConnectionError({ kind, message, cause })))
|
||||
})
|
||||
|
||||
yield* socket
|
||||
.runRaw(
|
||||
(message) =>
|
||||
Effect.gen(function* () {
|
||||
const bytes = typeof message === "string" ? encoder.encode(message).byteLength : message.byteLength
|
||||
const admitted = yield* Ref.modify(inboundBytes, (current) =>
|
||||
current + bytes <= InboundBytes ? [true, current + bytes] : [false, current],
|
||||
)
|
||||
if (!admitted) return yield* fail("overloaded", "Browser control receive byte budget is full.")
|
||||
return yield* BrowserControlProtocol.decodeFromDesktop(message).pipe(
|
||||
Effect.matchEffect({
|
||||
onFailure: (cause) =>
|
||||
Ref.update(inboundBytes, (current) => Math.max(0, current - bytes)).pipe(
|
||||
Effect.andThen(
|
||||
fail(
|
||||
cause.kind === "too_large" ? "message_too_large" : "invalid_message",
|
||||
"Browser control message is invalid.",
|
||||
cause,
|
||||
),
|
||||
),
|
||||
),
|
||||
onSuccess: (value) => {
|
||||
if (Queue.offerUnsafe(inbound, { message: value, bytes })) return Effect.void
|
||||
return Ref.update(inboundBytes, (current) => Math.max(0, current - bytes)).pipe(
|
||||
Effect.andThen(fail("overloaded", "Browser control receive queue is full.")),
|
||||
)
|
||||
},
|
||||
}),
|
||||
)
|
||||
}),
|
||||
{
|
||||
onOpen: opened.pipe(
|
||||
Effect.andThen(write(BrowserControlProtocol.encodeFromServer({ type: "browser.control.ready" }))),
|
||||
Effect.orDie,
|
||||
),
|
||||
},
|
||||
)
|
||||
.pipe(
|
||||
Effect.matchCauseEffect({
|
||||
onSuccess: () => fail("closed", "Browser control connection closed."),
|
||||
onFailure: (cause) => fail("transport", "Browser control connection failed.", Cause.squash(cause)),
|
||||
}),
|
||||
Effect.forkScoped,
|
||||
)
|
||||
|
||||
yield* Effect.gen(function* () {
|
||||
while (true) yield* write(yield* Queue.take(outbound))
|
||||
}).pipe(
|
||||
Effect.catch((cause) => fail("transport", "Browser control writer failed.", cause)),
|
||||
Effect.forkScoped,
|
||||
)
|
||||
|
||||
yield* Effect.addFinalizer(() =>
|
||||
Effect.all([Queue.shutdown(inbound), Queue.shutdown(outbound)], { concurrency: "unbounded", discard: true }),
|
||||
)
|
||||
|
||||
return {
|
||||
messages: Stream.fromQueue(inbound).pipe(
|
||||
Stream.mapEffect((item) =>
|
||||
Ref.update(inboundBytes, (current) => Math.max(0, current - item.bytes)).pipe(Effect.as(item.message)),
|
||||
),
|
||||
),
|
||||
send: (message) =>
|
||||
Effect.try({
|
||||
try: () => BrowserControlProtocol.encodeFromServer(message),
|
||||
catch: (cause) =>
|
||||
new BrowserHost.ConnectionError({
|
||||
kind: "transport",
|
||||
message: "Failed to encode browser control message.",
|
||||
cause,
|
||||
}),
|
||||
}).pipe(
|
||||
Effect.flatMap((frame) => Queue.offer(outbound, frame)),
|
||||
Effect.flatMap((offered) =>
|
||||
offered
|
||||
? Effect.void
|
||||
: new BrowserHost.ConnectionError({ kind: "overloaded", message: "Browser control send queue is full." }),
|
||||
),
|
||||
),
|
||||
close: (close, message) =>
|
||||
write(new Socket.CloseEvent(BrowserClose.control(close), message.slice(0, 123))).pipe(
|
||||
Effect.timeoutOrElse({ duration: "1 second", orElse: () => Effect.void }),
|
||||
Effect.catch(() => Effect.void),
|
||||
),
|
||||
} satisfies BrowserHost.Peer
|
||||
})
|
||||
@@ -0,0 +1,618 @@
|
||||
export * as BrowserTunnelServer from "./browser-tunnel"
|
||||
|
||||
import { BrowserHost } from "@opencode-ai/core/browser-host"
|
||||
import { BrowserTunnelProtocol } from "@opencode-ai/protocol/browser-tunnel"
|
||||
import { BrowserTunnel } from "@opencode-ai/schema/browser-tunnel"
|
||||
import {
|
||||
Cause,
|
||||
Context,
|
||||
Deferred,
|
||||
Effect,
|
||||
Fiber,
|
||||
Layer,
|
||||
Option,
|
||||
Queue,
|
||||
Ref,
|
||||
Result,
|
||||
Schema,
|
||||
Scope,
|
||||
Semaphore,
|
||||
Stream,
|
||||
SynchronizedRef,
|
||||
} from "effect"
|
||||
import { Socket } from "effect/unstable/socket"
|
||||
import { BrowserClose } from "./browser-close"
|
||||
|
||||
const ActiveLimit = 64
|
||||
const InboundCapacity = BrowserTunnelProtocol.InitialFrameWindow * 2 + 4
|
||||
|
||||
export class CapacityError extends Schema.TaggedErrorClass<CapacityError>()("BrowserTunnel.CapacityError", {
|
||||
limit: Schema.Int,
|
||||
message: Schema.String,
|
||||
}) {}
|
||||
|
||||
class TransportError extends Schema.TaggedErrorClass<TransportError>()("BrowserTunnel.TransportError", {
|
||||
kind: Schema.Literals(["socket_closed", "protocol", "too_large", "target", "lease_revoked"]),
|
||||
message: Schema.String,
|
||||
cause: Schema.optional(Schema.Defect()),
|
||||
}) {}
|
||||
|
||||
class ConnectError extends Schema.TaggedErrorClass<ConnectError>()("BrowserTunnel.ConnectError", {
|
||||
kind: Schema.Literals(["failed", "timeout"]),
|
||||
message: Schema.String,
|
||||
cause: Schema.optional(Schema.Defect()),
|
||||
}) {}
|
||||
|
||||
type Dial = (host: string, port: number) => Effect.Effect<import("node:net").Socket, ConnectError, Scope.Scope>
|
||||
|
||||
type Inbound = {
|
||||
readonly message: string | Uint8Array
|
||||
}
|
||||
|
||||
type TargetOutput = { readonly type: "data"; readonly data: Uint8Array } | { readonly type: "end" }
|
||||
|
||||
type ServerState = {
|
||||
readonly active: number
|
||||
readonly shutdown: boolean
|
||||
}
|
||||
|
||||
export interface Connection {
|
||||
readonly run: (socket: Socket.Socket, opened?: Effect.Effect<void>) => Effect.Effect<void, never, Scope.Scope>
|
||||
}
|
||||
|
||||
export interface Interface {
|
||||
readonly acquire: Effect.Effect<Connection, CapacityError, Scope.Scope>
|
||||
readonly shutdown: Effect.Effect<void>
|
||||
}
|
||||
|
||||
export class Service extends Context.Service<Service, Interface>()("@opencode/server/BrowserTunnel") {}
|
||||
|
||||
export function make(dial: Dial = connect) {
|
||||
return Effect.gen(function* () {
|
||||
const browser = yield* BrowserHost.Service
|
||||
const state = yield* SynchronizedRef.make<ServerState>({ active: 0, shutdown: false })
|
||||
const connections = new Set<Effect.Effect<void>>()
|
||||
|
||||
const shutdown = Effect.fn("BrowserTunnel.shutdown")(function* () {
|
||||
const first = yield* SynchronizedRef.modify(state, (current) => [
|
||||
!current.shutdown,
|
||||
{ ...current, shutdown: true },
|
||||
])
|
||||
if (!first) return
|
||||
yield* Effect.all(Array.from(connections), { concurrency: "unbounded", discard: true })
|
||||
})
|
||||
|
||||
yield* Effect.addFinalizer(() => shutdown())
|
||||
|
||||
const acquire: Interface["acquire"] = Effect.acquireRelease(
|
||||
SynchronizedRef.modifyEffect(
|
||||
state,
|
||||
Effect.fnUntraced(function* (current) {
|
||||
if (current.shutdown) {
|
||||
return yield* new CapacityError({
|
||||
limit: ActiveLimit,
|
||||
message: "The browser tunnel server is shutting down.",
|
||||
})
|
||||
}
|
||||
if (current.active >= ActiveLimit) {
|
||||
return yield* new CapacityError({
|
||||
limit: ActiveLimit,
|
||||
message: "The browser tunnel limit has been reached.",
|
||||
})
|
||||
}
|
||||
return [undefined, { ...current, active: current.active + 1 }] as const
|
||||
}),
|
||||
),
|
||||
() => SynchronizedRef.update(state, (current) => ({ ...current, active: Math.max(0, current.active - 1) })),
|
||||
).pipe(
|
||||
Effect.andThen(Ref.make(false)),
|
||||
Effect.map((started) => ({
|
||||
run: (socket: Socket.Socket, opened = Effect.void) =>
|
||||
Effect.gen(function* () {
|
||||
const write = yield* socket.writer
|
||||
if (yield* Ref.getAndSet(started, true)) {
|
||||
yield* close(write, BrowserClose.Code.ProtocolError, "Browser tunnel connection can only run once")
|
||||
return
|
||||
}
|
||||
const restart = write(new Socket.CloseEvent(BrowserClose.Code.Restart, "Server restarting")).pipe(
|
||||
Effect.timeoutOrElse({ duration: "1 second", orElse: () => Effect.void }),
|
||||
Effect.catch(() => Effect.void),
|
||||
)
|
||||
connections.add(restart)
|
||||
yield* Effect.gen(function* () {
|
||||
if ((yield* SynchronizedRef.get(state)).shutdown) {
|
||||
yield* socket
|
||||
.runRaw(() => Effect.void, { onOpen: opened.pipe(Effect.andThen(restart)) })
|
||||
.pipe(
|
||||
Effect.timeoutOrElse({ duration: "1 second", orElse: () => Effect.void }),
|
||||
Effect.catch(() => Effect.void),
|
||||
)
|
||||
return
|
||||
}
|
||||
yield* serve(browser, socket, write, dial, opened).pipe(Effect.catch(() => Effect.void))
|
||||
}).pipe(Effect.ensuring(Effect.sync(() => connections.delete(restart))))
|
||||
}),
|
||||
})),
|
||||
)
|
||||
|
||||
return Service.of({ acquire, shutdown: shutdown() })
|
||||
})
|
||||
}
|
||||
|
||||
export const layer = Layer.effect(Service, make())
|
||||
|
||||
const serve = Effect.fn("BrowserTunnel.serve")(function* (
|
||||
browser: BrowserHost.Interface,
|
||||
socket: Socket.Socket,
|
||||
writeSocket: (data: string | Uint8Array | Socket.CloseEvent) => Effect.Effect<void, Socket.SocketError>,
|
||||
dial: Dial,
|
||||
opened: Effect.Effect<void>,
|
||||
) {
|
||||
const inbound = yield* Queue.dropping<Inbound, TransportError>(InboundCapacity)
|
||||
|
||||
const reader = yield* socket
|
||||
.runRaw(
|
||||
(message) => {
|
||||
const invalid = rawFrameError(message)
|
||||
if (invalid) return fail(inbound, invalid)
|
||||
return Queue.offerUnsafe(inbound, { message })
|
||||
? Effect.void
|
||||
: fail(inbound, new TransportError({ kind: "protocol", message: "Browser tunnel receive queue is full." }))
|
||||
},
|
||||
{
|
||||
onOpen: opened.pipe(
|
||||
Effect.andThen(writeSocket(BrowserTunnelProtocol.encodeFromServer({ type: "browser.tunnel.ready" }))),
|
||||
Effect.orDie,
|
||||
),
|
||||
},
|
||||
)
|
||||
.pipe(
|
||||
Effect.matchCauseEffect({
|
||||
onSuccess: () =>
|
||||
fail(inbound, new TransportError({ kind: "socket_closed", message: "Browser tunnel closed." })),
|
||||
onFailure: (cause) =>
|
||||
fail(
|
||||
inbound,
|
||||
new TransportError({
|
||||
kind: "socket_closed",
|
||||
message: "Browser tunnel failed.",
|
||||
cause: Cause.squash(cause),
|
||||
}),
|
||||
),
|
||||
}),
|
||||
Effect.forkScoped,
|
||||
)
|
||||
|
||||
const firstResult = yield* Effect.result(
|
||||
Queue.take(inbound).pipe(
|
||||
Effect.timeoutOrElse({
|
||||
duration: "5 seconds",
|
||||
orElse: () => Effect.fail(new TransportError({ kind: "protocol", message: "Browser tunnel open timed out." })),
|
||||
}),
|
||||
),
|
||||
)
|
||||
if (Result.isFailure(firstResult)) {
|
||||
yield* reject(
|
||||
writeSocket,
|
||||
"invalid_open",
|
||||
firstResult.failure.message,
|
||||
firstResult.failure.kind === "too_large" ? BrowserClose.Code.MessageTooLarge : BrowserClose.Code.ProtocolError,
|
||||
)
|
||||
return
|
||||
}
|
||||
const first = firstResult.success
|
||||
const firstFrame = yield* BrowserTunnelProtocol.decodeFromDesktop(first.message).pipe(Effect.option)
|
||||
if (
|
||||
Option.isNone(firstFrame) ||
|
||||
firstFrame.value.type !== "control" ||
|
||||
firstFrame.value.message.type !== "browser.tunnel.open"
|
||||
) {
|
||||
yield* reject(
|
||||
writeSocket,
|
||||
"invalid_open",
|
||||
"Browser tunnel open message is invalid.",
|
||||
BrowserClose.Code.InvalidPayload,
|
||||
)
|
||||
return
|
||||
}
|
||||
const open = firstFrame.value.message
|
||||
|
||||
const lease = yield* browser.lease(open.sessionID)
|
||||
if (Option.isNone(lease)) {
|
||||
yield* reject(
|
||||
writeSocket,
|
||||
"not_attached",
|
||||
"No desktop browser is attached to this Session.",
|
||||
BrowserClose.Code.Normal,
|
||||
)
|
||||
return
|
||||
}
|
||||
if (lease.value.id !== open.leaseID) {
|
||||
yield* reject(writeSocket, "stale_lease", "The desktop browser lease is stale.", BrowserClose.Code.Normal)
|
||||
return
|
||||
}
|
||||
|
||||
const target = yield* Effect.result(
|
||||
Effect.raceFirst(
|
||||
dial(open.target.host, open.target.port),
|
||||
Effect.raceFirst(
|
||||
Fiber.join(reader).pipe(
|
||||
Effect.andThen(new TransportError({ kind: "socket_closed", message: "Browser tunnel closed." })),
|
||||
),
|
||||
lease.value.revoked.pipe(
|
||||
Effect.andThen(new TransportError({ kind: "lease_revoked", message: "Browser attachment was revoked." })),
|
||||
),
|
||||
),
|
||||
),
|
||||
)
|
||||
if (Result.isFailure(target)) {
|
||||
if (target.failure instanceof TransportError) {
|
||||
if (target.failure.kind === "lease_revoked") {
|
||||
yield* reject(writeSocket, "stale_lease", target.failure.message, BrowserClose.Code.Normal)
|
||||
}
|
||||
return
|
||||
}
|
||||
yield* reject(
|
||||
writeSocket,
|
||||
target.failure.kind === "timeout" ? "connect_timeout" : "connect_failed",
|
||||
target.failure.message,
|
||||
BrowserClose.Code.Normal,
|
||||
)
|
||||
return
|
||||
}
|
||||
const tcp = target.success
|
||||
|
||||
const sending = yield* Semaphore.make(1)
|
||||
const outboundBytes = yield* Semaphore.make(open.receiveWindow)
|
||||
const outboundFrames = yield* Semaphore.make(open.receiveFrames)
|
||||
const outboundOutstanding = yield* Ref.make({ bytes: 0, frames: 0 })
|
||||
const inboundRemaining = yield* Ref.make({
|
||||
bytes: BrowserTunnelProtocol.InitialWindowBytes,
|
||||
frames: BrowserTunnelProtocol.InitialFrameWindow,
|
||||
})
|
||||
const targetEnded = yield* Deferred.make<void>()
|
||||
const send = (message: BrowserTunnel.FromServer) =>
|
||||
sending.withPermits(1)(
|
||||
writeSocket(BrowserTunnelProtocol.encodeFromServer(message)).pipe(
|
||||
Effect.mapError(
|
||||
(cause) =>
|
||||
new TransportError({ kind: "socket_closed", message: "Failed to send tunnel control frame.", cause }),
|
||||
),
|
||||
),
|
||||
)
|
||||
const sendData = (data: Uint8Array) =>
|
||||
outboundFrames.take(1).pipe(
|
||||
Effect.andThen(outboundBytes.take(data.byteLength)),
|
||||
Effect.andThen(
|
||||
Ref.update(outboundOutstanding, (outstanding) => ({
|
||||
bytes: outstanding.bytes + data.byteLength,
|
||||
frames: outstanding.frames + 1,
|
||||
})),
|
||||
),
|
||||
Effect.andThen(
|
||||
sending.withPermits(1)(
|
||||
writeSocket(BrowserTunnelProtocol.data(data)).pipe(
|
||||
Effect.mapError(
|
||||
(cause) => new TransportError({ kind: "socket_closed", message: "Failed to send tunnel data.", cause }),
|
||||
),
|
||||
),
|
||||
),
|
||||
),
|
||||
)
|
||||
|
||||
yield* send({
|
||||
type: "browser.tunnel.opened",
|
||||
receiveWindow: BrowserTunnel.WindowSize.make(BrowserTunnelProtocol.InitialWindowBytes),
|
||||
receiveFrames: BrowserTunnel.FrameWindow.make(BrowserTunnelProtocol.InitialFrameWindow),
|
||||
})
|
||||
|
||||
const output = yield* Queue.bounded<TargetOutput, TransportError>(2)
|
||||
const onData = (data: Uint8Array) => {
|
||||
tcp.pause()
|
||||
if (Queue.offerUnsafe(output, { type: "data", data })) return
|
||||
Queue.failCauseUnsafe(
|
||||
output,
|
||||
Cause.fail(new TransportError({ kind: "target", message: "Browser tunnel target output queue is full." })),
|
||||
)
|
||||
}
|
||||
const onEnd = () => {
|
||||
if (Queue.offerUnsafe(output, { type: "end" })) return
|
||||
Queue.failCauseUnsafe(
|
||||
output,
|
||||
Cause.fail(new TransportError({ kind: "target", message: "Browser tunnel target end queue is full." })),
|
||||
)
|
||||
}
|
||||
const onError = (cause: Error) =>
|
||||
Queue.failCauseUnsafe(
|
||||
output,
|
||||
Cause.fail(new TransportError({ kind: "target", message: "Browser tunnel target failed.", cause })),
|
||||
)
|
||||
const onClose = (hadError: boolean) => {
|
||||
if (!hadError) return
|
||||
Queue.failCauseUnsafe(
|
||||
output,
|
||||
Cause.fail(new TransportError({ kind: "target", message: "Browser tunnel target closed with an error." })),
|
||||
)
|
||||
}
|
||||
tcp.on("data", onData)
|
||||
tcp.once("end", onEnd)
|
||||
tcp.once("error", onError)
|
||||
tcp.once("close", onClose)
|
||||
yield* Effect.addFinalizer(() =>
|
||||
Effect.sync(() => {
|
||||
tcp.off("data", onData)
|
||||
tcp.off("end", onEnd)
|
||||
tcp.off("error", onError)
|
||||
tcp.off("close", onClose)
|
||||
}).pipe(Effect.andThen(Queue.shutdown(output))),
|
||||
)
|
||||
|
||||
const desktop = { ended: false, done: false }
|
||||
const fromDesktop = Effect.whileLoop({
|
||||
while: () => !desktop.done,
|
||||
body: () =>
|
||||
Effect.gen(function* () {
|
||||
const frame = desktop.ended
|
||||
? yield* Effect.raceFirst(
|
||||
Queue.take(inbound).pipe(Effect.map(Option.some)),
|
||||
Deferred.await(targetEnded).pipe(Effect.as(Option.none<Inbound>())),
|
||||
)
|
||||
: Option.some(yield* Queue.take(inbound))
|
||||
if (Option.isNone(frame)) {
|
||||
desktop.done = true
|
||||
return
|
||||
}
|
||||
const decoded = yield* BrowserTunnelProtocol.decodeFromDesktop(frame.value.message).pipe(
|
||||
Effect.mapError(
|
||||
(cause) =>
|
||||
new TransportError({
|
||||
kind: cause.kind === "too_large" ? "too_large" : "protocol",
|
||||
message: "Browser tunnel frame is invalid.",
|
||||
cause,
|
||||
}),
|
||||
),
|
||||
)
|
||||
if (decoded.type === "data") {
|
||||
if (desktop.ended) {
|
||||
yield* new TransportError({ kind: "protocol", message: "Browser tunnel received data after end." })
|
||||
return
|
||||
}
|
||||
const accepted = yield* Ref.modify(inboundRemaining, (window) =>
|
||||
decoded.data.byteLength <= window.bytes && window.frames > 0
|
||||
? [true, { bytes: window.bytes - decoded.data.byteLength, frames: window.frames - 1 }]
|
||||
: ([false, window] as const),
|
||||
)
|
||||
if (!accepted) {
|
||||
yield* new TransportError({ kind: "protocol", message: "Browser tunnel receive window exceeded." })
|
||||
return
|
||||
}
|
||||
yield* write(tcp, decoded.data)
|
||||
yield* Ref.update(inboundRemaining, (window) => ({
|
||||
bytes: window.bytes + decoded.data.byteLength,
|
||||
frames: window.frames + 1,
|
||||
}))
|
||||
yield* send({
|
||||
type: "browser.tunnel.window",
|
||||
bytes: BrowserTunnel.WindowBytes.make(decoded.data.byteLength),
|
||||
frames: BrowserTunnel.FrameWindow.make(1),
|
||||
})
|
||||
return
|
||||
}
|
||||
const control = decoded.message
|
||||
if (control.type === "browser.tunnel.open") {
|
||||
yield* new TransportError({ kind: "protocol", message: "Browser tunnel cannot be opened twice." })
|
||||
return
|
||||
}
|
||||
if (control.type === "browser.tunnel.window") {
|
||||
const released = yield* Ref.modify(outboundOutstanding, (outstanding) =>
|
||||
control.bytes <= outstanding.bytes && control.frames <= outstanding.frames
|
||||
? [
|
||||
true,
|
||||
{
|
||||
bytes: outstanding.bytes - control.bytes,
|
||||
frames: outstanding.frames - control.frames,
|
||||
},
|
||||
]
|
||||
: ([false, outstanding] as const),
|
||||
)
|
||||
if (!released) {
|
||||
yield* new TransportError({ kind: "protocol", message: "Browser tunnel window exceeds sent data." })
|
||||
return
|
||||
}
|
||||
yield* outboundBytes.release(control.bytes)
|
||||
yield* outboundFrames.release(control.frames)
|
||||
return
|
||||
}
|
||||
if (control.type === "browser.tunnel.reset") {
|
||||
yield* new TransportError({
|
||||
kind: "socket_closed",
|
||||
message: `Desktop reset browser tunnel: ${control.code}`,
|
||||
})
|
||||
return
|
||||
}
|
||||
if (desktop.ended) {
|
||||
yield* new TransportError({ kind: "protocol", message: "Browser tunnel received duplicate end." })
|
||||
return
|
||||
}
|
||||
yield* end(tcp)
|
||||
desktop.ended = true
|
||||
}),
|
||||
step: () => undefined,
|
||||
})
|
||||
|
||||
const targetState = { done: false }
|
||||
const fromTarget = Effect.whileLoop({
|
||||
while: () => !targetState.done,
|
||||
body: () =>
|
||||
Effect.gen(function* () {
|
||||
const item = yield* Queue.take(output)
|
||||
if (item.type === "end") {
|
||||
yield* send({ type: "browser.tunnel.end" })
|
||||
yield* Deferred.succeed(targetEnded, undefined)
|
||||
targetState.done = true
|
||||
return
|
||||
}
|
||||
yield* sendTargetData(item.data, sendData).pipe(Effect.ensuring(Effect.sync(() => tcp.resume())))
|
||||
}),
|
||||
step: () => undefined,
|
||||
})
|
||||
|
||||
const transfer = Effect.all([fromDesktop, fromTarget], { concurrency: "unbounded", discard: true })
|
||||
yield* Effect.raceFirst(
|
||||
transfer,
|
||||
Effect.raceFirst(
|
||||
Fiber.join(reader).pipe(
|
||||
Effect.andThen(new TransportError({ kind: "socket_closed", message: "Browser tunnel closed." })),
|
||||
),
|
||||
lease.value.revoked.pipe(
|
||||
Effect.andThen(new TransportError({ kind: "lease_revoked", message: "Browser attachment was revoked." })),
|
||||
),
|
||||
),
|
||||
).pipe(
|
||||
Effect.matchEffect({
|
||||
onSuccess: () => close(writeSocket, BrowserClose.Code.Normal, "Browser tunnel complete"),
|
||||
onFailure: (error) =>
|
||||
send({
|
||||
type: "browser.tunnel.reset",
|
||||
code:
|
||||
error.kind === "lease_revoked"
|
||||
? "lease_revoked"
|
||||
: error.kind === "too_large"
|
||||
? "message_too_large"
|
||||
: error.kind === "protocol"
|
||||
? "protocol_error"
|
||||
: error.kind === "target"
|
||||
? "target_error"
|
||||
: "cancelled",
|
||||
}).pipe(
|
||||
Effect.catch(() => Effect.void),
|
||||
Effect.andThen(
|
||||
close(
|
||||
writeSocket,
|
||||
error.kind === "too_large"
|
||||
? BrowserClose.Code.MessageTooLarge
|
||||
: error.kind === "protocol"
|
||||
? BrowserClose.Code.ProtocolError
|
||||
: error.kind === "target"
|
||||
? BrowserClose.Code.UpstreamError
|
||||
: BrowserClose.Code.GoingAway,
|
||||
error.message,
|
||||
),
|
||||
),
|
||||
),
|
||||
}),
|
||||
Effect.ensuring(Effect.sync(() => tcp.destroy())),
|
||||
)
|
||||
})
|
||||
|
||||
function sendTargetData(
|
||||
data: Uint8Array,
|
||||
send: (data: Uint8Array) => Effect.Effect<void, TransportError>,
|
||||
): Effect.Effect<void, TransportError> {
|
||||
return Stream.fromIterable(
|
||||
Array.from({ length: Math.ceil(data.byteLength / BrowserTunnelProtocol.MaxDataBytes) }, (_, index) =>
|
||||
data.subarray(index * BrowserTunnelProtocol.MaxDataBytes, (index + 1) * BrowserTunnelProtocol.MaxDataBytes),
|
||||
),
|
||||
).pipe(Stream.runForEach(send))
|
||||
}
|
||||
|
||||
function rawFrameError(message: string | Uint8Array) {
|
||||
if (typeof message === "string") {
|
||||
return new TransportError({ kind: "protocol", message: "Browser tunnel frames must use binary framing." })
|
||||
}
|
||||
const limit =
|
||||
message[0] === BrowserTunnelProtocol.FrameType.Control
|
||||
? BrowserTunnelProtocol.MaxControlBytes + 1
|
||||
: BrowserTunnelProtocol.MaxDataBytes + 1
|
||||
if (message.byteLength <= limit) return undefined
|
||||
return new TransportError({ kind: "too_large", message: "Browser tunnel frame is too large." })
|
||||
}
|
||||
|
||||
function connect(host: string, port: number) {
|
||||
return Effect.gen(function* () {
|
||||
const net = yield* Effect.promise(() => import("node:net"))
|
||||
return yield* Effect.acquireRelease(
|
||||
Effect.callback<import("node:net").Socket, ConnectError>((resume) => {
|
||||
const socket = new net.Socket({
|
||||
allowHalfOpen: true,
|
||||
})
|
||||
const onError = (cause: Error) => {
|
||||
resume(
|
||||
Effect.fail(
|
||||
new ConnectError({ kind: "failed", message: "Failed to connect browser tunnel target.", cause }),
|
||||
),
|
||||
)
|
||||
}
|
||||
const onConnect = () => {
|
||||
socket.off("error", onError)
|
||||
socket.setNoDelay(true)
|
||||
resume(Effect.succeed(socket))
|
||||
}
|
||||
socket.once("error", onError)
|
||||
socket.connect(port, host, onConnect)
|
||||
return Effect.sync(() => socket.destroy())
|
||||
}).pipe(
|
||||
Effect.timeoutOrElse({
|
||||
duration: "10 seconds",
|
||||
orElse: () =>
|
||||
Effect.fail(new ConnectError({ kind: "timeout", message: "Browser tunnel target connection timed out." })),
|
||||
}),
|
||||
),
|
||||
(socket) => Effect.sync(() => socket.destroy()),
|
||||
)
|
||||
})
|
||||
}
|
||||
|
||||
function write(socket: import("node:net").Socket, data: Uint8Array) {
|
||||
return Effect.callback<void, TransportError>((resume) => {
|
||||
socket.write(data, (cause) => {
|
||||
if (cause) {
|
||||
resume(
|
||||
Effect.fail(new TransportError({ kind: "target", message: "Failed to write browser tunnel data.", cause })),
|
||||
)
|
||||
return
|
||||
}
|
||||
resume(Effect.void)
|
||||
})
|
||||
})
|
||||
}
|
||||
|
||||
function end(socket: import("node:net").Socket) {
|
||||
return Effect.try({
|
||||
try: () => socket.end(),
|
||||
catch: (cause) => new TransportError({ kind: "target", message: "Failed to end browser tunnel target.", cause }),
|
||||
})
|
||||
}
|
||||
|
||||
function reject(
|
||||
write: (data: string | Uint8Array | Socket.CloseEvent) => Effect.Effect<void, Socket.SocketError>,
|
||||
code: BrowserTunnel.OpenErrorCode,
|
||||
message: string,
|
||||
closeCode: number,
|
||||
) {
|
||||
return Effect.try({
|
||||
try: () => BrowserTunnelProtocol.encodeFromServer({ type: "browser.tunnel.rejected", code, message }),
|
||||
catch: () => undefined,
|
||||
}).pipe(
|
||||
Effect.flatMap((frame) => (frame ? write(frame) : Effect.void)),
|
||||
Effect.catch(() => Effect.void),
|
||||
Effect.andThen(close(write, closeCode, message)),
|
||||
)
|
||||
}
|
||||
|
||||
function close(
|
||||
write: (data: string | Uint8Array | Socket.CloseEvent) => Effect.Effect<void, Socket.SocketError>,
|
||||
code: number,
|
||||
reason: string,
|
||||
) {
|
||||
return write(new Socket.CloseEvent(code, reason.slice(0, 123))).pipe(
|
||||
Effect.timeoutOrElse({ duration: "1 second", orElse: () => Effect.void }),
|
||||
Effect.catch(() => Effect.void),
|
||||
)
|
||||
}
|
||||
|
||||
function fail(queue: Queue.Queue<Inbound, TransportError>, error: TransportError) {
|
||||
return Effect.sync(() => {
|
||||
Queue.failCauseUnsafe(queue, Cause.fail(error))
|
||||
})
|
||||
}
|
||||
@@ -11,6 +11,7 @@ import { CommandHandler } from "./handlers/command"
|
||||
import { SkillHandler } from "./handlers/skill"
|
||||
import { EventHandler } from "./handlers/event"
|
||||
import { AgentHandler } from "./handlers/agent"
|
||||
import { BrowserHandler } from "./handlers/browser"
|
||||
import { PluginHandler } from "./handlers/plugin"
|
||||
import { HealthHandler } from "./handlers/health"
|
||||
import { ServerHandler } from "./handlers/server"
|
||||
@@ -35,6 +36,7 @@ export const handlers = Layer.mergeAll(
|
||||
DebugHandler,
|
||||
LocationHandler,
|
||||
AgentHandler,
|
||||
BrowserHandler,
|
||||
PluginHandler,
|
||||
SessionHandler,
|
||||
MessageHandler,
|
||||
|
||||
@@ -0,0 +1,84 @@
|
||||
import { NodeHttpServerRequest } from "@effect/platform-node"
|
||||
import { BrowserHost } from "@opencode-ai/core/browser-host"
|
||||
import { BROWSER_CONTROL_PROTOCOL, BROWSER_TUNNEL_PROTOCOL } from "@opencode-ai/protocol/groups/browser"
|
||||
import { ConflictError, ServiceUnavailableError } from "@opencode-ai/protocol/errors"
|
||||
import { Effect } from "effect"
|
||||
import { HttpServerRequest, HttpServerResponse } from "effect/unstable/http"
|
||||
import { HttpApiBuilder } from "effect/unstable/httpapi"
|
||||
import { ServerResponse } from "node:http"
|
||||
import { Api } from "../api"
|
||||
import { BrowserControlConnection } from "../browser-control-connection"
|
||||
import { BrowserTunnelServer } from "../browser-tunnel"
|
||||
import { CorsConfig, isAllowedRequestOrigin, type CorsOptions } from "../cors"
|
||||
|
||||
export const BrowserHandler = HttpApiBuilder.group(Api, "server.browser", (handlers) =>
|
||||
Effect.gen(function* () {
|
||||
const browser = yield* BrowserHost.Service
|
||||
const tunnels = yield* BrowserTunnelServer.Service
|
||||
const cors = yield* CorsConfig
|
||||
|
||||
return handlers
|
||||
.handleRaw(
|
||||
"browser.control.connect",
|
||||
Effect.fn("BrowserHandler.control")(function* (ctx) {
|
||||
const rejected = rejectUpgrade(ctx.request.headers, BROWSER_CONTROL_PROTOCOL, cors)
|
||||
if (rejected) return rejected
|
||||
const connection = yield* browser.claim.pipe(
|
||||
Effect.mapError((error) => new ConflictError({ resource: "browser", message: error.message })),
|
||||
)
|
||||
const socket = yield* Effect.orDie(ctx.request.upgrade)
|
||||
const peer = yield* BrowserControlConnection.make(
|
||||
socket,
|
||||
Effect.sync(() => markUpgraded(ctx.request)),
|
||||
)
|
||||
yield* connection.run(peer).pipe(
|
||||
Effect.catchTags({
|
||||
"BrowserHost.ProtocolError": (error) =>
|
||||
Effect.logWarning("Browser control protocol failed", { message: error.message }),
|
||||
"BrowserHost.ConnectionError": (error) =>
|
||||
Effect.logDebug("Browser control connection closed", { message: error.message }),
|
||||
}),
|
||||
)
|
||||
return HttpServerResponse.empty()
|
||||
}),
|
||||
)
|
||||
.handleRaw(
|
||||
"browser.tunnel.connect",
|
||||
Effect.fn("BrowserHandler.tunnel")(function* (ctx) {
|
||||
const rejected = rejectUpgrade(ctx.request.headers, BROWSER_TUNNEL_PROTOCOL, cors)
|
||||
if (rejected) return rejected
|
||||
const connection = yield* tunnels.acquire.pipe(
|
||||
Effect.mapError((error) => new ServiceUnavailableError({ service: "browser", message: error.message })),
|
||||
)
|
||||
const socket = yield* Effect.orDie(ctx.request.upgrade)
|
||||
yield* connection.run(
|
||||
socket,
|
||||
Effect.sync(() => markUpgraded(ctx.request)),
|
||||
)
|
||||
return HttpServerResponse.empty()
|
||||
}),
|
||||
)
|
||||
}),
|
||||
)
|
||||
|
||||
function markUpgraded(request: HttpServerRequest.HttpServerRequest) {
|
||||
const socket = NodeHttpServerRequest.toIncomingMessage(request).socket
|
||||
// Bun leaves its HTTP handshake response assigned after ws takes ownership. Detaching
|
||||
// matches Node's post-upgrade socket state and lets Effect complete the raw handler normally.
|
||||
const response = Reflect.get(socket, "_httpMessage")
|
||||
if (response instanceof ServerResponse) response.detachSocket(socket)
|
||||
}
|
||||
|
||||
function rejectUpgrade(
|
||||
headers: Readonly<Record<string, string | undefined>>,
|
||||
protocol: string,
|
||||
cors: CorsOptions | undefined,
|
||||
) {
|
||||
if (!isAllowedRequestOrigin(headers.origin, headers.host, cors)) {
|
||||
return HttpServerResponse.empty({ status: 403 })
|
||||
}
|
||||
if (headers["sec-websocket-protocol"]?.split(",", 1)[0]?.trim() !== protocol) {
|
||||
return HttpServerResponse.empty({ status: 426, headers: { "sec-websocket-protocol": protocol } })
|
||||
}
|
||||
return undefined
|
||||
}
|
||||
@@ -3,6 +3,7 @@ import { UnauthorizedError } from "@opencode-ai/protocol/errors"
|
||||
import { Authorization } from "@opencode-ai/protocol/middleware/authorization"
|
||||
export { Authorization } from "@opencode-ai/protocol/middleware/authorization"
|
||||
import { hasPtyConnectTicketURL } from "@opencode-ai/protocol/groups/pty"
|
||||
import { isBrowserConnectURL } from "@opencode-ai/protocol/groups/browser"
|
||||
import { Effect, Encoding, Layer, Redacted } from "effect"
|
||||
import { HttpEffect, HttpServerRequest, HttpServerResponse } from "effect/unstable/http"
|
||||
|
||||
@@ -28,7 +29,7 @@ function decodeCredential(input: string) {
|
||||
|
||||
function credentialFromRequest(request: HttpServerRequest.HttpServerRequest) {
|
||||
const url = new URL(request.url, "http://localhost")
|
||||
const token = url.searchParams.get(AUTH_TOKEN_QUERY)
|
||||
const token = isBrowserConnectURL(request.url) ? undefined : url.searchParams.get(AUTH_TOKEN_QUERY)
|
||||
if (token) return decodeCredential(token)
|
||||
const match = /^Basic\s+(.+)$/i.exec(request.headers.authorization ?? "")
|
||||
if (match) return decodeCredential(match[1])
|
||||
|
||||
@@ -2,6 +2,7 @@ export * as ServerProcess from "./process"
|
||||
|
||||
import { NodeHttpServer, NodeHttpServerRequest } from "@effect/platform-node"
|
||||
import { SessionRestart } from "@opencode-ai/core/session/execution/restart"
|
||||
import { BrowserHost } from "@opencode-ai/core/browser-host"
|
||||
import { ServiceStatus } from "@opencode-ai/protocol/groups/health"
|
||||
import { hasPtyConnectTicketURL } from "@opencode-ai/protocol/groups/pty"
|
||||
import { Cause, Context, Deferred, Effect, Exit, Layer, Option, Ref, Schema, Scope } from "effect"
|
||||
@@ -15,6 +16,7 @@ import { withoutParentSpan } from "./request-tracing"
|
||||
import { createRoutes } from "./routes"
|
||||
import { ServerInfo } from "./server-info"
|
||||
import { Status } from "./service-status"
|
||||
import { BrowserTunnelServer } from "./browser-tunnel"
|
||||
import type { ServerOptions } from "./options"
|
||||
|
||||
export interface Lifecycle<E = never, R = never> {
|
||||
@@ -46,6 +48,7 @@ export const start = Effect.fn("ServerProcess.start")(function* <E, R>(
|
||||
})
|
||||
const bound = yield* listen({ hostname, port })
|
||||
const application = yield* Ref.make(Option.none<App>())
|
||||
const applicationShutdown = yield* Ref.make(Effect.void)
|
||||
// Request fibers may continue inbound trace context, but must not inherit the server startup parent.
|
||||
yield* bound.http
|
||||
.serve(
|
||||
@@ -68,6 +71,7 @@ export const start = Effect.fn("ServerProcess.start")(function* <E, R>(
|
||||
yield* Effect.addFinalizer(() =>
|
||||
status.beginStopping.pipe(
|
||||
Effect.andThen(Ref.set(application, Option.none())),
|
||||
Effect.andThen(Ref.get(applicationShutdown).pipe(Effect.flatMap((shutdown) => shutdown))),
|
||||
Effect.andThen(Effect.sync(() => bound.server.closeAllConnections())),
|
||||
),
|
||||
)
|
||||
@@ -94,6 +98,12 @@ export const start = Effect.fn("ServerProcess.start")(function* <E, R>(
|
||||
)
|
||||
}
|
||||
yield* Ref.set(application, Option.some(Context.get(context, HttpRouter.HttpRouter).asHttpEffect()))
|
||||
yield* Ref.set(
|
||||
applicationShutdown,
|
||||
Context.get(context, BrowserTunnelServer.Service).shutdown.pipe(
|
||||
Effect.andThen(Context.get(context, BrowserHost.Service).shutdown),
|
||||
),
|
||||
)
|
||||
yield* status.ready
|
||||
return { address: bound.http.address, shutdown: Deferred.await(shutdown) }
|
||||
}).pipe(
|
||||
@@ -130,9 +140,39 @@ function bind(hostname: string, port: number) {
|
||||
const parentScope = yield* Scope.Scope
|
||||
const serverScope = yield* Scope.fork(parentScope)
|
||||
const server = createServer()
|
||||
const sockets = new Set<import("node:net").Socket>()
|
||||
const onConnection = (socket: import("node:net").Socket) => {
|
||||
sockets.add(socket)
|
||||
socket.once("close", () => sockets.delete(socket))
|
||||
}
|
||||
const onUpgrade = (_request: unknown, socket: import("node:net").Socket) => sockets.add(socket)
|
||||
server.on("connection", onConnection)
|
||||
server.on("upgrade", onUpgrade)
|
||||
return yield* Effect.gen(function* () {
|
||||
const http = yield* NodeHttpServer.make(() => server, { port, host: hostname })
|
||||
yield* Effect.addFinalizer(() => Effect.sync(() => server.closeAllConnections()))
|
||||
// Node's closeAllConnections deliberately excludes upgraded sockets.
|
||||
yield* Effect.addFinalizer(() =>
|
||||
Effect.sync(() => {
|
||||
server.off("connection", onConnection)
|
||||
server.off("upgrade", onUpgrade)
|
||||
server.closeAllConnections()
|
||||
}).pipe(
|
||||
Effect.andThen(
|
||||
Effect.suspend(() => {
|
||||
if (sockets.size === 0) return Effect.void
|
||||
return Effect.sleep("1 second").pipe(
|
||||
Effect.andThen(
|
||||
Effect.sync(() => {
|
||||
for (const socket of sockets) socket.destroy()
|
||||
sockets.clear()
|
||||
}),
|
||||
),
|
||||
)
|
||||
}),
|
||||
),
|
||||
),
|
||||
)
|
||||
return { http, server, scope: serverScope }
|
||||
}).pipe(
|
||||
Effect.provideService(Scope.Scope, serverScope),
|
||||
@@ -241,7 +281,8 @@ function unavailable(status: Status.State) {
|
||||
/**
|
||||
* The managed server owns restart continuity: it resumes Sessions the previous server suspended and
|
||||
* suspends its own active Sessions on graceful shutdown. Suspension runs while the drains are still
|
||||
* alive: connections close first, this finalizer runs next, and Session execution teardown follows.
|
||||
* alive: request admission stops first, application-owned transports receive their shutdown signal,
|
||||
* listener connections close, and this finalizer runs during application teardown.
|
||||
*/
|
||||
const installRestartContinuity = Effect.fnUntraced(function* (restart: SessionRestart.Interface) {
|
||||
yield* Effect.forkScoped(restart.resumeSuspendedSessions)
|
||||
|
||||
@@ -4,6 +4,7 @@ import { LayerNode } from "@opencode-ai/util/effect/layer-node"
|
||||
import { httpClient } from "@opencode-ai/util/effect/app-node-platform"
|
||||
import { AppNodeBuilder } from "@opencode-ai/core/effect/app-node-builder"
|
||||
import { Bus } from "@opencode-ai/core/bus"
|
||||
import { BrowserHost } from "@opencode-ai/core/browser-host"
|
||||
import { EventLogger } from "@opencode-ai/core/event-logger"
|
||||
import { FileSystemSearch } from "@opencode-ai/core/filesystem/search"
|
||||
import { Observability } from "@opencode-ai/util/observability"
|
||||
@@ -40,11 +41,13 @@ import { layer } from "./location"
|
||||
import { formLocationLayer } from "./middleware/form-location"
|
||||
import { sessionLocationLayer } from "./middleware/session-location"
|
||||
import { ServerInfo } from "./server-info"
|
||||
import { BrowserTunnelServer } from "./browser-tunnel"
|
||||
import type { ServerOptions } from "./options"
|
||||
|
||||
const applicationServices = LayerNode.group([
|
||||
Database.node,
|
||||
Bus.node,
|
||||
BrowserHost.node,
|
||||
EventLogger.node,
|
||||
httpClient,
|
||||
Job.node,
|
||||
@@ -131,6 +134,7 @@ function makeRoutes<AuthError, AuthServices>(
|
||||
return serviceLayer.pipe(
|
||||
Layer.flatMap((context) => {
|
||||
const services = Layer.succeedContext(context)
|
||||
const browserTunnel = BrowserTunnelServer.layer.pipe(Layer.provide(services))
|
||||
const requestServices = Layer.merge(
|
||||
Layer.succeedContext(Context.pick(PermissionSaved.Service, Project.Service, WellKnown.Service)(context)),
|
||||
ServerInfo.layer(serviceURLs, options.app),
|
||||
@@ -144,6 +148,7 @@ function makeRoutes<AuthError, AuthServices>(
|
||||
Layer.provide(schemaErrorLayer),
|
||||
Layer.provide(auth),
|
||||
HttpRouter.provideRequest(requestServices),
|
||||
Layer.provideMerge(browserTunnel),
|
||||
Layer.provideMerge(services),
|
||||
Layer.provideMerge(HttpRouter.layer),
|
||||
)
|
||||
|
||||
@@ -0,0 +1,105 @@
|
||||
import { BrowserHost } from "@opencode-ai/core/browser-host"
|
||||
import { BrowserTunnelProtocol } from "@opencode-ai/protocol/browser-tunnel"
|
||||
import { Browser } from "@opencode-ai/schema/browser"
|
||||
import { BrowserTunnel } from "@opencode-ai/schema/browser-tunnel"
|
||||
import { Session } from "@opencode-ai/schema/session"
|
||||
import { describe, expect } from "bun:test"
|
||||
import { Deferred, Effect, Fiber, Option, Queue } from "effect"
|
||||
import { Socket } from "effect/unstable/socket"
|
||||
import { it } from "../../core/test/lib/effect"
|
||||
import { BrowserTunnelServer } from "../src/browser-tunnel"
|
||||
|
||||
const sessionID = Session.ID.make("ses_pending_tunnel")
|
||||
const leaseID = Browser.LeaseID.make("brl_pendingtunnel")
|
||||
const state: Browser.State = {
|
||||
url: "https://example.com/",
|
||||
title: "Example",
|
||||
loading: false,
|
||||
canGoBack: false,
|
||||
canGoForward: false,
|
||||
generation: 1,
|
||||
}
|
||||
const end = Symbol("end")
|
||||
|
||||
const makeSocket = Effect.gen(function* () {
|
||||
const inbound = yield* Queue.unbounded<string | Uint8Array | typeof end>()
|
||||
const outbound = yield* Queue.unbounded<string | Uint8Array | Socket.CloseEvent>()
|
||||
return {
|
||||
inbound,
|
||||
outbound,
|
||||
socket: Socket.make({
|
||||
runRaw: (handler, options) =>
|
||||
Effect.gen(function* () {
|
||||
if (options?.onOpen) yield* options.onOpen
|
||||
while (true) {
|
||||
const message = yield* Queue.take(inbound)
|
||||
if (message === end) return
|
||||
const handled = handler(message)
|
||||
if (Effect.isEffect(handled)) yield* Effect.asVoid(handled)
|
||||
}
|
||||
}),
|
||||
writer: Effect.succeed((message) => Queue.offer(outbound, message).pipe(Effect.asVoid)),
|
||||
}),
|
||||
}
|
||||
})
|
||||
|
||||
const cancellationCase = (cause: "reader" | "lease") =>
|
||||
Effect.gen(function* () {
|
||||
const revoked = yield* Deferred.make<void>()
|
||||
const started = yield* Deferred.make<void>()
|
||||
const cancelled = yield* Deferred.make<void>()
|
||||
const browser = BrowserHost.Service.of({
|
||||
claim: Effect.die("unused"),
|
||||
lease: () =>
|
||||
Effect.succeed(
|
||||
Option.some({
|
||||
id: leaseID,
|
||||
sessionID,
|
||||
state,
|
||||
revoked: Deferred.await(revoked),
|
||||
request: () => Effect.die("unused"),
|
||||
}),
|
||||
),
|
||||
shutdown: Effect.void,
|
||||
})
|
||||
const tunnels = yield* BrowserTunnelServer.make(() =>
|
||||
Deferred.succeed(started, undefined).pipe(
|
||||
Effect.andThen(Effect.never),
|
||||
Effect.onInterrupt(() => Deferred.succeed(cancelled, undefined).pipe(Effect.asVoid)),
|
||||
),
|
||||
).pipe(Effect.provideService(BrowserHost.Service, browser))
|
||||
const connection = yield* tunnels.acquire
|
||||
const transport = yield* makeSocket
|
||||
const running = yield* Effect.scoped(connection.run(transport.socket)).pipe(Effect.forkChild)
|
||||
|
||||
const ready = yield* Queue.take(transport.outbound)
|
||||
const frame = ready instanceof Uint8Array ? ready : yield* Effect.die("expected tunnel ready frame")
|
||||
expect(yield* BrowserTunnelProtocol.decodeFromServer(frame)).toEqual({
|
||||
type: "control",
|
||||
message: { type: "browser.tunnel.ready" },
|
||||
})
|
||||
yield* Queue.offer(
|
||||
transport.inbound,
|
||||
BrowserTunnelProtocol.encodeFromDesktop({
|
||||
type: "browser.tunnel.open",
|
||||
sessionID,
|
||||
leaseID,
|
||||
target: { host: BrowserTunnel.Host.make("target.example"), port: BrowserTunnel.Port.make(443) },
|
||||
receiveWindow: BrowserTunnel.WindowSize.make(BrowserTunnelProtocol.InitialWindowBytes),
|
||||
receiveFrames: BrowserTunnel.FrameWindow.make(BrowserTunnelProtocol.InitialFrameWindow),
|
||||
}),
|
||||
)
|
||||
yield* Deferred.await(started)
|
||||
|
||||
if (cause === "reader") yield* Queue.offer(transport.inbound, end)
|
||||
if (cause === "lease") yield* Deferred.succeed(revoked, undefined)
|
||||
|
||||
yield* Deferred.await(cancelled)
|
||||
yield* Fiber.join(running)
|
||||
})
|
||||
|
||||
describe("BrowserTunnelServer", () => {
|
||||
it.effect("interrupts a pending target dial when the reader ends or the lease is revoked", () =>
|
||||
Effect.forEach(["reader", "lease"] as const, cancellationCase, { discard: true }),
|
||||
)
|
||||
})
|
||||
@@ -0,0 +1,468 @@
|
||||
import { NodeSocket } from "@effect/platform-node"
|
||||
import { Browser } from "@opencode-ai/schema/browser"
|
||||
import { BrowserControl } from "@opencode-ai/schema/browser-control"
|
||||
import { BrowserTunnel } from "@opencode-ai/schema/browser-tunnel"
|
||||
import { Session } from "@opencode-ai/schema/session"
|
||||
import { BROWSER_CONTROL_PROTOCOL, BROWSER_TUNNEL_PROTOCOL } from "@opencode-ai/protocol/groups/browser"
|
||||
import { BrowserTunnelProtocol } from "@opencode-ai/protocol/browser-tunnel"
|
||||
import { expect } from "bun:test"
|
||||
import { Deferred, Effect, Exit, Fiber, Queue, Schema, Scope } from "effect"
|
||||
import { TestConsole } from "effect/testing"
|
||||
import { HttpServer } from "effect/unstable/http"
|
||||
import { randomBytes } from "node:crypto"
|
||||
import { request } from "node:http"
|
||||
import { createServer } from "node:net"
|
||||
import { it } from "../../core/test/lib/effect"
|
||||
import { ServerProcess } from "../src/process"
|
||||
|
||||
const authorization = `Basic ${Buffer.from("opencode:secret").toString("base64")}`
|
||||
const encodeControl = Schema.encodeSync(Schema.fromJsonString(BrowserControl.FromDesktop))
|
||||
const decodeControl = Schema.decodeUnknownSync(Schema.fromJsonString(BrowserControl.FromServer))
|
||||
|
||||
const startServer = Effect.fn("BrowserServerTest.startServer")(function* () {
|
||||
const server = yield* ServerProcess.start<never, never>({
|
||||
hostname: "127.0.0.1",
|
||||
port: 0,
|
||||
password: "secret",
|
||||
app: { version: "test-version" },
|
||||
database: { path: ":memory:" },
|
||||
})
|
||||
const url = new URL(HttpServer.formatAddress(server.address))
|
||||
url.protocol = "ws:"
|
||||
return url
|
||||
})
|
||||
|
||||
const open = Effect.fn("BrowserServerTest.open")(function* (
|
||||
url: URL,
|
||||
protocol: string,
|
||||
headers: Record<string, string> = { authorization },
|
||||
) {
|
||||
const messages = yield* Queue.unbounded<{ readonly data: string | Uint8Array; readonly binary: boolean }, Error>()
|
||||
const closed = yield* Deferred.make<{ readonly code: number; readonly reason: string }>()
|
||||
const webSocket = yield* Effect.acquireRelease(
|
||||
Effect.callback<NodeSocket.NodeWS.WebSocket, Error>((resume) => {
|
||||
const webSocket = new NodeSocket.NodeWS.WebSocket(url, protocol, { headers })
|
||||
webSocket.on("message", (data, binary) =>
|
||||
Queue.offerUnsafe(messages, { data: binary ? bytes(data) : Buffer.from(bytes(data)).toString(), binary }),
|
||||
)
|
||||
webSocket.once("close", (code, reason) =>
|
||||
Deferred.doneUnsafe(closed, Effect.succeed({ code, reason: reason.toString() })),
|
||||
)
|
||||
const onOpen = () => {
|
||||
webSocket.off("error", onError)
|
||||
resume(Effect.succeed(webSocket))
|
||||
}
|
||||
const onError = (error: Error) => {
|
||||
webSocket.off("open", onOpen)
|
||||
resume(Effect.fail(error))
|
||||
}
|
||||
webSocket.once("open", onOpen)
|
||||
webSocket.once("error", onError)
|
||||
return Effect.sync(() => webSocket.terminate())
|
||||
}),
|
||||
(webSocket) => Effect.sync(() => webSocket.terminate()),
|
||||
)
|
||||
return { webSocket, messages, closed }
|
||||
})
|
||||
|
||||
const upgradeStatus = (url: URL, protocol: string, headers: Record<string, string> = { authorization }) =>
|
||||
Effect.callback<number, Error>((resume) => {
|
||||
const target = new URL(url)
|
||||
target.protocol = "http:"
|
||||
const upgrade = request(target, {
|
||||
headers: {
|
||||
...headers,
|
||||
connection: "Upgrade",
|
||||
upgrade: "websocket",
|
||||
"sec-websocket-key": randomBytes(16).toString("base64"),
|
||||
"sec-websocket-protocol": protocol,
|
||||
"sec-websocket-version": "13",
|
||||
},
|
||||
})
|
||||
upgrade.once("response", (response) => {
|
||||
resume(Effect.succeed(response.statusCode ?? 0))
|
||||
response.destroy()
|
||||
})
|
||||
upgrade.once("upgrade", (response, socket) => {
|
||||
resume(Effect.succeed(response.statusCode ?? 101))
|
||||
socket.destroy()
|
||||
})
|
||||
upgrade.once("error", (error) => resume(Effect.fail(error)))
|
||||
upgrade.end()
|
||||
return Effect.sync(() => upgrade.destroy())
|
||||
})
|
||||
|
||||
const next = (webSocket: Effect.Success<ReturnType<typeof open>>) => Queue.take(webSocket.messages)
|
||||
|
||||
const exchange = Effect.fn("BrowserServerTest.exchange")(function* (
|
||||
webSocket: Effect.Success<ReturnType<typeof open>>,
|
||||
message: string | Uint8Array,
|
||||
) {
|
||||
yield* Effect.callback<void, Error>((resume) =>
|
||||
webSocket.webSocket.send(message, { binary: typeof message !== "string" }, (error) =>
|
||||
resume(error ? Effect.fail(error) : Effect.void),
|
||||
),
|
||||
)
|
||||
return yield* next(webSocket)
|
||||
})
|
||||
|
||||
function bytes(data: NodeSocket.NodeWS.RawData) {
|
||||
if (data instanceof ArrayBuffer) return new Uint8Array(data)
|
||||
if (Array.isArray(data)) return new Uint8Array(Buffer.concat(data))
|
||||
return new Uint8Array(data.buffer, data.byteOffset, data.byteLength)
|
||||
}
|
||||
|
||||
const tunnelControl = Effect.fn("BrowserServerTest.tunnelControl")(function* (frame: {
|
||||
readonly data: string | Uint8Array
|
||||
}) {
|
||||
const decoded = yield* BrowserTunnelProtocol.decodeFromServer(frame.data)
|
||||
if (decoded.type !== "control") throw new Error("expected browser tunnel control frame")
|
||||
return decoded.message
|
||||
})
|
||||
|
||||
const echoServer = Effect.gen(function* () {
|
||||
const connected = yield* Deferred.make<void>()
|
||||
const ended = yield* Deferred.make<void>()
|
||||
const sentEnd = yield* Deferred.make<void>()
|
||||
const sockets = new Set<import("node:net").Socket>()
|
||||
const server = yield* Effect.acquireRelease(
|
||||
Effect.callback<ReturnType<typeof createServer>, Error>((resume) => {
|
||||
const server = createServer({ allowHalfOpen: true }, (socket) => {
|
||||
sockets.add(socket)
|
||||
Deferred.doneUnsafe(connected, Effect.void)
|
||||
socket.on("data", (data) => socket.write(data))
|
||||
socket.on("end", () => {
|
||||
Deferred.doneUnsafe(ended, Effect.void)
|
||||
socket.end(() => Deferred.doneUnsafe(sentEnd, Effect.void))
|
||||
})
|
||||
socket.once("close", () => sockets.delete(socket))
|
||||
})
|
||||
server.once("error", (error) => resume(Effect.fail(error)))
|
||||
server.listen(0, "127.0.0.1", () => resume(Effect.succeed(server)))
|
||||
return Effect.sync(() => server.close())
|
||||
}),
|
||||
(server) =>
|
||||
Effect.sync(() => {
|
||||
for (const socket of sockets) socket.destroy()
|
||||
server.close()
|
||||
}),
|
||||
)
|
||||
return { server, connected, ended, sentEnd }
|
||||
})
|
||||
|
||||
const pushServer = Effect.acquireRelease(
|
||||
Effect.callback<ReturnType<typeof createServer>, Error>((resume) => {
|
||||
const server = createServer((socket) => socket.end(Buffer.alloc(512 * 1_024, 7)))
|
||||
server.once("error", (error) => resume(Effect.fail(error)))
|
||||
server.listen(0, "127.0.0.1", () => resume(Effect.succeed(server)))
|
||||
return Effect.sync(() => server.close())
|
||||
}),
|
||||
(server) => Effect.sync(() => server.close()),
|
||||
)
|
||||
|
||||
const collectData = (
|
||||
tunnel: Effect.Success<ReturnType<typeof open>>,
|
||||
bytes = 0,
|
||||
frames = 0,
|
||||
): Effect.Effect<{ readonly bytes: number; readonly frames: number }, Error | BrowserTunnelProtocol.FrameError> =>
|
||||
Effect.gen(function* () {
|
||||
const decoded = yield* BrowserTunnelProtocol.decodeFromServer((yield* next(tunnel)).data)
|
||||
if (decoded.type === "data") {
|
||||
tunnel.webSocket.send(
|
||||
BrowserTunnelProtocol.encodeFromDesktop({
|
||||
type: "browser.tunnel.window",
|
||||
bytes: BrowserTunnel.WindowBytes.make(decoded.data.byteLength),
|
||||
frames: BrowserTunnel.FrameWindow.make(1),
|
||||
}),
|
||||
{ binary: true },
|
||||
)
|
||||
return yield* collectData(tunnel, bytes + decoded.data.byteLength, frames + 1)
|
||||
}
|
||||
if (decoded.message.type === "browser.tunnel.window") return yield* collectData(tunnel, bytes, frames)
|
||||
if (decoded.message.type === "browser.tunnel.end") return { bytes, frames }
|
||||
return yield* Effect.fail(new Error(`Unexpected browser tunnel message: ${decoded.message.type}`))
|
||||
})
|
||||
|
||||
it.live(
|
||||
"authenticates browser upgrades and tunnels TCP through an attached lease",
|
||||
() =>
|
||||
Effect.gen(function* () {
|
||||
const base = yield* startServer()
|
||||
const controlURL = new URL("/api/browser/control", base)
|
||||
const tunnelURL = new URL("/api/browser/tunnel", base)
|
||||
|
||||
expect(yield* upgradeStatus(controlURL, BROWSER_CONTROL_PROTOCOL, {})).toBe(401)
|
||||
const queryAuth = new URL(controlURL)
|
||||
queryAuth.searchParams.set("auth_token", Buffer.from("opencode:secret").toString("base64"))
|
||||
expect(yield* upgradeStatus(queryAuth, BROWSER_CONTROL_PROTOCOL, {})).toBe(401)
|
||||
for (const [path, protocol] of [
|
||||
["/api/browser/control/", BROWSER_CONTROL_PROTOCOL],
|
||||
["/%61pi/%62rowser/%63ontrol", BROWSER_CONTROL_PROTOCOL],
|
||||
["/API//browser/control;jsessionid=ignored", BROWSER_CONTROL_PROTOCOL],
|
||||
["/api/browser/tunnel/", BROWSER_TUNNEL_PROTOCOL],
|
||||
["/%61pi/%62rowser/%74unnel", BROWSER_TUNNEL_PROTOCOL],
|
||||
] as const) {
|
||||
const alternate = new URL(path, base)
|
||||
alternate.searchParams.set("auth_token", Buffer.from("opencode:secret").toString("base64"))
|
||||
expect(yield* upgradeStatus(alternate, protocol, {})).toBe(401)
|
||||
}
|
||||
expect(yield* upgradeStatus(controlURL, "opencode.browser.control.invalid")).toBe(426)
|
||||
expect(
|
||||
yield* upgradeStatus(controlURL, BROWSER_CONTROL_PROTOCOL, {
|
||||
authorization,
|
||||
origin: "https://malicious.example",
|
||||
}),
|
||||
).toBe(403)
|
||||
|
||||
const control = yield* open(controlURL, BROWSER_CONTROL_PROTOCOL)
|
||||
expect(decodeControl((yield* next(control)).data)).toEqual({ type: "browser.control.ready" })
|
||||
expect(yield* upgradeStatus(controlURL, BROWSER_CONTROL_PROTOCOL)).toBe(409)
|
||||
|
||||
const sessionID = Session.ID.make("ses_browser_server")
|
||||
const leaseID = Browser.LeaseID.make("brl_browserserver")
|
||||
const sessionURL = new URL("/api/session", base)
|
||||
sessionURL.protocol = "http:"
|
||||
const created = yield* Effect.promise(() =>
|
||||
fetch(sessionURL, {
|
||||
method: "POST",
|
||||
headers: { authorization, "content-type": "application/json" },
|
||||
body: JSON.stringify({ id: sessionID }),
|
||||
}),
|
||||
)
|
||||
expect(created.status).toBe(200)
|
||||
const acknowledged = yield* exchange(
|
||||
control,
|
||||
encodeControl({
|
||||
type: "browser.control.sync",
|
||||
revision: 1,
|
||||
attachments: [
|
||||
{
|
||||
sessionID,
|
||||
leaseID,
|
||||
state: {
|
||||
url: "http://localhost/",
|
||||
title: "Local",
|
||||
loading: false,
|
||||
canGoBack: false,
|
||||
canGoForward: false,
|
||||
generation: 1,
|
||||
},
|
||||
},
|
||||
],
|
||||
}),
|
||||
)
|
||||
expect(acknowledged.binary).toBe(false)
|
||||
expect(decodeControl(acknowledged.data)).toEqual({ type: "browser.control.synced", revision: 1 })
|
||||
|
||||
const stale = yield* open(tunnelURL, BROWSER_TUNNEL_PROTOCOL)
|
||||
expect(yield* tunnelControl(yield* next(stale))).toEqual({ type: "browser.tunnel.ready" })
|
||||
const rejected = yield* exchange(
|
||||
stale,
|
||||
BrowserTunnelProtocol.encodeFromDesktop({
|
||||
type: "browser.tunnel.open",
|
||||
sessionID,
|
||||
leaseID: Browser.LeaseID.make("brl_stale"),
|
||||
target: { host: BrowserTunnel.Host.make("127.0.0.1"), port: BrowserTunnel.Port.make(1) },
|
||||
receiveWindow: BrowserTunnel.WindowSize.make(BrowserTunnelProtocol.InitialWindowBytes),
|
||||
receiveFrames: BrowserTunnel.FrameWindow.make(BrowserTunnelProtocol.InitialFrameWindow),
|
||||
}),
|
||||
)
|
||||
expect(yield* tunnelControl(rejected)).toMatchObject({
|
||||
type: "browser.tunnel.rejected",
|
||||
code: "stale_lease",
|
||||
})
|
||||
stale.webSocket.terminate()
|
||||
|
||||
const target = yield* echoServer
|
||||
const address = target.server.address()
|
||||
if (address === null || typeof address === "string") throw new Error("echo server did not bind TCP")
|
||||
const tunnel = yield* open(tunnelURL, BROWSER_TUNNEL_PROTOCOL)
|
||||
expect(yield* tunnelControl(yield* next(tunnel))).toEqual({ type: "browser.tunnel.ready" })
|
||||
const openFrame = BrowserTunnelProtocol.encodeFromDesktop({
|
||||
type: "browser.tunnel.open",
|
||||
sessionID,
|
||||
leaseID,
|
||||
target: { host: BrowserTunnel.Host.make("127.0.0.1"), port: BrowserTunnel.Port.make(address.port) },
|
||||
receiveWindow: BrowserTunnel.WindowSize.make(BrowserTunnelProtocol.InitialWindowBytes),
|
||||
receiveFrames: BrowserTunnel.FrameWindow.make(BrowserTunnelProtocol.InitialFrameWindow),
|
||||
})
|
||||
yield* Effect.callback<void, Error>((resume) =>
|
||||
tunnel.webSocket.send(openFrame, { binary: true }, (error) => resume(error ? Effect.fail(error) : Effect.void)),
|
||||
)
|
||||
yield* Deferred.await(target.connected)
|
||||
const opened = yield* next(tunnel)
|
||||
expect(opened.binary).toBe(true)
|
||||
expect(yield* tunnelControl(opened)).toEqual({
|
||||
type: "browser.tunnel.opened",
|
||||
receiveWindow: BrowserTunnel.WindowSize.make(BrowserTunnelProtocol.InitialWindowBytes),
|
||||
receiveFrames: BrowserTunnel.FrameWindow.make(BrowserTunnelProtocol.InitialFrameWindow),
|
||||
})
|
||||
|
||||
yield* Effect.callback<void, Error>((resume) =>
|
||||
tunnel.webSocket.send(BrowserTunnelProtocol.data(Buffer.from("browser tunnel")), { binary: true }, (error) =>
|
||||
resume(error ? Effect.fail(error) : Effect.void),
|
||||
),
|
||||
)
|
||||
expect(yield* tunnelControl(yield* next(tunnel))).toEqual({
|
||||
type: "browser.tunnel.window",
|
||||
bytes: BrowserTunnel.WindowBytes.make(Buffer.byteLength("browser tunnel")),
|
||||
frames: BrowserTunnel.FrameWindow.make(1),
|
||||
})
|
||||
const echoed = yield* next(tunnel)
|
||||
expect(echoed.binary).toBe(true)
|
||||
const echoedFrame = yield* BrowserTunnelProtocol.decodeFromServer(echoed.data)
|
||||
if (echoedFrame.type !== "data") throw new Error("expected browser tunnel data frame")
|
||||
expect(Buffer.from(echoedFrame.data).toString()).toBe("browser tunnel")
|
||||
tunnel.webSocket.send(
|
||||
BrowserTunnelProtocol.encodeFromDesktop({
|
||||
type: "browser.tunnel.window",
|
||||
bytes: BrowserTunnel.WindowBytes.make(echoedFrame.data.byteLength),
|
||||
frames: BrowserTunnel.FrameWindow.make(1),
|
||||
}),
|
||||
{ binary: true },
|
||||
)
|
||||
|
||||
tunnel.webSocket.send(BrowserTunnelProtocol.encodeFromDesktop({ type: "browser.tunnel.end" }), { binary: true })
|
||||
yield* Deferred.await(target.ended)
|
||||
yield* Deferred.await(target.sentEnd)
|
||||
const ended = yield* next(tunnel)
|
||||
expect(ended.binary).toBe(true)
|
||||
expect(yield* tunnelControl(ended)).toEqual({ type: "browser.tunnel.end" })
|
||||
|
||||
tunnel.webSocket.terminate()
|
||||
|
||||
const pushing = yield* pushServer
|
||||
const pushingAddress = pushing.address()
|
||||
if (pushingAddress === null || typeof pushingAddress === "string") throw new Error("push server did not bind TCP")
|
||||
const large = yield* open(tunnelURL, BROWSER_TUNNEL_PROTOCOL)
|
||||
yield* tunnelControl(yield* next(large))
|
||||
yield* exchange(
|
||||
large,
|
||||
BrowserTunnelProtocol.encodeFromDesktop({
|
||||
type: "browser.tunnel.open",
|
||||
sessionID,
|
||||
leaseID,
|
||||
target: { host: BrowserTunnel.Host.make("127.0.0.1"), port: BrowserTunnel.Port.make(pushingAddress.port) },
|
||||
receiveWindow: BrowserTunnel.WindowSize.make(BrowserTunnelProtocol.MaxDataBytes),
|
||||
receiveFrames: BrowserTunnel.FrameWindow.make(1),
|
||||
}),
|
||||
)
|
||||
const pushed = yield* collectData(large)
|
||||
expect(pushed.bytes).toBe(512 * 1_024)
|
||||
expect(pushed.frames).toBeGreaterThanOrEqual(8)
|
||||
large.webSocket.send(BrowserTunnelProtocol.encodeFromDesktop({ type: "browser.tunnel.end" }), { binary: true })
|
||||
large.webSocket.terminate()
|
||||
|
||||
control.webSocket.terminate()
|
||||
}),
|
||||
15_000,
|
||||
)
|
||||
|
||||
it.live(
|
||||
"rejects an oversized raw tunnel frame before opening a tunnel",
|
||||
() =>
|
||||
Effect.gen(function* () {
|
||||
const base = yield* startServer()
|
||||
const control = new Uint8Array(BrowserTunnelProtocol.MaxControlBytes + 2)
|
||||
control[0] = BrowserTunnelProtocol.FrameType.Control
|
||||
for (const frame of [new Uint8Array(BrowserTunnelProtocol.MaxDataBytes + 2), control]) {
|
||||
const tunnel = yield* open(new URL("/api/browser/tunnel", base), BROWSER_TUNNEL_PROTOCOL)
|
||||
expect(yield* tunnelControl(yield* next(tunnel))).toEqual({ type: "browser.tunnel.ready" })
|
||||
|
||||
const rejected = yield* exchange(tunnel, frame)
|
||||
expect(yield* tunnelControl(rejected)).toMatchObject({
|
||||
type: "browser.tunnel.rejected",
|
||||
code: "invalid_open",
|
||||
})
|
||||
expect(yield* Deferred.await(tunnel.closed)).toMatchObject({ code: 1009 })
|
||||
}
|
||||
}),
|
||||
10_000,
|
||||
)
|
||||
|
||||
it.live(
|
||||
"closes active browser transports with the service-restart code",
|
||||
() =>
|
||||
Effect.gen(function* () {
|
||||
const scope = yield* Scope.make()
|
||||
const server = yield* ServerProcess.start<never, never>({
|
||||
hostname: "127.0.0.1",
|
||||
port: 0,
|
||||
password: "secret",
|
||||
app: { version: "test-version" },
|
||||
database: { path: ":memory:" },
|
||||
}).pipe(Effect.provideService(Scope.Scope, scope))
|
||||
const base = new URL(HttpServer.formatAddress(server.address))
|
||||
base.protocol = "ws:"
|
||||
const control = yield* open(new URL("/api/browser/control", base), BROWSER_CONTROL_PROTOCOL)
|
||||
expect(decodeControl((yield* next(control)).data)).toEqual({ type: "browser.control.ready" })
|
||||
|
||||
const sessionID = Session.ID.make("ses_browser_shutdown")
|
||||
const leaseID = Browser.LeaseID.make("brl_browsershutdown")
|
||||
const sessionURL = new URL("/api/session", base)
|
||||
sessionURL.protocol = "http:"
|
||||
const created = yield* Effect.promise(() =>
|
||||
fetch(sessionURL, {
|
||||
method: "POST",
|
||||
headers: { authorization, "content-type": "application/json" },
|
||||
body: JSON.stringify({ id: sessionID }),
|
||||
}),
|
||||
)
|
||||
expect(created.status).toBe(200)
|
||||
expect(
|
||||
decodeControl(
|
||||
(yield* exchange(
|
||||
control,
|
||||
encodeControl({
|
||||
type: "browser.control.sync",
|
||||
revision: 1,
|
||||
attachments: [
|
||||
{
|
||||
sessionID,
|
||||
leaseID,
|
||||
state: {
|
||||
url: "http://localhost/",
|
||||
title: "Local",
|
||||
loading: false,
|
||||
canGoBack: false,
|
||||
canGoForward: false,
|
||||
generation: 1,
|
||||
},
|
||||
},
|
||||
],
|
||||
}),
|
||||
)).data,
|
||||
),
|
||||
).toEqual({ type: "browser.control.synced", revision: 1 })
|
||||
|
||||
const target = yield* echoServer
|
||||
const address = target.server.address()
|
||||
if (address === null || typeof address === "string") throw new Error("echo server did not bind TCP")
|
||||
const tunnel = yield* open(new URL("/api/browser/tunnel", base), BROWSER_TUNNEL_PROTOCOL)
|
||||
expect(yield* tunnelControl(yield* next(tunnel))).toEqual({ type: "browser.tunnel.ready" })
|
||||
expect(
|
||||
yield* tunnelControl(
|
||||
yield* exchange(
|
||||
tunnel,
|
||||
BrowserTunnelProtocol.encodeFromDesktop({
|
||||
type: "browser.tunnel.open",
|
||||
sessionID,
|
||||
leaseID,
|
||||
target: { host: BrowserTunnel.Host.make("127.0.0.1"), port: BrowserTunnel.Port.make(address.port) },
|
||||
receiveWindow: BrowserTunnel.WindowSize.make(BrowserTunnelProtocol.InitialWindowBytes),
|
||||
receiveFrames: BrowserTunnel.FrameWindow.make(BrowserTunnelProtocol.InitialFrameWindow),
|
||||
}),
|
||||
),
|
||||
),
|
||||
).toMatchObject({ type: "browser.tunnel.opened" })
|
||||
|
||||
const closing = yield* Effect.forkChild(Scope.close(scope, Exit.void), { startImmediately: true })
|
||||
expect(yield* Deferred.await(control.closed)).toMatchObject({ code: 1012 })
|
||||
expect(yield* Deferred.await(tunnel.closed)).toMatchObject({ code: 1012 })
|
||||
yield* Fiber.join(closing)
|
||||
expect((yield* TestConsole.logLines).filter((line) => String(line).includes("Socket already assigned"))).toEqual(
|
||||
[],
|
||||
)
|
||||
}),
|
||||
10_000,
|
||||
)
|
||||
+250
-68
@@ -160,6 +160,134 @@
|
||||
"summary": "Get server information"
|
||||
}
|
||||
},
|
||||
"/api/browser/control": {
|
||||
"get": {
|
||||
"tags": [
|
||||
"browser"
|
||||
],
|
||||
"operationId": "v2.browser.control.connect",
|
||||
"parameters": [],
|
||||
"security": [],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Success",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"type": "boolean"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"400": {
|
||||
"description": "InvalidRequestError",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/InvalidRequestError"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"401": {
|
||||
"description": "UnauthorizedError",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/UnauthorizedError"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"403": {
|
||||
"description": "WebSocket Origin is not allowed."
|
||||
},
|
||||
"409": {
|
||||
"description": "ConflictError",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/ConflictError"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"426": {
|
||||
"description": "WebSocket subprotocol opencode.browser.control.v1 is required."
|
||||
}
|
||||
},
|
||||
"description": "Establish an authenticated WebSocket carrying Session-scoped browser attachments and semantic browser commands.",
|
||||
"summary": "Connect desktop browser host",
|
||||
"x-websocket": true,
|
||||
"x-websocket-subprotocol": "opencode.browser.control.v1",
|
||||
"x-websocket-incoming": "BrowserControl.FromDesktop",
|
||||
"x-websocket-outgoing": "BrowserControl.FromServer"
|
||||
}
|
||||
},
|
||||
"/api/browser/tunnel": {
|
||||
"get": {
|
||||
"tags": [
|
||||
"browser"
|
||||
],
|
||||
"operationId": "v2.browser.tunnel.connect",
|
||||
"parameters": [],
|
||||
"security": [],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Success",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"type": "boolean"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"400": {
|
||||
"description": "InvalidRequestError",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/InvalidRequestError"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"401": {
|
||||
"description": "UnauthorizedError",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/UnauthorizedError"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"403": {
|
||||
"description": "WebSocket Origin is not allowed."
|
||||
},
|
||||
"426": {
|
||||
"description": "WebSocket subprotocol opencode.browser.tunnel.v1 is required."
|
||||
},
|
||||
"503": {
|
||||
"description": "ServiceUnavailableError",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/ServiceUnavailableError"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"description": "Establish an authenticated WebSocket carrying one TCP stream dialed from the OpenCode server.",
|
||||
"summary": "Open browser network tunnel",
|
||||
"x-websocket": true,
|
||||
"x-websocket-subprotocol": "opencode.browser.tunnel.v1",
|
||||
"x-websocket-incoming": "BrowserTunnel.FromDesktop and binary DATA frames",
|
||||
"x-websocket-outgoing": "BrowserTunnel.FromServer and binary DATA frames"
|
||||
}
|
||||
},
|
||||
"/api/location": {
|
||||
"get": {
|
||||
"tags": [
|
||||
@@ -12012,6 +12140,64 @@
|
||||
],
|
||||
"additionalProperties": false
|
||||
},
|
||||
"ConflictError": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"_tag": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"ConflictError"
|
||||
]
|
||||
},
|
||||
"message": {
|
||||
"type": "string"
|
||||
},
|
||||
"resource": {
|
||||
"anyOf": [
|
||||
{
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"type": "null"
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"_tag",
|
||||
"message"
|
||||
],
|
||||
"additionalProperties": false
|
||||
},
|
||||
"ServiceUnavailableError": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"_tag": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"ServiceUnavailableError"
|
||||
]
|
||||
},
|
||||
"message": {
|
||||
"type": "string"
|
||||
},
|
||||
"service": {
|
||||
"anyOf": [
|
||||
{
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"type": "null"
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"_tag",
|
||||
"message"
|
||||
],
|
||||
"additionalProperties": false
|
||||
},
|
||||
"Location.Info": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
@@ -12838,35 +13024,6 @@
|
||||
],
|
||||
"additionalProperties": false
|
||||
},
|
||||
"ConflictError": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"_tag": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"ConflictError"
|
||||
]
|
||||
},
|
||||
"message": {
|
||||
"type": "string"
|
||||
},
|
||||
"resource": {
|
||||
"anyOf": [
|
||||
{
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"type": "null"
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"_tag",
|
||||
"message"
|
||||
],
|
||||
"additionalProperties": false
|
||||
},
|
||||
"CommandNotFoundError": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
@@ -13058,35 +13215,6 @@
|
||||
],
|
||||
"additionalProperties": false
|
||||
},
|
||||
"ServiceUnavailableError": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"_tag": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"ServiceUnavailableError"
|
||||
]
|
||||
},
|
||||
"message": {
|
||||
"type": "string"
|
||||
},
|
||||
"service": {
|
||||
"anyOf": [
|
||||
{
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"type": "null"
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"_tag",
|
||||
"message"
|
||||
],
|
||||
"additionalProperties": false
|
||||
},
|
||||
"SessionBusyError": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
@@ -13705,7 +13833,14 @@
|
||||
"type": "string"
|
||||
},
|
||||
"name": {
|
||||
"type": "string"
|
||||
"anyOf": [
|
||||
{
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"type": "null"
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
@@ -13715,7 +13850,7 @@
|
||||
],
|
||||
"additionalProperties": false
|
||||
},
|
||||
"LLM.ToolContent": {
|
||||
"Tool.Content": {
|
||||
"anyOf": [
|
||||
{
|
||||
"$ref": "#/components/schemas/Tool.TextContent"
|
||||
@@ -13741,12 +13876,12 @@
|
||||
"type": "array",
|
||||
"prefixItems": [
|
||||
{
|
||||
"$ref": "#/components/schemas/LLM.ToolContent"
|
||||
"$ref": "#/components/schemas/Tool.Content"
|
||||
}
|
||||
],
|
||||
"minItems": 1,
|
||||
"items": {
|
||||
"$ref": "#/components/schemas/LLM.ToolContent"
|
||||
"$ref": "#/components/schemas/Tool.Content"
|
||||
}
|
||||
},
|
||||
"metadata": {
|
||||
@@ -13795,12 +13930,12 @@
|
||||
"type": "array",
|
||||
"prefixItems": [
|
||||
{
|
||||
"$ref": "#/components/schemas/LLM.ToolContent"
|
||||
"$ref": "#/components/schemas/Tool.Content"
|
||||
}
|
||||
],
|
||||
"minItems": 1,
|
||||
"items": {
|
||||
"$ref": "#/components/schemas/LLM.ToolContent"
|
||||
"$ref": "#/components/schemas/Tool.Content"
|
||||
}
|
||||
},
|
||||
"metadata": {
|
||||
@@ -17114,6 +17249,49 @@
|
||||
],
|
||||
"additionalProperties": false
|
||||
},
|
||||
"Tool.FileContent1": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"type": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"file"
|
||||
]
|
||||
},
|
||||
"uri": {
|
||||
"type": "string"
|
||||
},
|
||||
"mime": {
|
||||
"type": "string"
|
||||
},
|
||||
"name": {
|
||||
"anyOf": [
|
||||
{
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"type": "null"
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"type",
|
||||
"uri",
|
||||
"mime"
|
||||
],
|
||||
"additionalProperties": false
|
||||
},
|
||||
"Tool.Content1": {
|
||||
"anyOf": [
|
||||
{
|
||||
"$ref": "#/components/schemas/Tool.TextContent"
|
||||
},
|
||||
{
|
||||
"$ref": "#/components/schemas/Tool.FileContent1"
|
||||
}
|
||||
]
|
||||
},
|
||||
"Session.Message.ProviderState8": {
|
||||
"type": "object"
|
||||
},
|
||||
@@ -17197,12 +17375,12 @@
|
||||
"type": "array",
|
||||
"prefixItems": [
|
||||
{
|
||||
"$ref": "#/components/schemas/LLM.ToolContent"
|
||||
"$ref": "#/components/schemas/Tool.Content1"
|
||||
}
|
||||
],
|
||||
"minItems": 1,
|
||||
"items": {
|
||||
"$ref": "#/components/schemas/LLM.ToolContent"
|
||||
"$ref": "#/components/schemas/Tool.Content1"
|
||||
}
|
||||
},
|
||||
"metadata": {
|
||||
@@ -17320,12 +17498,12 @@
|
||||
"type": "array",
|
||||
"prefixItems": [
|
||||
{
|
||||
"$ref": "#/components/schemas/LLM.ToolContent"
|
||||
"$ref": "#/components/schemas/Tool.Content1"
|
||||
}
|
||||
],
|
||||
"minItems": 1,
|
||||
"items": {
|
||||
"$ref": "#/components/schemas/LLM.ToolContent"
|
||||
"$ref": "#/components/schemas/Tool.Content1"
|
||||
}
|
||||
},
|
||||
"metadata": {
|
||||
@@ -29135,6 +29313,10 @@
|
||||
{
|
||||
"name": "server"
|
||||
},
|
||||
{
|
||||
"name": "browser",
|
||||
"description": "Desktop browser host control and server-network tunnel routes."
|
||||
},
|
||||
{
|
||||
"name": "location"
|
||||
},
|
||||
|
||||
@@ -160,6 +160,134 @@
|
||||
"summary": "Get server information"
|
||||
}
|
||||
},
|
||||
"/api/browser/control": {
|
||||
"get": {
|
||||
"tags": [
|
||||
"browser"
|
||||
],
|
||||
"operationId": "v2.browser.control.connect",
|
||||
"parameters": [],
|
||||
"security": [],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Success",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"type": "boolean"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"400": {
|
||||
"description": "InvalidRequestError",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/InvalidRequestError"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"401": {
|
||||
"description": "UnauthorizedError",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/UnauthorizedError"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"403": {
|
||||
"description": "WebSocket Origin is not allowed."
|
||||
},
|
||||
"409": {
|
||||
"description": "ConflictError",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/ConflictError"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"426": {
|
||||
"description": "WebSocket subprotocol opencode.browser.control.v1 is required."
|
||||
}
|
||||
},
|
||||
"description": "Establish an authenticated WebSocket carrying Session-scoped browser attachments and semantic browser commands.",
|
||||
"summary": "Connect desktop browser host",
|
||||
"x-websocket": true,
|
||||
"x-websocket-subprotocol": "opencode.browser.control.v1",
|
||||
"x-websocket-incoming": "BrowserControl.FromDesktop",
|
||||
"x-websocket-outgoing": "BrowserControl.FromServer"
|
||||
}
|
||||
},
|
||||
"/api/browser/tunnel": {
|
||||
"get": {
|
||||
"tags": [
|
||||
"browser"
|
||||
],
|
||||
"operationId": "v2.browser.tunnel.connect",
|
||||
"parameters": [],
|
||||
"security": [],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Success",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"type": "boolean"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"400": {
|
||||
"description": "InvalidRequestError",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/InvalidRequestError"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"401": {
|
||||
"description": "UnauthorizedError",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/UnauthorizedError"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"403": {
|
||||
"description": "WebSocket Origin is not allowed."
|
||||
},
|
||||
"426": {
|
||||
"description": "WebSocket subprotocol opencode.browser.tunnel.v1 is required."
|
||||
},
|
||||
"503": {
|
||||
"description": "ServiceUnavailableError",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/ServiceUnavailableError"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"description": "Establish an authenticated WebSocket carrying one TCP stream dialed from the OpenCode server.",
|
||||
"summary": "Open browser network tunnel",
|
||||
"x-websocket": true,
|
||||
"x-websocket-subprotocol": "opencode.browser.tunnel.v1",
|
||||
"x-websocket-incoming": "BrowserTunnel.FromDesktop and binary DATA frames",
|
||||
"x-websocket-outgoing": "BrowserTunnel.FromServer and binary DATA frames"
|
||||
}
|
||||
},
|
||||
"/api/location": {
|
||||
"get": {
|
||||
"tags": [
|
||||
@@ -12012,6 +12140,64 @@
|
||||
],
|
||||
"additionalProperties": false
|
||||
},
|
||||
"ConflictError": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"_tag": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"ConflictError"
|
||||
]
|
||||
},
|
||||
"message": {
|
||||
"type": "string"
|
||||
},
|
||||
"resource": {
|
||||
"anyOf": [
|
||||
{
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"type": "null"
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"_tag",
|
||||
"message"
|
||||
],
|
||||
"additionalProperties": false
|
||||
},
|
||||
"ServiceUnavailableError": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"_tag": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"ServiceUnavailableError"
|
||||
]
|
||||
},
|
||||
"message": {
|
||||
"type": "string"
|
||||
},
|
||||
"service": {
|
||||
"anyOf": [
|
||||
{
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"type": "null"
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"_tag",
|
||||
"message"
|
||||
],
|
||||
"additionalProperties": false
|
||||
},
|
||||
"Location.Info": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
@@ -12838,35 +13024,6 @@
|
||||
],
|
||||
"additionalProperties": false
|
||||
},
|
||||
"ConflictError": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"_tag": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"ConflictError"
|
||||
]
|
||||
},
|
||||
"message": {
|
||||
"type": "string"
|
||||
},
|
||||
"resource": {
|
||||
"anyOf": [
|
||||
{
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"type": "null"
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"_tag",
|
||||
"message"
|
||||
],
|
||||
"additionalProperties": false
|
||||
},
|
||||
"CommandNotFoundError": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
@@ -13058,35 +13215,6 @@
|
||||
],
|
||||
"additionalProperties": false
|
||||
},
|
||||
"ServiceUnavailableError": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"_tag": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"ServiceUnavailableError"
|
||||
]
|
||||
},
|
||||
"message": {
|
||||
"type": "string"
|
||||
},
|
||||
"service": {
|
||||
"anyOf": [
|
||||
{
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"type": "null"
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"_tag",
|
||||
"message"
|
||||
],
|
||||
"additionalProperties": false
|
||||
},
|
||||
"SessionBusyError": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
@@ -13705,7 +13833,14 @@
|
||||
"type": "string"
|
||||
},
|
||||
"name": {
|
||||
"type": "string"
|
||||
"anyOf": [
|
||||
{
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"type": "null"
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
@@ -13715,7 +13850,7 @@
|
||||
],
|
||||
"additionalProperties": false
|
||||
},
|
||||
"LLM.ToolContent": {
|
||||
"Tool.Content": {
|
||||
"anyOf": [
|
||||
{
|
||||
"$ref": "#/components/schemas/Tool.TextContent"
|
||||
@@ -13741,12 +13876,12 @@
|
||||
"type": "array",
|
||||
"prefixItems": [
|
||||
{
|
||||
"$ref": "#/components/schemas/LLM.ToolContent"
|
||||
"$ref": "#/components/schemas/Tool.Content"
|
||||
}
|
||||
],
|
||||
"minItems": 1,
|
||||
"items": {
|
||||
"$ref": "#/components/schemas/LLM.ToolContent"
|
||||
"$ref": "#/components/schemas/Tool.Content"
|
||||
}
|
||||
},
|
||||
"metadata": {
|
||||
@@ -13795,12 +13930,12 @@
|
||||
"type": "array",
|
||||
"prefixItems": [
|
||||
{
|
||||
"$ref": "#/components/schemas/LLM.ToolContent"
|
||||
"$ref": "#/components/schemas/Tool.Content"
|
||||
}
|
||||
],
|
||||
"minItems": 1,
|
||||
"items": {
|
||||
"$ref": "#/components/schemas/LLM.ToolContent"
|
||||
"$ref": "#/components/schemas/Tool.Content"
|
||||
}
|
||||
},
|
||||
"metadata": {
|
||||
@@ -17114,6 +17249,49 @@
|
||||
],
|
||||
"additionalProperties": false
|
||||
},
|
||||
"Tool.FileContent1": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"type": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"file"
|
||||
]
|
||||
},
|
||||
"uri": {
|
||||
"type": "string"
|
||||
},
|
||||
"mime": {
|
||||
"type": "string"
|
||||
},
|
||||
"name": {
|
||||
"anyOf": [
|
||||
{
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"type": "null"
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"type",
|
||||
"uri",
|
||||
"mime"
|
||||
],
|
||||
"additionalProperties": false
|
||||
},
|
||||
"Tool.Content1": {
|
||||
"anyOf": [
|
||||
{
|
||||
"$ref": "#/components/schemas/Tool.TextContent"
|
||||
},
|
||||
{
|
||||
"$ref": "#/components/schemas/Tool.FileContent1"
|
||||
}
|
||||
]
|
||||
},
|
||||
"Session.Message.ProviderState8": {
|
||||
"type": "object"
|
||||
},
|
||||
@@ -17197,12 +17375,12 @@
|
||||
"type": "array",
|
||||
"prefixItems": [
|
||||
{
|
||||
"$ref": "#/components/schemas/LLM.ToolContent"
|
||||
"$ref": "#/components/schemas/Tool.Content1"
|
||||
}
|
||||
],
|
||||
"minItems": 1,
|
||||
"items": {
|
||||
"$ref": "#/components/schemas/LLM.ToolContent"
|
||||
"$ref": "#/components/schemas/Tool.Content1"
|
||||
}
|
||||
},
|
||||
"metadata": {
|
||||
@@ -17320,12 +17498,12 @@
|
||||
"type": "array",
|
||||
"prefixItems": [
|
||||
{
|
||||
"$ref": "#/components/schemas/LLM.ToolContent"
|
||||
"$ref": "#/components/schemas/Tool.Content1"
|
||||
}
|
||||
],
|
||||
"minItems": 1,
|
||||
"items": {
|
||||
"$ref": "#/components/schemas/LLM.ToolContent"
|
||||
"$ref": "#/components/schemas/Tool.Content1"
|
||||
}
|
||||
},
|
||||
"metadata": {
|
||||
@@ -29135,6 +29313,10 @@
|
||||
{
|
||||
"name": "server"
|
||||
},
|
||||
{
|
||||
"name": "browser",
|
||||
"description": "Desktop browser host control and server-network tunnel routes."
|
||||
},
|
||||
{
|
||||
"name": "location"
|
||||
},
|
||||
|
||||
Reference in New Issue
Block a user