Gracefully exit the server #622
Merged
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
Collaborator
|
Do you want a review on this yet? |
Collaborator
Author
|
Yes, the this MR is ready for review, but the corresponding hls changes at haskell/haskell-language-server#4701 still need some more polishing. |
soulomoon
force-pushed
the
gracefullyexit
branch
from
6ee37a0 to
3cf7ceb
Compare
This comment was marked as outdated.
This comment was marked as outdated.
Collaborator
|
@soulomoon I assume, you still want a review? 🙈 I mean, this is still ready for review, right? |
Collaborator
Author
|
@fendor Yes, thanks for picking it up. If the general change looks good, I can resolve the conflict. |
fendor
approved these changes
Nov 24, 2025
Collaborator
fendor
left a comment
fendor
left a comment
There was a problem hiding this comment.
LGTM, got some nitpicks and mostly documentation update requests.
Thank you for chasing this issue down, it is really quite annoying!
Should we perhaps add a Note [Handle Server exiting] or something like that?
fendor
reviewed
Nov 25, 2025
- Track shutdown/exit separately and wait for sender to flush before exit - Make runServerWithHandles resilient to broken pipes and log truncated messages - Have runServerWith/ioLoop return proper exit codes based on shutdown state - Adjust processing to use sender wait action during shutdown and log exit - Fix functional test harness to assert zero exit code instead of ExitSuccess - Tidy minor CI workflow whitespace in format.yaml and nix.yaml
soulomoon
force-pushed
the
gracefullyexit
branch
from
375ea8a to
df52cc0
Compare
fendor
reviewed
Nov 25, 2025
Co-authored-by: fendor <fendor@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 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.
The main purpose of this patch is to fix the long standing broken pipe issue in hls, see haskell/haskell-language-server#1875. It accompanied with the hls fix haskell/haskell-language-server#4701
This pull request introduces several improvements to the LSP server's shutdown and exit handling. The changes ensure that output is properly flushed and errors are logged if the client disconnects unexpectedly, and that the server's sender thread is gracefully shut down. The shutdown and exit logic is now more explicit with new state tracking and barriers.
resExitbarrier toLanguageContextStateand anisExitingfunction to track when the server should exit, ensuring that the server stops processing messages after an exit notification is received. [1]clientOutto catch and logBrokenPipeerrors when sending output fails (e.g., if the client closes the output handle), including a truncated version of the outgoing message for debugging.withAsyncandraceto better manage the sender thread lifecycle and ensure clean shutdowns. [1]sendServerfunction to terminate after sending the shutdown response, preventing further messages from being sent after shutdown. Modified the main server loop and sender logic to wait for the sender thread to finish after shutdown, with a timeout and logging if it does not stop in time.summary generated by Copilot