lib: support overriding http\s.globalAgent #25170

illBeRoy · 2018-12-21T18:39:12Z

Overriding require('http').globalAgent and require('https').globalAgent is now respected by consequent requests.

In order to achieve that, the following changes were made:

http: module.exports.globalAgent is now defined through Object.defineProperty. Its getter and setter return \ set require('_http_agent').globalAgent.
https: the https globalAgent is not the same as _http_agent, and is defined in https module itself. Therefore, the fix here was to simply use module.exports.globalAgent to support mutation.
test/parallel: according tests were added for both http and https, where in both we create a server, set the default agent to a newly created instance and make a request to that server. We then assert that the given instance was actually used by inspecting its sockets property.

On a side note, this is my first contribution to the project. Would appreciate feedback :)

Checklist

make -j4 test (UNIX), or vcbuild test (Windows) passes
tests and/or benchmarks are included
commit message follows commit guidelines

Overriding `require('http[s]').globalAgent` is now respected by consequent requests. In order to achieve that, the following changes were made: 1. Implmentation in `http`: `module.exports.globalAgent` is now defined through `Object.defineProperty`. Its getter and setter return \ set `require('_http_agent').globalAgent`. 2. Implementation in `https`: the https `globalAgent` is not the same as `_http_agent`, and is defined in `https` module itself. Therefore, the fix here was to simply use `module.exports.globalAgent` to support mutation. 3. According tests were added for both `http` and `https`, where in both we create a server, set the default agent to a newly created instance and make a request to that server. We then assert that the given instance was actually used by inspecting its sockets property. Fixes: nodejs#23281

Trott · 2018-12-23T11:24:21Z

CI: https://ci.nodejs.org/job/node-test-pull-request/19759/

Trott · 2018-12-23T11:24:28Z

Will this require updates to the docs?

illBeRoy · 2018-12-23T12:23:21Z

Hey @Trott,

I believe that the way it worked up until now was a bug, because one could expect reassigning to http[s] globalAgent would work much like mutating it, which currently works. The inconsistent behavior, where mutating is possible but overriding is not, was the result of destructuring in both modules, and that is what I attended to :)

That's why I don't think a change to the docs is required - as far as I can see, they simply state that the globalAgent is the default agent for all requests (in both HTTP and HTTPS).

Then again - if you deem it required, I'll be more than happy update my PR :)

Trott · 2018-12-23T17:20:28Z

Resume Build CI: https://ci.nodejs.org/job/node-test-pull-request/19764/

Trott · 2018-12-23T20:59:58Z

Resume Build CI again: https://ci.nodejs.org/job/node-test-pull-request/19768/ ✔️

Trott · 2018-12-23T23:36:52Z

@nodejs/http

illBeRoy · 2019-01-07T12:06:50Z

Hey again :) I'm not quite sure about the process, but since it's approved, is there anything else for me to do? how do I know if it was merged? Thanks!

addaleax · 2019-01-07T23:10:56Z

@illBeRoy Pinging us is the exact right thing to do. :)

Landed in 5774688, and congratulations to your first contribution! 🎉

Overriding `require('http[s]').globalAgent` is now respected by consequent requests. In order to achieve that, the following changes were made: 1. Implmentation in `http`: `module.exports.globalAgent` is now defined through `Object.defineProperty`. Its getter and setter return \ set `require('_http_agent').globalAgent`. 2. Implementation in `https`: the https `globalAgent` is not the same as `_http_agent`, and is defined in `https` module itself. Therefore, the fix here was to simply use `module.exports.globalAgent` to support mutation. 3. According tests were added for both `http` and `https`, where in both we create a server, set the default agent to a newly created instance and make a request to that server. We then assert that the given instance was actually used by inspecting its sockets property. Fixes: #23281 PR-URL: #25170 Reviewed-By: James M Snell <jasnell@gmail.com>

Overriding `require('http[s]').globalAgent` is now respected by consequent requests. In order to achieve that, the following changes were made: 1. Implmentation in `http`: `module.exports.globalAgent` is now defined through `Object.defineProperty`. Its getter and setter return \ set `require('_http_agent').globalAgent`. 2. Implementation in `https`: the https `globalAgent` is not the same as `_http_agent`, and is defined in `https` module itself. Therefore, the fix here was to simply use `module.exports.globalAgent` to support mutation. 3. According tests were added for both `http` and `https`, where in both we create a server, set the default agent to a newly created instance and make a request to that server. We then assert that the given instance was actually used by inspecting its sockets property. Fixes: nodejs#23281 PR-URL: nodejs#25170 Reviewed-By: James M Snell <jasnell@gmail.com>

