Skip to content

fine-grained edits with retries if they fail #15

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
merged 4 commits into from
Oct 18, 2025
Merged

fine-grained edits with retries if they fail #15

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
d9b5b52
fine-grained edits with retries if they fail
jpolitz Sep 16, 2025
6f641f5
fine-grained edits from _external_ sources (like undo)
jpolitz Sep 17, 2025
8e14863
reorganize and cleanup
jpolitz Sep 17, 2025
e71f6a9
edit and save the document if it started empty to force its context
jpolitz Sep 17, 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
61 changes: 53 additions & 8 deletions src/pyretCPOWebEditor.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -227,8 +227,51 @@ export function makePyretPane(
// Remember that a single text document can also be shared between multiple custom
// editors (this happens for example when you split a custom editor)

const editQueue : [vscode.WorkspaceEdit, string][] = [];
let isProcessingEdits = false;
function queueEdit(edit: vscode.WorkspaceEdit, source: string) {
editQueue.push([edit, source]);
processEditQueue();
}
async function processEditQueue() {
function enqueueFullEdit(source : string) {
const fullEdit = new vscode.WorkspaceEdit();
fullEdit.replace(
document.uri,
new vscode.Range(0, 0, document.lineCount, 0),
source);
editQueue.push([fullEdit, source]);
}
if (editQueue.length === 0) { return; }
else if (isProcessingEdits) { return; }
else {
const [edit, source] = editQueue.shift()!;
try {
isProcessingEdits = true;
console.log("Processing edit from ", source);
const ok = await vscode.workspace.applyEdit(edit);
// If something went wrong with the edit, try again but just force the
// whole document contents to match
if(!ok) {
console.error("applyEdit returned false, updating full contents", edit, source);
enqueueFullEdit(source);
Copy link

@blerner blerner Sep 17, 2025

Choose a reason for hiding this comment

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

I worry that this line is both here and in the catch block, such that if this line itself causes a problem (somehow), then we immediately try to do it again...

Copy link
Owner Author

@jpolitz jpolitz Sep 17, 2025

Choose a reason for hiding this comment

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

I hear you, but enqueueFullEdit is pure constructor/builder calls and push. I wish there was a TS annotation for “does not throw”!

Copy link

@blerner blerner Sep 17, 2025

Choose a reason for hiding this comment

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

oh oh, I misread, and thought the close-brace of enqueueFullEdit included this processing step as well (i.e. enqueue, and immediately try to process if there's anything to process). Yeah, pure constructor calls should be simple enough. So then the only fallible line is the applyEdit call? Or is even that infallible, since you'll get the !ok result from the await? I guess I'm not quite sure what the try/catch is accomplishing...

Copy link
Owner Author

@jpolitz jpolitz Sep 17, 2025

Choose a reason for hiding this comment

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

Yeah, I have actually never generated an input that causes this catch to trigger. The docs for applyEdit do not say that it will ever throw (https://code.visualstudio.com/api/references/vscode-api#workspace), just return false. So this may be over-cautious of me. I'm just super paranoid about losing fine-grained edits that bork a file.

Copy link
Owner Author

@jpolitz jpolitz Sep 17, 2025

Choose a reason for hiding this comment

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

(And other functions have throws documentation if they can, so I think the assumption is that applyEdit does not throw.)

}
}
catch (e) {
console.error("Error applying edit: ", e);
enqueueFullEdit(source);
}
finally {
isProcessingEdits = false;
processEditQueue();
}
}

}
const changeDocumentSubscription = vscode.workspace.onDidChangeTextDocument(e => {
if (e.document.uri.toString() === document.uri.toString()) {
const hasChanges = e.contentChanges.length > 0;
const isOurDocument = e.document.uri.toString() === document.uri.toString();
if (hasChanges && isOurDocument && !isProcessingEdits) {
updateWebview();
}
});
Expand Down Expand Up @@ -310,15 +353,17 @@ export function makePyretPane(
console.log("Got change", e);
const edit = new vscode.WorkspaceEdit();

// Just replace the entire document every time for this example extension.
// A more complete extension should compute minimal edits instead.
// NOTE(joe): we have these on the change events from CodeMirror
// Configure the edit from the CodeMirror change event in e.data.change
const from = e.data.change.from;
Copy link

@blerner blerner Sep 17, 2025

Choose a reason for hiding this comment

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

Can you clean this to use {from, to, text}=e.data.change?

const to = e.data.change.to;
const text = e.data.change.text;
const range = new vscode.Range(from.line, from.ch, to.line, to.ch);
const newText = text.join('\n');
edit.replace(
document.uri,
new vscode.Range(0, 0, document.lineCount, 0),
e.state.editorContents)
vscode.workspace.applyEdit(edit);
document.save();
range,
newText);
queueEdit(edit, e.state.editorContents);
break;
}
default: console.log("Got a message: ", e);
Expand Down