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.

Sign up for GitHub

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

Jump to bottom

url: allow use of URL with http.request and https.request #10638

Closed
wants to merge 2 commits into from
Closed

url: allow use of URL with http.request and https.request #10638

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ce4e718
url: allow use of URL with http.request and https.request
jasnell Jan 5, 2017
02b136d
Improvements
jasnell Jan 6, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 3 additions & 1 deletion lib/_http_client.js
View file
Open in desktop
Expand Up @@ -13,7 +13,7 @@ const debug = common.debug;
const OutgoingMessage = require('_http_outgoing').OutgoingMessage;
const Agent = require('_http_agent');
const Buffer = require('buffer').Buffer;

const urlToOptions = require('internal/url').urlToOptions;

function ClientRequest(options, cb) {
var self = this;
Expand All @@ -24,6 +24,8 @@ function ClientRequest(options, cb) {
if (!options.hostname) {
throw new Error('Unable to determine the domain name');
}
} else if (options instanceof url.URL) {
Copy link
Member

Choose a reason for hiding this comment

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

If I understand correctly this makes using the new URL api and using additional options(like agent) mutual exclusive?

Copy link
Member

Choose a reason for hiding this comment

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

True, but that's already the case if you pass the URL as a string or the result of url.parse. We can think later about a way to pass a URL object along with additional options but I don't think it should block this PR.

Copy link
Member

Choose a reason for hiding this comment

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

Ah I should have make this one a comment, not a change request :/ Sorry.

Copy link
Member

Choose a reason for hiding this comment

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

No worries!

Copy link
Member Author

Choose a reason for hiding this comment

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

Yes, making those mutually exclusive is intentional. Attaching additional non-standard properties to the URL object is not something that we should promote. And as @targos points out, that is already the case when passing the URL as a string.

options = urlToOptions(options);
} else {
options = util._extend({}, options);
}
Expand Down
3 changes: 3 additions & 0 deletions lib/https.js
View file
Open in desktop
Expand Up @@ -8,6 +8,7 @@ const http = require('http');
const util = require('util');
const inherits = util.inherits;
const debug = util.debuglog('https');
const urlToOptions = require('internal/url').urlToOptions;

function Server(opts, requestListener) {
if (!(this instanceof Server)) return new Server(opts, requestListener);
Expand Down Expand Up @@ -192,6 +193,8 @@ exports.request = function request(options, cb) {
if (!options.hostname) {
throw new Error('Unable to determine the domain name');
}
} else if (options instanceof url.URL) {
options = urlToOptions(options);
} else {
options = util._extend({}, options);
}
Expand Down
24 changes: 24 additions & 0 deletions lib/internal/url.js
View file
Open in desktop
Expand Up @@ -908,8 +908,32 @@ function domainToUnicode(domain) {
return binding.domainToUnicode(String(domain));
}

// Utility function that converts a URL object into an ordinary
// options object as expected by the http.request and https.request
// APIs.
function urlToOptions(url) {
var options = {
protocol: url.protocol,
host: url.host,
hostname: url.hostname,
hash: url.hash,
search: url.search,
pathname: url.pathname,
path: `${url.pathname}${url.search}`,
href: url.href
};
if (url.port !== '') {
options.port = Number(url.port);
}
if (url.username || url.password) {
options.auth = `${url.username}:${url.password}`;
Copy link

Choose a reason for hiding this comment

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

This doesn't support new URL("http://0:0@hostname/")

}
return options;
}

exports.URL = URL;
exports.originFor = originFor;
exports.domainToASCII = domainToASCII;
exports.domainToUnicode = domainToUnicode;
exports.encodeAuth = encodeAuth;
exports.urlToOptions = urlToOptions;
9 changes: 7 additions & 2 deletions test/parallel/test-http-client-get-url.js
View file
Open in desktop
Expand Up @@ -2,6 +2,8 @@
const common = require('../common');
const assert = require('assert');
const http = require('http');
const url = require('url');
const URL = url.URL;

var server = http.createServer(common.mustCall(function(req, res) {
assert.equal('GET', req.method);
Expand All @@ -10,8 +12,11 @@ var server = http.createServer(common.mustCall(function(req, res) {
res.write('hello\n');
res.end();
server.close();
}));
}, 3));

server.listen(0, function() {
http.get(`http://127.0.0.1:${this.address().port}/foo?bar`);
const u = `http://127.0.0.1:${this.address().port}/foo?bar`;
http.get(u);
http.get(url.parse(u));
http.get(new URL(u));
});
9 changes: 7 additions & 2 deletions test/parallel/test-https-client-get-url.js
View file
Open in desktop
Expand Up @@ -12,6 +12,8 @@ if (!common.hasCrypto) {
const https = require('https');

const fs = require('fs');
const url = require('url');
const URL = url.URL;

var options = {
key: fs.readFileSync(common.fixturesDir + '/keys/agent1-key.pem'),
Expand All @@ -25,8 +27,11 @@ var server = https.createServer(options, common.mustCall(function(req, res) {
res.write('hello\n');
res.end();
server.close();
}));
}, 3));

server.listen(0, function() {
https.get(`https://127.0.0.1:${this.address().port}/foo?bar`);
const u = `https://127.0.0.1:${this.address().port}/foo?bar`;
https.get(u);
https.get(url.parse(u));
https.get(new URL(u));
});
17 changes: 17 additions & 0 deletions test/parallel/test-whatwg-url-properties.js
View file
Open in desktop
@@ -1,9 +1,11 @@
// Flags: --expose-internals
'use strict';

require('../common');

const URL = require('url').URL;
const assert = require('assert');
const urlToOptions = require('internal/url').urlToOptions;
Copy link
Member

Choose a reason for hiding this comment

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

Maybe this one deserves a separate test? The name of this test doesn't really match this API here.

Copy link
Member Author

Choose a reason for hiding this comment

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

I'm not convinced that it matters too much either way, but there's no harm in separating it out.


const url = new URL('http://user:pass@foo.bar.com:21/aaa/zzz?l=24#test');
const oldParams = url.searchParams; // for test of [SameObject]
Expand Down Expand Up @@ -125,3 +127,18 @@ assert.strictEqual(url.toString(),
'https://user2:pass2@foo.bar.org:23/aaa/bbb?k=99#abcd');
assert.strictEqual((delete url.searchParams), true);
assert.strictEqual(url.searchParams, oldParams);

// Test urlToOptions
{
const opts =
urlToOptions(new URL('http://user:pass@foo.bar.com:21/aaa/zzz?l=24#test'));
assert.strictEqual(opts instanceof URL, false);
assert.strictEqual(opts.protocol, 'http:');
assert.strictEqual(opts.auth, 'user:pass');
assert.strictEqual(opts.hostname, 'foo.bar.com');
assert.strictEqual(opts.port, 21);
assert.strictEqual(opts.path, '/aaa/zzz?l=24');
assert.strictEqual(opts.pathname, '/aaa/zzz');
assert.strictEqual(opts.search, '?l=24');
assert.strictEqual(opts.hash, '#test');
}