Skip to content

Expose WebSocket upgrade context to handshake validation - #406

Merged
Armster15 merged 3 commits into
mainfrom
armster15/expose-websocket-upgrade-context
Sep 2, 2026
Merged

Expose WebSocket upgrade context to handshake validation#406
Armster15 merged 3 commits into
mainfrom
armster15/expose-websocket-upgrade-context

Conversation

@Armster15

@Armster15 Armster15 commented Sep 2, 2026

Copy link
Copy Markdown
Member

Why

River already stores WebSocket upgrade headers in connection.extras, but server handshake validation cannot read them. A downstream gateway authenticates a session cookie during WebSocket upgrade and needs to pass the verified identity to validate.

What changed

Server handshake validation now accepts one optional argument:

validate(metadata, previousMetadata, from, connectionExtras)

River passes the extras from the current connection at both validation sites:

  • The initial handshake receives the extras for the new socket.
  • A same-socket rehandshake receives the original extras for that socket.
  • A reconnect creates a new socket, so its handshake receives the new socket extras.

WebSocketServerTransport also accepts an optional fourth constructor argument:

new WebSocketServerTransport(wss, clientId, options, (ws, req) => extras)

The default behavior is unchanged. Without a factory, River stores the same cleaned upgrade headers that it stores today. The factory is synchronous because River must install the socket message handler during the connection event. Applications can finish asynchronous authentication before this event and let the factory read the verified result.

Existing three-argument validate functions still compile and work. This PR does not change protocol messages or package versions. The typing and tests follow the precedent in #403. The README now documents the new validator argument, factory, and synchronous constraint.

Test plan

  • npm run check
  • npm run test:single (785 passed, 1 skipped)
  • npm run build
  • npx prettier README.md --check

Versioning

  • Breaking protocol change
  • Breaking ts/js API change

~ written by Zerg 馃懢 (volatile-queen-8e97)

@Armster15 Armster15 added the zergling-authored PRs authored by Zerg label Sep 2, 2026
@Armster15
Armster15 marked this pull request as ready for review September 2, 2026 08:54
@Armster15
Armster15 requested a review from a team as a code owner September 2, 2026 08:54
@Armster15
Armster15 requested review from wernst and removed request for a team September 2, 2026 08:54
@Armster15
Armster15 merged commit 2cb060f into main Sep 2, 2026
7 checks passed
@Armster15
Armster15 deleted the armster15/expose-websocket-upgrade-context branch September 2, 2026 20:34
@Armster15 Armster15 mentioned this pull request Sep 2, 2026
2 tasks
Armster15 added a commit that referenced this pull request Sep 2, 2026
## Why

River 0.222.0 includes the WebSocket connection extras API from
#406. This prepares that change for
publication to npm.

Original conversation:
https://replit.slack.com/archives/D0AEJNMGCSG/p1788333765717319

## What changed

Bumps the `@replit/river` package version from 0.221.0 to 0.222.0 in
`package.json` and `package-lock.json`. This PR does not change source
code or dependencies.

## Test plan

- `npm run check`
- `npm run test:single` (785 passed, 1 skipped)
- `npm run build`

## Versioning

- [ ] Breaking protocol change
- [ ] Breaking ts/js API change

~ written by Zerg 馃懢
([volatile-queen-8e97](https://zerg.zergrush.dev/chat?id=volatile-queen-8e97))
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