opencode/packages/opencode/src/plugin/index.ts

import type { Hooks, PluginInput, Plugin as PluginInstance, PluginModule } from "@opencode-ai/plugin"
import { Config } from "../config/config"
import { Bus } from "../bus"
import { Log } from "../util/log"
import { createOpencodeClient } from "@opencode-ai/sdk"
import { Flag } from "../flag/flag"
import { CodexAuthPlugin } from "./codex"
import { Session } from "../session"
import { NamedError } from "@opencode-ai/util/error"
import { CopilotAuthPlugin } from "./copilot"
import { gitlabAuthPlugin as GitlabAuthPlugin } from "opencode-gitlab-auth"
import { PoeAuthPlugin } from "opencode-poe-auth"
import { Effect, Layer, ServiceMap, Stream } from "effect"
import { InstanceState } from "@/effect/instance-state"
import { makeRuntime } from "@/effect/run-service"
import { errorMessage } from "@/util/error"
import { Installation } from "@/installation"
import {
  checkPluginCompatibility,
  getDefaultPlugin,
  isDeprecatedPlugin,
  parsePluginSpecifier,
  pluginSource,
  resolvePluginEntrypoint,
  resolvePluginTarget,
} from "./shared"

export namespace Plugin {
  const log = Log.create({ service: "plugin" })

  type State = {
    hooks: Hooks[]
  }

  type Loaded = {
    item: Config.PluginSpec
    spec: string
    mod: Record<string, unknown>
  }

  // Hook names that follow the (input, output) => Promise<void> trigger pattern
  type TriggerName = {
    [K in keyof Hooks]-?: NonNullable<Hooks[K]> extends (input: any, output: any) => Promise<void> ? K : never
  }[keyof Hooks]

  export interface Interface {
    readonly trigger: <
      Name extends TriggerName,
      Input = Parameters<Required<Hooks>[Name]>[0],
      Output = Parameters<Required<Hooks>[Name]>[1],
    >(
      name: Name,
      input: Input,
      output: Output,
    ) => Effect.Effect<Output>
    readonly list: () => Effect.Effect<Hooks[]>
    readonly init: () => Effect.Effect<void>
  }

  export class Service extends ServiceMap.Service<Service, Interface>()("@opencode/Plugin") {}

  // Built-in plugins that are directly imported (not installed from npm)
  const INTERNAL_PLUGINS: PluginInstance[] = [CodexAuthPlugin, CopilotAuthPlugin, GitlabAuthPlugin, PoeAuthPlugin]

  function isServerPlugin(value: unknown): value is PluginInstance {
    return typeof value === "function"
  }

  function getServerPlugin(value: unknown) {
    if (isServerPlugin(value)) return value
    if (!value || typeof value !== "object" || !("server" in value)) return
    if (!isServerPlugin(value.server)) return
    return value.server
  }

  function getLegacyPlugins(mod: Record<string, unknown>) {
    const seen = new Set<unknown>()
    const result: PluginInstance[] = []

    for (const entry of Object.values(mod)) {
      if (seen.has(entry)) continue
      seen.add(entry)
      const plugin = getServerPlugin(entry)
      if (!plugin) throw new TypeError("Plugin export is not a function")
      result.push(plugin)
    }

    return result
  }

  async function resolvePlugin(spec: string) {
    const parsed = parsePluginSpecifier(spec)
    const target = await resolvePluginTarget(spec, parsed).catch((err) => {
      const cause = err instanceof Error ? err.cause : err
      const detail = errorMessage(cause ?? err)
      log.error("failed to install plugin", { pkg: parsed.pkg, version: parsed.version, error: detail })
      Bus.publish(Session.Event.Error, {
        error: new NamedError.Unknown({
          message: `Failed to install plugin ${parsed.pkg}@${parsed.version}: ${detail}`,
        }).toObject(),
      })
      return ""
    })
    if (!target) return
    return target
  }

  async function prepPlugin(item: Config.PluginSpec): Promise<Loaded | undefined> {
    const spec = Config.pluginSpecifier(item)
    if (isDeprecatedPlugin(spec)) return
    log.info("loading plugin", { path: spec })
    const resolved = await resolvePlugin(spec)
    if (!resolved) return

    if (pluginSource(spec) === "npm") {
      const incompatible = await checkPluginCompatibility(resolved, Installation.VERSION)
        .then(() => false)
        .catch((err) => {
          const message = errorMessage(err)
          log.warn("plugin incompatible", { path: spec, error: message })
          Bus.publish(Session.Event.Error, {
            error: new NamedError.Unknown({
              message: `Plugin ${spec} skipped: ${message}`,
            }).toObject(),
          })
          return true
        })
      if (incompatible) return
    }

    const target = resolved
    const entry = await resolvePluginEntrypoint(spec, target, "server").catch((err) => {
      const message = errorMessage(err)
      log.error("failed to resolve plugin server entry", { path: spec, target, error: message })
      Bus.publish(Session.Event.Error, {
        error: new NamedError.Unknown({
          message: `Failed to load plugin ${spec}: ${message}`,
        }).toObject(),
      })
      return
    })
    if (!entry) return

    const mod = await import(entry).catch((err) => {
      const message = errorMessage(err)
      log.error("failed to load plugin", { path: spec, target: entry, error: message })
      Bus.publish(Session.Event.Error, {
        error: new NamedError.Unknown({
          message: `Failed to load plugin ${spec}: ${message}`,
        }).toObject(),
      })
      return
    })
    if (!mod) return

    return {
      item,
      spec,
      mod,
    }
  }

