-
-
Notifications
You must be signed in to change notification settings - Fork 306
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
fix: prevent eventstream errors on shutdown or client aborts #5784
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -18,7 +18,13 @@ export function getRoutes(config: ChainForkConfig, api: ServerApi<Api>): ServerR | |
const controller = new AbortController(); | ||
|
||
try { | ||
// Add injected headers from other pluggins. This is required for fastify-cors for example | ||
// 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 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 | ||
res.hijack(); | ||
|
||
// Add injected headers from other plugins. This is required for fastify-cors for example | ||
// From: https://github.com/NodeFactoryIo/fastify-sse-v2/blob/b1686a979fbf655fb9936c0560294a0c094734d4/src/plugin.ts | ||
Object.entries(res.getHeaders()).forEach(([key, value]) => { | ||
if (value !== undefined) res.raw.setHeader(key, value); | ||
|
@@ -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. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Removed as it did not resolve the issue (added in #5722) |
||
|
||
const data = eventSerdes.toJson(event); | ||
res.raw.write(serializeSSEEvent({event: event.type, data})); | ||
} catch (e) { | ||
|
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.
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.
hijack()
is not async, see reply.js#L116