Notable Changes * compression / zlib: * Added brotli support (Anna Henningsen and Zach Vacura) nodejs#24938 * console: * Added `inspectOptions` option (Ruben Bridgewater) nodejs#24978 * crypto: * Always accept private keys as public keys (Tobias Nießen) nodejs#25217 * deps: * Upgrade npm to v6.5.0 (Jordan Harband) nodejs#25234 * fs: * Use internalBinding('fs') internally instead of process.binding('fs') (Masashi Hirano) nodejs#22478 * http(s): * Support overriding http\\s.globalAgent (Roy Sommer) nodejs#25170 * util: * Inspect ArrayBuffers contents closely (Ruben Bridgewater) nodejs#25006 * worker: * Expose workers by default and remove `--experimental-worker` flag (Anna Henningsen) nodejs#25361 PR-URL: nodejs#25537

Notable Changes * compression / zlib: * Added brotli support (Anna Henningsen and Zach Vacura) #24938 * console: * Added `inspectOptions` option (Ruben Bridgewater) #24978 * crypto: * Always accept private keys as public keys (Tobias Nießen) #25217 * deps: * Upgrade npm to v6.5.0 (Jordan Harband) #25234 * fs: * Use internalBinding('fs') internally instead of process.binding('fs') (Masashi Hirano) #22478 * http(s): * Support overriding http\\s.globalAgent (Roy Sommer) #25170 * util: * Inspect ArrayBuffers contents closely (Ruben Bridgewater) #25006 * worker: * Expose workers by default and remove `--experimental-worker` flag (Anna Henningsen) #25361 PR-URL: #25537

Overriding `require('http[s]').globalAgent` is now respected by consequent requests. In order to achieve that, the following changes were made: 1. Implmentation in `http`: `module.exports.globalAgent` is now defined through `Object.defineProperty`. Its getter and setter return \ set `require('_http_agent').globalAgent`. 2. Implementation in `https`: the https `globalAgent` is not the same as `_http_agent`, and is defined in `https` module itself. Therefore, the fix here was to simply use `module.exports.globalAgent` to support mutation. 3. According tests were added for both `http` and `https`, where in both we create a server, set the default agent to a newly created instance and make a request to that server. We then assert that the given instance was actually used by inspecting its sockets property. Fixes: #23281 PR-URL: #25170 Reviewed-By: James M Snell <jasnell@gmail.com>

Under ECMAScript modules when you do "import * as https from 'https'" you get a new object with properties copied from https module exports. So if this is a regular data property, you will just override a copy, but if this would be a accessor property, we can still access the actual https.globalAgent. Refs: nodejs#25170, nodejs#9386

nodejs-github-bot added http Issues or PRs related to the http subsystem. https Issues or PRs related to the https subsystem. labels Dec 21, 2018

illBeRoy force-pushed the fix/overridable-http-https-global-agent branch from 23a222e to 633e0fe Compare December 21, 2018 20:13

illBeRoy mentioned this pull request Dec 21, 2018

Can we restart the work on overridable globalAgent? #23281

Closed

jasnell added the semver-minor PRs that contain new features and should be released in the next minor version. label Dec 27, 2018

jasnell approved these changes Dec 27, 2018

View reviewed changes

addaleax closed this Jan 7, 2019

BridgeAR mentioned this pull request Jan 16, 2019

v11.7.0 proposal #25537

Merged

MylesBorins mentioned this pull request Jan 24, 2019

v11.8.0 proposal #25687

Merged

This was referenced Mar 16, 2019

HTTP and HTTPS agent node-fetch/node-fetch#588

Closed

Cross-protocol redirect reuses same agent, but for instance http.Agent doesn't support followed https request node-fetch/node-fetch#571

Closed

BethGriggs mentioned this pull request May 1, 2019

v10.16.0 proposal #27514

Merged

ktrongnhan mentioned this pull request May 26, 2019

Node 10.8.0 does not support lookup on Agent #27695

Closed

whut mentioned this pull request Jul 17, 2023

https: make https.globalAgent overridable also under ECMAScript Modules #48808

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

lib: support overriding http\s.globalAgent #25170

lib: support overriding http\s.globalAgent #25170

illBeRoy commented Dec 21, 2018

Trott commented Dec 23, 2018

Trott commented Dec 23, 2018

illBeRoy commented Dec 23, 2018 •

edited

Loading

Trott commented Dec 23, 2018

Trott commented Dec 23, 2018 •

edited

Loading

Trott commented Dec 23, 2018

illBeRoy commented Jan 7, 2019

addaleax commented Jan 7, 2019 •

edited

Loading

lib: support overriding http\s.globalAgent #25170

lib: support overriding http\s.globalAgent #25170

Conversation

illBeRoy commented Dec 21, 2018

Checklist

Trott commented Dec 23, 2018

Trott commented Dec 23, 2018

illBeRoy commented Dec 23, 2018 • edited Loading

Trott commented Dec 23, 2018

Trott commented Dec 23, 2018 • edited Loading

Trott commented Dec 23, 2018

illBeRoy commented Jan 7, 2019

addaleax commented Jan 7, 2019 • edited Loading

illBeRoy commented Dec 23, 2018 •

edited

Loading

Trott commented Dec 23, 2018 •

edited

Loading

addaleax commented Jan 7, 2019 •

edited

Loading