Skip to content

Commit 9337915

Browse files
committed
feat(tools): wire guarded writes into the diff-view save paths (S4b, #1375)
1 parent 0ccdb09 commit 9337915

14 files changed

Lines changed: 779 additions & 13 deletions

‎src/core/tools/ApplyDiffTool.ts‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -173,7 +173,8 @@ export class ApplyDiffTool extends BaseTool<"apply_diff"> {
173173
return
174174
}
175175

176-
// Save directly without showing diff view or opening the file
176+
// Save directly without showing diff view or opening the file. The diff is
177+
// applied to an existing file, so edit-guard semantics require a prior read.
177178
task.diffViewProvider.editType = "modify"
178179
task.diffViewProvider.originalContent = originalContent
179180
await task.diffViewProvider.saveDirectly(
@@ -182,6 +183,7 @@ export class ApplyDiffTool extends BaseTool<"apply_diff"> {
182183
false,
183184
diagnosticsEnabled,
184185
writeDelayMs,
186+
"edit",
185187
)
186188
} else {
187189
// Original behavior with diff view

‎src/core/tools/ApplyPatchTool.ts‎

Lines changed: 22 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -214,7 +214,16 @@ export class ApplyPatchTool extends BaseTool<"apply_patch"> {
214214

215215
// Save the changes
216216
if (isPreventFocusDisruptionEnabled) {
217-
await task.diffViewProvider.saveDirectly(relPath, newContent, true, diagnosticsEnabled, writeDelayMs)
217+
// Guarded publish: the patch supplies the complete new content, so create-guard
218+
// semantics apply (an unobserved existing target is rejected, not overwritten).
219+
await task.diffViewProvider.saveDirectly(
220+
relPath,
221+
newContent,
222+
true,
223+
diagnosticsEnabled,
224+
writeDelayMs,
225+
"create",
226+
)
218227
} else {
219228
await task.diffViewProvider.saveChanges(diagnosticsEnabled, writeDelayMs)
220229
}
@@ -408,12 +417,14 @@ export class ApplyPatchTool extends BaseTool<"apply_patch"> {
408417

409418
// Save new content to the new path
410419
if (isPreventFocusDisruptionEnabled) {
420+
// The move destination is published with the complete new content.
411421
await task.diffViewProvider.saveDirectly(
412422
change.movePath,
413423
newContent,
414424
false,
415425
diagnosticsEnabled,
416426
writeDelayMs,
427+
"create",
417428
)
418429
} else {
419430
// Write to new path and delete old file
@@ -433,7 +444,16 @@ export class ApplyPatchTool extends BaseTool<"apply_patch"> {
433444
} else {
434445
// Save changes to the same file
435446
if (isPreventFocusDisruptionEnabled) {
436-
await task.diffViewProvider.saveDirectly(relPath, newContent, false, diagnosticsEnabled, writeDelayMs)
447+
// Guarded publish: the patched file content is complete, so create-guard
448+
// semantics apply (stale observed versions are rejected with a re-read hint).
449+
await task.diffViewProvider.saveDirectly(
450+
relPath,
451+
newContent,
452+
false,
453+
diagnosticsEnabled,
454+
writeDelayMs,
455+
"create",
456+
)
437457
} else {
438458
await task.diffViewProvider.saveChanges(diagnosticsEnabled, writeDelayMs)
439459
}

‎src/core/tools/EditFileTool.ts‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -436,13 +436,16 @@ export class EditFileTool extends BaseTool<"edit_file"> {
436436

437437
// Save the changes
438438
if (isPreventFocusDisruptionEnabled) {
439-
// Direct file write without diff view or opening the file
439+
// Direct file write without diff view or opening the file. In-place edits
440+
// use edit-guard semantics (a prior read is required); new-file creation
441+
// keeps create-guard semantics.
440442
await task.diffViewProvider.saveDirectly(
441443
relPath,
442444
newContent,
443445
isNewFile,
444446
diagnosticsEnabled,
445447
writeDelayMs,
448+
isNewFile ? "create" : "edit",
446449
)
447450
} else {
448451
// Call saveChanges to update the DiffViewProvider properties

‎src/core/tools/EditTool.ts‎

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -211,8 +211,16 @@ export class EditTool extends BaseTool<"edit"> {
211211

212212
// Save the changes
213213
if (isPreventFocusDisruptionEnabled) {
214-
// Direct file write without diff view or opening the file
215-
await task.diffViewProvider.saveDirectly(relPath, newContent, false, diagnosticsEnabled, writeDelayMs)
214+
// Direct file write without diff view or opening the file. This tool only
215+
// edits existing files, so edit-guard semantics require a prior read.
216+
await task.diffViewProvider.saveDirectly(
217+
relPath,
218+
newContent,
219+
false,
220+
diagnosticsEnabled,
221+
writeDelayMs,
222+
"edit",
223+
)
216224
} else {
217225
// Call saveChanges to update the DiffViewProvider properties
218226
await task.diffViewProvider.saveChanges(diagnosticsEnabled, writeDelayMs)

‎src/core/tools/SearchReplaceTool.ts‎

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -207,8 +207,16 @@ export class SearchReplaceTool extends BaseTool<"search_replace"> {
207207

208208
// Save the changes
209209
if (isPreventFocusDisruptionEnabled) {
210-
// Direct file write without diff view or opening the file
211-
await task.diffViewProvider.saveDirectly(relPath, newContent, false, diagnosticsEnabled, writeDelayMs)
210+
// Direct file write without diff view or opening the file. This tool only
211+
// edits existing files, so edit-guard semantics require a prior read.
212+
await task.diffViewProvider.saveDirectly(
213+
relPath,
214+
newContent,
215+
false,
216+
diagnosticsEnabled,
217+
writeDelayMs,
218+
"edit",
219+
)
212220
} else {
213221
// Call saveChanges to update the DiffViewProvider properties
214222
await task.diffViewProvider.saveChanges(diagnosticsEnabled, writeDelayMs)

‎src/core/tools/WriteToFileTool.ts‎

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -133,7 +133,16 @@ export class WriteToFileTool extends BaseTool<"write_to_file"> {
133133
return
134134
}
135135

136-
await task.diffViewProvider.saveDirectly(relPath, newContent, false, diagnosticsEnabled, writeDelayMs)
136+
// Guarded publish: this write carries the complete file content, so it uses
137+
// create-guard semantics (unobserved targets may only be created when absent).
138+
await task.diffViewProvider.saveDirectly(
139+
relPath,
140+
newContent,
141+
false,
142+
diagnosticsEnabled,
143+
writeDelayMs,
144+
"create",
145+
)
137146
} else {
138147
if (!task.diffViewProvider.isEditing) {
139148
const partialMessage = JSON.stringify(sharedMessageProps)
Lines changed: 157 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,157 @@
1+
// npx vitest run core/tools/__tests__/applyDiffTool.guardedWrite.spec.ts
2+
3+
import type { MockedFunction } from "vitest"
4+
5+
import { fileExistsAtPath } from "../../../utils/fs"
6+
import type { Task } from "../../task/Task"
7+
import { ApplyDiffTool } from "../ApplyDiffTool"
8+
9+
vi.mock("fs/promises", () => ({
10+
default: {
11+
readFile: vi.fn().mockResolvedValue("original file content\n"),
12+
},
13+
}))
14+
15+
vi.mock("../../../utils/fs", () => ({
16+
fileExistsAtPath: vi.fn().mockResolvedValue(true),
17+
}))
18+
19+
vi.mock("../../prompts/responses", () => ({
20+
formatResponse: {
21+
toolError: vi.fn((msg: string) => `Error: ${msg}`),
22+
rooIgnoreError: vi.fn((filePath: string) => `Access denied: ${filePath}`),
23+
createPrettyPatch: vi.fn(() => "mock-diff"),
24+
},
25+
}))
26+
27+
vi.mock("../../diff/stats", () => ({
28+
sanitizeUnifiedDiff: vi.fn((diff: string) => diff),
29+
computeDiffStats: vi.fn(() => ({ additions: 1, deletions: 1 })),
30+
}))
31+
32+
describe("ApplyDiffTool.execute - guarded write (S4b, epic #1375)", () => {
33+
const mockedFileExistsAtPath = fileExistsAtPath as MockedFunction<typeof fileExistsAtPath>
34+
35+
let tool: ApplyDiffTool
36+
let mockTask: Pick<
37+
Task,
38+
| "cwd"
39+
| "consecutiveMistakeCount"
40+
| "consecutiveMistakeCountForApplyDiff"
41+
| "recordToolError"
42+
| "rooIgnoreController"
43+
| "rooProtectedController"
44+
| "say"
45+
| "processQueuedMessages"
46+
| "didEditFile"
47+
| "api"
48+
| "diffStrategy"
49+
| "diffViewProvider"
50+
| "providerRef"
51+
| "fileContextTracker"
52+
>
53+
let mockSaveDirectly: MockedFunction<(...args: unknown[]) => Promise<unknown>>
54+
let mockAskApproval: MockedFunction<(...args: unknown[]) => Promise<boolean>>
55+
let mockHandleError: MockedFunction<(...args: unknown[]) => Promise<void>>
56+
let mockPushToolResult: MockedFunction<(...args: unknown[]) => void>
57+
58+
beforeEach(() => {
59+
vi.clearAllMocks()
60+
61+
mockedFileExistsAtPath.mockResolvedValue(true)
62+
63+
mockSaveDirectly = vi.fn().mockResolvedValue({
64+
newProblemsMessage: "",
65+
userEdits: undefined,
66+
finalContent: "new content",
67+
})
68+
69+
// Structural stubs for the guarded-write path: the real DiffViewProvider is
70+
// out of scope here, so vi.fn() doubles stand in for the members the tool
71+
// touches (the saveDirectly double also records the writeKind plumbing).
72+
const diffViewProviderStub = {
73+
editType: undefined as "create" | "modify" | undefined,
74+
originalContent: undefined as string | undefined,
75+
saveDirectly: mockSaveDirectly,
76+
pushToolWriteResult: vi.fn().mockResolvedValue("Saved file"),
77+
reset: vi.fn().mockResolvedValue(undefined),
78+
}
79+
mockTask = {
80+
cwd: "/workspace/project",
81+
consecutiveMistakeCount: 0,
82+
consecutiveMistakeCountForApplyDiff: new Map(),
83+
recordToolError: vi.fn(),
84+
rooIgnoreController: {
85+
validateAccess: vi.fn().mockReturnValue(true),
86+
} as unknown as Task["rooIgnoreController"],
87+
rooProtectedController: {
88+
isWriteProtected: vi.fn().mockReturnValue(false),
89+
} as unknown as Task["rooProtectedController"],
90+
say: vi.fn().mockResolvedValue(undefined),
91+
processQueuedMessages: vi.fn(),
92+
didEditFile: false,
93+
api: {
94+
getModel: () => ({ id: "claude-sonnet-4-5" }),
95+
} as unknown as Task["api"],
96+
diffStrategy: {
97+
applyDiff: vi.fn().mockResolvedValue({ success: true, content: "modified file content\n" }),
98+
} as unknown as Task["diffStrategy"],
99+
diffViewProvider: diffViewProviderStub as unknown as Task["diffViewProvider"],
100+
providerRef: {
101+
deref: vi.fn().mockReturnValue({
102+
getState: vi.fn().mockResolvedValue({
103+
diagnosticsEnabled: true,
104+
writeDelayMs: 1000,
105+
// Exercise the focus-disruption (saveDirectly) save path.
106+
experiments: { preventFocusDisruption: true },
107+
}),
108+
}),
109+
} as unknown as Task["providerRef"],
110+
fileContextTracker: {
111+
trackFileContext: vi.fn().mockResolvedValue(undefined),
112+
} as unknown as Task["fileContextTracker"],
113+
}
114+
115+
mockAskApproval = vi.fn().mockResolvedValue(true)
116+
mockHandleError = vi.fn().mockResolvedValue(undefined)
117+
mockPushToolResult = vi.fn()
118+
119+
tool = new ApplyDiffTool()
120+
})
121+
122+
it("publishes through the guarded saveDirectly with edit kind", async () => {
123+
await tool.execute({ path: "src/thing.ts", diff: "unified diff" }, mockTask as Task, {
124+
askApproval: mockAskApproval,
125+
handleError: mockHandleError,
126+
pushToolResult: mockPushToolResult,
127+
})
128+
129+
expect(mockSaveDirectly).toHaveBeenCalledWith(
130+
"src/thing.ts",
131+
"modified file content\n",
132+
false,
133+
true,
134+
1000,
135+
"edit",
136+
)
137+
expect(mockPushToolResult).toHaveBeenCalledWith("Saved file")
138+
expect(mockTask.didEditFile).toBe(true)
139+
expect(mockHandleError).not.toHaveBeenCalled()
140+
})
141+
142+
it("surfaces the unobserved edit remediation as a tool error", async () => {
143+
const guardError = new Error("File not read yet -- read the file, then retry.")
144+
mockSaveDirectly.mockRejectedValue(guardError)
145+
146+
await tool.execute({ path: "src/thing.ts", diff: "unified diff" }, mockTask as Task, {
147+
askApproval: mockAskApproval,
148+
handleError: mockHandleError,
149+
pushToolResult: mockPushToolResult,
150+
})
151+
152+
expect(mockHandleError).toHaveBeenCalledWith("applying diff", guardError)
153+
expect(vi.mocked(mockTask.diffViewProvider.reset)).toHaveBeenCalled()
154+
expect(mockTask.didEditFile).toBe(false)
155+
expect(mockPushToolResult).not.toHaveBeenCalledWith("Saved file")
156+
})
157+
})

0 commit comments

Comments
 (0)