Skip to content

feat: enhance diff streaming and content insertion #3055

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
wants to merge 4 commits into from
Closed

feat: enhance diff streaming and content insertion #3055

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
030ac28
feat: enhance insert_content with streaming and error handling
Apr 30, 2025
32aeeb2
feat: improve diff streaming and UI responsiveness
Apr 30, 2025
8d4877b
feat: enhance insert content tool error handling
Apr 30, 2025
01b9399
fix: improve insert content feedback and line handling
Apr 30, 2025
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
1 change: 1 addition & 0 deletions src/core/task/Task.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -165,6 +165,7 @@ export class Task extends EventEmitter<ClineEvents> {
consecutiveMistakeCount: number = 0
consecutiveMistakeLimit: number
consecutiveMistakeCountForApplyDiff: Map<string, number> = new Map()
consecutiveMistakeCountForInsertContent: Map<string, number> = new Map()
toolUsage: ToolUsage = {}

// Checkpoints
Expand Down
259 changes: 153 additions & 106 deletions src/core/tools/applyDiffTool.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,20 @@ import { addLineNumbers } from "../../integrations/misc/extract-text"
import { RecordSource } from "../context-tracking/FileContextTrackerTypes"
import { telemetryService } from "../../services/telemetry/TelemetryService"
import { unescapeHtmlEntities } from "../../utils/text-normalization"
import { inspect } from "util"

// Find the last complete REPLACE marker
function processDiffForStreaming(diffContent: string): string {
const lastReplaceIndex = diffContent.lastIndexOf(">>>>>>> REPLACE")
if (lastReplaceIndex === -1) {
// No complete sections yet
return ""
}

// Only include content up to and including the last REPLACE marker
diffContent = diffContent.substring(0, lastReplaceIndex + ">>>>>>> REPLACE".length)
return diffContent
}

export async function applyDiffTool(
cline: Task,
Expand All @@ -35,24 +49,39 @@ export async function applyDiffTool(
}

try {
// 2. Handle ongoing streaming updates
if (block.partial) {
// Update GUI message
let toolProgressStatus

if (cline.diffStrategy && cline.diffStrategy.getProgressStatus) {
if (cline.diffStrategy?.getProgressStatus) {
toolProgressStatus = cline.diffStrategy.getProgressStatus(block)
if (toolProgressStatus && Object.keys(toolProgressStatus).length === 0) {
return
}
}

if (toolProgressStatus && Object.keys(toolProgressStatus).length === 0) {
if (!relPath || !(await fileExistsAtPath(path.resolve(cline.cwd, relPath)))) {
return
}

await cline
.ask("tool", JSON.stringify(sharedMessageProps), block.partial, toolProgressStatus)
.catch(() => {})

return
if (diffContent) {
const processedContent = processDiffForStreaming(diffContent)
if (!processedContent) {
return
}
diffContent = processedContent

await cline
.ask(
"tool",
JSON.stringify({ ...sharedMessageProps, diff: diffContent }),
block.partial,
toolProgressStatus,
)
.catch(() => {})
}
} else {
// 3. For completed model output, all parameters must be valid
// Unlike streaming mode, we report errors since the model output is complete
if (!relPath) {
cline.consecutiveMistakeCount++
cline.recordToolError("apply_diff")
Expand Down Expand Up @@ -86,134 +115,152 @@ export async function applyDiffTool(
pushToolResult(formattedError)
return
}
}

const originalContent = await fs.readFile(absolutePath, "utf-8")
// 4. Apply diff to file content (shared path)
const absolutePath = path.resolve(cline.cwd, relPath)
const originalContent = await fs.readFile(absolutePath, "utf-8")

const diffResult = (await cline.diffStrategy?.applyDiff(
originalContent,
diffContent!, // Safe to assert here since we validated above
parseInt(block.params.start_line ?? ""),
)) ?? {
success: false,
error: "No diff strategy available",
}

// Apply the diff to the original content
const diffResult = (await cline.diffStrategy?.applyDiff(
originalContent,
diffContent,
parseInt(block.params.start_line ?? ""),
)) ?? {
success: false,
error: "No diff strategy available",
}
console.debug("diffResult", inspect(diffResult, { depth: 5 }))
let partErrors = ""

if (!diffResult.success) {
cline.consecutiveMistakeCount++
const currentCount = (cline.consecutiveMistakeCountForApplyDiff.get(relPath) || 0) + 1
cline.consecutiveMistakeCountForApplyDiff.set(relPath, currentCount)
let formattedError = ""
telemetryService.captureDiffApplicationError(cline.taskId, currentCount)

if (diffResult.failParts && diffResult.failParts.length > 0) {
for (const failPart of diffResult.failParts) {
if (failPart.success) {
continue
}

const errorDetails = failPart.details ? JSON.stringify(failPart.details, null, 2) : ""

formattedError = `<error_details>\n${
failPart.error
}${errorDetails ? `\n\nDetails:\n${errorDetails}` : ""}\n</error_details>`
// 5. Handle diff application failures
// During streaming, silently ignore failures since content may be incomplete
if (block.partial && !diffResult.success) {
return
} else if (!diffResult.success) {
cline.consecutiveMistakeCount++
const currentCount = (cline.consecutiveMistakeCountForApplyDiff.get(relPath) || 0) + 1
cline.consecutiveMistakeCountForApplyDiff.set(relPath, currentCount)
let formattedError = ""
telemetryService.captureDiffApplicationError(cline.taskId, currentCount)

if (diffResult.failParts && diffResult.failParts.length > 0) {
for (const failPart of diffResult.failParts) {
if (failPart.success) {
continue
}
} else {
const errorDetails = diffResult.details ? JSON.stringify(diffResult.details, null, 2) : ""

formattedError = `Unable to apply diff to file: ${absolutePath}\n\n<error_details>\n${
diffResult.error
const errorDetails = failPart.details ? JSON.stringify(failPart.details, null, 2) : ""

formattedError = `<error_details>\n${
failPart.error
}${errorDetails ? `\n\nDetails:\n${errorDetails}` : ""}\n</error_details>`
}

if (currentCount >= 2) {
await cline.say("diff_error", formattedError)
partErrors += formattedError
}
} else {
const errorDetails = diffResult.details ? JSON.stringify(diffResult.details, null, 2) : ""

cline.recordToolError("apply_diff", formattedError)
formattedError = `Unable to apply diff to file: ${absolutePath}\n\n<error_details>\n${
diffResult.error
}${errorDetails ? `\n\nDetails:\n${errorDetails}` : ""}\n</error_details>`
}

pushToolResult(formattedError)
return
if (currentCount >= 2) {
await cline.say("diff_error", formattedError)
}

cline.consecutiveMistakeCount = 0
cline.consecutiveMistakeCountForApplyDiff.delete(relPath)
cline.recordToolError("apply_diff", formattedError)

pushToolResult(formattedError)
return
}

// 6. Update UI with successful diff (common path)
cline.consecutiveMistakeCount = 0
cline.consecutiveMistakeCountForApplyDiff.delete(relPath)

// Show diff view before asking for approval
cline.diffViewProvider.editType = "modify"
// Show diff view before asking for approval
cline.diffViewProvider.editType = "modify"
if (cline.diffViewProvider.isEditing) {
await cline.diffViewProvider.update(diffResult.content, true, false)
} else {
await cline.diffViewProvider.open(relPath)
await cline.diffViewProvider.update(diffResult.content, true)
await cline.diffViewProvider.scrollToFirstDiff()
}

const completeMessage = JSON.stringify({
...sharedMessageProps,
diff: diffContent,
} satisfies ClineSayTool)
// 7. For streaming updates, show preview without asking for confirmation
if (block.partial) return
const completeMessage = JSON.stringify({
...sharedMessageProps,
diff: diffContent,
} satisfies ClineSayTool)

let toolProgressStatus
// 8. For completed output, get user approval and finalize changes
let toolProgressStatus

if (cline.diffStrategy && cline.diffStrategy.getProgressStatus) {
toolProgressStatus = cline.diffStrategy.getProgressStatus(block, diffResult)
}
if (cline.diffStrategy?.getProgressStatus) {
toolProgressStatus = cline.diffStrategy.getProgressStatus(block, diffResult)
}

const didApprove = await askApproval("tool", completeMessage, toolProgressStatus)
const didApprove = await askApproval("tool", completeMessage, toolProgressStatus)

if (!didApprove) {
await cline.diffViewProvider.revertChanges() // Cline likely handles closing the diff view
return
}
if (!didApprove) {
await cline.diffViewProvider.revertChanges()
return
}

const { newProblemsMessage, userEdits, finalContent } = await cline.diffViewProvider.saveChanges()
// 9. Save approved changes and provide feedback
const { newProblemsMessage, userEdits, finalContent } = await cline.diffViewProvider.saveChanges()

// Track file edit operation
if (relPath) {
await cline.fileContextTracker.trackFileContext(relPath, "roo_edited" as RecordSource)
}
// Track file edit operation
if (relPath) {
await cline.fileContextTracker.trackFileContext(relPath, "roo_edited" as RecordSource)
}

// Used to determine if we should wait for busy terminal to update before sending api request
cline.didEditFile = true
let partFailHint = ""
cline.didEditFile = true
let partFailHint = ""

if (diffResult.failParts && diffResult.failParts.length > 0) {
partFailHint = `But unable to apply all diff parts to file: ${absolutePath}, silently use <read_file> tool to check newest file version and re-apply diffs\n`
}
if (diffResult.failParts && diffResult.failParts.length > 0) {
partFailHint = `But unable to apply all diff parts to file: ${absolutePath}, silently use <read_file> tool to check newest file version and re-apply diffs\n`
}

if (userEdits) {
await cline.say(
"user_feedback_diff",
JSON.stringify({
tool: fileExists ? "editedExistingFile" : "newFileCreated",
path: getReadablePath(cline.cwd, relPath),
diff: userEdits,
} satisfies ClineSayTool),
)

pushToolResult(
`The user made the following updates to your content:\n\n${userEdits}\n\n` +
partFailHint +
`The updated content, which includes both your original modifications and the user's edits, has been successfully saved to ${relPath.toPosix()}. Here is the full, updated content of the file, including line numbers:\n\n` +
`<final_file_content path="${relPath.toPosix()}">\n${addLineNumbers(
finalContent || "",
)}\n</final_file_content>\n\n` +
`Please note:\n` +
`1. You do not need to re-write the file with these changes, as they have already been applied.\n` +
`2. Proceed with the task using this updated file content as the new baseline.\n` +
`3. If the user's edits have addressed part of the task or changed the requirements, adjust your approach accordingly.` +
`${newProblemsMessage}`,
)
} else {
pushToolResult(
`Changes successfully applied to ${relPath.toPosix()}:\n\n${newProblemsMessage}\n` + partFailHint,
)
}
if (userEdits) {
const fileExists = await fileExistsAtPath(path.resolve(cline.cwd, relPath))

await cline.diffViewProvider.reset()
await cline.say(
"user_feedback_diff",
JSON.stringify({
tool: fileExists ? "editedExistingFile" : "newFileCreated",
path: getReadablePath(cline.cwd, relPath),
diff: userEdits,
} satisfies ClineSayTool),
)

return
pushToolResult(
(partErrors ? `Partial errors encountered:\n${partErrors}\n\n` : "") +
`The user made the following updates to your content:\n\n${userEdits}\n\n` +
partFailHint +
`The updated content, which includes both your original modifications and the user's edits, has been successfully saved to ${relPath.toPosix()}. Here is the full, updated content of the file, including line numbers:\n\n` +
`<final_file_content path="${relPath.toPosix()}">\n${addLineNumbers(
finalContent || "",
)}\n</final_file_content>\n\n` +
`Please note:\n` +
`1. You do not need to re-write the file with these changes, as they have already been applied.\n` +
`2. Proceed with the task using this updated file content as the new baseline.\n` +
`3. If the user's edits have addressed part of the task or changed the requirements, adjust your approach accordingly.` +
`${newProblemsMessage}`,
)
} else {
pushToolResult(
`Changes successfully applied to ${relPath.toPosix()}:\n\n${newProblemsMessage}\n` + partFailHint,
)
}

await cline.diffViewProvider.reset()
} catch (error) {
await handleError("applying diff", error)
await cline.diffViewProvider.reset()
return
}
}
Loading