diff --git a/packages/client/src/promise/generated/client.ts b/packages/client/src/promise/generated/client.ts index f2c271e286c..ee6685636ce 100644 --- a/packages/client/src/promise/generated/client.ts +++ b/packages/client/src/promise/generated/client.ts @@ -292,7 +292,10 @@ export function make(options: ClientOptions) { const fetch = options.fetch ?? globalThis.fetch const prepare = (descriptor: RequestDescriptor, requestOptions?: RequestOptions) => { - const url = new URL(descriptor.path, options.baseUrl) + // A leading slash would replace any path prefix on baseUrl, so join relative to it. + const baseUrl = new URL(options.baseUrl) + if (!baseUrl.pathname.endsWith("/")) baseUrl.pathname += "/" + const url = new URL(descriptor.path.slice(1), baseUrl) for (const [key, value] of Object.entries(descriptor.query ?? {})) appendQuery(url.searchParams, key, value) const headers = new Headers(options.headers) for (const [key, value] of Object.entries(descriptor.headers ?? {})) { diff --git a/packages/client/src/solid/pty.ts b/packages/client/src/solid/pty.ts index 47c87827755..1dc7afd6309 100644 --- a/packages/client/src/solid/pty.ts +++ b/packages/client/src/solid/pty.ts @@ -26,7 +26,9 @@ export function createPtyClient(api: OpenCodeClient, options: PtyClientOptions) location: input.location, "x-opencode-ticket": "1", }) - const url = new URL(`/api/pty/${encodeURIComponent(input.ptyID)}/connect`, options.url) + const baseUrl = new URL(options.url) + if (!baseUrl.pathname.endsWith("/")) baseUrl.pathname += "/" + const url = new URL(`api/pty/${encodeURIComponent(input.ptyID)}/connect`, baseUrl) if (input.location?.directory) url.searchParams.set("location[directory]", input.location.directory) if (input.cursor !== undefined) url.searchParams.set("cursor", String(input.cursor)) url.searchParams.set("ticket", result.data.ticket) @@ -46,7 +48,9 @@ export function createPersistentPtyClient(api: OpenCodeClient, options: PtyClien ptyID: input.ptyID, "x-opencode-ticket": "1", }) - const url = new URL(`/api/experimental/persistent-pty/${encodeURIComponent(input.ptyID)}/connect`, options.url) + const baseUrl = new URL(options.url) + if (!baseUrl.pathname.endsWith("/")) baseUrl.pathname += "/" + const url = new URL(`api/experimental/persistent-pty/${encodeURIComponent(input.ptyID)}/connect`, baseUrl) url.searchParams.set("ticket", token.ticket) url.searchParams.set("cursor", String(input.cursor)) url.searchParams.set("attachment_id", input.attachmentID) diff --git a/packages/client/test/promise.test.ts b/packages/client/test/promise.test.ts index 185fd8a1581..604184ec2c8 100644 --- a/packages/client/test/promise.test.ts +++ b/packages/client/test/promise.test.ts @@ -83,6 +83,34 @@ test("config.get returns ordered config entries for a location", async () => { expect(request?.url).toBe("http://localhost:3000/api/config?location%5Bdirectory%5D=%2Ftmp%2Fproject") }) +test("requests keep a path prefix on baseUrl", async () => { + let request: Request | undefined + const client = OpenCode.make({ + baseUrl: "http://localhost:8888/ws/abc", + fetch: async (input) => { + request = input instanceof Request ? input : new Request(input) + return Response.json({ version: "2.0.0", pid: 1, urls: [], paths: { tmp: "/tmp" } }) + }, + }) + + await client.server.info() + expect(request?.url).toBe("http://localhost:8888/ws/abc/api/info") +}) + +test("requests join against the base URL pathname", async () => { + let request: Request | undefined + const client = OpenCode.make({ + baseUrl: "http://localhost:8888/ws/abc?tenant=one#fragment", + fetch: async (input) => { + request = input instanceof Request ? input : new Request(input) + return Response.json({ version: "2.0.0", pid: 1, urls: [], paths: { tmp: "/tmp" } }) + }, + }) + + await client.server.info() + expect(request?.url).toBe("http://localhost:8888/ws/abc/api/info") +}) + test("vcs.base and committed diffs preserve location and explicit base on the wire", async () => { const requests: Request[] = [] const location = { directory: "/repo", project: { id: "global", directory: "/repo", canonical: "/repo" } } diff --git a/packages/client/test/solid-pty.test.ts b/packages/client/test/solid-pty.test.ts index a02681c0c33..a5c7aa48f6a 100644 --- a/packages/client/test/solid-pty.test.ts +++ b/packages/client/test/solid-pty.test.ts @@ -8,7 +8,7 @@ describe("createPtyClient", () => { let socketURL: URL | undefined const socket = { binaryType: "blob" } as unknown as WebSocket const api = OpenCode.make({ - baseUrl: "https://server.example/base", + baseUrl: "https://server.example", headers: { Authorization: "Basic credential" }, fetch: async (input, init) => { request = input instanceof Request ? input : new Request(input, init) @@ -22,7 +22,7 @@ describe("createPtyClient", () => { }, }) const pty = createPtyClient(api, { - url: "https://server.example/base", + url: "https://server.example", openSocket(url) { socketURL = url return socket @@ -65,6 +65,31 @@ describe("createPtyClient", () => { await expect(pty.connect({ ptyID: "pty_1", location: { directory: "/repo" } })).rejects.toThrow() expect(opened).toBe(false) }) + + test("keeps the server path prefix when opening the terminal socket", async () => { + let socketURL: URL | undefined + const api = OpenCode.make({ + baseUrl: "https://server.example/base", + fetch: async () => + Response.json({ + location: { + directory: "/repo", + project: { id: "project_1", directory: "/repo", canonical: "/repo" }, + }, + data: { ticket: "ticket-1", expires_in: 60 }, + }), + }) + const pty = createPtyClient(api, { + url: "https://server.example/base", + openSocket(url) { + socketURL = url + return { binaryType: "blob" } as unknown as WebSocket + }, + }) + + await pty.connect({ ptyID: "pty_1" }) + expect(socketURL?.toString()).toBe("wss://server.example/base/api/pty/pty_1/connect?ticket=ticket-1") + }) }) describe("createPersistentPtyClient", () => { @@ -73,7 +98,7 @@ describe("createPersistentPtyClient", () => { let socketURL: URL | undefined const socket = { binaryType: "blob" } as unknown as WebSocket const api = OpenCode.make({ - baseUrl: "https://server.example/base", + baseUrl: "https://server.example", headers: { Authorization: "Basic credential" }, fetch: async (input, init) => { request = input instanceof Request ? input : new Request(input, init) @@ -81,7 +106,7 @@ describe("createPersistentPtyClient", () => { }, }) const pty = createPersistentPtyClient(api, { - url: "https://server.example/base", + url: "https://server.example", openSocket(url) { socketURL = url return socket @@ -98,4 +123,24 @@ describe("createPersistentPtyClient", () => { ) expect(socket.binaryType).toBe("arraybuffer") }) + + test("keeps the server path prefix when opening the persistent terminal socket", async () => { + let socketURL: URL | undefined + const api = OpenCode.make({ + baseUrl: "https://server.example/base", + fetch: async () => Response.json({ data: { ticket: "ticket-1", expires_in: 60 } }), + }) + const pty = createPersistentPtyClient(api, { + url: "https://server.example/base", + openSocket(url) { + socketURL = url + return { binaryType: "blob" } as unknown as WebSocket + }, + }) + + await pty.connect({ ptyID: "pty_1", cursor: 0, attachmentID: "attachment_1" }) + expect(socketURL?.toString()).toBe( + "wss://server.example/base/api/experimental/persistent-pty/pty_1/connect?ticket=ticket-1&cursor=0&attachment_id=attachment_1&takeover=false&input_protocol=1", + ) + }) }) diff --git a/packages/httpapi-codegen/src/index.ts b/packages/httpapi-codegen/src/index.ts index 66807ac73db..ccc81be5abb 100644 --- a/packages/httpapi-codegen/src/index.ts +++ b/packages/httpapi-codegen/src/index.ts @@ -967,7 +967,7 @@ function renderPromiseClient(groups: ReadonlyArray) { if (group.endpoints[0]?.topLevel) return fields return `${JSON.stringify(group.identifier)}: { ${fields} }` }) - return `import type { ${imports.join(", ")} } from "./types.js"\nimport { ClientError } from "./client-error.js"\n\nexport interface ClientOptions {\n readonly baseUrl: string\n readonly fetch?: typeof globalThis.fetch\n readonly headers?: RequestInit["headers"]\n}\n\nexport interface RequestOptions {\n readonly signal?: AbortSignal\n readonly headers?: RequestInit["headers"]\n /** Reports every chunk a streaming response receives, including keepalive comments that yield no event. */\n readonly onActivity?: () => void\n}\n\ninterface RequestDescriptor {\n readonly method: string\n readonly path: string\n readonly query?: Record\n readonly headers?: Record\n readonly body?: unknown\n readonly successStatus: number\n readonly declaredStatuses: ReadonlyArray\n readonly empty: boolean\n}\n\nconst maxSseEventBytes = 16 * 1024 * 1024\n\nexport function make(options: ClientOptions) {\n const fetch = options.fetch ?? globalThis.fetch\n\n const prepare = (descriptor: RequestDescriptor, requestOptions?: RequestOptions) => {\n const url = new URL(descriptor.path, options.baseUrl)\n for (const [key, value] of Object.entries(descriptor.query ?? {})) appendQuery(url.searchParams, key, value)\n const headers = new Headers(options.headers)\n for (const [key, value] of Object.entries(descriptor.headers ?? {})) {\n if (value !== undefined && value !== null) headers.set(key, String(value))\n }\n for (const [key, value] of new Headers(requestOptions?.headers)) headers.set(key, value)\n if (descriptor.body !== undefined && !headers.has("content-type")) headers.set("content-type", "application/json")\n return {\n url,\n init: {\n method: descriptor.method,\n signal: requestOptions?.signal,\n headers,\n body: descriptor.body === undefined ? undefined : JSON.stringify(descriptor.body),\n } satisfies RequestInit,\n }\n }\n\n const execute = async (descriptor: RequestDescriptor, requestOptions?: RequestOptions) => {\n try {\n const prepared = prepare(descriptor, requestOptions)\n return await fetch(prepared.url, prepared.init)\n } catch (cause) {\n throw new ClientError("Transport", { cause })\n }\n }\n\n const responseError = async (response: Response, descriptor: RequestDescriptor): Promise => {\n if (descriptor.declaredStatuses.includes(response.status)) throw await json(response)\n try {\n await response.body?.cancel()\n } catch {}\n throw new ClientError("UnexpectedStatus", { cause: { status: response.status } })\n }\n\n const request = async (descriptor: RequestDescriptor, requestOptions?: RequestOptions): Promise => {\n const response = await execute(descriptor, requestOptions)\n if (response.status !== descriptor.successStatus) return responseError(response, descriptor)\n if (descriptor.empty) {\n try {\n await response.body?.cancel()\n } catch {}\n return undefined as A\n }\n return await json(response) as A\n }\n\n const sse = (descriptor: RequestDescriptor, requestOptions?: RequestOptions): AsyncIterable => ({\n async *[Symbol.asyncIterator]() {\n const response = await execute(descriptor, requestOptions)\n if (response.status !== descriptor.successStatus) await responseError(response, descriptor)\n if (!isContentType(response, "text/event-stream")) {\n try {\n await response.body?.cancel()\n } catch {}\n throw new ClientError("UnsupportedContentType")\n }\n if (response.body === null) throw new ClientError("MalformedResponse")\n const reader = response.body.getReader()\n const decoder = new TextDecoder()\n let buffer = ""\n try {\n while (true) {\n let next: ReadableStreamReadResult\n try {\n next = await reader.read()\n } catch (cause) {\n throw new ClientError("Transport", { cause })\n }\n if (!next.done) requestOptions?.onActivity?.()\n buffer += decoder.decode(next.value, { stream: !next.done })\n if (buffer.length > maxSseEventBytes) throw new ClientError("SseEventTooLarge")\n const trailingCarriageReturn = !next.done && buffer.endsWith("\\r")\n if (trailingCarriageReturn) buffer = buffer.slice(0, -1)\n buffer = buffer.replaceAll("\\r\\n", "\\n").replaceAll("\\r", "\\n")\n if (trailingCarriageReturn) buffer += "\\r"\n if (next.done && buffer !== "") buffer += "\\n\\n"\n let boundary = buffer.indexOf("\\n\\n")\n while (boundary >= 0) {\n const block = buffer.slice(0, boundary)\n buffer = buffer.slice(boundary + 2)\n const data = block.split("\\n").flatMap((line) => line.startsWith("data:") ? [line.slice(5).trimStart()] : []).join("\\n")\n if (data !== "") {\n try {\n yield JSON.parse(data) as A\n } catch (cause) {\n throw new ClientError("MalformedResponse", { cause })\n }\n }\n boundary = buffer.indexOf("\\n\\n")\n }\n if (next.done) return\n }\n } finally {\n try {\n await reader.cancel()\n } catch {}\n reader.releaseLock()\n }\n },\n })\n\n return { ${fields.join(", ")} }\n}\n\nfunction appendQuery(params: URLSearchParams, key: string, value: unknown): void {\n if (value === undefined) return\n if (value === null) {\n params.append(key, "null")\n return\n }\n if (Array.isArray(value)) {\n for (const item of value) appendQuery(params, key, item)\n return\n }\n if (typeof value === "object") {\n for (const [child, item] of Object.entries(value)) appendQuery(params, \`\${key}[\${child}]\`, item)\n return\n }\n params.append(key, String(value))\n}\n\nasync function json(response: Response): Promise {\n if (!isContentType(response, "application/json") && !response.headers.get("content-type")?.includes("+json")) {\n try {\n await response.body?.cancel()\n } catch {}\n throw new ClientError("UnsupportedContentType")\n }\n let text: string\n try {\n text = await response.text()\n } catch (cause) {\n throw new ClientError("Transport", { cause })\n }\n if (text === "") throw new ClientError("MalformedResponse")\n try {\n return JSON.parse(text)\n } catch (cause) {\n throw new ClientError("MalformedResponse", { cause })\n }\n}\n\nfunction isContentType(response: Response, expected: string) {\n return response.headers.get("content-type")?.split(";", 1)[0]?.trim().toLowerCase() === expected\n}\n` + return `import type { ${imports.join(", ")} } from "./types.js"\nimport { ClientError } from "./client-error.js"\n\nexport interface ClientOptions {\n readonly baseUrl: string\n readonly fetch?: typeof globalThis.fetch\n readonly headers?: RequestInit["headers"]\n}\n\nexport interface RequestOptions {\n readonly signal?: AbortSignal\n readonly headers?: RequestInit["headers"]\n /** Reports every chunk a streaming response receives, including keepalive comments that yield no event. */\n readonly onActivity?: () => void\n}\n\ninterface RequestDescriptor {\n readonly method: string\n readonly path: string\n readonly query?: Record\n readonly headers?: Record\n readonly body?: unknown\n readonly successStatus: number\n readonly declaredStatuses: ReadonlyArray\n readonly empty: boolean\n}\n\nconst maxSseEventBytes = 16 * 1024 * 1024\n\nexport function make(options: ClientOptions) {\n const fetch = options.fetch ?? globalThis.fetch\n\n const prepare = (descriptor: RequestDescriptor, requestOptions?: RequestOptions) => {\n // A leading slash would replace any path prefix on baseUrl, so join relative to it.\n const baseUrl = new URL(options.baseUrl)\n if (!baseUrl.pathname.endsWith("/")) baseUrl.pathname += "/"\n const url = new URL(descriptor.path.slice(1), baseUrl)\n for (const [key, value] of Object.entries(descriptor.query ?? {})) appendQuery(url.searchParams, key, value)\n const headers = new Headers(options.headers)\n for (const [key, value] of Object.entries(descriptor.headers ?? {})) {\n if (value !== undefined && value !== null) headers.set(key, String(value))\n }\n for (const [key, value] of new Headers(requestOptions?.headers)) headers.set(key, value)\n if (descriptor.body !== undefined && !headers.has("content-type")) headers.set("content-type", "application/json")\n return {\n url,\n init: {\n method: descriptor.method,\n signal: requestOptions?.signal,\n headers,\n body: descriptor.body === undefined ? undefined : JSON.stringify(descriptor.body),\n } satisfies RequestInit,\n }\n }\n\n const execute = async (descriptor: RequestDescriptor, requestOptions?: RequestOptions) => {\n try {\n const prepared = prepare(descriptor, requestOptions)\n return await fetch(prepared.url, prepared.init)\n } catch (cause) {\n throw new ClientError("Transport", { cause })\n }\n }\n\n const responseError = async (response: Response, descriptor: RequestDescriptor): Promise => {\n if (descriptor.declaredStatuses.includes(response.status)) throw await json(response)\n try {\n await response.body?.cancel()\n } catch {}\n throw new ClientError("UnexpectedStatus", { cause: { status: response.status } })\n }\n\n const request = async (descriptor: RequestDescriptor, requestOptions?: RequestOptions): Promise => {\n const response = await execute(descriptor, requestOptions)\n if (response.status !== descriptor.successStatus) return responseError(response, descriptor)\n if (descriptor.empty) {\n try {\n await response.body?.cancel()\n } catch {}\n return undefined as A\n }\n return await json(response) as A\n }\n\n const sse = (descriptor: RequestDescriptor, requestOptions?: RequestOptions): AsyncIterable => ({\n async *[Symbol.asyncIterator]() {\n const response = await execute(descriptor, requestOptions)\n if (response.status !== descriptor.successStatus) await responseError(response, descriptor)\n if (!isContentType(response, "text/event-stream")) {\n try {\n await response.body?.cancel()\n } catch {}\n throw new ClientError("UnsupportedContentType")\n }\n if (response.body === null) throw new ClientError("MalformedResponse")\n const reader = response.body.getReader()\n const decoder = new TextDecoder()\n let buffer = ""\n try {\n while (true) {\n let next: ReadableStreamReadResult\n try {\n next = await reader.read()\n } catch (cause) {\n throw new ClientError("Transport", { cause })\n }\n if (!next.done) requestOptions?.onActivity?.()\n buffer += decoder.decode(next.value, { stream: !next.done })\n if (buffer.length > maxSseEventBytes) throw new ClientError("SseEventTooLarge")\n const trailingCarriageReturn = !next.done && buffer.endsWith("\\r")\n if (trailingCarriageReturn) buffer = buffer.slice(0, -1)\n buffer = buffer.replaceAll("\\r\\n", "\\n").replaceAll("\\r", "\\n")\n if (trailingCarriageReturn) buffer += "\\r"\n if (next.done && buffer !== "") buffer += "\\n\\n"\n let boundary = buffer.indexOf("\\n\\n")\n while (boundary >= 0) {\n const block = buffer.slice(0, boundary)\n buffer = buffer.slice(boundary + 2)\n const data = block.split("\\n").flatMap((line) => line.startsWith("data:") ? [line.slice(5).trimStart()] : []).join("\\n")\n if (data !== "") {\n try {\n yield JSON.parse(data) as A\n } catch (cause) {\n throw new ClientError("MalformedResponse", { cause })\n }\n }\n boundary = buffer.indexOf("\\n\\n")\n }\n if (next.done) return\n }\n } finally {\n try {\n await reader.cancel()\n } catch {}\n reader.releaseLock()\n }\n },\n })\n\n return { ${fields.join(", ")} }\n}\n\nfunction appendQuery(params: URLSearchParams, key: string, value: unknown): void {\n if (value === undefined) return\n if (value === null) {\n params.append(key, "null")\n return\n }\n if (Array.isArray(value)) {\n for (const item of value) appendQuery(params, key, item)\n return\n }\n if (typeof value === "object") {\n for (const [child, item] of Object.entries(value)) appendQuery(params, \`\${key}[\${child}]\`, item)\n return\n }\n params.append(key, String(value))\n}\n\nasync function json(response: Response): Promise {\n if (!isContentType(response, "application/json") && !response.headers.get("content-type")?.includes("+json")) {\n try {\n await response.body?.cancel()\n } catch {}\n throw new ClientError("UnsupportedContentType")\n }\n let text: string\n try {\n text = await response.text()\n } catch (cause) {\n throw new ClientError("Transport", { cause })\n }\n if (text === "") throw new ClientError("MalformedResponse")\n try {\n return JSON.parse(text)\n } catch (cause) {\n throw new ClientError("MalformedResponse", { cause })\n }\n}\n\nfunction isContentType(response: Response, expected: string) {\n return response.headers.get("content-type")?.split(";", 1)[0]?.trim().toLowerCase() === expected\n}\n` } function promiseTypePrefix(group: string, path: ReadonlyArray) { diff --git a/packages/httpapi-codegen/test/generate.test.ts b/packages/httpapi-codegen/test/generate.test.ts index 40dbe076c5e..74f6a0a6073 100644 --- a/packages/httpapi-codegen/test/generate.test.ts +++ b/packages/httpapi-codegen/test/generate.test.ts @@ -885,7 +885,7 @@ describe("HttpApiCodegen.generate", () => { await using emitted = await emittedModule(output) let request: Request | undefined const client = emitted.module.OpenCode.make({ - baseUrl: "https://example.com", + baseUrl: "https://example.com/base?tenant=one#fragment", fetch: async (input: RequestInfo | URL) => { request = input instanceof Request ? input : new Request(input) return Response.json({ data: "hello" }) @@ -894,7 +894,7 @@ describe("HttpApiCodegen.generate", () => { expect(await client.session.get({ sessionID: "a/b" })).toBe("hello") expect(request?.method).toBe("GET") - expect(request?.url).toBe("https://example.com/session/a%2Fb") + expect(request?.url).toBe("https://example.com/base/session/a%2Fb") }) test("maps an emitted no-content response to undefined", async () => {