http-proxy-middleware 0.17.2-beta → 0.18.0

package/lib/index.js

@@ -1,137 +1,152 @@
-var _              = require('lodash');
-var httpProxy      = require('http-proxy');
-var configFactory  = require('./config-factory');
-var handlers       = require('./handlers');
-var contextMatcher = require('./context-matcher');
-var PathRewriter   = require('./path-rewriter');
-var Router         = require('./router');
-var logger         = require('./logger').getInstance();
-var getArrow       = require('./logger').getArrow;
-
-module.exports = HttpProxyMiddleware;
-
-function HttpProxyMiddleware(context, opts) {
-    // https://github.com/chimurai/http-proxy-middleware/issues/57
-    var wsUpgradeDebounced  = _.debounce(handleUpgrade);
-    var config              = configFactory.createConfig(context, opts);
-    var proxyOptions        = config.options;
-
-    // create proxy
-    var proxy = httpProxy.createProxyServer({});
-    logger.info('[HPM] Proxy created:', config.context, ' -> ', proxyOptions.target);
-
-    var pathRewriter = PathRewriter.create(proxyOptions.pathRewrite); // returns undefined when "pathRewrite" is not provided
-
-    // attach handler to http-proxy events
-    handlers.init(proxy, proxyOptions);
-
-    // log errors for debug purpose
-    proxy.on('error', logError);
-
-    // https://github.com/chimurai/http-proxy-middleware/issues/19
-    // expose function to upgrade externally
-    middleware.upgrade = wsUpgradeDebounced;
-
-    return middleware;
-
-    function middleware(req, res, next) {
-        if (shouldProxy(config.context, req)) {
-            var activeProxyOptions = prepareProxyRequest(req);
-            proxy.web(req, res, activeProxyOptions);
-        } else {
-            next();
-        }
-
-        if (proxyOptions.ws === true) {
-            catchUpgradeRequest(req.connection.server);
-        }
+var _ = require('lodash')
+var httpProxy = require('http-proxy')
+var configFactory = require('./config-factory')
+var handlers = require('./handlers')
+var contextMatcher = require('./context-matcher')
+var PathRewriter = require('./path-rewriter')
+var Router = require('./router')
+var logger = require('./logger').getInstance()
+var getArrow = require('./logger').getArrow
+
+module.exports = HttpProxyMiddleware
+
+function HttpProxyMiddleware (context, opts) {
+  // https://github.com/chimurai/http-proxy-middleware/issues/57
+  var wsUpgradeDebounced = _.debounce(handleUpgrade)
+  var wsInitialized = false
+  var config = configFactory.createConfig(context, opts)
+  var proxyOptions = config.options
+
+  // create proxy
+  var proxy = httpProxy.createProxyServer({})
+  logger.info('[HPM] Proxy created:', config.context, ' -> ', proxyOptions.target)
+
+  var pathRewriter = PathRewriter.create(proxyOptions.pathRewrite) // returns undefined when "pathRewrite" is not provided
+
+  // attach handler to http-proxy events
+  handlers.init(proxy, proxyOptions)
+
+  // log errors for debug purpose
+  proxy.on('error', logError)
+
+  // https://github.com/chimurai/http-proxy-middleware/issues/19
+  // expose function to upgrade externally
+  middleware.upgrade = wsUpgradeDebounced
+
+  return middleware
+
+  function middleware (req, res, next) {
+    if (shouldProxy(config.context, req)) {
+      var activeProxyOptions = prepareProxyRequest(req)
+      proxy.web(req, res, activeProxyOptions)
+    } else {
+      next()
     }
 
-    function catchUpgradeRequest(server) {
-        server.on('upgrade', wsUpgradeDebounced);
+    if (proxyOptions.ws === true) {
+      // use initial request to access the server object to subscribe to http upgrade event
+      catchUpgradeRequest(req.connection.server)
     }
-
-    function handleUpgrade(req, socket, head) {
-        if (shouldProxy(config.context, req)) {
-            var activeProxyOptions = prepareProxyRequest(req);
-            proxy.ws(req, socket, head, activeProxyOptions);
-            logger.info('[HPM] Upgrading to WebSocket');
-        }
+  }
+
+  function catchUpgradeRequest (server) {
+    // subscribe once; don't subscribe on every request...
+    // https://github.com/chimurai/http-proxy-middleware/issues/113
+    if (!wsInitialized) {
+      server.on('upgrade', wsUpgradeDebounced)
+      wsInitialized = true
     }
+  }
 
-    /**
-     * Determine whether request should be proxied.
-     *
-     * @private
-     * @return {Boolean}
-     */
-    function shouldProxy(context, req) {
-        var path = (req.originalUrl || req.url);
-        return contextMatcher.match(context, path, req);
-    }
+  function handleUpgrade (req, socket, head) {
+    // set to initialized when used externally
+    wsInitialized = true
 
-    /**
-     * Apply option.router and option.pathRewrite
-     * Order matters:
-          Router uses original path for routing;
-          NOT the modified path, after it has been rewritten by pathRewrite
-     */
-    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);
-
-        // store uri before it gets rewritten for logging
-        var originalPath = req.url;
-        var newProxyOptions = _.cloneDeep(proxyOptions);
-
-        // Apply in order:
-        // 1. option.router
-        // 2. option.pathRewrite
-        __applyRouter(req, newProxyOptions);
-        __applyPathRewrite(req, pathRewriter);
-
-        // 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);
-        }
-
-        return newProxyOptions;
+    if (shouldProxy(config.context, req)) {
+      var activeProxyOptions = prepareProxyRequest(req)
+      proxy.ws(req, socket, head, activeProxyOptions)
+      logger.info('[HPM] Upgrading to WebSocket')
+    }
+  }
+
+  /**
+   * Determine whether request should be proxied.
+   *
+   * @private
+   * @param  {String} context [description]
+   * @param  {Object} req     [description]
+   * @return {Boolean}
+   */
+  function shouldProxy (context, req) {
+    var path = (req.originalUrl || req.url)
+    return contextMatcher.match(context, path, req)
+  }
+
+  /**
+   * Apply option.router and option.pathRewrite
+   * Order matters:
+   *    Router uses original path for routing;
+   *    NOT the modified path, after it has been rewritten by pathRewrite
+   * @param {Object} req
+   * @return {Object} proxy options
+   */
+  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)
+
+    // store uri before it gets rewritten for logging
+    var originalPath = req.url
+    var newProxyOptions = _.assign({}, proxyOptions)
+
+    // Apply in order:
+    // 1. option.router
+    // 2. option.pathRewrite
+    __applyRouter(req, newProxyOptions)
+    __applyPathRewrite(req, pathRewriter)
+
+    // 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)
     }
 
-    // Modify option.target when router present.
-    function __applyRouter(req, options) {
-        var newTarget;
+    return newProxyOptions
+  }
 
-        if (options.router) {
-            newTarget = Router.getTarget(req, options);
+  // Modify option.target when router present.
+  function __applyRouter (req, options) {
+    var newTarget
 
-            if (newTarget) {
-                logger.debug('[HPM] Router new target: %s -> "%s"', options.target, newTarget);
-                options.target = newTarget;
-            }
-        }
-    }
+    if (options.router) {
+      newTarget = Router.getTarget(req, options)
 
-    // rewrite path
-    function __applyPathRewrite(req, pathRewriter) {
-        if (pathRewriter) {
-            var path = pathRewriter(req.url, req);
-
-            if (path) {
-                req.url =  path;
-            } else {
-                logger.info('[HPM] pathRewrite: No rewritten path found. (%s)', req.url);
-            }
-        }
+      if (newTarget) {
+        logger.debug('[HPM] Router new target: %s -> "%s"', options.target, newTarget)
+        options.target = newTarget
+      }
+    }
+  }
+
+  // rewrite path
+  function __applyPathRewrite (req, pathRewriter) {
+    if (pathRewriter) {
+      var path = pathRewriter(req.url, req)
+
+      if (typeof path === 'string') {
+        req.url = path
+      } else {
+        logger.info('[HPM] pathRewrite: No rewritten path found. (%s)', req.url)
+      }
     }
+  }
 
-    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 errReference = 'https://nodejs.org/api/errors.html#errors_common_system_errors'; // link to Node Common Systems Errors page
+  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('[HPM] Error occurred while trying to proxy request %s from %s to %s (%s) (%s)', req.url, hostname, target, err.code, errReference);
-    }
-};
+    logger.error(errorMessage, req.url, hostname, target, err.code, errReference)
+  }
+}

