Deprecate url.parse API in favor of URL constructor

index.js

@@ -1,18 +1,19 @@
 'use strict'
 
-const parseUrl = require('url').parse
+const PROTOCOL_PLACEHOLDER = 'protocol-placeholder:'
+const { URL, parse } = require('url')
 const parseForwarded = require('forwarded-parse')
 const net = require('net')
 
 module.exports = function (req) {
   const raw = req.originalUrl || req.url
-  const url = parseUrl(raw || '')
+  const url = parsePartialURL(raw)
   const secure = req.secure || (req.connection && req.connection.encrypted)
   const result = { raw: raw }
-  let host
+  let host, forwarded
 
   if (req.headers.forwarded) {
-    let forwarded = getFirstHeader(req, 'forwarded')
+    forwarded = getFirstHeader(req, 'forwarded')
     try {
       // Always choose the original (first) Forwarded pair in case the request
       // passed through multiple proxies
@@ -23,7 +24,6 @@ module.exports = function (req) {
         const port = conn[conn.length - 1].split(':')[1]
         if (port) host.port = Number(port)
       }
-      if (forwarded.proto) host.protocol = forwarded.proto + ':'
     } catch (e) {}
   } else if (req.headers['x-forwarded-host']) {
     host = parsePartialURL(getFirstHeader(req, 'x-forwarded-host'))
@@ -38,13 +38,14 @@ module.exports = function (req) {
   }
 
   // protocol
-  if (url.protocol) result.protocol = url.protocol
+  if (url.protocol !== PROTOCOL_PLACEHOLDER) result.protocol = url.protocol
   else if (req.headers['x-forwarded-proto']) result.protocol = getFirstHeader(req, 'x-forwarded-proto') + ':'
   else if (req.headers['x-forwarded-protocol']) result.protocol = getFirstHeader(req, 'x-forwarded-protocol') + ':'
   else if (req.headers['x-url-scheme']) result.protocol = getFirstHeader(req, 'x-url-scheme') + ':'
   else if (req.headers['front-end-https']) result.protocol = getFirstHeader(req, 'front-end-https') === 'on' ? 'https:' : 'http:'
   else if (req.headers['x-forwarded-ssl']) result.protocol = getFirstHeader(req, 'x-forwarded-ssl') === 'on' ? 'https:' : 'http:'
-  else if (host.protocol) result.protocol = host.protocol
+  else if (forwarded && forwarded.proto) result.protocol = forwarded.proto + ':'
+  else if (host.protocol && host.protocol !== PROTOCOL_PLACEHOLDER) result.protocol = host.protocol
   else if (secure) result.protocol = 'https:'
   else result.protocol = 'http:'
 
@@ -92,7 +93,10 @@ function getFirstHeader (req, header) {
 
 function parsePartialURL (url) {
   const containsProtocol = url.indexOf('://') !== -1
-  const result = parseUrl(containsProtocol ? url : 'invalid://' + url)
-  if (!containsProtocol) result.protocol = ''
-  return result
+  const urlToParse = containsProtocol ? url : PROTOCOL_PLACEHOLDER + '//' + url
+  try {
+    return new URL(urlToParse)
+  } catch (e) {
+    return parse(urlToParse)
+  }
 }

test.js

@@ -22,6 +22,34 @@ test('http - root, no special http headers', function (t) {
   })
 })
 
+test('http - double slash, no special http headers', function (t) {
+  t.plan(1)
+  http({path: '//some/path'}, function (result, port) {
+    t.deepEqual(result, {
+      protocol: 'http:',
+      hostname: 'localhost',
+      port: port,
+      pathname: '//some/path',
+      full: 'http://localhost:' + port + '//some/path',
+      raw: '//some/path'
+    })
+  })
+})
+
+test('http - auth like, no special http headers', function (t) {
+  t.plan(1)
+  http({path: '//user@pass'}, function (result, port) {
+    t.deepEqual(result, {
+      protocol: 'http:',
+      hostname: 'localhost',
+      port: port,
+      pathname: '//user@pass',
+      full: 'http://localhost:' + port + '//user@pass',
+      raw: '//user@pass'
+    })
+  })
+})
+
 test('http - path, no special http headers', function (t) {
   t.plan(1)
   http({path: '/some/path'}, function (result, port) {
@@ -115,6 +143,34 @@ test('https - path, no special http headers', function (t) {
   })
 })
 
+test('http - double slash, no special http headers', function (t) {
+  t.plan(1)
+  https({path: '//some/path'}, function (result, port) {
+    t.deepEqual(result, {
+      protocol: 'https:',
+      hostname: 'localhost',
+      port: port,
+      pathname: '//some/path',
+      full: 'https://localhost:' + port + '//some/path',
+      raw: '//some/path'
+    })
+  })
+})
+
+test('http - auth like, no special http headers', function (t) {
+  t.plan(1)
+  https({path: '//user@pass'}, function (result, port) {
+    t.deepEqual(result, {
+      protocol: 'https:',
+      hostname: 'localhost',
+      port: port,
+      pathname: '//user@pass',
+      full: 'https://localhost:' + port + '//user@pass',
+      raw: '//user@pass'
+    })
+  })
+})
+
 test('https - path+query params, no special http headers', function (t) {
   t.plan(1)
   https({path: '/some/path?key=value'}, function (result, port) {
@@ -691,6 +747,15 @@ test('No Host header', function (t) {
   t.end()
 })
 
+test('Weird auth string', function (t) {
+  const mockReq = {url: '@@', headers: {}, connection: {}}
+  t.deepEqual(originalUrl(mockReq), {
+    protocol: 'http:',
+    raw: '@@'
+  })
+  t.end()
+})
+
 /**
  * Utils
  */