http-proxy-middleware 0.19.0 → 0.19.1

package/index.js

@@ -1,5 +1,5 @@
 var HPM = require('./lib')
 
-module.exports = function (context, opts) {
+module.exports = function(context, opts) {
   return new HPM(context, opts)
 }

package/lib/config-factory.js

@@ -7,7 +7,7 @@ module.exports = {
   createConfig: createConfig
 }
 
-function createConfig (context, opts) {
+function createConfig(context, opts) {
   // structure of config object to be returned
   var config = {
     context: undefined,
@@ -19,8 +19,8 @@ function createConfig (context, opts) {
     config.context = '/'
     config.options = _.assign(config.options, context)
 
-  // app.use('/api', proxy('http://localhost:9000'));
-  // app.use(proxy('http://localhost:9000/api'));
+    // app.use('/api', proxy('http://localhost:9000'));
+    // app.use(proxy('http://localhost:9000/api'));
   } else if (isStringShortHand(context)) {
     var oUrl = url.parse(context)
     var target = [oUrl.protocol, '//', oUrl.host].join('')
@@ -31,7 +31,7 @@ function createConfig (context, opts) {
     if (oUrl.protocol === 'ws:' || oUrl.protocol === 'wss:') {
       config.options.ws = true
     }
-  // app.use('/api', proxy({target:'http://localhost:9000'}));
+    // app.use('/api', proxy({target:'http://localhost:9000'}));
   } else {
     config.context = context
     config.options = _.assign(config.options, opts)
@@ -63,9 +63,9 @@ function createConfig (context, opts) {
  * @param  {String}  context [description]
  * @return {Boolean}         [description]
  */
-function isStringShortHand (context) {
+function isStringShortHand(context) {
   if (_.isString(context)) {
-    return !!(url.parse(context).host)
+    return !!url.parse(context).host
   }
 }
 
@@ -80,16 +80,18 @@ function isStringShortHand (context) {
  * @param  {*}       opts    [description]
  * @return {Boolean}         [description]
  */
-function isContextless (context, opts) {
-  return (_.isPlainObject(context) && _.isEmpty(opts))
+function isContextless(context, opts) {
+  return _.isPlainObject(context) && _.isEmpty(opts)
 }
 
-function mapLegacyProxyHostOption (options) {
+function mapLegacyProxyHostOption(options) {
   // set options.headers.host when option.proxyHost is provided
   if (options.proxyHost) {
     logger.warn('*************************************')
     logger.warn('[HPM] Deprecated "option.proxyHost"')
-    logger.warn('      Use "option.changeOrigin" or "option.headers.host" instead')
+    logger.warn(
+      '      Use "option.changeOrigin" or "option.headers.host" instead'
+    )
     logger.warn('      "option.proxyHost" will be removed in future release.')
     logger.warn('*************************************')
 
@@ -101,7 +103,7 @@ function mapLegacyProxyHostOption (options) {
 }
 
 // Warn deprecated proxyTable api usage
-function mapLegacyProxyTableOption (options) {
+function mapLegacyProxyTableOption(options) {
   if (options.proxyTable) {
     logger.warn('*************************************')
     logger.warn('[HPM] Deprecated "option.proxyTable"')
@@ -116,7 +118,7 @@ function mapLegacyProxyTableOption (options) {
   return options
 }
 
-function configureLogger (options) {
+function configureLogger(options) {
   if (options.logLevel) {
     logger.setLevel(options.logLevel)
   }

package/lib/context-matcher.js

@@ -8,7 +8,7 @@ module.exports = {
   match: matchContext
 }
 
-function matchContext (context, uri, req) {
+function matchContext(context, uri, req) {
   // single path
   if (isStringPath(context)) {
     return matchSingleStringPath(context, uri)
@@ -45,18 +45,18 @@ function matchContext (context, uri, req) {
  * @param  {String} uri     'http://example.org/api/b/c/d.html'
  * @return {Boolean}
  */
-function matchSingleStringPath (context, uri) {
+function matchSingleStringPath(context, uri) {
   var pathname = getUrlPathName(uri)
   return pathname.indexOf(context) === 0
 }
 
-function matchSingleGlobPath (pattern, uri) {
+function matchSingleGlobPath(pattern, uri) {
   var pathname = getUrlPathName(uri)
   var matches = micromatch(pathname, pattern)
-  return matches && (matches.length > 0)
+  return matches && matches.length > 0
 }
 
-function matchMultiGlobPath (patternList, uri) {
+function matchMultiGlobPath(patternList, uri) {
   return matchSingleGlobPath(patternList, uri)
 }
 
@@ -65,7 +65,7 @@ function matchMultiGlobPath (patternList, uri) {
  * @param  {String} uri     'http://example.org/api/b/c/d.html'
  * @return {Boolean}
  */
-function matchMultiPath (contextList, uri) {
+function matchMultiPath(contextList, uri) {
   for (var i = 0; i < contextList.length; i++) {
     var context = contextList[i]
     if (matchSingleStringPath(context, uri)) {
@@ -81,14 +81,14 @@ function matchMultiPath (contextList, uri) {
  * @param  {String} uri from req.url
  * @return {String}     RFC 3986 path
  */
-function getUrlPathName (uri) {
+function getUrlPathName(uri) {
   return uri && url.parse(uri).pathname
 }
 
-function isStringPath (context) {
+function isStringPath(context) {
   return _.isString(context) && !isGlob(context)
 }
 
-function isGlobPath (context) {
+function isGlobPath(context) {
   return isGlob(context)
 }

package/lib/errors.js

@@ -1,8 +1,12 @@
 /* eslint-disable max-len */
 
 module.exports = {
-  ERR_CONFIG_FACTORY_TARGET_MISSING: '[HPM] Missing "target" option. Example: {target: "http://www.example.org"}',
-  ERR_CONTEXT_MATCHER_GENERIC: '[HPM] Invalid context. Expecting something like: "/api" or ["/api", "/ajax"]',
-  ERR_CONTEXT_MATCHER_INVALID_ARRAY: '[HPM] Invalid context. Expecting something like: ["/api", "/ajax"] or ["/api/**", "!**.html"]',
-  ERR_PATH_REWRITER_CONFIG: '[HPM] Invalid pathRewrite config. Expecting object with pathRewrite config or a rewrite function'
+  ERR_CONFIG_FACTORY_TARGET_MISSING:
+    '[HPM] Missing "target" option. Example: {target: "http://www.example.org"}',
+  ERR_CONTEXT_MATCHER_GENERIC:
+    '[HPM] Invalid context. Expecting something like: "/api" or ["/api", "/ajax"]',
+  ERR_CONTEXT_MATCHER_INVALID_ARRAY:
+    '[HPM] Invalid context. Expecting something like: ["/api", "/ajax"] or ["/api/**", "!**.html"]',
+  ERR_PATH_REWRITER_CONFIG:
+    '[HPM] Invalid pathRewrite config. Expecting object with pathRewrite config or a rewrite function'
 }

package/lib/handlers.js

@@ -6,22 +6,29 @@ module.exports = {
   getHandlers: getProxyEventHandlers
 }
 
-function init (proxy, opts) {
+function init(proxy, opts) {
   var handlers = getProxyEventHandlers(opts)
 
-  _.forIn(handlers, function (handler, eventName) {
+  _.forIn(handlers, function(handler, eventName) {
     proxy.on(eventName, handlers[eventName])
   })
 
   logger.debug('[HPM] Subscribed to http-proxy events: ', _.keys(handlers))
 }
 
-function getProxyEventHandlers (opts) {
+function getProxyEventHandlers(opts) {
   // https://github.com/nodejitsu/node-http-proxy#listening-for-proxy-events
-  var proxyEvents = ['error', 'proxyReq', 'proxyReqWs', 'proxyRes', 'open', 'close']
+  var proxyEvents = [
+    'error',
+    'proxyReq',
+    'proxyReqWs',
+    'proxyRes',
+    'open',
+    'close'
+  ]
   var handlers = {}
 
-  _.forEach(proxyEvents, function (event) {
+  _.forEach(proxyEvents, function(event) {
     // all handlers for the http-proxy events are prefixed with 'on'.
     // loop through options and try to find these handlers
     // and add them to the handlers object for subscription in init().
@@ -46,8 +53,8 @@ function getProxyEventHandlers (opts) {
   return handlers
 }
 
-function defaultErrorHandler (err, req, res) {
-  var host = (req.headers && req.headers.host)
+function defaultErrorHandler(err, req, res) {
+  var host = req.headers && req.headers.host
   var code = err.code
 
   if (res.writeHead && !res.headersSent) {
@@ -60,7 +67,8 @@ function defaultErrorHandler (err, req, res) {
         case 'ECONNREFUSED':
           res.writeHead(504)
           break
-        default: res.writeHead(500)
+        default:
+          res.writeHead(500)
       }
     }
   }
@@ -68,7 +76,7 @@ function defaultErrorHandler (err, req, res) {
   res.end('Error occured while trying to proxy to: ' + host + req.url)
 }
 
-function logClose (req, socket, head) {
+function logClose(req, socket, head) {
   // view disconnected websocket connections
   logger.info('[HPM] Client disconnected')
 }

package/lib/index.js

@@ -10,7 +10,7 @@ var getArrow = require('./logger').getArrow
 
 module.exports = HttpProxyMiddleware
 
-function HttpProxyMiddleware (context, opts) {
+function HttpProxyMiddleware(context, opts) {
   // https://github.com/chimurai/http-proxy-middleware/issues/57
   var wsUpgradeDebounced = _.debounce(handleUpgrade)
   var wsInitialized = false
@@ -19,7 +19,12 @@ function HttpProxyMiddleware (context, opts) {
 
   // create proxy
   var proxy = httpProxy.createProxyServer({})
-  logger.info('[HPM] Proxy created:', config.context, ' -> ', proxyOptions.target)
+  logger.info(
+    '[HPM] Proxy created:',
+    config.context,
+    ' -> ',
+    proxyOptions.target
+  )
 
   var pathRewriter = PathRewriter.create(proxyOptions.pathRewrite) // returns undefined when "pathRewrite" is not provided
 
@@ -35,7 +40,7 @@ function HttpProxyMiddleware (context, opts) {
 
   return middleware
 
-  function middleware (req, res, next) {
+  function middleware(req, res, next) {
     if (shouldProxy(config.context, req)) {
       var activeProxyOptions = prepareProxyRequest(req)
       proxy.web(req, res, activeProxyOptions)
@@ -49,7 +54,7 @@ function HttpProxyMiddleware (context, opts) {
     }
   }
 
-  function catchUpgradeRequest (server) {
+  function catchUpgradeRequest(server) {
     // subscribe once; don't subscribe on every request...
     // https://github.com/chimurai/http-proxy-middleware/issues/113
     if (!wsInitialized) {
@@ -58,7 +63,7 @@ function HttpProxyMiddleware (context, opts) {
     }
   }
 
-  function handleUpgrade (req, socket, head) {
+  function handleUpgrade(req, socket, head) {
     // set to initialized when used externally
     wsInitialized = true
 
@@ -77,8 +82,8 @@ function HttpProxyMiddleware (context, opts) {
    * @param  {Object} req     [description]
    * @return {Boolean}
    */
-  function shouldProxy (context, req) {
-    var path = (req.originalUrl || req.url)
+  function shouldProxy(context, req) {
+    var path = req.originalUrl || req.url
     return contextMatcher.match(context, path, req)
   }
 
@@ -90,10 +95,10 @@ function HttpProxyMiddleware (context, opts) {
    * @param {Object} req
    * @return {Object} proxy options
    */
-  function prepareProxyRequest (req) {
+  function prepareProxyRequest(req) {
     // https://github.com/chimurai/http-proxy-middleware/issues/17
     // https://github.com/chimurai/http-proxy-middleware/issues/94
-    req.url = (req.originalUrl || req.url)
+    req.url = req.originalUrl || req.url
 
     // store uri before it gets rewritten for logging
     var originalPath = req.url
@@ -107,29 +112,44 @@ function HttpProxyMiddleware (context, opts) {
 
     // debug logging for both http(s) and websockets
     if (proxyOptions.logLevel === 'debug') {
-      var arrow = getArrow(originalPath, req.url, proxyOptions.target, newProxyOptions.target)
-      logger.debug('[HPM] %s %s %s %s', req.method, originalPath, arrow, newProxyOptions.target)
+      var arrow = getArrow(
+        originalPath,
+        req.url,
+        proxyOptions.target,
+        newProxyOptions.target
+      )
+      logger.debug(
+        '[HPM] %s %s %s %s',
+        req.method,
+        originalPath,
+        arrow,
+        newProxyOptions.target
+      )
     }
 
     return newProxyOptions
   }
 
   // Modify option.target when router present.
-  function __applyRouter (req, options) {
+  function __applyRouter(req, options) {
     var newTarget
 
     if (options.router) {
       newTarget = Router.getTarget(req, options)
 
       if (newTarget) {
-        logger.debug('[HPM] Router new target: %s -> "%s"', options.target, newTarget)
+        logger.debug(
+          '[HPM] Router new target: %s -> "%s"',
+          options.target,
+          newTarget
+        )
         options.target = newTarget
       }
     }
   }
 
   // rewrite path
-  function __applyPathRewrite (req, pathRewriter) {
+  function __applyPathRewrite(req, pathRewriter) {
     if (pathRewriter) {
       var path = pathRewriter(req.url, req)
 
@@ -141,12 +161,22 @@ function HttpProxyMiddleware (context, opts) {
     }
   }
 
-  function logError (err, req, res) {
-    var hostname = (req.headers && req.headers.host) || (req.hostname || req.host) // (websocket) || (node0.10 || node 4/5)
+  function logError(err, req, res) {
+    var hostname =
+      (req.headers && req.headers.host) || (req.hostname || req.host) // (websocket) || (node0.10 || node 4/5)
     var target = proxyOptions.target.host || proxyOptions.target
-    var errorMessage = '[HPM] Error occurred while trying to proxy request %s from %s to %s (%s) (%s)'
-    var errReference = 'https://nodejs.org/api/errors.html#errors_common_system_errors' // link to Node Common Systems Errors page
-
-    logger.error(errorMessage, req.url, hostname, target, err.code, errReference)
+    var errorMessage =
+      '[HPM] Error occurred while trying to proxy request %s from %s to %s (%s) (%s)'
+    var errReference =
+      'https://nodejs.org/api/errors.html#errors_common_system_errors' // link to Node Common Systems Errors page
+
+    logger.error(
+      errorMessage,
+      req.url,
+      hostname,
+      target,
+      err.code || err,
+      errReference
+    )
   }
 }

package/lib/logger.js

@@ -22,7 +22,7 @@ var LEVELS = {
 
 module.exports = {
   // singleton
-  getInstance: function () {
+  getInstance: function() {
     if (!loggerInstance) {
       loggerInstance = new Logger()
     }
@@ -32,7 +32,7 @@ module.exports = {
   getArrow: getArrow
 }
 
-function Logger () {
+function Logger() {
   var logLevel
   var provider
 
@@ -42,12 +42,12 @@ function Logger () {
     info: info,
     warn: warn,
     error: error,
-    setLevel: function (v) {
+    setLevel: function(v) {
       if (isValidLevel(v)) {
         logLevel = v
       }
     },
-    setProvider: function (fn) {
+    setProvider: function(fn) {
       if (fn && isValidProvider(fn)) {
         provider = fn(defaultProvider)
       }
@@ -58,37 +58,37 @@ function Logger () {
 
   return api
 
-  function init () {
+  function init() {
     api.setLevel('info')
-    api.setProvider(function () {
+    api.setProvider(function() {
       return defaultProvider
     })
   }
 
   // log will log messages, regardless of logLevels
-  function log () {
+  function log() {
     provider.log(_interpolate.apply(null, arguments))
   }
 
-  function debug () {
+  function debug() {
     if (_showLevel('debug')) {
       provider.debug(_interpolate.apply(null, arguments))
     }
   }
 
-  function info () {
+  function info() {
     if (_showLevel('info')) {
       provider.info(_interpolate.apply(null, arguments))
     }
   }
 
-  function warn () {
+  function warn() {
     if (_showLevel('warn')) {
       provider.warn(_interpolate.apply(null, arguments))
     }
   }
 
-  function error () {
+  function error() {
     if (_showLevel('error')) {
       provider.error(_interpolate.apply(null, arguments))
     }
@@ -99,11 +99,11 @@ function Logger () {
    * @param  {String}  showLevel [debug, info, warn, error, silent]
    * @return {Boolean}
    */
-  function _showLevel (showLevel) {
+  function _showLevel(showLevel) {
     var result = false
     var currentLogLevel = LEVELS[logLevel]
 
-    if (currentLogLevel && (currentLogLevel <= LEVELS[showLevel])) {
+    if (currentLogLevel && currentLogLevel <= LEVELS[showLevel]) {
       result = true
     }
 
@@ -112,14 +112,14 @@ function Logger () {
 
   // make sure logged messages and its data are return interpolated
   // make it possible for additional log data, such date/time or custom prefix.
-  function _interpolate () {
+  function _interpolate() {
     var fn = _.spread(util.format)
     var result = fn(_.slice(arguments))
 
     return result
   }
 
-  function isValidProvider (fnProvider) {
+  function isValidProvider(fnProvider) {
     var result = true
 
     if (fnProvider && !_.isFunction(fnProvider)) {
@@ -129,7 +129,7 @@ function Logger () {
     return result
   }
 
-  function isValidLevel (levelName) {
+  function isValidLevel(levelName) {
     var validLevels = _.keys(LEVELS)
     var isValid = _.includes(validLevels, levelName)
 
@@ -153,10 +153,10 @@ function Logger () {
  * @param  {String} newTarget
  * @return {String}
  */
-function getArrow (originalPath, newPath, originalTarget, newTarget) {
+function getArrow(originalPath, newPath, originalTarget, newTarget) {
   var arrow = ['>']
-  var isNewTarget = (originalTarget !== newTarget) // router
-  var isNewPath = (originalPath !== newPath) // pathRewrite
+  var isNewTarget = originalTarget !== newTarget // router
+  var isNewPath = originalPath !== newPath // pathRewrite
 
   if (isNewPath && !isNewTarget) {
     arrow.unshift('~')

package/lib/path-rewriter.js

@@ -12,7 +12,7 @@ module.exports = {
  * @param {Object} rewriteConfig
  * @return {Function} Function to rewrite paths; This function should accept `path` (request.url) as parameter
  */
-function createPathRewriter (rewriteConfig) {
+function createPathRewriter(rewriteConfig) {
   var rulesCache
 
   if (!isValidRewriteConfig(rewriteConfig)) {
@@ -27,10 +27,10 @@ function createPathRewriter (rewriteConfig) {
     return rewritePath
   }
 
-  function rewritePath (path) {
+  function rewritePath(path) {
     var result = path
 
-    _.forEach(rulesCache, function (rule) {
+    _.forEach(rulesCache, function(rule) {
       if (rule.regex.test(path)) {
         result = result.replace(rule.regex, rule.value)
         logger.debug('[HPM] Rewriting path from "%s" to "%s"', path, result)
@@ -42,30 +42,36 @@ function createPathRewriter (rewriteConfig) {
   }
 }
 
-function isValidRewriteConfig (rewriteConfig) {
+function isValidRewriteConfig(rewriteConfig) {
   if (_.isFunction(rewriteConfig)) {
     return true
   } else if (!_.isEmpty(rewriteConfig) && _.isPlainObject(rewriteConfig)) {
     return true
-  } else if (_.isUndefined(rewriteConfig) ||
-               _.isNull(rewriteConfig) ||
-               _.isEqual(rewriteConfig, {})) {
+  } else if (
+    _.isUndefined(rewriteConfig) ||
+    _.isNull(rewriteConfig) ||
+    _.isEqual(rewriteConfig, {})
+  ) {
     return false
   } else {
     throw new Error(ERRORS.ERR_PATH_REWRITER_CONFIG)
   }
 }
 
-function parsePathRewriteRules (rewriteConfig) {
+function parsePathRewriteRules(rewriteConfig) {
   var rules = []
 
   if (_.isPlainObject(rewriteConfig)) {
-    _.forIn(rewriteConfig, function (value, key) {
+    _.forIn(rewriteConfig, function(value, key) {
       rules.push({
         regex: new RegExp(key),
         value: rewriteConfig[key]
       })
-      logger.info('[HPM] Proxy rewrite rule created: "%s" ~> "%s"', key, rewriteConfig[key])
+      logger.info(
+        '[HPM] Proxy rewrite rule created: "%s" ~> "%s"',
+        key,
+        rewriteConfig[key]
+      )
     })
   }
 

package/lib/router.js

@@ -5,7 +5,7 @@ module.exports = {
   getTarget: getTarget
 }
 
-function getTarget (req, config) {
+function getTarget(req, config) {
   var newTarget
   var router = config.router
 
@@ -18,22 +18,24 @@ function getTarget (req, config) {
   return newTarget
 }
 
-function getTargetFromProxyTable (req, table) {
+function getTargetFromProxyTable(req, table) {
   var result
   var host = req.headers.host
   var path = req.url
 
   var hostAndPath = host + path
 
-  _.forIn(table, function (value, key) {
+  _.forIn(table, function(value, key) {
     if (containsPath(key)) {
-      if (hostAndPath.indexOf(key) > -1) { // match 'localhost:3000/api'
+      if (hostAndPath.indexOf(key) > -1) {
+        // match 'localhost:3000/api'
         result = table[key]
         logger.debug('[HPM] Router table match: "%s"', key)
         return false
       }
     } else {
-      if (key === host) { // match 'localhost:3000'
+      if (key === host) {
+        // match 'localhost:3000'
         result = table[key]
         logger.debug('[HPM] Router table match: "%s"', host)
         return false
@@ -44,6 +46,6 @@ function getTargetFromProxyTable (req, table) {
   return result
 }
 
-function containsPath (v) {
+function containsPath(v) {
   return v.indexOf('/') > -1
 }