Skip to content
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

http: throw an error for unexpected agent values #10053

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 10 additions & 3 deletions lib/_http_client.js
Original file line number Diff line number Diff line change
Expand Up @@ -62,9 +62,16 @@ function ClientRequest(options, cb) {
var defaultAgent = options._defaultAgent || Agent.globalAgent;
if (agent === false) {
agent = new defaultAgent.constructor();
} else if ((agent === null || agent === undefined) &&
typeof options.createConnection !== 'function') {
agent = defaultAgent;
} else if (agent === null || agent === undefined) {
if (typeof options.createConnection !== 'function') {
agent = defaultAgent;
}
// Explicitly pass through this statement as agent will not be used
// when createConnection is provided.
} else if (!(agent instanceof Agent.Agent)) {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How about userland Agent? Those Agent Class maybe not inherits from Agent.Agent and now will be all fails to use them. e.g.: TunnelingAgent https://github.com/request/tunnel-agent/blob/master/index.js#L47

throw new TypeError(
'Agent option must be an instance of http.Agent, undefined or false.'
);
}
self.agent = agent;

Expand Down
64 changes: 64 additions & 0 deletions test/parallel/test-http-client-reject-unexpected-agent.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
'use strict';
const common = require('../common');
const assert = require('assert');
const http = require('http');

const baseOptions = {
method: 'GET',
port: undefined,
host: common.localhostIPv4,
};

const failingAgentOptions = [
true,
'agent',
{},
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

would be good to inject a couple other js types here: Function, Number, Symbol

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

added those types

1,
() => null,
Symbol(),
];

const acceptableAgentOptions = [
false,
undefined,
null,
new http.Agent(),
];

const server = http.createServer((req, res) => {
res.end('hello');
});

let numberOfResponses = 0;
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you add a process.on('exit', () => assert.strictEqual(numberOfResponses, acceptableAgentOptions.length))?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the numberOfResponses is really only used to close the server. The callback for the .on('response') listener is wrapped in common.mustCall() and that is called once per request, so if any fail the whole thing should fail. Is that acceptable or do we need to also count the responses on exit?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

'Need' is too big a word but it's a cheap extra sanity check.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Understood. Added this check to the test file. Thanks!


function createRequest(agent) {
const options = Object.assign(baseOptions, {agent});
const request = http.request(options);
request.end();
request.on('response', common.mustCall(() => {
numberOfResponses++;
if (numberOfResponses === acceptableAgentOptions.length) {
server.close();
}
}));
}

server.listen(0, baseOptions.host, common.mustCall(function() {
baseOptions.port = this.address().port;

failingAgentOptions.forEach((agent) => {
assert.throws(
() => createRequest(agent),
/^TypeError: Agent option must be an instance of http.Agent/,
`Expected typeof agent: ${typeof agent} to be rejected`
);
});

acceptableAgentOptions.forEach((agent) => {
assert.doesNotThrow(() => createRequest(agent));
});
}));

process.on('exit', () => {
assert.strictEqual(numberOfResponses, acceptableAgentOptions.length);
});