fix(coderd): ensure inbox WebSocket is closed when client disconnects #21652
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
This is similar to #19711 The way this endpoint works is that it subscribes to the database for notifications. When a notification is received, it pipes that notification down the WebSocket. If
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Relates to #19715
This is similar to #19711
This endpoint works by doing the following:
httpapi.HeartbeatThe critical issue here is that
httpapi.Heartbeatsilently fails when the client has disconnected. This means we never cancel the request context, leaving the WebSocket alive until we receive a notification from the database and fail to write that down the pipe.By replacing usage of
httpapi.Heartbeatwithhttpapi.HeartbeatClose, we cancel the context when the heartbeat fails to write due to the client disconnecting. This allows us to cleanup without waiting for a notification to come through the pubsub channel.