Use URL rather than url.parse() in pg-connection-string

Swapping the deprecated Node.js API for the modern cross
environment API.

Author: petebacondarwin

packages/pg-connection-string/index.js

@@ -1,8 +1,5 @@
 'use strict'
 
-var url = require('url')
-var fs = require('fs')
-
 //Parse method copied from https://github.com/brianc/node-postgres
 //Copyright (c) 2010-2014 Brian Carlson ([email protected])
 //MIT License
@@ -11,51 +8,53 @@ var fs = require('fs')
 function parse(str) {
   //unix socket
   if (str.charAt(0) === '/') {
-    var config = str.split(' ')
+    const config = str.split(' ')
     return { host: config[0], database: config[1] }
   }
 
-  // url parse expects spaces encoded as %20
-  var result = url.parse(
-    / |%[^a-f0-9]|%[a-f0-9][^a-f0-9]/i.test(str) ? encodeURI(str).replace(/\%25(\d\d)/g, '%$1') : str,
-    true
-  )
-  var config = result.query
-  for (var k in config) {
-    if (Array.isArray(config[k])) {
-      config[k] = config[k][config[k].length - 1]
-    }
+  // Check for empty host in URL
+
+  const config = {}
+  let result
+  let dummyHost = false
+  if (/ |%[^a-f0-9]|%[a-f0-9][^a-f0-9]/i.test(str)) {
+    // Ensure spaces are encoded as %20
+    str = encodeURI(str).replace(/\%25(\d\d)/g, '%$1')
+  }
+
+  try {
+    result = new URL(str, 'postgres://base')
+  } catch (e) {
+    // The URL is invalid so try again with a dummy host
+    result = new URL(str.replace('@/', '@___DUMMY___/'), 'postgres://base')
+    dummyHost = true
   }
 
-  var auth = (result.auth || ':').split(':')
-  config.user = auth[0]
-  config.password = auth.splice(1).join(':')
+  // We'd like to use Object.fromEntries() here but Node.js 10 does not support it
+  for (const entry of result.searchParams.entries()) {
+    config[entry[0]] = entry[1]
+  }
+
+  config.user = config.user || decodeURIComponent(result.username)
+  config.password = config.password || decodeURIComponent(result.password)
 
   config.port = result.port
   if (result.protocol == 'socket:') {
     config.host = decodeURI(result.pathname)
-    config.database = result.query.db
-    config.client_encoding = result.query.encoding
+    config.database = result.searchParams.get('db')
+    config.client_encoding = result.searchParams.get('encoding')
     return config
   }
+  const hostname = dummyHost ? '' : result.hostname
   if (!config.host) {
     // Only set the host if there is no equivalent query param.
-    config.host = result.hostname
+    config.host = decodeURIComponent(hostname)
+  } else if (hostname) {
+    result.pathname = hostname + result.pathname
   }
 
-  // If the host is missing it might be a URL-encoded path to a socket.
-  var pathname = result.pathname
-  if (!config.host && pathname && /^%2f/i.test(pathname)) {
-    var pathnameSplit = pathname.split('/')
-    config.host = decodeURIComponent(pathnameSplit[0])
-    pathname = pathnameSplit.splice(1).join('/')
-  }
-  // result.pathname is not always guaranteed to have a '/' prefix (e.g. relative urls)
-  // only strip the slash if it is present.
-  if (pathname && pathname.charAt(0) === '/') {
-    pathname = pathname.slice(1) || null
-  }
-  config.database = pathname && decodeURI(pathname)
+  const pathname = result.pathname.slice(1) || null
+  config.database = pathname ? decodeURI(pathname) : null
 
   if (config.ssl === 'true' || config.ssl === '1') {
     config.ssl = true
@@ -69,6 +68,9 @@ function parse(str) {
     config.ssl = {}
   }
 
+  // Only try to load fs if we expect to read from the disk
+  const fs = config.sslcert || config.sslkey || config.sslrootcert ? require('fs') : null
+
   if (config.sslcert) {
     config.ssl.cert = fs.readFileSync(config.sslcert).toString()
   }

packages/pg-connection-string/test/parse.js

@@ -168,7 +168,7 @@ describe('parse', function () {
     subject.database.should.equal('%2Fdbname')
   })
 
-  it('configuration parameter host treats encoded socket as part of the db name', function () {
+  it('configuration parameter host treats encoded host as part of the db name', function () {
     var subject = parse('pg://user:pass@%2Funix%2Fsocket/dbname?host=localhost')
     subject.user.should.equal('user')
     subject.password.should.equal('pass')

packages/pg/lib/connection.js

@@ -92,7 +92,8 @@ class Connection extends EventEmitter {
         }
       }
 
-      if (net.isIP(host) === 0) {
+      var net = require('net')
+      if (net.isIP && net.isIP(host) === 0) {
         options.servername = host
       }
       try {