fix(setupServer): set max listeners on the "request.signal" #1765
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
kettanaito
commented
Oct 10, 2023
| // "AbortController" so if the parent aborts, all the | ||
| // clones are automatically aborted. | ||
| setMaxListeners( | ||
| Math.max(defaultMaxListeners, this.currentHandlers.length), |
There was a problem hiding this comment.
We must never set fewer max listeners than defaultMaxListeners, even if there are fewer request handlers, because that may produce false positive "possible memory leak" errors from Node.
Node sets the max listeners to 10 by default, if I'm not mistaken. If there are fewer request handlers, keep the default max listeners count.
kettanaito
commented
Oct 10, 2023
| @@ -194,11 +196,11 @@ export abstract class RequestHandler< | |||
| this.isUsed = true | |||
|
|
|||
| const parsedResult = await this.parse({ | |||
| request: mainRequestRef.clone(), | |||
| request: args.request, | |||
There was a problem hiding this comment.
No more cloning of the intercepted request for the internal phases. Each request handler class must clone the given request by itself if it intends to read its body.
34 tasks
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 the issue when having a large number of request handlers would result in the following error from Node when processing an intercepting request:
Why was this error printed?
When a large number of event listeners is added to any target, Node preemptively prints an error letting you know that something may be off (a potential memory leak). However, in the case of the request handlers, we are expecting at least a N
abortevent listener to be added to the originalrequest.signalbecause every request handler clones the intercepted request at least once (so it could read its body when logging it).How is this fixed?
By using
require('events').setMaxListeners()on therequest.signal.