import { describe, expect } from "bun:test" import { ToolFailure } from "@opencode-ai/ai" import { Context, Effect, Exit, Fiber, Schema, Stream } from "effect" import { Plugin as EffectPlugin } from "@opencode-ai/plugin/effect" import { Config as ConfigSchema } from "@opencode-ai/schema/config" import { Agent } from "@opencode-ai/core/agent" import { Bus } from "@opencode-ai/core/bus" import { Plugin } from "@opencode-ai/core/plugin" import { PluginHost } from "@opencode-ai/core/plugin/host" import { PluginRuntime } from "@opencode-ai/core/plugin/runtime" import { Location } from "@opencode-ai/core/location" import { PersistentPty } from "@opencode-ai/core/persistent-pty" import { Project } from "@opencode-ai/core/project" import { AbsolutePath } from "@opencode-ai/core/schema" import { Session } from "@opencode-ai/core/session" import { SessionMessage } from "@opencode-ai/core/session/message" import { Tool } from "@opencode-ai/core/tool" import { Vcs } from "@opencode-ai/core/vcs" import { Pty } from "@opencode-ai/schema/pty" import { testEffect } from "./lib/effect" import { PluginTestLayer } from "./plugin/fixture" const it = testEffect(PluginTestLayer) class Secret extends Context.Service()("@opencode/test/PluginSecret") {} const versioned = (plugin: EffectPlugin.Plugin, version = "1") => ({ ...plugin, version }) describe("Plugin", () => { it.effect("routes experimental terminal reads through the runtime cell without wrapping results", () => Effect.gen(function* () { const plugins = yield* Plugin.Service const runtime = yield* PluginRuntime.Service const cell = PluginRuntime.makeCell() const host = yield* PluginHost.make(plugins).pipe(Effect.provide(PluginRuntime.layerWithCell(cell))) const sessionID = Session.ID.make("ses_terminal") const pending = host.experimental.terminal.read({ sessionID, lines: 3 }) const seen: unknown[] = [] const terminal = { ptyID: Pty.ID.make("pty_terminal"), title: "Build", cwd: "/workspace", foregroundProcess: null, screen: { text: "one\ntwo\nthree", cols: 80, rows: 2, cursor: { x: 3, y: 1 } }, } const error = new PersistentPty.UnavailableError({ message: "terminal daemon unavailable" }) cell.runtime = { ...runtime, persistentPty: { read: (id, lines) => { seen.push({ sessionID: id, lines }) if (id === Session.ID.make("ses_failure")) return Effect.fail(error) return Effect.succeed(id === sessionID ? terminal : null) }, }, } expect(Object.keys(host.experimental)).toEqual(["terminal"]) expect(Object.keys(host.experimental.terminal)).toEqual(["read"]) expect(yield* pending).toBe(terminal) expect(yield* host.experimental.terminal.read({ sessionID })).toBe(terminal) expect(yield* host.experimental.terminal.read({ sessionID: Session.ID.make("ses_empty") })).toBeNull() expect( yield* host.experimental.terminal.read({ sessionID: Session.ID.make("ses_failure") }).pipe(Effect.flip), ).toBe(error) expect(seen).toEqual([ { sessionID, lines: 3 }, { sessionID, lines: undefined }, { sessionID: Session.ID.make("ses_empty"), lines: undefined }, { sessionID: Session.ID.make("ses_failure"), lines: undefined }, ]) cell.runtime = undefined expect(Exit.isFailure(yield* pending.pipe(Effect.exit))).toBe(true) }), ) it.effect("exposes the current location to activated plugins", () => Effect.gen(function* () { const plugins = yield* Plugin.Service const location = yield* Location.Service const seen: Location.Info[] = [] yield* plugins.activate([ versioned( EffectPlugin.define({ id: "location-context", effect: (ctx) => Effect.sync(() => { seen.push(ctx.location) }), }), "1", ), ]) expect(seen).toEqual([ new Location.Info({ directory: location.directory, workspaceID: location.workspaceID, project: location.project, }), ]) }), ) it.live("exposes public events through the plugin context", () => Effect.gen(function* () { const plugins = yield* Plugin.Service const bus = yield* Bus.Service const host = yield* PluginHost.make(plugins) const received = yield* host.event.subscribe().pipe( Stream.filter((event) => event.type === "config.updated"), Stream.runHead, Effect.forkScoped({ startImmediately: true }), ) yield* Effect.sleep("10 millis") yield* bus.publish(ConfigSchema.Event.Updated, {}) expect((yield* Fiber.join(received)).valueOrUndefined?.type).toBe("config.updated") }), ) it.effect("exposes MCP reads and transforms and routes explicit read locations", () => Effect.gen(function* () { const plugins = yield* Plugin.Service const runtime = yield* PluginRuntime.Service const target = AbsolutePath.make("/target") const routed: string[] = [] const host = yield* PluginHost.make(plugins).pipe( Effect.provideService( PluginRuntime.Service, PluginRuntime.Service.of({ ...runtime, location: { agent: runtime.location.agent, mcp: { list: (ref) => Effect.sync(() => { routed.push(`list:${ref.directory}`) return { location: new Location.Info({ directory: ref.directory, project: { id: Project.ID.make("project"), directory: ref.directory, canonical: ref.directory, }, }), data: [], } }), }, }, }), ), ) const location = { directory: target } expect(Object.keys(host.mcp).sort()).toEqual(["list", "reload", "transform"]) expect((yield* host.mcp.list({ location }).pipe(Effect.orDie)).location.directory).toBe(target) expect(routed).toEqual(["list:/target"]) }), ) it.effect("forwards session interrupt options through the runtime cell", () => Effect.gen(function* () { const plugins = yield* Plugin.Service const fallback = yield* PluginRuntime.Service const cell = PluginRuntime.makeCell() const sessionID = Session.ID.create() const calls: Array<{ sessionID: Session.ID; options: { continue?: boolean } | undefined }> = [] cell.runtime = { ...fallback, session: { ...fallback.session, interrupt: (id, options) => Effect.sync(() => { calls.push({ sessionID: id, options }) return true }), }, } const runtime = yield* PluginRuntime.Service.pipe(Effect.provide(PluginRuntime.layerWithCell(cell))) const host = yield* PluginHost.make(plugins).pipe(Effect.provideService(PluginRuntime.Service, runtime)) expect(yield* runtime.session.interrupt(sessionID)).toBe(true) expect(yield* host.session.interrupt({ sessionID, continue: true })).toEqual({ interrupted: true }) expect(calls).toEqual([ { sessionID, options: undefined }, { sessionID, options: { continue: true } }, ]) }), ) it.effect("registers and removes scoped VCS providers", () => Effect.gen(function* () { const plugins = yield* Plugin.Service const vcs = yield* Vcs.Service const provider = EffectPlugin.define({ id: "custom-vcs", effect: (ctx) => ctx.vcs .transform((draft) => { draft.add({ id: "custom", name: "Custom VCS", info: () => Effect.succeed({ branch: { current: "feature" } }), branches: () => Effect.succeed(["feature"]), status: () => Effect.succeed([]), diff: () => Effect.succeed([]), }) draft.default.set("custom") }) .pipe(Effect.asVoid), }) yield* plugins.activate([versioned(provider)]) expect(yield* vcs.info()).toEqual({ branch: { current: "feature" } }) expect(yield* vcs.branches()).toEqual(["feature"]) yield* plugins.activate([]) expect(yield* vcs.info()).toEqual({ branch: {} }) }), ) it.effect("replaces plugins by ID and version", () => Effect.gen(function* () { const plugins = yield* Plugin.Service const agents = yield* Agent.Service const bus = yield* Bus.Service let description = "first" let updates = 0 const unsubscribe = yield* bus.listen((event) => Effect.sync(() => { if (event.type === Plugin.Event.Updated.type) updates++ }), ) const managed = () => EffectPlugin.define({ id: "managed", effect: (ctx) => ctx.agent .transform((agents) => agents.update("configured", (agent) => { agent.description = description }), ) .pipe(Effect.asVoid), }) yield* plugins.activate([versioned(managed(), "1")]) expect((yield* agents.get(Agent.ID.make("configured")))?.description).toBe("first") description = "second" yield* plugins.activate([versioned(managed(), "2")]) expect((yield* agents.get(Agent.ID.make("configured")))?.description).toBe("second") description = "third" yield* plugins.activate([versioned(managed(), "2")]) expect(updates).toBe(2) expect((yield* agents.get(Agent.ID.make("configured")))?.description).toBe("second") yield* plugins.activate( [versioned(managed(), "2")], [ { source: { type: "package", package: "broken" }, status: "failed", error: "failed to resolve", tui: false, }, ], ) expect(updates).toBe(3) yield* plugins.activate([]) expect(yield* agents.get(Agent.ID.make("configured"))).toBeUndefined() expect(updates).toBe(4) yield* unsubscribe }), ) it.effect("emits rebuilt state when disabling one plugin while another remains enabled", () => Effect.gen(function* () { const plugins = yield* Plugin.Service const agents = yield* Agent.Service const bus = yield* Bus.Service const definitions = ["first", "second"].map((id) => versioned( EffectPlugin.define({ id, effect: (ctx) => ctx.agent.transform((draft) => draft.update(id, () => {})), }), ), ) yield* plugins.activate(definitions) const observed: string[][] = [] const unsubscribe = yield* bus.listen((event) => event.type === Agent.Event.Updated.type ? agents.list().pipe( Effect.flatMap((items) => Effect.sync(() => observed.push(items.map((item) => item.id)))), Effect.asVoid, ) : Effect.void, ) yield* Effect.addFinalizer(() => unsubscribe) yield* plugins.activate(definitions.slice(1)) expect(yield* agents.get(Agent.ID.make("first"))).toBeUndefined() expect(yield* agents.get(Agent.ID.make("second"))).toBeDefined() expect(observed).toEqual([["second"]]) }), ) it.effect("rejects duplicate IDs before replacing active plugins", () => Effect.gen(function* () { const plugins = yield* Plugin.Service const active = Plugin.ID.make("active") const duplicate = "duplicate" yield* plugins.activate([{ id: active, version: "1", effect: () => Effect.void }]) const result = yield* plugins .activate([ { id: duplicate, version: "1", effect: () => Effect.void }, { id: duplicate, version: "1", effect: () => Effect.void }, ]) .pipe(Effect.exit) expect(Exit.isFailure(result)).toBe(true) expect(yield* plugins.list()).toEqual([{ id: active, source: { type: "builtin" }, status: "active", tui: false }]) }), ) it.effect("skips failed plugins and loads the rest", () => Effect.gen(function* () { const plugins = yield* Plugin.Service const agents = yield* Agent.Service let fail = true const good = EffectPlugin.define({ id: "good", effect: (ctx) => ctx.agent .transform((agents) => agents.update("configured", (agent) => { agent.description = "loaded" }), ) .pipe(Effect.asVoid), }) const bad = EffectPlugin.define({ id: "bad", effect: () => { if (fail) return Effect.die(new Error("materialization failed")) return Effect.void }, }) yield* plugins.activate([versioned(good), versioned(bad)]) expect(yield* plugins.list()).toEqual([ { id: Plugin.ID.make("good"), source: { type: "builtin" }, status: "active", tui: false }, { id: Plugin.ID.make("bad"), source: { type: "builtin" }, status: "failed", error: expect.stringContaining("materialization failed"), tui: false, }, ]) expect((yield* agents.get(Agent.ID.make("configured")))?.description).toBe("loaded") fail = false yield* plugins.activate([versioned(good), versioned(bad, "2")]) expect(yield* plugins.list()).toEqual([ { id: Plugin.ID.make("good"), source: { type: "builtin" }, status: "active", tui: false }, { id: Plugin.ID.make("bad"), source: { type: "builtin" }, status: "active", tui: false }, ]) }), ) it.effect("keeps plugins active when a tool registration is invalid", () => Effect.gen(function* () { const plugins = yield* Plugin.Service const tools = yield* Tool.Service const agents = yield* Agent.Service yield* plugins.activate([ { id: "partial-tools", version: "1", effect: (ctx) => Effect.gen(function* () { yield* ctx.tool.transform((draft) => { const tool = { name: "healthy", description: "Healthy tool", input: Schema.Struct({}), execute: () => Effect.succeed({ content: "ok" }), options: { codemode: false }, } draft.add({ ...tool, name: "invalid", options: { namespace: "invalid..namespace" } }) draft.add(tool) }) yield* ctx.agent.transform((draft) => draft.update("configured", (agent) => { agent.description = "setup continued" }), ) }), }, ]) expect(yield* plugins.list()).toEqual([ { id: Plugin.ID.make("partial-tools"), source: { type: "builtin" }, status: "active", tui: false }, ]) expect((yield* agents.get(Agent.ID.make("configured")))?.description).toBe("setup continued") expect((yield* tools.snapshot()).definitions.map((tool) => tool.name)).toEqual(["healthy", "execute"]) yield* plugins.activate([]) expect((yield* tools.snapshot()).definitions.map((tool) => tool.name)).toEqual(["execute"]) }), ) it.effect("restores the previous plugin when its replacement fails", () => Effect.gen(function* () { const plugins = yield* Plugin.Service const agents = yield* Agent.Service const previous = EffectPlugin.define({ id: "managed", effect: (ctx) => ctx.agent .transform((agents) => agents.update("configured", (agent) => { agent.description = "previous" }), ) .pipe(Effect.asVoid), }) const replacement = EffectPlugin.define({ id: "managed", effect: (ctx) => Effect.gen(function* () { yield* ctx.agent.transform((agents) => agents.update("configured", (agent) => { agent.description = "replacement" }), ) return yield* Effect.die(new Error("replacement failed")) }), }) yield* plugins.activate([versioned(previous)]) yield* plugins.activate([versioned(replacement, "2")]) expect(yield* plugins.list()).toEqual([ { id: Plugin.ID.make("managed"), source: { type: "builtin" }, status: "failed", error: expect.stringContaining("replacement failed"), tui: false, }, ]) expect((yield* agents.get(Agent.ID.make("configured")))?.description).toBe("previous") }), ) it.effect("deactivates a plugin when replacement and restoration fail", () => Effect.gen(function* () { const plugins = yield* Plugin.Service const agents = yield* Agent.Service let loads = 0 const previous = EffectPlugin.define({ id: "managed", effect: (ctx) => { loads++ if (loads > 1) return Effect.die(new Error("restoration failed")) return ctx.agent .transform((agents) => agents.update("configured", (agent) => { agent.description = "previous" }), ) .pipe(Effect.asVoid) }, }) const replacement = EffectPlugin.define({ id: "managed", effect: () => Effect.die(new Error("replacement failed")), }) yield* plugins.activate([versioned(previous)]) yield* plugins.activate([versioned(replacement, "2")]) expect(yield* plugins.list()).toEqual([ { id: Plugin.ID.make("managed"), source: { type: "builtin" }, status: "failed", error: expect.stringContaining("replacement failed"), tui: false, }, ]) expect(yield* agents.get(Agent.ID.make("configured"))).toBeUndefined() }), ) it.effect("closes the previous generation in reverse order", () => Effect.gen(function* () { const plugins = yield* Plugin.Service const closed: string[] = [] yield* plugins.activate( ["first", "second"].map((id) => ({ id, version: "1", effect: () => Effect.addFinalizer(() => Effect.sync(() => closed.push(id))), })), ) yield* plugins.activate([]) expect(closed).toEqual(["second", "first"]) }), ) it.effect("isolates plugins from ambient services", () => Effect.gen(function* () { const plugins = yield* Plugin.Service let visible = true const plugin = EffectPlugin.define({ id: "isolated", effect: () => Effect.serviceOption(Secret).pipe( Effect.tap((secret) => Effect.sync(() => (visible = secret._tag === "Some"))), Effect.asVoid, ), }) yield* plugins.activate([versioned(plugin)]).pipe(Effect.provideService(Secret, "secret")) expect(visible).toBe(false) }), ) it.effect("provides isolated durable storage for each plugin ID", () => Effect.gen(function* () { const plugins = yield* Plugin.Service const storage = new Map() yield* plugins.activate( ["a", "a:b", "雪"].map((id) => ({ id, version: "1", effect: (context: EffectPlugin.Context) => Effect.sync(() => storage.set(id, context.storage)), })), ) const first = storage.get("a") const second = storage.get("a:b") const unicode = storage.get("雪") if (!first || !second || !unicode) return yield* Effect.die("plugin storage was not activated") yield* first.set("b:c", { plugin: "a" }) yield* second.set("c", { plugin: "a:b" }) yield* unicode.set("c", { plugin: "雪" }) expect(yield* first.get("b:c")).toEqual({ plugin: "a" }) expect(yield* second.get("c")).toEqual({ plugin: "a:b" }) expect(yield* unicode.get("c")).toEqual({ plugin: "雪" }) expect(yield* first.get("c")).toBeUndefined() const prefix = "%_:/雪/" yield* first.set(`${prefix}beta`, [2]) yield* first.set(`${prefix}alpha`, [1]) const firstPage = yield* first.scan({ prefix, limit: 1 }) expect(firstPage).toEqual({ entries: [{ key: `${prefix}alpha`, value: [1] }], next: `${prefix}alpha` }) expect(yield* first.scan({ prefix, after: firstPage.next, limit: 1 })).toEqual({ entries: [{ key: `${prefix}beta`, value: [2] }], }) expect(yield* first.scan({ prefix: `${prefix}%_` })).toEqual({ entries: [] }) expect(yield* first.scan({ prefix: "" })).toEqual({ entries: [ { key: `${prefix}alpha`, value: [1] }, { key: `${prefix}beta`, value: [2] }, { key: "b:c", value: { plugin: "a" } }, ], }) yield* first.remove("b:c") yield* first.remove("b:c") expect(yield* first.get("b:c")).toBeUndefined() return undefined }), ) it.effect("registers location tools through the plugin context", () => Effect.gen(function* () { const plugins = yield* Plugin.Service const registry = yield* Tool.Service const plugin = EffectPlugin.define({ id: "tool-plugin", effect: (ctx) => ctx.tool .transform((draft) => draft.add({ name: "plugin_tool", options: { codemode: false }, description: "Plugin tool", input: Schema.Struct({}), output: Schema.Struct({ ok: Schema.Boolean }), execute: () => Effect.succeed({ output: { ok: true } }), }), ) .pipe(Effect.orDie), }) yield* plugins.activate([versioned(plugin)]) expect((yield* registry.snapshot()).definitions.map((tool) => tool.name)).toContain("plugin_tool") yield* plugins.activate([]) expect((yield* registry.snapshot()).definitions.map((tool) => tool.name)).not.toContain("plugin_tool") }), ) it.effect("namespaces tool names and routes codemode registrations through execute", () => Effect.gen(function* () { const plugins = yield* Plugin.Service const registry = yield* Tool.Service const tool = (name: string, description: string, options?: Tool.Options) => ({ name, options, description, input: Schema.Struct({}), output: Schema.Struct({ ok: Schema.Boolean }), execute: () => Effect.succeed({ output: { ok: true } }), }) const plugin = EffectPlugin.define({ id: "grouped-tools", effect: (ctx) => ctx.tool .transform((draft) => { draft.add(tool("plain", "Plain", { codemode: false })) draft.add(tool("look/up", "Lookup", { namespace: "context7", codemode: false })) draft.add(tool("search", "Search", { namespace: "context7" })) }) .pipe(Effect.orDie), }) yield* plugins.activate([versioned(plugin)]) expect((yield* registry.snapshot()).definitions.map((tool) => tool.name)).toEqual([ "context7_look_up", "plain", "execute", ]) }), ) it.effect("fires before/after tool hooks with mutable events around execution", () => Effect.gen(function* () { const plugins = yield* Plugin.Service const registry = yield* Tool.Service const executed: unknown[] = [] const seen: { before?: { input: unknown; tool: string } after?: { input: unknown; status: string; content: unknown; metadata: unknown } } = {} const plugin = EffectPlugin.define({ id: "tool-hooks", effect: (ctx) => Effect.gen(function* () { yield* ctx.tool .transform((draft) => draft.add({ name: "echo", options: { codemode: false }, description: "Echo", input: Schema.Struct({ text: Schema.String }), output: Schema.Struct({ text: Schema.String }), execute: ({ text }) => Effect.sync(() => executed.push({ text })).pipe(Effect.as({ output: { text } })), }), ) .pipe(Effect.orDie) yield* ctx.tool .hook("execute.before", (event) => Effect.sync(() => { expect(event).not.toHaveProperty("inputSchema") seen.before = { input: event.input, tool: event.tool } event.tool = "echo" event.input = { text: "before-mutated" } }), ) .pipe(Effect.asVoid) yield* ctx.tool .hook("execute.after", (event) => Effect.sync(() => { seen.after = { input: event.input, status: event.status, content: event.status === "completed" ? event.result.content : undefined, metadata: event.status === "completed" ? event.result.metadata : event.error.metadata, } if (event.status !== "completed") return event.result = { ...event.result, content: [{ type: "text", text: "after-mutated" }], metadata: { rewritten: true }, } }), ) .pipe(Effect.asVoid) yield* ctx.tool .hook("execute.after", (event) => Effect.sync(() => { if (event.status === "completed" && Array.isArray(event.result.content)) event.result.content.splice(0) }), ) .pipe(Effect.asVoid) }), }) yield* plugins.activate([versioned(plugin)]) const toolSet = yield* registry.snapshot() const execution = yield* toolSet.execute({ sessionID: Session.ID.make("ses_hooks"), agent: Agent.ID.make("build"), messageID: SessionMessage.ID.make("msg_hooks"), call: { type: "tool-call", id: "call-hooks", name: "misspelled", input: { text: "original" } }, }) expect(seen.before).toEqual({ input: { text: "original" }, tool: "misspelled", }) expect(executed).toEqual([{ text: "before-mutated" }]) expect(seen.after).toEqual({ input: { text: "before-mutated" }, status: "completed", content: [{ type: "text", text: '{"text":"before-mutated"}' }], metadata: undefined, }) expect(execution).toMatchObject({ content: [{ type: "text", text: '{"text":"before-mutated"}' }], metadata: { rewritten: true }, }) }), ) it.effect("rejects tool execution when an execute.before hook fails", () => Effect.gen(function* () { const plugins = yield* Plugin.Service const registry = yield* Tool.Service const executed: unknown[] = [] const plugin = EffectPlugin.define({ id: "tool-hook-reject", effect: (ctx) => Effect.gen(function* () { yield* ctx.tool .transform((draft) => draft.add({ name: "echo", options: { codemode: false }, description: "Echo", input: Schema.Struct({ text: Schema.String }), output: Schema.Struct({ text: Schema.String }), execute: ({ text }) => Effect.sync(() => executed.push({ text })).pipe(Effect.as({ output: { text } })), }), ) .pipe(Effect.orDie) yield* ctx.tool .hook("execute.before", () => new ToolFailure({ message: "write disabled" })) .pipe(Effect.asVoid) }), }) yield* plugins.activate([versioned(plugin)]) const toolSet = yield* registry.snapshot() const failure = yield* toolSet .execute({ sessionID: Session.ID.make("ses_hook_reject"), agent: Agent.ID.make("build"), messageID: SessionMessage.ID.make("msg_hook_reject"), call: { type: "tool-call", id: "call-hook-reject", name: "missing", input: { text: "original" } }, }) .pipe(Effect.flip) expect(failure).toMatchObject({ _tag: "Tool.Error", message: "write disabled" }) expect(executed).toEqual([]) }), ) })