Skip to content

Fix a potential race between didChange and didOpen #13209

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
Colengms merged 4 commits into from
Jan 28, 2025
Merged

Fix a potential race between didChange and didOpen #13209

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
9f8cdda
Address a potential race between didChange and didOpen
Colengms Jan 28, 2025
62906f1
Merge branch 'main' of https://github.com/microsoft/vscode-cpptools i…
Colengms Jan 28, 2025
958969f
Address a potential race between didChange and didOpen
Colengms Jan 28, 2025
5036415
Merge branch 'main' into coleng/fix_didOpen_didChange_race
Colengms Jan 28, 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
12 changes: 11 additions & 1 deletion Extension/src/LanguageServer/extension.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -172,8 +172,13 @@ export async function activate(): Promise<void> {
getCustomConfigProviders().forEach(provider => void client.onRegisterCustomConfigurationProvider(provider));
});

disposables.push(vscode.workspace.onDidChangeConfiguration(onDidChangeSettings));
// These handlers for didChangeTextDocument and didOpenTextDocument are intentionally synchronous and are
// intended primarily to maintain openFileVersions with the most recent versions of files, as quickly as
// possible, without being delayed by awaits or queued behind other LSP messages, etc..
disposables.push(vscode.workspace.onDidChangeTextDocument(onDidChangeTextDocument));
disposables.push(vscode.workspace.onDidOpenTextDocument(onDidOpenTextDocument));

disposables.push(vscode.workspace.onDidChangeConfiguration(onDidChangeSettings));
disposables.push(vscode.window.onDidChangeTextEditorVisibleRanges((e) => clients.ActiveClient.enqueue(async () => onDidChangeTextEditorVisibleRanges(e))));
disposables.push(vscode.window.onDidChangeActiveTextEditor((e) => clients.ActiveClient.enqueue(async () => onDidChangeActiveTextEditor(e))));
ui.didChangeActiveEditor(); // Handle already active documents (for non-cpp files that we don't register didOpen).
Expand Down Expand Up @@ -303,6 +308,11 @@ function onDidChangeTextDocument(event: vscode.TextDocumentChangeEvent): void {
me.onDidChangeTextDocument(event);
}

function onDidOpenTextDocument(document: vscode.TextDocument): void {
const me: Client = clients.getClientFor(document.uri);
me.onDidOpenTextDocument(document);
}

let noActiveEditorTimeout: NodeJS.Timeout | undefined;

async function onDidChangeTextEditorVisibleRanges(event: vscode.TextEditorVisibleRangesChangeEvent): Promise<void> {
Expand Down
1 change: 0 additions & 1 deletion Extension/src/LanguageServer/protocolFilter.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,6 @@ export function createProtocolFilter(): Middleware {
return;
}
// client.takeOwnership() will call client.TrackedDocuments.add() again, but that's ok. It's a Set.
client.onDidOpenTextDocument(document);
client.takeOwnership(document);
void sendMessage(document);
}
Expand Down