  async function applyPlugin(load: Loaded, input: PluginInput, hooks: Hooks[]) {
    const plugin = getDefaultPlugin(load.mod) as PluginModule | undefined
    if (plugin?.server) {
      hooks.push(await plugin.server(input, Config.pluginOptions(load.item)))
      return
    }

    for (const server of getLegacyPlugins(load.mod)) {
      hooks.push(await server(input, Config.pluginOptions(load.item)))
    }
  }

  export const layer = Layer.effect(
    Service,
    Effect.gen(function* () {
      const bus = yield* Bus.Service

      const cache = yield* InstanceState.make<State>(
        Effect.fn("Plugin.state")(function* (ctx) {
          const hooks: Hooks[] = []

          yield* Effect.promise(async () => {
            const { Server } = await import("../server/server")

            const client = createOpencodeClient({
              baseUrl: "http://localhost:4096",
              directory: ctx.directory,
              headers: Flag.OPENCODE_SERVER_PASSWORD
                ? {
                    Authorization: `Basic ${Buffer.from(`${Flag.OPENCODE_SERVER_USERNAME ?? "opencode"}:${Flag.OPENCODE_SERVER_PASSWORD}`).toString("base64")}`,
                  }
                : undefined,
              fetch: async (...args) => Server.Default().app.fetch(...args),
            })
            const cfg = await Config.get()
            const input: PluginInput = {
              client,
              project: ctx.project,
              worktree: ctx.worktree,
              directory: ctx.directory,
              get serverUrl(): URL {
                return Server.url ?? new URL("http://localhost:4096")
              },
              $: Bun.$,
            }

            for (const plugin of INTERNAL_PLUGINS) {
              log.info("loading internal plugin", { name: plugin.name })
              const init = await plugin(input).catch((err) => {
                log.error("failed to load internal plugin", { name: plugin.name, error: err })
              })
              if (init) hooks.push(init)
            }

            const plugins = Flag.OPENCODE_PURE ? [] : (cfg.plugin ?? [])
            if (Flag.OPENCODE_PURE && cfg.plugin?.length) {
              log.info("skipping external plugins in pure mode", { count: cfg.plugin.length })
            }
            if (plugins.length) await Config.waitForDependencies()

            const loaded = await Promise.all(plugins.map((item) => prepPlugin(item)))
            for (const load of loaded) {
              if (!load) continue

              // Keep plugin execution sequential so hook registration and execution
              // order remains deterministic across plugin runs.
              await applyPlugin(load, input, hooks).catch((err) => {
                const message = errorMessage(err)
                log.error("failed to load plugin", { path: load.spec, error: message })
                Bus.publish(Session.Event.Error, {
                  error: new NamedError.Unknown({
                    message: `Failed to load plugin ${load.spec}: ${message}`,
                  }).toObject(),
                })
              })
            }

            // Notify plugins of current config
            for (const hook of hooks) {
              try {
                await (hook as any).config?.(cfg)
              } catch (err) {
                log.error("plugin config hook failed", { error: err })
              }
            }
          })

          // Subscribe to bus events, fiber interrupted when scope closes
          yield* bus.subscribeAll().pipe(
            Stream.runForEach((input) =>
              Effect.sync(() => {
                for (const hook of hooks) {
                  hook["event"]?.({ event: input as any })
                }
              }),
            ),
            Effect.forkScoped,
          )

          return { hooks }
        }),
      )

      const trigger = Effect.fn("Plugin.trigger")(function* <
        Name extends TriggerName,
        Input = Parameters<Required<Hooks>[Name]>[0],
        Output = Parameters<Required<Hooks>[Name]>[1],
      >(name: Name, input: Input, output: Output) {
        if (!name) return output
        const state = yield* InstanceState.get(cache)
        yield* Effect.promise(async () => {
          for (const hook of state.hooks) {
            const fn = hook[name] as any
            if (!fn) continue
            await fn(input, output)
          }
        })
        return output
      })

      const list = Effect.fn("Plugin.list")(function* () {
        const state = yield* InstanceState.get(cache)
        return state.hooks
      })

      const init = Effect.fn("Plugin.init")(function* () {
        yield* InstanceState.get(cache)
      })

      return Service.of({ trigger, list, init })
    }),
  )

  export const defaultLayer = layer.pipe(Layer.provide(Bus.layer))
  const { runPromise } = makeRuntime(Service, defaultLayer)

  export async function trigger<
    Name extends TriggerName,
    Input = Parameters<Required<Hooks>[Name]>[0],
    Output = Parameters<Required<Hooks>[Name]>[1],
  >(name: Name, input: Input, output: Output): Promise<Output> {
    return runPromise((svc) => svc.trigger(name, input, output))
  }

  export async function list(): Promise<Hooks[]> {
    return runPromise((svc) => svc.list())
  }

  export async function init() {
    return runPromise((svc) => svc.init())
  }
}