Skip to content

Commit 224690b

Browse files
committed
fix(write-to-file): clean partial state on task abort
1 parent be0e154 commit 224690b

2 files changed

Lines changed: 87 additions & 30 deletions

File tree

‎src/core/tools/WriteToFileTool.ts‎

Lines changed: 28 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ import path from "path"
22
import delay from "delay"
33
import fs from "fs/promises"
44

5-
import { type ClineSayTool, DEFAULT_WRITE_DELAY_MS } from "@roo-code/types"
5+
import { type ClineSayTool, DEFAULT_WRITE_DELAY_MS, RooCodeEventName } from "@roo-code/types"
66

77
import { Task } from "../task/Task"
88
import { formatResponse } from "../prompts/responses"
@@ -39,11 +39,29 @@ export class WriteToFileTool extends BaseTool<"write_to_file"> {
3939
*/
4040
private lastSeenPartialPathByTaskId = new Map<string, string | undefined>()
4141

42+
/**
43+
* Tracks abort cleanup listeners for per-task partial state so normal execute()
44+
* finalization can unregister them and abandoned streams are torn down on abort.
45+
*/
46+
private partialStateAbortCleanupByTaskId = new Map<string, { task: Task; cleanup: () => void }>()
47+
4248
private getPartialStreamFailureKey(task: Task): string {
4349
return `${task.taskId}.${task.instanceId}`
4450
}
4551

52+
private registerTaskPartialStateCleanup(task: Task): void {
53+
const key = this.getPartialStreamFailureKey(task)
54+
if (this.partialStateAbortCleanupByTaskId.has(key)) {
55+
return
56+
}
57+
58+
const cleanup = () => this.resetTaskPartialState(task)
59+
this.partialStateAbortCleanupByTaskId.set(key, { task, cleanup })
60+
task.once(RooCodeEventName.TaskAborted, cleanup)
61+
}
62+
4663
private hasPathStabilizedForTask(task: Task, partialPath: string | undefined): boolean {
64+
this.registerTaskPartialStateCleanup(task)
4765
const key = this.getPartialStreamFailureKey(task)
4866
const lastSeenPath = this.lastSeenPartialPathByTaskId.get(key)
4967
const pathHasStabilized = lastSeenPath !== undefined && lastSeenPath === partialPath
@@ -53,6 +71,11 @@ export class WriteToFileTool extends BaseTool<"write_to_file"> {
5371

5472
private resetTaskPartialState(task: Task): void {
5573
const key = this.getPartialStreamFailureKey(task)
74+
const abortCleanup = this.partialStateAbortCleanupByTaskId.get(key)
75+
if (abortCleanup) {
76+
task.off(RooCodeEventName.TaskAborted, abortCleanup.cleanup)
77+
this.partialStateAbortCleanupByTaskId.delete(key)
78+
}
5679
this.lastSeenPartialPathByTaskId.delete(key)
5780
this.partialStreamFailuresByTaskId.delete(key)
5881
}
@@ -71,8 +94,12 @@ export class WriteToFileTool extends BaseTool<"write_to_file"> {
7194

7295
override resetPartialState(): void {
7396
super.resetPartialState()
97+
for (const { task, cleanup } of this.partialStateAbortCleanupByTaskId.values()) {
98+
task.off(RooCodeEventName.TaskAborted, cleanup)
99+
}
74100
this.partialStreamFailuresByTaskId.clear()
75101
this.lastSeenPartialPathByTaskId.clear()
102+
this.partialStateAbortCleanupByTaskId.clear()
76103
}
77104

78105
async execute(params: WriteToFileParams, task: Task, callbacks: ToolCallbacks): Promise<void> {

‎src/core/tools/__tests__/writeToFileTool.spec.ts‎

Lines changed: 59 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
import * as path from "path"
22

3+
import { RooCodeEventName } from "@roo-code/types"
34
import type { MockedFunction } from "vitest"
45

56
import { fileExistsAtPath, createDirectoriesForFile } from "../../../utils/fs"
@@ -188,6 +189,8 @@ describe("writeToFileTool", () => {
188189
}
189190
mockCline.say = vi.fn().mockResolvedValue(undefined)
190191
mockCline.ask = vi.fn().mockResolvedValue(undefined)
192+
mockCline.once = vi.fn()
193+
mockCline.off = vi.fn()
191194
mockCline.finalizePartialToolAsk = vi.fn().mockResolvedValue(undefined)
192195
mockCline.recordToolError = vi.fn()
193196
mockCline.sayAndCreateMissingParamError = vi.fn().mockResolvedValue("Missing param error")
@@ -457,6 +460,29 @@ describe("writeToFileTool", () => {
457460
await executeWriteFileTool({}, { fileExists: false, isPartial: true })
458461
expect(mockCline.ask).toHaveBeenCalledTimes(2)
459462
})
463+
464+
it("cleans per-task partial state when the task aborts before execute finalization", async () => {
465+
let abortCleanup: (() => void) | undefined
466+
mockCline.once.mockImplementation((event: RooCodeEventName, listener: () => void) => {
467+
if (event === RooCodeEventName.TaskAborted) {
468+
abortCleanup = listener
469+
}
470+
return mockCline
471+
})
472+
473+
await executeWriteFileTool({}, { fileExists: false, isPartial: true })
474+
await executeWriteFileTool({}, { fileExists: false, isPartial: true })
475+
expect(mockCline.ask).toHaveBeenCalledTimes(1)
476+
expect(mockCline.once).toHaveBeenCalledWith(RooCodeEventName.TaskAborted, expect.any(Function))
477+
478+
abortCleanup?.()
479+
480+
await executeWriteFileTool({}, { fileExists: false, isPartial: true })
481+
expect(mockCline.ask).toHaveBeenCalledTimes(1)
482+
483+
await executeWriteFileTool({}, { fileExists: false, isPartial: true })
484+
expect(mockCline.ask).toHaveBeenCalledTimes(2)
485+
})
460486
})
461487

462488
describe("user interaction", () => {
@@ -612,22 +638,24 @@ describe("writeToFileTool", () => {
612638

613639
it("continues execute error cleanup when finalizing partial ask fails", async () => {
614640
const consoleErrorSpy = vi.spyOn(console, "error").mockImplementation(() => {})
615-
mockedCreateDirectoriesForFile.mockRejectedValue(
616-
Object.assign(new Error("EACCES: permission denied, mkdir '/ro'"), { code: "EACCES" }),
617-
)
618-
mockCline.finalizePartialToolAsk.mockRejectedValue(new Error("finalize failed"))
619-
620-
await executeWriteFileTool({}, { fileExists: false })
641+
try {
642+
mockedCreateDirectoriesForFile.mockRejectedValue(
643+
Object.assign(new Error("EACCES: permission denied, mkdir '/ro'"), { code: "EACCES" }),
644+
)
645+
mockCline.finalizePartialToolAsk.mockRejectedValue(new Error("finalize failed"))
621646

622-
expect(mockCline.finalizePartialToolAsk).toHaveBeenCalled()
623-
expect(mockHandleError).toHaveBeenCalledWith("writing file", expect.any(Error))
624-
expect(mockCline.diffViewProvider.reset).toHaveBeenCalled()
625-
expect(consoleErrorSpy).toHaveBeenCalledWith(
626-
"Error finalizing write_to_file partial tool ask:",
627-
expect.any(Error),
628-
)
647+
await executeWriteFileTool({}, { fileExists: false })
629648

630-
consoleErrorSpy.mockRestore()
649+
expect(mockCline.finalizePartialToolAsk).toHaveBeenCalled()
650+
expect(mockHandleError).toHaveBeenCalledWith("writing file", expect.any(Error))
651+
expect(mockCline.diffViewProvider.reset).toHaveBeenCalled()
652+
expect(consoleErrorSpy).toHaveBeenCalledWith(
653+
"Error finalizing write_to_file partial tool ask:",
654+
expect.any(Error),
655+
)
656+
} finally {
657+
consoleErrorSpy.mockRestore()
658+
}
631659
})
632660

633661
it("keeps partial stream failures isolated per task", async () => {
@@ -674,23 +702,25 @@ describe("writeToFileTool", () => {
674702

675703
it("continues partial failure cleanup when finalizing partial ask fails", async () => {
676704
const consoleErrorSpy = vi.spyOn(console, "error").mockImplementation(() => {})
677-
mockCline.diffViewProvider.open.mockRejectedValue(
678-
Object.assign(new Error("EROFS: read-only file system, mkdir '/scratch'"), { code: "EROFS" }),
679-
)
680-
mockCline.finalizePartialToolAsk.mockRejectedValue(new Error("finalize failed"))
681-
682-
await executeWriteFileTool({}, { fileExists: false, isPartial: true })
683-
await executeWriteFileTool({}, { fileExists: false, isPartial: true })
705+
try {
706+
mockCline.diffViewProvider.open.mockRejectedValue(
707+
Object.assign(new Error("EROFS: read-only file system, mkdir '/scratch'"), { code: "EROFS" }),
708+
)
709+
mockCline.finalizePartialToolAsk.mockRejectedValue(new Error("finalize failed"))
684710

685-
expect(mockCline.finalizePartialToolAsk).toHaveBeenCalled()
686-
expect(mockCline.diffViewProvider.reset).toHaveBeenCalled()
687-
expect(mockHandleError).not.toHaveBeenCalled()
688-
expect(consoleErrorSpy).toHaveBeenCalledWith(
689-
"Error finalizing write_to_file partial tool ask:",
690-
expect.any(Error),
691-
)
711+
await executeWriteFileTool({}, { fileExists: false, isPartial: true })
712+
await executeWriteFileTool({}, { fileExists: false, isPartial: true })
692713

693-
consoleErrorSpy.mockRestore()
714+
expect(mockCline.finalizePartialToolAsk).toHaveBeenCalled()
715+
expect(mockCline.diffViewProvider.reset).toHaveBeenCalled()
716+
expect(mockHandleError).not.toHaveBeenCalled()
717+
expect(consoleErrorSpy).toHaveBeenCalledWith(
718+
"Error finalizing write_to_file partial tool ask:",
719+
expect.any(Error),
720+
)
721+
} finally {
722+
consoleErrorSpy.mockRestore()
723+
}
694724
})
695725

696726
it.skipIf(process.platform === "win32")(

0 commit comments

Comments
 (0)