Skip to content

Commit 306d230

Browse files
aduh95RafaelGSS
authored andcommitted
url: allow extension of user provided URL objects
PR-URL: #46989 Fixes: #46981 Reviewed-By: Yagiz Nizipli <[email protected]>
1 parent 5938a52 commit 306d230

File tree

3 files changed

+51
-13
lines changed

3 files changed

+51
-13
lines changed

doc/api/url.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1226,6 +1226,11 @@ pathToFileURL('/some/path%.c'); // Correct: file:///some/path%25.c (POSI
12261226
added:
12271227
- v15.7.0
12281228
- v14.18.0
1229+
changes:
1230+
- version: REPLACEME
1231+
pr-url: https://github.com/nodejs/node/pull/46989
1232+
description: The returned object will also contain all the own enumerable
1233+
properties of the `url` argument.
12291234
-->
12301235
12311236
* `url` {URL} The [WHATWG URL][] object to convert to an options object.

lib/internal/url.js

Lines changed: 19 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1140,26 +1140,32 @@ function domainToUnicode(domain) {
11401140
return _domainToUnicode(`${domain}`);
11411141
}
11421142

1143-
// Utility function that converts a URL object into an ordinary
1144-
// options object as expected by the http.request and https.request
1145-
// APIs.
1143+
/**
1144+
* Utility function that converts a URL object into an ordinary options object
1145+
* as expected by the `http.request` and `https.request` APIs.
1146+
* @param {URL} url
1147+
* @returns {Record<string, unknown>}
1148+
*/
11461149
function urlToHttpOptions(url) {
1150+
const { hostname, pathname, port, username, password, search } = url;
11471151
const options = {
1152+
__proto__: null,
1153+
...url, // In case the url object was extended by the user.
11481154
protocol: url.protocol,
1149-
hostname: url.hostname && StringPrototypeStartsWith(url.hostname, '[') ?
1150-
StringPrototypeSlice(url.hostname, 1, -1) :
1151-
url.hostname,
1155+
hostname: hostname && StringPrototypeStartsWith(hostname, '[') ?
1156+
StringPrototypeSlice(hostname, 1, -1) :
1157+
hostname,
11521158
hash: url.hash,
1153-
search: url.search,
1154-
pathname: url.pathname,
1155-
path: `${url.pathname || ''}${url.search || ''}`,
1159+
search: search,
1160+
pathname: pathname,
1161+
path: `${pathname || ''}${search || ''}`,
11561162
href: url.href,
11571163
};
1158-
if (url.port !== '') {
1159-
options.port = Number(url.port);
1164+
if (port !== '') {
1165+
options.port = Number(port);
11601166
}
1161-
if (url.username || url.password) {
1162-
options.auth = `${decodeURIComponent(url.username)}:${decodeURIComponent(url.password)}`;
1167+
if (username || password) {
1168+
options.auth = `${decodeURIComponent(username)}:${decodeURIComponent(password)}`;
11631169
}
11641170
return options;
11651171
}
Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
'use strict';
2+
3+
const common = require('../common');
4+
const assert = require('node:assert');
5+
const http = require('node:http');
6+
7+
const headers = { foo: 'Bar' };
8+
const server = http.createServer(common.mustCall((req, res) => {
9+
assert.strictEqual(req.url, '/ping?q=term');
10+
assert.strictEqual(req.headers?.foo, headers.foo);
11+
req.resume();
12+
req.on('end', () => {
13+
res.writeHead(200);
14+
res.end('pong');
15+
});
16+
}));
17+
18+
server.listen(0, common.localhostIPv4, () => {
19+
const { address, port } = server.address();
20+
const url = new URL(`http://${address}:${port}/ping?q=term`);
21+
url.headers = headers;
22+
const clientReq = http.request(url);
23+
clientReq.on('close', common.mustCall(() => {
24+
server.close();
25+
}));
26+
clientReq.end();
27+
});

0 commit comments

Comments
 (0)