luna/oh-my-opencode
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

fix(hashline-edit): stabilize TUI diff metadata and output flow

Browse Source 
Align edit/write hashline handling with TUI expectations by preserving metadata through tool execution, keeping unified diff raw to avoid duplicated line numbers, and tightening read/write/edit outputs plus tests for reliable agent operation.
This commit is contained in:
YeonGyu-Kim
2026-02-19 17:09:46 +09:00
parent 52029a0d42
commit 6869a2c0b5
7 changed files with 443 additions and 167 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/tools/hashline-edit/tools.test.ts
+197 -22
View File
@@ -1,10 +1,36 @@
import { describe, it, expect, beforeEach, afterEach } from "bun:test"
import { describe, it, expect, beforeEach, afterEach, mock } from "bun:test"
import type { ToolContext } from "@opencode-ai/plugin/tool"
import { consumeToolMetadata, clearPendingStore } from "../../features/tool-metadata-store"
import { createHashlineEditTool } from "./tools"
import * as fs from "node:fs"
import * as path from "node:path"
import * as os from "node:os"
import { computeLineHash } from "./hash-computation"
type MetadataPayload = {
title?: string
metadata?: Record<string, unknown>
}
function createMockContext(overrides?: Partial<Pick<ToolContext, "metadata">>): ToolContext {
return {
sessionID: "test",
messageID: "test",
agent: "test",
directory: "/tmp",
worktree: "/tmp",
abort: new AbortController().signal,
metadata: overrides?.metadata ?? mock(() => {}),
ask: async () => {},
}
}
type ToolContextWithCallID = ToolContext & {
callID?: string
callId?: string
call_id?: string
}
describe("createHashlineEditTool", () => {
let tempDir: string
let tool: ReturnType<typeof createHashlineEditTool>
@@ -16,6 +42,7 @@ describe("createHashlineEditTool", () => {
afterEach(() => {
fs.rmSync(tempDir, { recursive: true, force: true })
clearPendingStore()
})
describe("tool definition", () => {
@@ -30,11 +57,11 @@ describe("createHashlineEditTool", () => {
expect(tool.description).toContain("replace")
})
it("has path parameter", () => {
it("has filePath parameter", () => {
//#given tool is created
//#when checking parameters
//#then path parameter exists as required string
expect(tool.args.path).toBeDefined()
//#then filePath exists
expect(tool.args.filePath).toBeDefined()
})
it("has edits parameter as array", () => {
@@ -53,10 +80,10 @@ describe("createHashlineEditTool", () => {
//#when executing tool
const result = await tool.execute(
{
path: nonExistentPath,
filePath: nonExistentPath,
edits: [{ type: "set_line", line: "1:00", text: "new content" }],
},
{ sessionID: "test", messageID: "test", agent: "test", abort: new AbortController() }
createMockContext()
)
//#then error is returned
@@ -73,10 +100,10 @@ describe("createHashlineEditTool", () => {
//#when executing set_line edit
const result = await tool.execute(
{
path: filePath,
filePath,
edits: [{ type: "set_line", line: `2:${line2Hash}`, text: "modified line2" }],
},
{ sessionID: "test", messageID: "test", agent: "test", abort: new AbortController() }
createMockContext()
)
//#then file is modified and diff is returned
@@ -94,10 +121,10 @@ describe("createHashlineEditTool", () => {
//#when executing insert_after edit
const result = await tool.execute(
{
path: filePath,
filePath,
edits: [{ type: "insert_after", line: `1:${line1Hash}`, text: "inserted" }],
},
{ sessionID: "test", messageID: "test", agent: "test", abort: new AbortController() }
createMockContext()
)
//#then line is inserted after specified line
@@ -115,7 +142,7 @@ describe("createHashlineEditTool", () => {
//#when executing replace_lines edit
const result = await tool.execute(
{
path: filePath,
filePath,
edits: [
{
type: "replace_lines",
@@ -125,7 +152,7 @@ describe("createHashlineEditTool", () => {
},
],
},
{ sessionID: "test", messageID: "test", agent: "test", abort: new AbortController() }
createMockContext()
)
//#then lines are replaced
@@ -141,10 +168,10 @@ describe("createHashlineEditTool", () => {
//#when executing replace edit
const result = await tool.execute(
{
path: filePath,
filePath,
edits: [{ type: "replace", old_text: "world", new_text: "universe" }],
},
{ sessionID: "test", messageID: "test", agent: "test", abort: new AbortController() }
createMockContext()
)
//#then text is replaced
@@ -162,13 +189,13 @@ describe("createHashlineEditTool", () => {
//#when executing multiple edits
const result = await tool.execute(
{
path: filePath,
filePath,
edits: [
{ type: "set_line", line: `1:${line1Hash}`, text: "new1" },
{ type: "set_line", line: `3:${line3Hash}`, text: "new3" },
],
},
{ sessionID: "test", messageID: "test", agent: "test", abort: new AbortController() }
createMockContext()
)
//#then both edits are applied
@@ -184,10 +211,10 @@ describe("createHashlineEditTool", () => {
//#when executing with wrong hash (valid format but wrong value)
const result = await tool.execute(
{
path: filePath,
filePath,
edits: [{ type: "set_line", line: "1:ff", text: "new" }],
},
{ sessionID: "test", messageID: "test", agent: "test", abort: new AbortController() }
createMockContext()
)
//#then hash mismatch error is returned
@@ -204,10 +231,10 @@ describe("createHashlineEditTool", () => {
//#when executing with escaped newline
const result = await tool.execute(
{
path: filePath,
filePath,
edits: [{ type: "set_line", line: `1:${line1Hash}`, text: "new\\nline" }],
},
{ sessionID: "test", messageID: "test", agent: "test", abort: new AbortController() }
createMockContext()
)
//#then newline is unescaped
@@ -224,16 +251,164 @@ describe("createHashlineEditTool", () => {
//#when executing edit
const result = await tool.execute(
{
path: filePath,
filePath,
edits: [{ type: "set_line", line: `1:${line1Hash}`, text: "new content" }],
},
{ sessionID: "test", messageID: "test", agent: "test", abort: new AbortController() }
createMockContext()
)
//#then result contains success indicator and diff
expect(result).toContain("Successfully")
expect(result).toContain("old content")
expect(result).toContain("new content")
expect(result).toContain("Updated file (LINE:HASH|content)")
expect(result).toMatch(/1:[a-f0-9]{2}\|new content/)
})
})
describe("context.metadata for TUI diff", () => {
it("calls context.metadata with diff and filediff on successful edit", async () => {
//#given file with content and mock context
const filePath = path.join(tempDir, "test.txt")
fs.writeFileSync(filePath, "line1\nline2\nline3")
const line2Hash = computeLineHash(2, "line2")
const metadataMock = mock((_: MetadataPayload) => {})
const ctx = createMockContext({ metadata: metadataMock })
//#when executing a successful edit
await tool.execute(
{
filePath,
edits: [{ type: "set_line", line: `2:${line2Hash}`, text: "modified" }],
},
ctx
)
//#then context.metadata is called with diff string and filediff object
expect(metadataMock).toHaveBeenCalledTimes(1)
const call = metadataMock.mock.calls[0]?.[0]
expect(call).toBeDefined()
if (!call || !call.metadata) {
throw new Error("metadata payload missing")
}
expect(call.title).toBe(filePath)
expect(call.metadata.filePath).toBe(filePath)
expect(call.metadata.path).toBe(filePath)
expect(call.metadata.file).toBe(filePath)
expect(call.metadata.diff).toContain("---")
expect(call.metadata.diff).toContain("+++")
expect(call.metadata.diff).toContain("-line2")
expect(call.metadata.diff).toContain("+modified")
expect(call.metadata.filediff.file).toBe(filePath)
expect(call.metadata.filediff.path).toBe(filePath)
expect(call.metadata.filediff.filePath).toBe(filePath)
expect(typeof call.metadata.filediff.before).toBe("string")
expect(typeof call.metadata.filediff.after).toBe("string")
expect(typeof call.metadata.filediff.additions).toBe("number")
expect(typeof call.metadata.filediff.deletions).toBe("number")
})
it("includes hashline content in filediff before/after", async () => {
//#given file with known content
const filePath = path.join(tempDir, "test.txt")
fs.writeFileSync(filePath, "hello\nworld")
const line1Hash = computeLineHash(1, "hello")
const metadataMock = mock((_: MetadataPayload) => {})
const ctx = createMockContext({ metadata: metadataMock })
//#when executing edit
await tool.execute(
{
filePath,
edits: [{ type: "set_line", line: `1:${line1Hash}`, text: "hi" }],
},
ctx
)
//#then filediff.before contains hashline format of original content
const call = metadataMock.mock.calls[0]?.[0]
expect(call).toBeDefined()
if (!call || !call.metadata) {
throw new Error("metadata payload missing")
}
expect(call.metadata.filediff.before).toContain("1:")
expect(call.metadata.filediff.before).toContain("|hello")
expect(call.metadata.filediff.after).toContain("1:")
expect(call.metadata.filediff.after).toContain("|hi")
})
it("reports correct additions and deletions count", async () => {
//#given file with content
const filePath = path.join(tempDir, "test.txt")
fs.writeFileSync(filePath, "aaa\nbbb\nccc")
const metadataMock = mock((_: MetadataPayload) => {})
const ctx = createMockContext({ metadata: metadataMock })
//#when replacing text that changes one line
await tool.execute(
{
filePath,
edits: [{ type: "replace", old_text: "bbb", new_text: "xxx" }],
},
ctx
)
//#then additions and deletions are both 1
const call = metadataMock.mock.calls[0]?.[0]
expect(call).toBeDefined()
if (!call || !call.metadata) {
throw new Error("metadata payload missing")
}
expect(call.metadata.filediff.additions).toBe(1)
expect(call.metadata.filediff.deletions).toBe(1)
})
it("does not call context.metadata on error", async () => {
//#given non-existent file
const nonExistentPath = path.join(tempDir, "nope.txt")
const metadataMock = mock(() => {})
const ctx = createMockContext({ metadata: metadataMock })
//#when executing tool on missing file
await tool.execute(
{
filePath: nonExistentPath,
edits: [{ type: "set_line", line: "1:00", text: "new" }],
},
ctx
)
//#then context.metadata is never called
expect(metadataMock).not.toHaveBeenCalled()
})
it("stores metadata for tool.execute.after restoration when callID exists", async () => {
//#given file and context with callID
const filePath = path.join(tempDir, "test.txt")
fs.writeFileSync(filePath, "line1\nline2")
const line2Hash = computeLineHash(2, "line2")
const metadataMock = mock((_: MetadataPayload) => {})
const ctx: ToolContextWithCallID = {
...createMockContext({ metadata: metadataMock }),
callID: "call-edit-meta-1",
}
//#when executing edit
await tool.execute(
{
filePath,
edits: [{ type: "set_line", line: `2:${line2Hash}`, text: "modified" }],
},
ctx,
)
//#then pending metadata store has restorable metadata
const restored = consumeToolMetadata(ctx.sessionID, "call-edit-meta-1")
expect(restored).toBeDefined()
expect(restored?.title).toBe(filePath)
expect(typeof restored?.metadata?.diff).toBe("string")
expect(restored?.metadata?.filediff).toBeDefined()
})
})
})