Skip to content

Fix file revert on abort #949

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

Merged
cte merged 2 commits into from
Feb 11, 2025
Merged

Fix file revert on abort #949

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
901adc5
Fix file revert on abort
cte Feb 11, 2025
6119cb1
Update comment
cte Feb 11, 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
22 changes: 17 additions & 5 deletions src/core/Cline.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -732,13 +732,18 @@ export class Cline {
}

async abortTask() {
Copy link
Contributor

@ellipsis-dev ellipsis-dev bot Feb 11, 2025

Choose a reason for hiding this comment

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

Given the fix for file revert on abort, please add (or update) unit/integration tests covering this abort behavior to ensure regressions are caught.

this.abort = true // Will stop any autonomously running promises.
// Will stop any autonomously running promises.
this.abort = true

this.terminalManager.disposeAll()
this.urlContentFetcher.closeBrowser()
this.browserSession.closeBrowser()
// Need to await for when we want to make sure directories/files are
// reverted before re-starting the task from a checkpoint.
await this.diffViewProvider.revertChanges()

// If we're not streaming then `abortStream` (which reverts the diff
// view changes) won't be called, so we need to revert the changes here.
if (this.isStreaming && this.diffViewProvider.isEditing) {
await this.diffViewProvider.revertChanges()
}
}

// Tools
Expand Down Expand Up @@ -2817,6 +2822,8 @@ export class Cline {
}

const abortStream = async (cancelReason: ClineApiReqCancelReason, streamingFailedMessage?: string) => {
console.log(`[Cline#abortStream] cancelReason = ${cancelReason}`)
Copy link
Contributor

@ellipsis-dev ellipsis-dev bot Feb 11, 2025

Choose a reason for hiding this comment

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

Avoid using raw console.log for logging. Consider using a structured logging mechanism or an existing logger to ensure consistent and production-ready logs.

Suggested change
console.log(`[Cline#abortStream] cancelReason = ${cancelReason}`)
logger.info(`[Cline#abortStream] cancelReason = ${cancelReason}`)


if (this.diffViewProvider.isEditing) {
await this.diffViewProvider.revertChanges() // closes diff view
}
Expand Down Expand Up @@ -2871,6 +2878,7 @@ export class Cline {
const stream = this.attemptApiRequest(previousApiReqIndex) // yields only if the first chunk is successful, otherwise will allow the user to retry the request (most likely due to rate limit error, which gets thrown on the first chunk)
let assistantMessage = ""
let reasoningMessage = ""
this.isStreaming = true
Copy link
Collaborator Author

@cte cte Feb 11, 2025

Choose a reason for hiding this comment

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

Taken from Cline's current main.

try {
for await (const chunk of stream) {
if (!chunk) {
Expand Down Expand Up @@ -2903,11 +2911,13 @@ export class Cline {
}

if (this.abort) {
console.log("aborting stream...")
console.log(`aborting stream, this.abandoned = ${this.abandoned}`)

if (!this.abandoned) {
// only need to gracefully abort if this instance isn't abandoned (sometimes openrouter stream hangs, in which case this would affect future instances of cline)
await abortStream("user_cancelled")
}

break // aborts the stream
}

Expand Down Expand Up @@ -2940,6 +2950,8 @@ export class Cline {
// await this.providerRef.deref()?.postStateToWebview()
}
}
} finally {
this.isStreaming = false
Copy link
Collaborator Author

@cte cte Feb 11, 2025

Choose a reason for hiding this comment

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

Taken from Cline's current main.

}

// need to call here in case the stream was aborted
Expand Down
Loading