package/lib/logger.js

@@ -1,144 +1,144 @@
-var util = require('util');
-var _ = require('lodash');
+var util = require('util')
+var _ = require('lodash')
 
-var loggerInstance;
+var loggerInstance
 
 var defaultProvider = {
-    log: console.log,
-    debug: console.log,    // use .log(); since console does not have .debug()
-    info: console.info,
-    warn: console.warn,
-    error: console.error
-};
+  log: console.log,
+  debug: console.log, // use .log(); since console does not have .debug()
+  info: console.info,
+  warn: console.warn,
+  error: console.error
+}
 
 // log level 'weight'
 var LEVELS = {
-    debug: 10,
-    info: 20,
-    warn: 30,
-    error: 50,
-    silent: 80
-};
+  debug: 10,
+  info: 20,
+  warn: 30,
+  error: 50,
+  silent: 80
+}
 
 module.exports = {
-    // singleton
-    getInstance: function() {
-        if (!loggerInstance) {
-            loggerInstance = new Logger();
-        }
+  // singleton
+  getInstance: function () {
+    if (!loggerInstance) {
+      loggerInstance = new Logger()
+    }
+
+    return loggerInstance
+  },
+  getArrow: getArrow
+}
 
-        return loggerInstance;
+function Logger () {
+  var logLevel
+  var provider
+
+  var api = {
+    log: log,
+    debug: debug,
+    info: info,
+    warn: warn,
+    error: error,
+    setLevel: function (v) {
+      if (isValidLevel(v)) {
+        logLevel = v
+      }
     },
-    getArrow: getArrow
-};
-
-function Logger() {
-    var logLevel;
-    var provider;
-
-    var api = {
-        log: log,
-        debug: debug,
-        info: info,
-        warn: warn,
-        error: error,
-        setLevel: function(v) {
-            if (isValidLevel(v)) {
-                logLevel = v;
-            }
-        },
-        setProvider: function(fn) {
-            if (fn && isValidProvider(fn)) {
-                provider = fn(defaultProvider);
-            }
-        }
-    };
-
-    init();
-
-    return api;
-
-    function init() {
-        api.setLevel('info');
-        api.setProvider(function() {
-            return defaultProvider;
-        });
+    setProvider: function (fn) {
+      if (fn && isValidProvider(fn)) {
+        provider = fn(defaultProvider)
+      }
     }
+  }
 
-    // log will log messages, regardless of logLevels
-    function log() {
-        provider.log(_interpolate.apply(null, arguments));
-    }
+  init()
 
-    function debug() {
-        if (_showLevel('debug')) {
-            provider.debug(_interpolate.apply(null, arguments));
-        }
-    }
+  return api
 
-    function info() {
-        if (_showLevel('info')) {
-            provider.info(_interpolate.apply(null, arguments));
-        }
-    }
+  function init () {
+    api.setLevel('info')
+    api.setProvider(function () {
+      return defaultProvider
+    })
+  }
 
-    function warn() {
-        if (_showLevel('warn')) {
-            provider.warn(_interpolate.apply(null, arguments));
-        }
-    }
+  // log will log messages, regardless of logLevels
+  function log () {
+    provider.log(_interpolate.apply(null, arguments))
+  }
 
-    function error() {
-        if (_showLevel('error')) {
-            provider.error(_interpolate.apply(null, arguments));
-        }
+  function debug () {
+    if (_showLevel('debug')) {
+      provider.debug(_interpolate.apply(null, arguments))
     }
+  }
 
-    /**
-     * Decide to log or not to log, based on the log levels 'weight'
-     * @param  {String}  showLevel [debug, info, warn, error, silent]
-     * @return {Boolean}
-     */
-    function _showLevel(showLevel) {
-        var result = false;
-        var currentLogLevel = LEVELS[logLevel];
+  function info () {
+    if (_showLevel('info')) {
+      provider.info(_interpolate.apply(null, arguments))
+    }
+  }
 
-        if (currentLogLevel && (currentLogLevel <= LEVELS[showLevel])) {
-            result = true;
-        }
+  function warn () {
+    if (_showLevel('warn')) {
+      provider.warn(_interpolate.apply(null, arguments))
+    }
+  }
 
-        return result;
+  function error () {
+    if (_showLevel('error')) {
+      provider.error(_interpolate.apply(null, arguments))
+    }
+  }
+
+  /**
+   * Decide to log or not to log, based on the log levels 'weight'
+   * @param  {String}  showLevel [debug, info, warn, error, silent]
+   * @return {Boolean}
+   */
+  function _showLevel (showLevel) {
+    var result = false
+    var currentLogLevel = LEVELS[logLevel]
+
+    if (currentLogLevel && (currentLogLevel <= LEVELS[showLevel])) {
+      result = true
     }
 
-    // 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() {
-        var fn = _.spread(util.format);
-        var result = fn(_.slice(arguments));
+    return result
+  }
 
-        return result;
-    }
+  // 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 () {
+    var fn = _.spread(util.format)
+    var result = fn(_.slice(arguments))
 
-    function isValidProvider(fnProvider) {
-        var result = true;
+    return result
+  }
 
-        if (fnProvider && !_.isFunction(fnProvider)) {
-            throw new Error('[HPM] Log provider config error. Expecting a function.');
-        }
+  function isValidProvider (fnProvider) {
+    var result = true
 
-        return result;
+    if (fnProvider && !_.isFunction(fnProvider)) {
+      throw new Error('[HPM] Log provider config error. Expecting a function.')
     }
 
-    function isValidLevel(levelName) {
-        var validLevels = _.keys(LEVELS);
-        var isValid = _.includes(validLevels, levelName);
+    return result
+  }
 
-        if (!isValid) {
-            throw new Error('[HPM] Log level error. Invalid logLevel.');
-        }
+  function isValidLevel (levelName) {
+    var validLevels = _.keys(LEVELS)
+    var isValid = _.includes(validLevels, levelName)
 
-        return isValid;
+    if (!isValid) {
+      throw new Error('[HPM] Log level error. Invalid logLevel.')
     }
+
+    return isValid
+  }
 }
 
 /**
@@ -146,13 +146,27 @@ function Logger() {
  * => router
  * ~> pathRewrite
  * ≈> router + pathRewrite
+ *
+ * @param  {String} originalPath
+ * @param  {String} newPath
+ * @param  {String} originalTarget
+ * @param  {String} newTarget
+ * @return {String}
  */
-function getArrow(originalPath, newPath, originalTarget, newTarget) {
-    var arrow = ['>'];
-    var isNewTarget = (originalTarget !== newTarget); // router
-    var isNewPath = (originalPath !== newPath); // pathRewrite
-
-    if (isNewPath && !isNewTarget) {arrow.unshift('~');} else if (!isNewPath && isNewTarget) {arrow.unshift('=');} else if (isNewPath && isNewTarget) {arrow.unshift('≈');} else {arrow.unshift('-');}
-
-    return arrow.join('');
+function getArrow (originalPath, newPath, originalTarget, newTarget) {
+  var arrow = ['>']
+  var isNewTarget = (originalTarget !== newTarget) // router
+  var isNewPath = (originalPath !== newPath) // pathRewrite
+
+  if (isNewPath && !isNewTarget) {
+    arrow.unshift('~')
+  } else if (!isNewPath && isNewTarget) {
+    arrow.unshift('=')
+  } else if (isNewPath && isNewTarget) {
+    arrow.unshift('≈')
+  } else {
+    arrow.unshift('-')
+  }
+
+  return arrow.join('')
 }