Don’t cancel in-progress diagnostic generation when calling DiagnosticReportManager.removeItemsFromCache
#1414
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
…icReportManager.removeItemsFromCache` This was causing a non-deterministic test failure: When target preparation finishes while a diagnostic request is in progress, it will re-open the document, which calls `DiagnosticReportManager.removeItemsFromCache` for that document’s URI. With the old implementation, we would thus cancel the diagnostics sourcekitd request and return a cancelled error to the diagnostics LSP request. While doing this, I also realized that there was a race condition: Document re-opening would happen outside of the SourceKit-LSP message handling queue and could thus run concurrently to any other request. This means that a sourcekitd request could run after `reopenDocument` had closed the document but before it was opened again. Introduce an internal reopen request that can be handled on the main message handling queue and thus doesn’t have this problem
|
@swift-ci Please test |
hamishknight
approved these changes
Jun 4, 2024
Comment on lines
-89
to
-93
| let tasksToCancel = reportTaskCache.filter { $0.snapshotID.uri == uri } | ||
| reportTaskCache.removeAll(where: { $0.snapshotID.uri == uri }) | ||
| for task in tasksToCancel { | ||
| await task.reportTask.cancel() | ||
| } |
There was a problem hiding this comment.
I suppose we could still do the cancellation on close/open (just not re-open), would that be beneficial?
There was a problem hiding this comment.
There wouldn’t be any point. The close and open are classified as MessageHandlingDependencyTracker.documentUpdate, so they will only execute after the diagnostic requests have finished.
Also, I don’t like implicit cancellation and think that the client should explicitly cancel a request if they no longer need it.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This was causing a non-deterministic test failure: When target preparation finishes while a diagnostic request is in progress, it will re-open the document, which calls
DiagnosticReportManager.removeItemsFromCachefor that document’s URI. With the old implementation, we would thus cancel the diagnostics sourcekitd request and return a cancelled error to the diagnostics LSP request.While doing this, I also realized that there was a race condition: Document re-opening would happen outside of the SourceKit-LSP message handling queue and could thus run concurrently to any other request. This means that a sourcekitd request could run after
reopenDocumenthad closed the document but before it was opened again. Introduce an internal reopen request that can be handled on the main message handling queue and thus doesn’t have this problem