doc && http: fix agent default value for keepAlive
#51115
Conversation
Since node 19, option keepAlive is true by default.
|
Review requested:
|
nodejs-github-bot
added
doc
| @@ -142,7 +142,7 @@ changes: | |||
| header is always sent when using an agent except when the `Connection` | |||
| header is explicitly specified or when the `keepAlive` and `maxSockets` | |||
| options are respectively set to `false` and `Infinity`, in which case | |||
| `Connection: close` will be used. **Default:** `false`. | |||
| `Connection: close` will be used. **Default:** `true`. | |||
There was a problem hiding this comment.
Line 111 in 99f6084
The default value is false.
There was a problem hiding this comment.
🤔
So a another line in doc is misleading.
Because
Line 557 in 99f6084
I understand the default value for a new Agent is falsy keepAlive, but the "default" globalAgent is set to true.
~ » nvm use system
Now using system version of node: v20.10.0 (npm v10.2.5)
--------------------------------------------------------------------------------------------------
~ » node -pe 'const {keepAlive, keepAliveMsecs} = http.globalAgent; ({keepAlive, keepAliveMsecs})'
{ keepAlive: true, keepAliveMsecs: 1000 }
~ » nvm use 18
Now using node v18.19.0 (npm v10.2.3)
--------------------------------------------------------------------------------------------------
~ » node -pe 'const {keepAlive, keepAliveMsecs} = http.globalAgent; ({keepAlive, keepAliveMsecs})'
{ keepAlive: false, keepAliveMsecs: 1000 }
To be complete, in our organization (https://www.radiofrance.fr/) we had some surprises with this change in our kubernetes infrastructure.
There was a problem hiding this comment.
Yes, you are right: the misleading line is the one you linked above. In #43522 I changed some options for the default agent (while leaving the constructor behavior untouched).
Could you please update this PR to fix that offending line instead of the one you proposed?
There was a problem hiding this comment.
Done. I hope my changes are what you expect.
zckrs
changed the title
keepAlivekeepAlive
lpinca
added
the
semver-major
|
I don't think we should change the default value in the constructor. The global agent has uses a different value and that's ok. Anyway this PR is correct now so I'm dropping my request for changes. |
|
Why is this semver-major? |
It changes the default value of the |
|
I agree, if we want the PR this way. But I don't think we want to flip the value on the code, just in the docs for the default agent (note: not the constructor, the default instance). |
Since node 19, option keepAlive is true by default.