Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
89 changes: 89 additions & 0 deletions packages/opencode/src/altimate/tool-label.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,89 @@
/**
* Produces a readable, dbt-aware title for a tool call — e.g. "Reading customers
* model" instead of a bare file path — so any client (chat webview, TUI, ...) can
* render a descriptive label straight from the tool part's `state.title`.
*
* This is the source of truth for tool-call labels: it runs inside the tool
* execute() wrapper (see `tool/tool.ts`) and rewrites the title every tool
* returns. Only file-acting tools (whose native title is a bare path) are
* rewritten; every other tool keeps the rich title it already emits.
*
* dbt naming ("model"/"seed"/...) is applied only when the path sits under the
* matching directory, so it degrades to the plain filename off-dbt.
*/

/** File-acting tools whose native title is a bare path → gerund verb. */
const FILE_TOOL_VERBS: Record<string, string> = {
read: "Reading",
write: "Writing",
edit: "Editing",
multiedit: "Editing",
glob: "Searching",
grep: "Searching",
list: "Listing",
}

/** dbt directory → singular noun used in the label. */
const DBT_DIR_KIND: Record<string, string> = {
models: "model",
seeds: "seed",
macros: "macro",
snapshots: "snapshot",
tests: "test",
analyses: "analysis",
analysis: "analysis",
}

function asString(value: unknown): string | undefined {
return typeof value === "string" && value.trim() ? value : undefined
}

