fix: prevent eventstream errors on shutdown or client aborts #5784
Conversation
This file contains 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
nazarhussain
requested changes
Jul 21, 2023
Performance Report✔️ no performance regression detected Full benchmark results
|
nflaig
force-pushed
the
nflaig/fix-cannot-set-headers
branch
3 times, most recently
from
b53faa9
to
8239979
Compare
nflaig
changed the title
nflaig
changed the title
nflaig
force-pushed
the
nflaig/fix-cannot-set-headers
branch
from
8239979
to
905c4b9
Compare
nflaig
commented
Jul 21, 2023
| @@ -37,9 +43,6 @@ export function getRoutes(config: ChainForkConfig, api: ServerApi<Api>): ServerR | |||
| await new Promise<void>((resolve, reject) => { | |||
| void api.eventstream(req.query.topics, controller.signal, (event) => { | |||
| try { | |||
| // If the request is already aborted, we don't need to send any more events. | |||
| if (req.raw.destroyed) return; | |||
There was a problem hiding this comment.
Removed as it did not resolve the issue (added in #5722)
| // Prevent Fastify from sending the response, this is recommended before writing to the `.raw` stream | ||
| // and avoids "Cannot set headers after they are sent to the client" errors during shutdown or abrupt client aborts. | ||
| // See https://github.com/fastify/fastify/issues/3979, https://github.com/ChainSafe/lodestar/issues/5783 | ||
| // eslint-disable-next-line @typescript-eslint/no-floating-promises |
There was a problem hiding this comment.
hijack() is not async, see reply.js#L116
nflaig
force-pushed
the
nflaig/fix-cannot-set-headers
branch
from
905c4b9
to
24843a6
Compare
nazarhussain
approved these changes
Jul 21, 2023
|
I researched a bit more to make sure "hijacking" the response ( The most important consideration is about not execution hooks in our case as closing the evenstream api via There are custom hooks that are skipped now, namely All other hooks are called before handler is invoked, meaning CORS headers are still set by plugin and |
|
🎉 This PR is included in v1.10.0 🎉 |
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.
Motivation
Closes #5783
Description
Before writing to the
.rawstream it is recommended to call.hijack, see fastify/fastify#3979 (comment).This prevents Fastify from sending the response and avoids "Error: Cannot set headers after they are sent to the client" errors during shutdown or client aborts.
See mention of
.hijack()in Lifecycle.md. Further details can be found in Reply.md#hijackThe previous changes done in #5722 and changes of this PR will fix all the errors reported in #5323. We might consider closing this issue as well after checking with user that reported it.