Skip to content

fix(tool.registry): tolerate failed custom tool imports #12279

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
dlukt wants to merge 1 commit into from
+42 −4
Closed

fix(tool.registry): tolerate failed custom tool imports #12279

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 42 additions & 4 deletions packages/opencode/src/tool/registry.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ import { LspTool } from "./lsp"
import { Truncate } from "./truncation"
import { PlanExitTool, PlanEnterTool } from "./plan"
import { ApplyPatchTool } from "./apply_patch"
import { pathToFileURL } from "url"

export namespace ToolRegistry {
const log = Log.create({ service: "tool.registry" })
Expand All @@ -38,12 +39,49 @@ export namespace ToolRegistry {
const matches = await Config.directories().then((dirs) =>
dirs.flatMap((dir) => [...glob.scanSync({ cwd: dir, absolute: true, followSymlinks: true, dot: true })]),
)
if (matches.length) await Config.waitForDependencies()

const load = (filepath: string, cacheKey?: string) => {
const url = pathToFileURL(filepath).href
return import(cacheKey ? `${url}?opencode=${cacheKey}` : url)
}

const invalid = (id: string, filepath: string, error: unknown): Tool.Info => {
const message = error instanceof Error ? error.message : String(error)
return Tool.define(id, {
description: `Custom tool failed to load: ${id}`,
parameters: z.unknown(),
execute: async () => ({
title: "Tool Load Error",
output: `Failed to load custom tool '${id}' from ${filepath}:\n\n${message}`,
metadata: {},
}),
})
}

for (const match of matches) {
const namespace = path.basename(match, path.extname(match))
const mod = await import(match)
for (const [id, def] of Object.entries<ToolDefinition>(mod)) {
custom.push(fromPlugin(id === "default" ? namespace : `${namespace}_${id}`, def))
const mod = await load(match).catch(async (error) => {
log.error("Failed to load custom tool module", { match, error })
await Config.installDependencies(path.dirname(path.dirname(match))).catch(() => {})
return load(match, Date.now().toString()).catch((e) => {
log.error("Failed to load custom tool module after installing deps", { match, error: e })
return undefined
})
})

if (!mod) {
custom.push(invalid(namespace, match, "Module failed to load"))
continue
}

for (const [id, def] of Object.entries(mod as Record<string, ToolDefinition>)) {
const toolID = id === "default" ? namespace : `${namespace}_${id}`
try {
custom.push(fromPlugin(toolID, def))
} catch (error) {
log.error("Failed to load custom tool definition", { match, id: toolID, error })
custom.push(invalid(toolID, match, error))
}
}
}

Expand Down
Loading