/**
* Turn a file path into a friendly target:
* - under a known dbt dir → "<name> <kind>" with the sql/yaml/csv extension stripped
* - otherwise → the basename, extension kept (e.g. "dbt_project.yml", "index.ts")
*/
function friendlyTarget(rawPath: string): string {
const segments = rawPath.replace(/\\/g, "/").replace(/^\.\//, "").split("/").filter(Boolean)
const base = segments[segments.length - 1] ?? rawPath
for (const segment of segments.slice(0, -1)) {
const kind = DBT_DIR_KIND[segment.toLowerCase()]

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P3: Non-dbt files under common directories like src/models can be shown as dbt objects because friendlyTarget() applies the dbt noun to any path segment named models, tests, or macros, regardless of the target file type. That makes labels such as Reading User.tsx model possible outside dbt projects; consider only applying the dbt noun when the target looks like a dbt resource (for example known dbt file extensions) and otherwise falling back to the basename.

Prompt for AI agents
Check if this issue is valid — if so, understand the root cause and fix it. At packages/opencode/src/altimate/tool-label.ts, line 50:

<comment>Non-dbt files under common directories like `src/models` can be shown as dbt objects because `friendlyTarget()` applies the dbt noun to any path segment named `models`, `tests`, or `macros`, regardless of the target file type. That makes labels such as `Reading User.tsx model` possible outside dbt projects; consider only applying the dbt noun when the target looks like a dbt resource (for example known dbt file extensions) and otherwise falling back to the basename.</comment>

<file context>
@@ -0,0 +1,89 @@
+  const segments = rawPath.replace(/\\/g, "/").replace(/^\.\//, "").split("/").filter(Boolean)
+  const base = segments[segments.length - 1] ?? rawPath
+  for (const segment of segments.slice(0, -1)) {
+    const kind = DBT_DIR_KIND[segment.toLowerCase()]
+    if (kind) {
+      const name = base.replace(/\.(sql|ya?ml|csv)$/i, "")
</file context>

Comment on lines +49 to +50

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[🟠 MEDIUM] Iterating left-to-right (from the root down) can incorrectly match an outer directory that coincidentally shares a name with a dbt folder, rather than the intended specific directory (e.g., an absolute path like /Users/user/models/my_project/macros/utils.sql would match models instead of macros, returning utils model instead of utils macro).

Consider iterating right-to-left (from the file upwards) to match the most specific parent directory.

Suggested change:

Suggested change
for (const segment of segments.slice(0, -1)) {
const kind = DBT_DIR_KIND[segment.toLowerCase()]
for (let i = segments.length - 2; i >= 0; i--) {
const segment = segments[i]
const kind = DBT_DIR_KIND[segment.toLowerCase()]

if (kind) {
const name = base.replace(/\.(sql|ya?ml|csv)$/i, "")
return `${name} ${kind}`
}
Comment on lines +51 to +54

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[🟠 MEDIUM] The regex misses .py (for Python models) and .md (for dbt documentation files), which are both common in dbt projects. Without these, a Python model would render as model.py model rather than model model. Consider adding them to the regex.

Suggested change:

Suggested change
if (kind) {
const name = base.replace(/\.(sql|ya?ml|csv)$/i, "")
return `${name} ${kind}`
}
if (kind) {
const name = base.replace(/\.(sql|ya?ml|csv|py|md)$/i, "")
return `${name} ${kind}`
}

}
return base
}
Comment on lines +46 to +57

/** Extract the display target for a given file tool from its input args. */
function fileTarget(tool: string, input: Record<string, unknown>): string | undefined {
if (tool === "glob" || tool === "grep") {
return asString(input["pattern"])
}
if (tool === "list") {
const path = asString(input["path"])
return path ? friendlyTarget(path) : undefined
}
// read / write / edit / multiedit
const filePath = asString(input["filePath"]) ?? asString(input["path"])
return filePath ? friendlyTarget(filePath) : undefined
}

/**
* @param tool the tool id (e.g. "read", "sql_analyze")
* @param input the tool's input args
* @param rawTitle the title the tool itself returned (a bare path for file tools,
* already human-readable for everything else)
* @returns a humanized label for file tools, otherwise the tool's own title.
*/
export function describeToolCall(tool: string, input: unknown, rawTitle?: string): string | undefined {
const fallback = asString(rawTitle)
const verb = FILE_TOOL_VERBS[tool]
if (verb && input && typeof input === "object") {
const target = fileTarget(tool, input as Record<string, unknown>)
if (target) return `${verb} ${target}`

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2: When list targets the worktree root (no path argument or empty relative path), fileTarget() returns undefined and asString(rawTitle) also returns undefined (since path.relative(worktree, worktree) is ""). The ?? fallback in tool.ts then yields the original empty-string title, producing a blank UI label. Consider producing a fallback like "Listing ." when a file tool has a verb but neither a usable target nor a non-empty raw title.

Prompt for AI agents
Check if this issue is valid — if so, understand the root cause and fix it. At packages/opencode/src/altimate/tool-label.ts, line 85:

<comment>When `list` targets the worktree root (no path argument or empty relative path), `fileTarget()` returns `undefined` and `asString(rawTitle)` also returns `undefined` (since `path.relative(worktree, worktree)` is `""`). The `??` fallback in `tool.ts` then yields the original empty-string title, producing a blank UI label. Consider producing a fallback like `"Listing ."` when a file tool has a verb but neither a usable target nor a non-empty raw title.</comment>

<file context>
@@ -0,0 +1,89 @@
+  const verb = FILE_TOOL_VERBS[tool]
+  if (verb && input && typeof input === "object") {
+    const target = fileTarget(tool, input as Record<string, unknown>)
+    if (target) return `${verb} ${target}`
+  }
+  // Non-file / rich-title tools: keep the title the tool already emitted.
</file context>

}
// Non-file / rich-title tools: keep the title the tool already emitted.
return fallback
}
Comment on lines +80 to +89
7 changes: 7 additions & 0 deletions packages/opencode/src/tool/tool.ts
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,9 @@ import { Truncate } from "./truncation"
// altimate_change start — telemetry instrumentation for tool execution
import { Telemetry } from "../altimate/telemetry"
// altimate_change end
// altimate_change start — humanize tool-call titles at the source
import { describeToolCall } from "../altimate/tool-label"
// altimate_change end

export namespace Tool {
interface Metadata {
Expand Down Expand Up @@ -121,6 +124,10 @@ export namespace Tool {
}
throw error
}
// altimate_change start — humanize the tool-call title at the source so any
// client (chat webview, TUI, ...) can render a readable label from state.title.
result = { ...result, title: describeToolCall(id, args, result.title) ?? result.title }
// altimate_change end
// Telemetry runs after execute() succeeds — wrapped so it never breaks the tool
try {
const isSoftFailure = result.metadata?.success === false
Expand Down
52 changes: 52 additions & 0 deletions packages/opencode/test/altimate/tool-label.test.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
import { describe, test, expect } from "bun:test"
import { describeToolCall } from "../../src/altimate/tool-label"

describe("describeToolCall", () => {
test("humanizes reads of a dbt model into 'Reading <name> model'", () => {
expect(describeToolCall("read", { filePath: "models/customers.sql" }, "models/customers.sql")).toBe(
"Reading customers model",
)
expect(
describeToolCall("read", { filePath: "models/staging/stg_customers.sql" }, "models/staging/stg_customers.sql"),
).toBe("Reading stg_customers model")
})

test("maps other dbt directories to their noun", () => {
expect(describeToolCall("edit", { filePath: "macros/cents_to_dollars.sql" }, "macros/cents_to_dollars.sql")).toBe(
"Editing cents_to_dollars macro",
)
expect(describeToolCall("write", { filePath: "analyses/rollup.sql" }, "analyses/rollup.sql")).toBe(
"Writing rollup analysis",
)
expect(describeToolCall("read", { filePath: "seeds/raw_customers.csv" }, "seeds/raw_customers.csv")).toBe(
"Reading raw_customers seed",
)
})

test("falls back to the filename for non-dbt paths (never a false 'model')", () => {
expect(describeToolCall("read", { filePath: "dbt_project.yml" }, "dbt_project.yml")).toBe("Reading dbt_project.yml")
expect(describeToolCall("read", { filePath: "src/index.ts" }, "src/index.ts")).toBe("Reading index.ts")
})

test("labels glob / grep / list by their target", () => {
expect(describeToolCall("glob", { pattern: "**/*.sql" }, "12 matches")).toBe("Searching **/*.sql")
expect(describeToolCall("grep", { pattern: "customer_id" }, "3 matches")).toBe("Searching customer_id")
expect(describeToolCall("list", { path: "models" }, "models/")).toBe("Listing models")
})

test("keeps the tool's own title for non-file / rich-title tools", () => {
expect(
describeToolCall("sql_analyze", { filePath: "models/customers.sql" }, "Analyze: 2 issues [high]"),
).toBe("Analyze: 2 issues [high]")
expect(describeToolCall("bash", { command: "dbt build" }, "Run full dbt build")).toBe("Run full dbt build")
// apply_patch carries a diff, not a path, so it keeps its own per-file title.
expect(describeToolCall("apply_patch", { patch: "*** Update File: models/x.sql" }, "# Patched x.sql")).toBe(
"# Patched x.sql",
)
})

test("falls back to the raw title when a file tool has no usable path", () => {
expect(describeToolCall("read", {}, "some title")).toBe("some title")
expect(describeToolCall("read", undefined, "some title")).toBe("some title")
})
})
7 changes: 5 additions & 2 deletions packages/opencode/test/tool/write.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -328,7 +328,7 @@ describe("tool.write", () => {
})

describe("title generation", () => {
test("returns relative path as title", async () => {
test("humanizes the title to a readable label", async () => {
await using tmp = await tmpdir()
const filepath = path.join(tmp.path, "src", "components", "Button.tsx")
await fs.mkdir(path.dirname(filepath), { recursive: true })
Expand All @@ -345,7 +345,10 @@ describe("tool.write", () => {
ctx,
)

expect(result.title).toEndWith(path.join("src", "components", "Button.tsx"))
// The execute() wrapper humanizes file-tool titles at the source
// (see src/altimate/tool-label.ts) — a non-dbt path degrades to the
// filename, so the title is a readable "Writing <file>" label.
Comment on lines +348 to +350
expect(result.title).toBe("Writing Button.tsx")
},
})
})
Expand Down
Loading