Add structured handshake rejections - #401
Open
Mayank808 wants to merge 2 commits into
Open
Conversation
Mayank808
marked this pull request as ready for review
August 20, 2026 21:13
Mayank808
requested review from
daweifeng-replit,
jackyzha0,
secobarbital and
wernst
and removed request for
a team
August 20, 2026 21:13
wernst
reviewed
Aug 22, 2026
| | 'REJECTED_UNSUPPORTED_CLIENT'; | ||
| // Application-defined rejection details. Older peers ignore this | ||
| // optional field. | ||
| details?: { |
There was a problem hiding this comment.
What do you think about making this just extras: unknown? I think at this point we're at the application boundary and we dont need to be prescriptive about shape. This is up to the app dev.
Contributor
Author
There was a problem hiding this comment.
I think that also works but might lead to a lot of application specific structures and duplication that we would have to keep track of. I think having some structure enforced in a details package could lead to bit more conformity in the codebase later on especially when this is only being used for error cases. But let me know this is a easy change and more about style preferences of the team
wernst
approved these changes
Aug 22, 2026
wernst
approved these changes
Aug 22, 2026
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
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.
Why
Custom handshake handlers can only return a River failure code. Applications must put specific failure states in error strings and parse those strings for retry decisions. We can log application specific errors which will improve logging and error handling flows.
Current specific use case is for terminal errors happening on river handshakes we want to close the river connection we have no way to differentiate between a handshake error that is terminal vs error retry
What changed
Custom handshake handlers can now return
rejectHandshake({ code, message, extras }). River sends these optional details in failed handshake responses and exposes them in protocol error events and logs. Existing handlers that return a River failure code continue to work without changes.Tests cover initial handshakes, re-handshakes, and compatibility with old clients and servers. The protocol and handshake documentation describe the new payload.
Versioning
~ written by Zerg 馃懢 (wp-8f1d1ac5)