http: allow url and options to be passed to http*.request and http*.get

Fixes: #20795 PR-URL: #21616 Reviewed-By: Tiancheng "Timothy" Gu <[email protected]> Reviewed-By: Ron Korving <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Matteo Collina <[email protected]> Backport-PR-URL: #21880 Reviewed-By: Trivikram Kamat <[email protected]> Reviewed-By: Rich Trott <[email protected]> Reviewed-By: Matteo Collina <[email protected]>

Author: rubys

doc/api/http.md

@@ -1794,15 +1794,20 @@ The `requestListener` is a function which is automatically
 added to the [`'request'`][] event.
 
 ## http.get(options[, callback])
+## http.get(url[, options][, callback])
 <!-- YAML
 added: v0.3.6
 changes:
+ - version: REPLACEME
+ pr-url: https://github.com/nodejs/node/pull/21616
+ description: allow both url and options to be passed to `http.get()`
  - version: v7.5.0
  pr-url: https://github.com/nodejs/node/pull/10638
  description: The `options` parameter can be a WHATWG `URL` object.
 -->
 
-*`options`{Object | string | URL} Accepts the same `options` as
+*`url`{string | URL}
+*`options`{Object} Accepts the same `options` as
 [`http.request()`][], with the `method` always set to `GET`.
  Properties that are inherited from the prototype are ignored.
 *`callback`{Function}
@@ -1866,15 +1871,20 @@ Global instance of `Agent` which is used as the default for all HTTP client
 requests.
 
 ## http.request(options[, callback])
+## http.request(url[, options][, callback])
 <!-- YAML
 added: v0.3.6
 changes:
+ - version: REPLACEME
+ pr-url: https://github.com/nodejs/node/pull/21616
+ description: allow both url and options to be passed to `http.request()`
  - version: v7.5.0
  pr-url: https://github.com/nodejs/node/pull/10638
  description: The `options` parameter can be a WHATWG `URL` object.
 -->
 
-*`options`{Object | string | URL}
+*`url`{string | URL}
+*`options`{Object}
 *`protocol`{string} Protocol to use. **Default:**`'http:'`.
 *`host`{string} A domain name or IP address of the server to issue the
  request to. **Default:**`'localhost'`.
@@ -1916,10 +1926,13 @@ changes:
 Node.js maintains several connections per server to make HTTP requests.
 This function allows one to transparently issue requests.
 
-`options` can be an object, a string, or a [`URL`][] object. If `options` is a
+`url` can be a string or a [`URL`][] object. If `url` is a
 string, it is automatically parsed with [`url.parse()`][]. If it is a [`URL`][]
 object, it will be automatically converted to an ordinary `options` object.
 
+If both `url` and `options` are specified, the objects are merged, with the
+`options` properties taking precedence.
+
 The optional `callback` parameter will be added as a one-time listener for
 the [`'response'`][] event.
 

doc/api/https.md

@@ -112,14 +112,19 @@ https.createServer(options, (req, res) =>{
 ```
 
 ## https.get(options[, callback])
+## https.get(url[, options][, callback])
 <!-- YAML
 added: v0.3.6
 changes:
+ - version: REPLACEME
+ pr-url: https://github.com/nodejs/node/pull/21616
+ description: allow both url and options to be passed to `https.get()`
  - version: v7.5.0
  pr-url: https://github.com/nodejs/node/pull/10638
  description: The `options` parameter can be a WHATWG `URL` object.
 -->
--`options`{Object | string | URL} Accepts the same `options` as
+-`url`{string | URL}
+-`options`{Object} Accepts the same `options` as
 [`https.request()`][], with the `method` always set to `GET`.
 -`callback`{Function}
 
@@ -155,17 +160,22 @@ added: v0.5.9
 Global instance of [`https.Agent`][] for all HTTPS client requests.
 
 ## https.request(options[, callback])
+## https.request(url[, options][, callback])
 <!-- YAML
 added: v0.3.6
 changes:
+ - version: REPLACEME
+ pr-url: https://github.com/nodejs/node/pull/21616
+ description: allow both url and options to be passed to `https.request()`
  - version: v9.3.0
  pr-url: https://github.com/nodejs/node/pull/14903
  description: The `options` parameter can now include `clientCertEngine`.
  - version: v7.5.0
  pr-url: https://github.com/nodejs/node/pull/10638
  description: The `options` parameter can be a WHATWG `URL` object.
 -->
--`options`{Object | string | URL} Accepts all `options` from
+-`url`{string | URL}
+-`options`{Object} Accepts all `options` from
 [`http.request()`][], with some differences in default values:
 -`protocol`**Default:**`'https:'`
 -`port`**Default:**`443`

lib/_http_client.js

@@ -60,22 +60,31 @@ function validateHost(host, name){
 returnhost;
 }
 
-functionClientRequest(options,cb){
+functionClientRequest(input,options,cb){
 OutgoingMessage.call(this);
 
-if(typeofoptions==='string'){
-options=url.parse(options);
-if(!options.hostname){
+if(typeofinput==='string'){
+input=url.parse(input);
+if(!input.hostname){
 thrownewERR_INVALID_DOMAIN_NAME();
 }
-}elseif(options&&options[searchParamsSymbol]&&
-options[searchParamsSymbol][searchParamsSymbol]){
+}elseif(input&&input[searchParamsSymbol]&&
+input[searchParamsSymbol][searchParamsSymbol]){
 // url.URL instance
-options=urlToOptions(options);
+input=urlToOptions(input);
 }else{
-options=util._extend({},options);
+cb=options;
+options=input;
+input=null;
 }
 
+if(typeofoptions==='function'){
+cb=options;
+options=null;
+}
+
+options=util._extend(input||{},options||{});
+
 varagent=options.agent;
 vardefaultAgent=options._defaultAgent||Agent.globalAgent;
 if(agent===false){

lib/http.js

@@ -37,12 +37,12 @@ function createServer(opts, requestListener){
 returnnewServer(opts,requestListener);
 }
 
-functionrequest(options,cb){
-returnnewClientRequest(options,cb);
+functionrequest(url,options,cb){
+returnnewClientRequest(url,options,cb);
 }
 
-functionget(options,cb){
-varreq=request(options,cb);
+functionget(url,options,cb){
+varreq=request(url,options,cb);
 req.end();
 returnreq;
 }

test/parallel/test-http-request-arguments.js

@@ -0,0 +1,28 @@
+'use strict';
+constcommon=require('../common');
+constassert=require('assert');
+consthttp=require('http');
+
+// Test providing both a url and options, with the options partially
+// replacing address and port portions of the URL provided.
+{
+constserver=http.createServer(
+common.mustCall((req,res)=>{
+assert.strictEqual(req.url,'/testpath');
+res.end();
+server.close();
+})
+);
+server.listen(
+0,
+common.mustCall(()=>{
+http.get(
+'http://example.com/testpath',
+{hostname: 'localhost',port: server.address().port},
+common.mustCall((res)=>{
+res.resume();
+})
+);
+})
+);
+}