-
Notifications
You must be signed in to change notification settings - Fork 277
fix(node-ws): fix WebSocket not working with app.route() #1623
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
🦋 Changeset detectedLatest commit: d90a14d The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #1623 +/- ##
=======================================
Coverage 84.41% 84.41%
=======================================
Files 120 120
Lines 3894 3895 +1
Branches 1052 1052
=======================================
+ Hits 3287 3288 +1
Misses 516 516
Partials 91 91
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
nakasyou
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sorry for late reply. This is great idea to solve it, thank you.
| const generateConnectionSymbol = () => Symbol('connection') | ||
|
|
||
| /** @example `c.env[CONNECTION_SYMBOL_KEY]` */ | ||
| const CONNECTION_SYMBOL_KEY: unique symbol = Symbol('CONNECTION_SYMBOL_KEY') |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This should be deleted.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@poteboy Can you handle this?
Summary
Fix WebSocket connections failing when the endpoint is registered under
app.route().Problem
When using
app.route(), WebSocket connections fail with400 Bad Request.Cause
The original implementation stored a connection symbol in
c.env:However, this doesn't persist when the WebSocket endpoint is registered via
app.route(). The exact reason is unclear, but it seemsc.envreference changes in that case.Solution
Instead of writing to
c.env, use aWeakSetto track therequestobject directly. Sincec.env.incoming(the request object) remains the same reference even throughapp.route(), this approach works reliably.The author should do the following, if applicable
yarn changesetat the top of this repo and push the changeset