Fix delayed server shutdown if clients are connected to the Watch server-streaming RPC of the Health API #2573
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.
Fixes #2572
Changes
Grpc.HealthCheck.HealthServiceImpl
class to theGrpc.AspNetCore.HealthChecks
namespace. This was necessary because theHealthServiceImpl
now requires theIHostApplicationLifetime
, which is not available in theGrpc.HealthCheck
package. I assumed you prefer not to modify references of that package. I did not change the original implementation to ensure backwards compatibility.ApplicationStopping
cancellation token in theGrpc.AspNetCore.HealthChecks.HealthServiceImpl
class to gracefully terminateWatch
streams during server shutdown. TheApplicationStopping
token was passed to theWaitToReadAsync
method to allow running calls to finish when the server is stopping. In the catch block, aNotServing
response is written to the response stream, though anRpcException
could be thrown if preferred.Testing
The following screenshot shows that the server now stops within a second, even if clients are connected to the
Watch
RPC at the time of shutdown. The server was stopped at 12:09:17 (via the terminal).