opencode/packages/opencode/test/server/httpapi-bridge.test.ts

import { afterEach, describe, expect, test } from "bun:test"
import type { UpgradeWebSocket } from "hono/ws"
import { Flag } from "@opencode-ai/core/flag/flag"
import { Instance } from "../../src/project/instance"
import { InstanceRoutes } from "../../src/server/routes/instance"
import { WorkspaceRoutes } from "../../src/server/routes/control/workspace"
import { ConfigApi } from "../../src/server/routes/instance/httpapi/config"
import { EventPaths } from "../../src/server/routes/instance/httpapi/event"
import { ExperimentalApi } from "../../src/server/routes/instance/httpapi/experimental"
import { FileApi, FilePaths } from "../../src/server/routes/instance/httpapi/file"
import { InstanceApi } from "../../src/server/routes/instance/httpapi/instance"
import { McpApi } from "../../src/server/routes/instance/httpapi/mcp"
import { PermissionApi } from "../../src/server/routes/instance/httpapi/permission"
import { ProjectApi } from "../../src/server/routes/instance/httpapi/project"
import { ProviderApi } from "../../src/server/routes/instance/httpapi/provider"
import { PtyApi, PtyPaths } from "../../src/server/routes/instance/httpapi/pty"
import { QuestionApi } from "../../src/server/routes/instance/httpapi/question"
import { SessionApi } from "../../src/server/routes/instance/httpapi/session"
import { SyncApi } from "../../src/server/routes/instance/httpapi/sync"
import { TuiApi } from "../../src/server/routes/instance/httpapi/tui"
import { WorkspaceApi } from "../../src/server/routes/instance/httpapi/workspace"
import * as Log from "@opencode-ai/core/util/log"
import { HttpApi, HttpApiGroup } from "effect/unstable/httpapi"
import { resetDatabase } from "../fixture/db"
import { tmpdir } from "../fixture/fixture"

void Log.init({ print: false })

const original = {
  OPENCODE_EXPERIMENTAL_HTTPAPI: Flag.OPENCODE_EXPERIMENTAL_HTTPAPI,
  OPENCODE_SERVER_PASSWORD: Flag.OPENCODE_SERVER_PASSWORD,
  OPENCODE_SERVER_USERNAME: Flag.OPENCODE_SERVER_USERNAME,
}

const websocket = (() => () => new Response(null, { status: 501 })) as unknown as UpgradeWebSocket

function app(input?: { password?: string; username?: string }) {
  Flag.OPENCODE_EXPERIMENTAL_HTTPAPI = true
  Flag.OPENCODE_SERVER_PASSWORD = input?.password
  Flag.OPENCODE_SERVER_USERNAME = input?.username
  return InstanceRoutes(websocket)
}

function routeKey(route: ReturnType<typeof InstanceRoutes>["routes"][number]) {
  return `${route.method} ${route.path}`
}

function reflectedHttpApiRoutes() {
  const routes = [`GET ${EventPaths.event}`, `GET ${PtyPaths.connect}`]

  function addRoutes<Id extends string, Groups extends HttpApiGroup.Any>(api: HttpApi.HttpApi<Id, Groups>) {
    HttpApi.reflect(api, {
      onGroup() {},
      onEndpoint({ endpoint }) {
        routes.push(`${endpoint.method} ${endpoint.path}`)
      },
    })
  }

  addRoutes(ConfigApi)
  addRoutes(ExperimentalApi)
  addRoutes(FileApi)
  addRoutes(InstanceApi)
  addRoutes(McpApi)
  addRoutes(PermissionApi)
  addRoutes(ProjectApi)
  addRoutes(ProviderApi)
  addRoutes(PtyApi)
  addRoutes(QuestionApi)
  addRoutes(SessionApi)
  addRoutes(SyncApi)
  addRoutes(TuiApi)
  addRoutes(WorkspaceApi)

  return [...new Set(routes)]
}

function authorization(username: string, password: string) {
  return `Basic ${Buffer.from(`${username}:${password}`).toString("base64")}`
}

function fileUrl(input?: { directory?: string; token?: string }) {
  const url = new URL(`http://localhost${FilePaths.content}`)
  url.searchParams.set("path", "hello.txt")
  if (input?.directory) url.searchParams.set("directory", input.directory)
  if (input?.token) url.searchParams.set("auth_token", input.token)
  return url
}

afterEach(async () => {
  Flag.OPENCODE_EXPERIMENTAL_HTTPAPI = original.OPENCODE_EXPERIMENTAL_HTTPAPI
  Flag.OPENCODE_SERVER_PASSWORD = original.OPENCODE_SERVER_PASSWORD
  Flag.OPENCODE_SERVER_USERNAME = original.OPENCODE_SERVER_USERNAME
  await Instance.disposeAll()
  await resetDatabase()
})

