Wait for cancellation to propagate in testDontReturnEmptyDiagnosticsIfDiagnosticRequestIsCancelled
#1412
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
|
@swift-ci Please test |
hamishknight
approved these changes
Jun 4, 2024
Comment on lines
122
to
123
| // `log(request:)` is called in `SourceKitD.send` before the request is sent, so we're hooking in here. | ||
| testHooks.sourcekitdRequestDidStart?(request) |
There was a problem hiding this comment.
Any reason not to put this in func send? I guess to avoid exposing it in the protocol?
There was a problem hiding this comment.
I was thinking because protocols can’t have stored properties. But somehow didn’t occur to me before that we could just make the test hooks a protocol requirement… 🤦🏽
ahoppen
force-pushed
the
wait-for-prepration-to-propagate
branch
2 times, most recently
from
420dc8a to
03b8a8a
Compare
|
@swift-ci Please test |
1 similar comment
|
@swift-ci Please test |
…IfDiagnosticRequestIsCancelled` I saw a few non-deterministic test failures. I think the issue was that handling of the `CancelRequestNotification` is done asynchronously, which left a short window in which the sourcekitd diagnostics request could run and return results instead of being cancelled. Wait for the diagnostic request to actually be cancelled before running it for real. While doing this, also introduce proper sourcekitd test hooks instead of relying on the preparation test hooks, which just got run as a side effect.
ahoppen
force-pushed
the
wait-for-prepration-to-propagate
branch
from
03b8a8a to
37e6a8a
Compare
|
@swift-ci Please test |
|
@swift-ci Please test Windows |
ahoppen
added a commit
to ahoppen/sourcekit-lsp
that referenced
this pull request
Jun 5, 2024
Turns out that sourcekitd test hooks were a bad idea because of the following comment that I wrote: ``` `testHooks` are only considered when an instance is being created. If a sourcekitd instance at the given path already exists, its test hooks will be used. ``` During test execution in Xcode, we generate a bunch of `SourceKitServer` instances in the same process that all call `DynamicallyLoadedSourceKitD.getOrCreate`. Now, if `testDontReturnEmptyDiagnosticsIfDiagnosticRequestIsCancelled` is not the first test being executed in the process (which usually it is not), the test hooks in it won’t get used. Switch back to using the preparation hooks, essentially reverting swiftlang#1412 and keeping the following snippet to fix the underlying issue ```swift // Poll until the `CancelRequestNotification` has been propagated to the request handling. for _ in 0..<Int(defaultTimeout * 100) { if Task.isCancelled { break } usleep(10_000) } ```
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.
I saw a few non-deterministic test failures. I think the issue was that handling of the
CancelRequestNotificationis done asynchronously, which left a short window in which the sourcekitd diagnostics request could run and return results instead of being cancelled. Wait for the diagnostic request to actually be cancelled before running it for real.While doing this, also introduce proper sourcekitd test hooks instead of relying on the preparation test hooks, which just got run as a side effect.