Skip to content

Fix HTTP/2 RST_STREAM behaviour, add auto-drain, deprecate 'aborted', fix related compat API issues #63249

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.

Sign up for GitHub

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

Open
pimterry wants to merge 7 commits into
base: main
Choose a base branch
from
Open

Fix HTTP/2 RST_STREAM behaviour, add auto-drain, deprecate 'aborted', fix related compat API issues #63249

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
ed1174a
http2: error for incomplete reads on RST, auto-drain, deprecate aborted
pimterry May 7, 2026
6932225
http2: fix stream error reporting & 'finish' in the compat API
pimterry May 11, 2026
3037fb4
Fix cpp formatting
pimterry May 12, 2026
c121108
Make respondWithFD match fixed H2 RST behaviour too
pimterry May 12, 2026
4778b13
Add example to deprecations & update PR ids
pimterry May 12, 2026
8208f2c
Tighten up the test cases a little
pimterry May 12, 2026
fc2bb1a
Make sure the respondWithFD test isn't flaky
pimterry May 12, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Add example to deprecations & update PR ids
  • Loading branch information
@pimterry
pimterry committed May 12, 2026
commit 4778b136591fe0c9ccebb54f2e21df48a59362b9
46 changes: 43 additions & 3 deletions doc/api/deprecations.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4579,14 +4579,54 @@ will throw an error in a future version.
<!-- YAML
changes:
- version: REPLACEME
pr-url: https://github.com/nodejs/node/pull/000000
pr-url: https://github.com/nodejs/node/pull/63249
description: Documentation-only deprecation.
-->

Type: Documentation-only

Use the standard {Stream} API: check `stream.destroyed` and listen for
`'close'` and `'error'`. Parallels [DEP0156][] for `http`.
Use standard stream events and state checks instead. Read-side aborts
(peer cancelled before sending `END_STREAM`) now surface as `'error'`
with code `ERR_HTTP2_STREAM_ABORTED` (clean peer reset code) or
`ERR_HTTP2_STREAM_ERROR` (non-clean code). Write-side aborts (peer
cancelled while we still had writes in flight) are detectable from
`'close'` by checking `writableFinished`. Parallels [DEP0156][] for
`http`.

```cjs
// Deprecated
server.on('stream', (stream) => {
stream.on('aborted', () => {
// Stream was closed while the writable was still open.
});
});
```

```cjs
// Use this instead
server.on('stream', (stream) => {
// Read-side abort: peer cancelled before sending END_STREAM.
stream.on('error', (err) => {
if (err.code === 'ERR_HTTP2_STREAM_ABORTED' ||
err.code === 'ERR_HTTP2_STREAM_ERROR') {
// Peer cancelled the request mid-stream.
}
});
// Write-side abort: our response didn't fully send before close.
stream.on('close', () => {
if (!stream.writableFinished) {
// Writes were aborted (peer cancel, local destroy, etc.).
}
});
});
```

The same patterns apply to the compatibility API (`req` / `res` on
`http2.createServer((req, res) => …)`). On the read-side, errors on the
underlying stream are emitted from `req`. On the write-side you can use
`res.on('close', …)` to hear about client aborts by checking
`res.writableFinished` to confirm whether the response was written
successfully before the response closed.

[DEP0142]: #dep0142-repl_builtinlibs
[DEP0156]: #dep0156-aborted-property-and-abort-aborted-event-in-http
Expand Down
6 changes: 3 additions & 3 deletions doc/api/http2.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1265,7 +1265,7 @@ destroyed.
added: v8.4.0
changes:
- version: REPLACEME
pr-url: https://github.com/nodejs/node/pull/000000
pr-url: https://github.com/nodejs/node/pull/63249
description: Documentation-only deprecation.
-->

Expand Down Expand Up @@ -1294,7 +1294,7 @@ the `http2stream.rstCode` property.
added: v8.4.0
changes:
- version: REPLACEME
pr-url: https://github.com/nodejs/node/pull/000000
pr-url: https://github.com/nodejs/node/pull/63249
description: >-
Also emitted on peer-initiated resets that arrive before
`END_STREAM` (`ERR_HTTP2_STREAM_ABORTED` for clean codes,
Expand Down Expand Up @@ -1736,7 +1736,7 @@ stream.on('push', (headers, flags) => {
added: v8.4.0
changes:
- version: REPLACEME
pr-url: https://github.com/nodejs/node/pull/000000
pr-url: https://github.com/nodejs/node/pull/63249
description: >-
If no `'response'` listener is attached when the response headers
arrive, the response body is now silently discarded - matching
Expand Down