Support handlers calling res.destroy() to abort sending a response#150
Merged
Marsup merged 2 commits intohapijs:masterfrom Aug 13, 2025
Merged
Support handlers calling res.destroy() to abort sending a response#150Marsup merged 2 commits intohapijs:masterfrom
Marsup merged 2 commits intohapijs:masterfrom
Conversation
kanongil
force-pushed
the
response-abort
branch
from
73991ef to
944e6c2
Compare
Marsup
reviewed
Aug 13, 2025
lib/response.js
Outdated
| }); | ||
| }; | ||
|
|
||
| const abort = finalize.bind(this, true); |
Contributor
There was a problem hiding this comment.
Bind won't work on arrow functions, shouldn't we just inline this below with a () => finalize(true)?
Contributor
Author
There was a problem hiding this comment.
Bind works for the purpose (adding true) as the first argument.
Granted the this is not used. () => finalize(true) is fine as well. Though, it cannot be inlined, as it needs to be removed again.
Contributor
|
Oh, looks like your other PR conflicted with this one. |
kanongil
force-pushed
the
response-abort
branch
from
944e6c2 to
dd468e0
Compare
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
When calling
res.destroy([err])before'finish', shot will currently either do nothing and never return, or reject/throw an unhandled exception.This does not seem desirable. This is fixed in this PR by detecting aborted responses, and exposing such through a new
abortedproperty. Depending on when the abort happens, more or less of theresponsecan be filled in along with it.I don't think this is a breaking change, since it only changes the behaviour of previously failing
inject()calls. It can however affect code that relies on the buggy behaviour. One example is this test from hapi, where inject will now return a value. But the test still passes. In fact all hapi tests still pass.Note that I'm not really a fan of the new
abortedproperty, since you will need to remember to check for it, as the response might otherwise look complete. Ideally this property would only be exposed with an option, and normally just reject with an error. This is however more of a breaking change, and conflicts with how hapi uses this module.