fix: parseUrl utility function

Author: yuxizhe

lib/instrumentation/express-utils.js

@@ -1,8 +1,14 @@
 'use strict'
 
-var url = require('url')
-
 var symbols = require('../symbols')
+var parsers = require('../parsers')
+
+var parseUrl
+try {
+  parseUrl = require('parseurl')
+} catch (e) {
+  parseUrl = req => parsers.parseUrl(req.url)
+}
 
 function normalizeSlash (value) {
   return value[0] === '/' ? value : '/' + value
@@ -45,7 +51,7 @@ function getPathFromRequest (req, useBase, usePathAsTransactionName) {
   }
 
   if (usePathAsTransactionName) {
-    const parsed = url.URL ? new url.URL(req.url, 'relative:///') : url.parse(req.url)
+    const parsed = parseUrl(req)
     return parsed && parsed.pathname
   }
 }

lib/instrumentation/http-shared.js

@@ -4,6 +4,8 @@ var url = require('url')
 
 var endOfStream = require('end-of-stream')
 
+var parsers = require('../parsers')
+
 const transactionForResponse = new WeakMap()
 exports.transactionForResponse = transactionForResponse
 
@@ -93,14 +95,14 @@ function formatURL (item) {
     search: item.search
   }
 }
+
 // NOTE: This will also stringify and parse URL instances
 // to a format which can be mixed into the options object.
 function ensureUrl (v) {
-  if (url.URL && (v instanceof url.URL || typeof v === 'string')) {
-    const urlObj = new url.URL(v.toString(), 'relative:///')
-    return formatURL(urlObj)
-  } else if (typeof v === 'string') {
-    return url.parse(v)
+  if (typeof v === 'string') {
+    return formatURL(parsers.parseUrl(v))
+  } else if (url.URL && v instanceof url.URL) {
+    return formatURL(v)
   } else {
     return v
   }
@@ -154,7 +156,7 @@ exports.traceOutgoingRequest = function (agent, moduleName, method) {
 
       ins.bindEmitter(req)
 
-      span.name = req.method + ' ' + req._headers.host + url.parse(req.path).pathname
+      span.name = req.method + ' ' + req._headers.host + parsers.parseUrl(req.path).pathname
 
       // TODO: Research if it's possible to add this to the prototype instead.
       // Or if it's somehow preferable to listen for when a `response` listener

lib/instrumentation/modules/http2.js

@@ -1,11 +1,10 @@
 'use strict'
 
-var url = require('url')
-
 var eos = require('end-of-stream')
 
 var shimmer = require('../shimmer')
 var symbols = require('../../symbols')
+var parsers = require('../../parsers')
 
 module.exports = function (http2, agent, { enabled }) {
   if (!enabled) return http2
@@ -155,7 +154,7 @@ module.exports = function (http2, agent, { enabled }) {
 
       ins.bindEmitter(req)
 
-      var urlObj = url.URL ? new url.URL(headers[':path'], 'relative:///') : url.parse(headers[':path'])
+      var urlObj = parsers.parseUrl(headers[':path'])
       var path = urlObj.pathname
       span.name = headers[':method'] + ' ' + host + path
 

lib/parsers.js

@@ -1,6 +1,7 @@
 'use strict'
 
 var util = require('util')
+var url = require('url')
 
 var afterAll = require('after-all-results')
 var basicAuth = require('basic-auth')
@@ -215,6 +216,10 @@ exports.parseCallsite = function (callsite, isError, agent, cb) {
   })
 }
 
+exports.parseUrl = function (urlStr) {
+  return url.URL ? new url.URL(urlStr, 'relative:///') : url.parse(urlStr)
+}
+
 // Default `culprit` to the top of the stack or the highest non `library_frame`
 // frame if such exists
 function getCulprit (frames) {