opencode/packages/plugin/test/host.test.ts

import assert from "node:assert/strict"
import { mkdir, mkdtemp, realpath, rm, writeFile } from "node:fs/promises"
import { tmpdir } from "node:os"
import path from "node:path"
import { describe, it } from "node:test"
import { pathToFileURL } from "node:url"
import { Host } from "../src/host.js"

// Every entrypoint throws if evaluated: resolution must never execute plugins.
const source = 'throw new Error("Plugin code must not run during resolution")'
const name = "@fixture/plugin"

async function fixture(files: Record<string, string>, installed = false) {
  const root = await realpath(await mkdtemp(path.join(tmpdir(), "opencode-host-")))
  const directory = installed ? path.join(root, "node_modules", name) : root
  await Promise.all(
    Object.entries(files).map(async ([file, content]) => {
      await mkdir(path.dirname(path.join(directory, file)), { recursive: true })
      await writeFile(path.join(directory, file), content)
    }),
  )
  return {
    target: { directory, ...(installed ? { name } : {}) },
    url: (file: string) => pathToFileURL(path.join(directory, file)).href,
    [Symbol.asyncDispose]: () => rm(root, { recursive: true, force: true }),
  }
}

describe("Host.resolve", () => {
  it("resolves conventional entrypoints without package.json", async () => {
    await using plugin = await fixture({ "index.ts": source, "tui.tsx": source, "rpc.ts": source })
    assert.deepEqual(Host.resolve(plugin.target), {
      server: plugin.url("index.ts"),
      tui: plugin.url("tui.tsx"),
      rpc: plugin.url("rpc.ts"),
      gui: undefined,
    })
  })

  it("resolves a TUI-only directory without an index or package.json", async () => {
    await using plugin = await fixture({ "tui.tsx": source })
    assert.deepEqual(Host.resolve(plugin.target), {
      server: undefined,
      tui: plugin.url("tui.tsx"),
      rpc: undefined,
      gui: undefined,
    })
  })

  for (const main of [undefined, "lib/backend.js"]) {
    it(`resolves packages without exports using ${main ?? "the default index"}`, async () => {
      await using plugin = await fixture(
        {
          "package.json": JSON.stringify({ name, main }),
          [main ?? "index.js"]: source,
          "tui.js": source,
          "rpc.js": source,
        },
        true,
      )
      assert.deepEqual(Host.resolve(plugin.target), {
        server: plugin.url(main ?? "index.js"),
        tui: plugin.url("tui.js"),
        rpc: plugin.url("rpc.js"),
        gui: undefined,
      })
    })
  }

  it("resolves local conventional entrypoints with package.json but no exports", async () => {
    await using plugin = await fixture({
      "package.json": JSON.stringify({ name, type: "module" }),
      "index.js": source,
      "tui.js": source,
      "rpc.js": source,
    })
    assert.deepEqual(Host.resolve(plugin.target), {
      server: plugin.url("index.js"),
      tui: plugin.url("tui.js"),
      rpc: plugin.url("rpc.js"),
      gui: undefined,
    })
  })

  it("honors exports and prefers the explicit server entrypoint over the root", async () => {
    await using plugin = await fixture(
      {
        "package.json": JSON.stringify({
          name,
          exports: {
            ".": "./dist/root.js",
            "./server": "./dist/backend.js",
            "./tui": "./dist/terminal.js",
            "./rpc": "./dist/contract.js",
          },
        }),
        "dist/root.js": source,
        "dist/backend.js": source,
        "dist/terminal.js": source,
        "dist/contract.js": source,
      },
      true,
    )
    assert.deepEqual(Host.resolve(plugin.target), {
      server: plugin.url("dist/backend.js"),
      tui: plugin.url("dist/terminal.js"),
      rpc: plugin.url("dist/contract.js"),
      gui: undefined,
    })
  })

  it("falls back to the root export and uses import rather than require conditions", async () => {
    await using plugin = await fixture(
      {
        "package.json": JSON.stringify({
          name,
          exports: {
            ".": { import: "./dist/server.mjs", require: "./dist/server.cjs" },
            "./tui": { import: "./dist/tui.mjs", require: "./dist/tui.cjs" },
          },
        }),
        "dist/server.mjs": source,
        "dist/server.cjs": source,
        "dist/tui.mjs": source,
        "dist/tui.cjs": source,
      },
      true,
    )
    assert.deepEqual(Host.resolve(plugin.target), {
      server: plugin.url("dist/server.mjs"),
      tui: plugin.url("dist/tui.mjs"),
      rpc: undefined,
      gui: undefined,
    })
  })

  it("supports TUI-only exports without falling back to unexported files", async () => {
    await using plugin = await fixture(
      {
        "package.json": JSON.stringify({ name, exports: { "./tui": "./dist/terminal.js" } }),
        "dist/terminal.js": source,
        "index.js": source,
        "server.js": source,
        "rpc.js": source,
      },
      true,
    )
    assert.deepEqual(Host.resolve(plugin.target), {
      server: undefined,
      tui: plugin.url("dist/terminal.js"),
      rpc: undefined,
      gui: undefined,
    })
  })

  it("resolves the GUI entrypoint from exports beside the server and TUI entrypoints", async () => {
    await using plugin = await fixture(
      {
        "package.json": JSON.stringify({
          name,
          exports: {
            ".": "./dist/server.js",
            "./tui": "./dist/tui.js",
            "./gui-experimental": "./dist/gui-experimental.cjs",
          },
        }),
        "dist/server.js": source,
        "dist/tui.js": source,
        "dist/gui-experimental.cjs": source,
      },
      true,
    )
    assert.deepEqual(Host.resolve(plugin.target), {
      server: plugin.url("dist/server.js"),
      tui: plugin.url("dist/tui.js"),
      rpc: undefined,
      gui: plugin.url("dist/gui-experimental.cjs"),
    })
  })

  it("resolves a local directory through its package.json exports, as the published package", async () => {
    await using plugin = await fixture({
      "package.json": JSON.stringify({
        name: "opencode-acme-plugin",
        exports: { ".": "./src/index.ts", "./gui-experimental": "./dist/gui-experimental.cjs" },
      }),
      "src/index.ts": source,
      "dist/gui-experimental.cjs": source,
      // Conventional root files are not part of the exports, so they do not load.
      "tui.tsx": source,
      "gui-experimental.cjs": source,
    })
    assert.deepEqual(Host.resolve(plugin.target), {
      server: plugin.url("src/index.ts"),
      tui: undefined,
      rpc: undefined,
      gui: plugin.url("dist/gui-experimental.cjs"),
    })
  })

  it("names a plugin without a server part after its package, or its local directory", async () => {
    await using named = await fixture({ "package.json": JSON.stringify({ name: "@acme/opencode-gui" }) })
    await using unnamed = await fixture({ "tui.tsx": source })
    await using published = await fixture({ "package.json": JSON.stringify({ name }) }, true)
    assert.equal(Host.packageID(named.target), "@acme/opencode-gui")
    assert.equal(Host.packageID(unnamed.target), path.basename(unnamed.target.directory))
    assert.equal(Host.packageID(published.target), name)
  })

  it("treats a package.json that does not parse as missing, so resolution falls back to root files", async () => {
    await using plugin = await fixture({ "package.json": '{ "name": "bad", ', "index.ts": source })
    assert.deepEqual(Host.resolve(plugin.target), {
      server: plugin.url("index.ts"),
      tui: undefined,
      rpc: undefined,
      gui: undefined,
    })
    assert.equal(Host.packageID(plugin.target), path.basename(plugin.target.directory))
  })

  it("resolves the conventional GUI entrypoint in a local directory", async () => {
    await using plugin = await fixture({ "index.ts": source, "gui-experimental.js": source })
    assert.deepEqual(Host.resolve(plugin.target), {
      server: plugin.url("index.ts"),
      tui: undefined,
      rpc: undefined,
      gui: plugin.url("gui-experimental.js"),
    })
  })

  it("does not treat TypeScript or ES module GUI sources as the CommonJS bundle", async () => {
    await using local = await fixture({ "index.ts": source, "gui.tsx": source })
    await using published = await fixture(
      {
        "package.json": JSON.stringify({
          name,
          exports: { ".": "./dist/server.js", "./gui-experimental": "./dist/gui-experimental.mjs" },
        }),
        "dist/server.js": source,
        "dist/gui-experimental.mjs": source,
      },
      true,
    )
    assert.equal(Host.resolve(local.target).gui, undefined)
    assert.equal(Host.resolve(published.target).gui, undefined)
  })

  it("does not return an exported entrypoint whose file is missing", async () => {
    await using plugin = await fixture(
      { "package.json": JSON.stringify({ name, exports: { "./tui": "./missing.js" } }) },
      true,
    )
    assert.deepEqual(Host.resolve(plugin.target), {
      server: undefined,
      tui: undefined,
      rpc: undefined,
      gui: undefined,
    })
  })
})