Implicitly cancel text document requests when the document is edited or closed #1629
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…or closed As a user makes an edit to a file, these requests are most likely no longer relevant. It also makes sure that a long-running sourcekitd request can't block the entire language server if the client does not cancel all requests. For example, consider the following sequence of requests: - `textDocument/semanticTokens/full` for document A - `textDocument/didChange` for document A - `textDocument/formatting` for document A If the editor is not cancelling the semantic tokens request on edit (like VS Code does), then the `didChange` notification is blocked on the semantic tokens request finishing. Hence, we also can't run the `textDocument/formatting` request. Cancelling the semantic tokens on the edit fixes the issue. rdar://133987424
Member
Author
|
@swift-ci Please test |
bnbarham
approved these changes
Aug 16, 2024
Comment on lines
+1283
to
+1285
| guard self.options.cancelTextDocumentRequestsOnEditAndCloseOrDefault else { | ||
| return | ||
| } |
Contributor
There was a problem hiding this comment.
Could just check in the outer method before queuing anything?
Member
Author
There was a problem hiding this comment.
No, because options is isolated to the SourceKitLSPServer instance and the outer cancelTextDocumentRequests method is nonisolated.
ahoppen
added a commit
to ahoppen/sourcekit-lsp
that referenced
this pull request
Jan 4, 2026
Instead, use `staleRequestSupport.retryOnContentModified` as an indicator which requests should return a `ContentModified` error when the document is modified. This fixes swiftlang#2136 by no longer implicitly cancelling inlayHints in Helix while still implicitly cancelling semantic tokens request, which was the motivation for swiftlang#1629. Fixes swiftlang#2136
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
As a user makes an edit to a file, these requests are most likely no longer relevant. It also makes sure that a long-running sourcekitd request can't block the entire language server if the client does not cancel all requests. For example, consider the following sequence of requests:
textDocument/semanticTokens/fullfor document AtextDocument/didChangefor document AtextDocument/formattingfor document AIf the editor is not cancelling the semantic tokens request on edit (like VS Code does), then the
didChangenotification is blocked on the semantic tokens request finishing. Hence, we also can't run thetextDocument/formattingrequest. Cancelling the semantic tokens on the edit fixes the issue.rdar://133987424