http: add shouldUpgradeCallback to let servers control HTTP upgrades #59824
+210
−5
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
|
Review requested:
|
nodejs-github-bot
added
http
Previously, you could either add no 'upgrade' event handler, in which case all upgrades were ignored, or add an 'upgrade' handler and all upgrade attempts would effectively succeed and skip normal request handling. This change adds a new shouldUpgradeCallback option to HTTP servers, which receives the request details and returns a boolean that controls whether the request should be upgraded.
pimterry
force-pushed
the
http-upgrade-callback
branch
from
27368d0 to
7468355
Compare
pimterry
added
the
semver-minor
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #59824 +/- ##
==========================================
+ Coverage 88.26% 88.29% +0.03%
==========================================
Files 701 702 +1
Lines 206644 206774 +130
Branches 39737 39780 +43
==========================================
+ Hits 182386 182571 +185
+ Misses 16279 16218 -61
- Partials 7979 7985 +6
🚀 New features to boost your workflow:
|
3 tasks
lpinca
approved these changes
Sep 11, 2025
github-actions
bot
removed
the
request-ci
pimterry
added
the
commit-queue-squash
|
@pimterry Unfortunately I don't have permission to approve the PR, otherwise LGTM. |
lpinca
approved these changes
Sep 12, 2025
pimterry
added
author ready
github-actions
bot
removed
the
request-ci
pimterry
added
the
commit-queue
nodejs-github-bot
removed
the
commit-queue
|
Landed in 65bee02 |
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.
Fixes #57054
Previously, you could either add no
upgradeevent handler to your HTTP server, in which case all HTTP upgrade requests were ignored, or you could add anupgradehandler and all upgrade attempts would always effectively succeed, going straight to theupgradeevent and skipping normal request handling.That can be inflexible, as there's plenty of cases where you want to support just upgrading specific requests (most commonly, specific protocols - e.g. upgrading to support websockets but not h2c).
This change adds a new
shouldUpgradeCallbackoption to HTTP servers, which receives the request details and returns a boolean that controls whether the request should be upgraded. Existing behaviour isn't changed, by making the default option value() => server.listenerCount('upgrade') > 0.