Handle backpressure and remove ExitReceiver #117
Merged
Conversation
This file contains 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
According to the [docs] for `tower_service::Service::poll_ready()`, the method implementation is supposed to return `Poll::Ready(Err(_))` if the service in question is no longer able to accept requests. In our current implementation, we return `Poll::Pending`, which is semantically incorrect. [docs]: https://docs.rs/tower-service/0.3.0/tower_service/trait.Service.html#tymethod.poll_ready This changes our `poll_ready()` implementation to conform with the upstream interface specification so we can properly handle backpressure.
This adapts `Server` to properly handle service backpressure by awaiting on `Service::poll_ready()` and exiting early if the underlying service returns `Poll::Ready(Err(_))`. This should make the `Server` shut itself down gracefully once it detects that the underlying service is no longer able to serve requests.
A nice side effect of the previous `poll_ready()` changes: since the `Server` now shuts itself automatically as soon as the underlying service returns a `Poll::Ready(Err(_))`, there is no reason to keep `ExitReceiver` around anymore. This allows users to await the `Server::serve()` future directly, which improves the API ergonomics quite a bit and allows us to get rid of `ExitReceiver` entirely.
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.
Changed
ErrfromLspService::poll_ready()if theexitnotification is received.Serveronce the underlying service'spoll_ready()returnsErr.Removed
ExitReceiverandLspService::close_handle().