describe("HttpApi Hono bridge", () => {
  test("mounts experimental handlers for every legacy instance route", () => {
    Flag.OPENCODE_EXPERIMENTAL_HTTPAPI = false
    const legacy = InstanceRoutes(websocket)
    Flag.OPENCODE_EXPERIMENTAL_HTTPAPI = true
    const experimental = InstanceRoutes(websocket)

    const bridge = experimental.routes.slice(0, experimental.routes.length - legacy.routes.length)
    const workspaceRoutes = WorkspaceRoutes().routes.map((route) => ({
      ...route,
      path: `/experimental/workspace${route.path === "/" ? "" : route.path}`,
    }))
    const legacyRoutes = [...new Set([...legacy.routes, ...workspaceRoutes].map(routeKey))]
    const bridgeRoutes = new Set(bridge.map(routeKey))

    expect(legacyRoutes.filter((route) => !bridgeRoutes.has(route))).toEqual([])
    expect([...bridgeRoutes].filter((route) => !legacyRoutes.includes(route)).sort()).toEqual([])
  })

  test("mounts every Effect HttpApi route through the Hono bridge", () => {
    Flag.OPENCODE_EXPERIMENTAL_HTTPAPI = false
    const legacy = InstanceRoutes(websocket)
    Flag.OPENCODE_EXPERIMENTAL_HTTPAPI = true
    const experimental = InstanceRoutes(websocket)

    const bridgeRoutes = new Set(
      experimental.routes.slice(0, experimental.routes.length - legacy.routes.length).map(routeKey),
    )
    const httpApiRoutes = reflectedHttpApiRoutes()

    expect(httpApiRoutes.filter((route) => !bridgeRoutes.has(route))).toEqual([])
    expect([...bridgeRoutes].filter((route) => !httpApiRoutes.includes(route)).sort()).toEqual([])
  })

  test("allows requests when auth is disabled", async () => {
    await using tmp = await tmpdir({ git: true })
    await Bun.write(`${tmp.path}/hello.txt`, "hello")

    const response = await app().request(fileUrl(), {
      headers: {
        "x-opencode-directory": tmp.path,
      },
    })

    expect(response.status).toBe(200)
    expect(await response.json()).toMatchObject({ content: "hello" })
  })

  test("provides instance context to bridged handlers", async () => {
    await using tmp = await tmpdir({ git: true })

    const response = await app().request("/project/current", {
      headers: {
        "x-opencode-directory": tmp.path,
      },
    })

    expect(response.status).toBe(200)
    expect(await response.json()).toMatchObject({ worktree: tmp.path })
  })

  test("requires credentials when auth is enabled", async () => {
    await using tmp = await tmpdir({ git: true })
    await Bun.write(`${tmp.path}/hello.txt`, "hello")

    const [missing, bad, good] = await Promise.all([
      app({ password: "secret" }).request(fileUrl(), {
        headers: { "x-opencode-directory": tmp.path },
      }),
      app({ password: "secret" }).request(fileUrl(), {
        headers: {
          authorization: authorization("opencode", "wrong"),
          "x-opencode-directory": tmp.path,
        },
      }),
      app({ password: "secret" }).request(fileUrl(), {
        headers: {
          authorization: authorization("opencode", "secret"),
          "x-opencode-directory": tmp.path,
        },
      }),
    ])

    expect(missing.status).toBe(401)
    expect(bad.status).toBe(401)
    expect(good.status).toBe(200)
  })

  test("accepts auth_token query credentials", async () => {
    await using tmp = await tmpdir({ git: true })
    await Bun.write(`${tmp.path}/hello.txt`, "hello")

    const response = await app({ password: "secret" }).request(
      fileUrl({ token: Buffer.from("opencode:secret").toString("base64") }),
      {
        headers: {
          "x-opencode-directory": tmp.path,
        },
      },
    )

    expect(response.status).toBe(200)
  })

  test("selects instance from query before directory header", async () => {
    await using header = await tmpdir({ git: true })
    await using query = await tmpdir({ git: true })
    await Bun.write(`${header.path}/hello.txt`, "header")
    await Bun.write(`${query.path}/hello.txt`, "query")

    const response = await app().request(fileUrl({ directory: query.path }), {
      headers: {
        "x-opencode-directory": header.path,
      },
    })

    expect(response.status).toBe(200)
    expect(await response.json()).toMatchObject({ content: "query" })
  })
})