Skip to content

Add structured handshake rejections - #401

Open
Mayank808 wants to merge 2 commits into
mainfrom
mayank/structured-handshake-rejections
Open

Add structured handshake rejections#401
Mayank808 wants to merge 2 commits into
mainfrom
mayank/structured-handshake-rejections

Conversation

@Mayank808

@Mayank808 Mayank808 commented Aug 20, 2026

Copy link
Copy Markdown
Contributor

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

  • Breaking protocol change
  • Breaking ts/js API change

~ written by Zerg 馃懢 (wp-8f1d1ac5)

@Mayank808 Mayank808 added the zergling-authored PRs authored by Zerg label Aug 20, 2026
@Mayank808
Mayank808 marked this pull request as ready for review August 20, 2026 21:13
@Mayank808
Mayank808 requested a review from a team as a code owner August 20, 2026 21:13
@Mayank808
Mayank808 requested review from daweifeng-replit, jackyzha0, secobarbital and wernst and removed request for a team August 20, 2026 21:13
Comment thread PROTOCOL.md
| 'REJECTED_UNSUPPORTED_CLIENT';
// Application-defined rejection details. Older peers ignore this
// optional field.
details?: {

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@Mayank808 Mayank808 Aug 22, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

zergling-authored PRs authored by Zerg

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants