http-proxy-middleware 0.19.2 → 0.20.0

package/CHANGELOG.md

@@ -1,8 +1,14 @@
 # Changelog
 
-## [v0.19.2](https://github.com/chimurai/http-proxy-middleware/releases/tag/v0.19.2)
-
-- chore(deps): http-proxy 1.18.1
+## [v0.20.0](https://github.com/chimurai/http-proxy-middleware/releases/tag/v0.20.0)
+
+- fix(ws): concurrent websocket requests do not get upgraded ([#335](https://github.com/chimurai/http-proxy-middleware/issues/335))
+- chore: drop node 6 (BREAKING CHANGE)
+- chore: update to micromatch@4 ([BREAKING CHANGE](https://github.com/micromatch/micromatch/blob/master/CHANGELOG.md#400---2019-03-20))
+- chore: update dev dependencies
+- refactor: migrate to typescript ([#328](https://github.com/chimurai/http-proxy-middleware/pull/328))
+- feat(middleware): Promise / async support ([#328](https://github.com/chimurai/http-proxy-middleware/pull/328/files#diff-7890bfeb41abb0fc0ef2670749c84077R50))
+- refactor: remove legacy options `proxyHost` and `proxyTable` (BREAKING CHANGE)
 
 ## [v0.19.1](https://github.com/chimurai/http-proxy-middleware/releases/tag/v0.19.1)
 

package/README.md

@@ -3,7 +3,7 @@
 [![Build Status](https://img.shields.io/travis/chimurai/http-proxy-middleware/master.svg?style=flat-square)](https://travis-ci.org/chimurai/http-proxy-middleware)
 [![Coveralls](https://img.shields.io/coveralls/chimurai/http-proxy-middleware.svg?style=flat-square)](https://coveralls.io/r/chimurai/http-proxy-middleware)
 [![dependency Status](https://img.shields.io/david/chimurai/http-proxy-middleware.svg?style=flat-square)](https://david-dm.org/chimurai/http-proxy-middleware#info=dependencies)
-[![dependency Status](https://snyk.io/test/npm/http-proxy-middleware/badge.svg)](https://snyk.io/test/npm/http-proxy-middleware)
+[![dependency Status](https://snyk.io/test/npm/http-proxy-middleware/badge.svg?style=flat-square)](https://snyk.io/test/npm/http-proxy-middleware)
 [![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)
 
 Node.js proxying made simple. Configure proxy middleware with ease for [connect](https://github.com/senchalabs/connect), [express](https://github.com/strongloop/express), [browser-sync](https://github.com/BrowserSync/browser-sync) and [many more](#compatible-servers).
@@ -15,13 +15,16 @@ Powered by the popular Nodejitsu [`http-proxy`](https://github.com/nodejitsu/nod
 Proxy `/api` requests to `http://www.example.org`
 
 ```javascript
-var express = require('express')
-var proxy = require('http-proxy-middleware')
+var express = require('express');
+var proxy = require('http-proxy-middleware');
 
-var app = express()
+var app = express();
 
-app.use('/api', proxy({ target: 'http://www.example.org', changeOrigin: true }))
-app.listen(3000)
+app.use(
+  '/api',
+  proxy({ target: 'http://www.example.org', changeOrigin: true })
+);
+app.listen(3000);
 
 // http://localhost:3000/api/foo/bar -> http://www.example.org/api/foo/bar
 ```
@@ -68,9 +71,9 @@ Proxy middleware configuration.
 #### proxy([context,] config)
 
 ```javascript
-var proxy = require('http-proxy-middleware')
+var proxy = require('http-proxy-middleware');
 
-var apiProxy = proxy('/api', { target: 'http://www.example.org' })
+var apiProxy = proxy('/api', { target: 'http://www.example.org' });
 //                   \____/   \_____________________________/
 //                     |                    |
 //                   context             options
@@ -88,7 +91,7 @@ var apiProxy = proxy('/api', { target: 'http://www.example.org' })
 
 ```javascript
 // shorthand syntax for the example above:
-var apiProxy = proxy('http://www.example.org/api')
+var apiProxy = proxy('http://www.example.org/api');
 ```
 
 More about the [shorthand configuration](#shorthand).
@@ -99,8 +102,8 @@ An example with `express` server.
 
 ```javascript
 // include dependencies
-var express = require('express')
-var proxy = require('http-proxy-middleware')
+var express = require('express');
+var proxy = require('http-proxy-middleware');
 
 // proxy middleware options
 var options = {
@@ -116,15 +119,15 @@ var options = {
     // override target 'http://www.example.org' to 'http://localhost:8000'
     'dev.localhost:3000': 'http://localhost:8000'
   }
-}
+};
 
 // create the proxy (without context)
-var exampleProxy = proxy(options)
+var exampleProxy = proxy(options);
 
 // mount `exampleProxy` in web server
-var app = express()
-app.use('/api', exampleProxy)
-app.listen(3000)
+var app = express();
+app.use('/api', exampleProxy);
+app.listen(3000);
 ```
 
 ## Context matching
@@ -172,10 +175,10 @@ Providing an alternative way to decide which requests should be proxied; In case
    * @return {Boolean}
    */
   var filter = function(pathname, req) {
-    return pathname.match('^/api') && req.method === 'GET'
-  }
+    return pathname.match('^/api') && req.method === 'GET';
+  };
 
-  var apiProxy = proxy(filter, { target: 'http://www.example.org' })
+  var apiProxy = proxy(filter, { target: 'http://www.example.org' });
   ```
 
 ## Options
@@ -224,14 +227,14 @@ Providing an alternative way to decide which requests should be proxied; In case
   // simple replace
   function logProvider(provider) {
     // replace the default console log provider.
-    return require('winston')
+    return require('winston');
   }
   ```
 
   ```javascript
   // verbose replacement
   function logProvider(provider) {
-    var logger = new (require('winston')).Logger()
+    var logger = new (require('winston')).Logger();
 
     var myCustomProvider = {
       log: logger.log,
@@ -239,14 +242,11 @@ Providing an alternative way to decide which requests should be proxied; In case
       info: logger.info,
       warn: logger.warn,
       error: logger.error
-    }
-    return myCustomProvider
+    };
+    return myCustomProvider;
   }
   ```
 
-- (DEPRECATED) **option.proxyHost**: Use `option.changeOrigin = true` instead.
-- (DEPRECATED) **option.proxyTable**: Use `option.router` instead.
-
 ### http-proxy events
 
 Subscribe to [http-proxy events](https://github.com/nodejitsu/node-http-proxy#listening-for-proxy-events):
@@ -257,10 +257,10 @@ Subscribe to [http-proxy events](https://github.com/nodejitsu/node-http-proxy#li
   function onError(err, req, res) {
     res.writeHead(500, {
       'Content-Type': 'text/plain'
-    })
+    });
     res.end(
       'Something went wrong. And we are reporting a custom error message.'
-    )
+    );
   }
   ```
 
@@ -268,8 +268,8 @@ Subscribe to [http-proxy events](https://github.com/nodejitsu/node-http-proxy#li
 
   ```javascript
   function onProxyRes(proxyRes, req, res) {
-    proxyRes.headers['x-added'] = 'foobar' // add new header to response
-    delete proxyRes.headers['x-removed'] // remove header from response
+    proxyRes.headers['x-added'] = 'foobar'; // add new header to response
+    delete proxyRes.headers['x-removed']; // remove header from response
   }
   ```
 
@@ -278,7 +278,7 @@ Subscribe to [http-proxy events](https://github.com/nodejitsu/node-http-proxy#li
   ```javascript
   function onProxyReq(proxyReq, req, res) {
     // add custom header to request
-    proxyReq.setHeader('x-added', 'foobar')
+    proxyReq.setHeader('x-added', 'foobar');
     // or log the req
   }
   ```
@@ -288,7 +288,7 @@ Subscribe to [http-proxy events](https://github.com/nodejitsu/node-http-proxy#li
   ```javascript
   function onProxyReqWs(proxyReq, req, socket, options, head) {
     // add custom header
-    proxyReq.setHeader('X-Special-Proxy-Header', 'foobar')
+    proxyReq.setHeader('X-Special-Proxy-Header', 'foobar');
   }
   ```
 
@@ -297,7 +297,7 @@ Subscribe to [http-proxy events](https://github.com/nodejitsu/node-http-proxy#li
   ```javascript
   function onOpen(proxySocket) {
     // listen for messages coming FROM the target here
-    proxySocket.on('data', hybiParseAndLogMessage)
+    proxySocket.on('data', hybiParseAndLogMessage);
   }
   ```
 
@@ -305,7 +305,7 @@ Subscribe to [http-proxy events](https://github.com/nodejitsu/node-http-proxy#li
   ```javascript
   function onClose(res, socket, head) {
     // view disconnected websocket connections
-    console.log('Client disconnected')
+    console.log('Client disconnected');
   }
   ```
 
@@ -383,13 +383,13 @@ The following options are provided by the underlying [http-proxy](https://github
 Use the shorthand syntax when verbose configuration is not needed. The `context` and `option.target` will be automatically configured when shorthand is used. Options can still be used if needed.
 
 ```javascript
-proxy('http://www.example.org:8000/api')
+proxy('http://www.example.org:8000/api');
 // proxy('/api', {target: 'http://www.example.org:8000'});
 
-proxy('http://www.example.org:8000/api/books/*/**.json')
+proxy('http://www.example.org:8000/api/books/*/**.json');
 // proxy('/api/books/*/**.json', {target: 'http://www.example.org:8000'});
 
-proxy('http://www.example.org:8000/api', { changeOrigin: true })
+proxy('http://www.example.org:8000/api', { changeOrigin: true });
 // proxy('/api', {target: 'http://www.example.org:8000', changeOrigin: true});
 ```
 
@@ -399,7 +399,10 @@ If you want to use the server's `app.use` `path` parameter to match requests;
 Create and mount the proxy without the http-proxy-middleware `context` parameter:
 
 ```javascript
-app.use('/api', proxy({ target: 'http://www.example.org', changeOrigin: true }))
+app.use(
+  '/api',
+  proxy({ target: 'http://www.example.org', changeOrigin: true })
+);
 ```
 
 `app.use` documentation:
@@ -411,13 +414,13 @@ app.use('/api', proxy({ target: 'http://www.example.org', changeOrigin: true }))
 
 ```javascript
 // verbose api
-proxy('/', { target: 'http://echo.websocket.org', ws: true })
+proxy('/', { target: 'http://echo.websocket.org', ws: true });
 
 // shorthand
-proxy('http://echo.websocket.org', { ws: true })
+proxy('http://echo.websocket.org', { ws: true });
 
 // shorter shorthand
-proxy('ws://echo.websocket.org')
+proxy('ws://echo.websocket.org');
 ```
 
 ### External WebSocket upgrade
@@ -425,13 +428,13 @@ proxy('ws://echo.websocket.org')
 In the previous WebSocket examples, http-proxy-middleware relies on a initial http request in order to listen to the http `upgrade` event. If you need to proxy WebSockets without the initial http request, you can subscribe to the server's http `upgrade` event manually.
 
 ```javascript
-var wsProxy = proxy('ws://echo.websocket.org', { changeOrigin: true })
+var wsProxy = proxy('ws://echo.websocket.org', { changeOrigin: true });
 
-var app = express()
-app.use(wsProxy)
+var app = express();
+app.use(wsProxy);
 
-var server = app.listen(3000)
-server.on('upgrade', wsProxy.upgrade) // <-- subscribe to http 'upgrade'
+var server = app.listen(3000);
+server.on('upgrade', wsProxy.upgrade); // <-- subscribe to http 'upgrade'
 ```
 
 ## Working examples
@@ -468,16 +471,20 @@ Run the test suite:
 
 ```bash
 # install dependencies
-$ npm install
+$ yarn
 
 # linting
-$ npm run lint
+$ yarn lint
+$ yarn lint:fix
+
+# building (compile typescript to js)
+$ yarn build
 
 # unit tests
-$ npm test
+$ yarn test
 
 # code coverage
-$ npm run cover
+$ yarn cover
 ```
 
 ## Changelog
@@ -488,4 +495,4 @@ $ npm run cover
 
 The MIT License (MIT)
 
-Copyright (c) 2015-2018 Steven Chim
+Copyright (c) 2015-2019 Steven Chim

package/dist/config-factory.js

@@ -0,0 +1,79 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const _ = require("lodash");
+const url = require("url");
+const errors_1 = require("./errors");
+const logger_1 = require("./logger");
+const logger = logger_1.getInstance();
+function createConfig(context, opts) {
+    // structure of config object to be returned
+    const config = {
+        context: undefined,
+        options: {}
+    };
+    // app.use('/api', proxy({target:'http://localhost:9000'}));
+    if (isContextless(context, opts)) {
+        config.context = '/';
+        config.options = _.assign(config.options, context);
+        // app.use('/api', proxy('http://localhost:9000'));
+        // app.use(proxy('http://localhost:9000/api'));
+    }
+    else if (isStringShortHand(context)) {
+        const oUrl = url.parse(context);
+        const target = [oUrl.protocol, '//', oUrl.host].join('');
+        config.context = oUrl.pathname || '/';
+        config.options = _.assign(config.options, { target }, opts);
+        if (oUrl.protocol === 'ws:' || oUrl.protocol === 'wss:') {
+            config.options.ws = true;
+        }
+        // app.use('/api', proxy({target:'http://localhost:9000'}));
+    }
+    else {
+        config.context = context;
+        config.options = _.assign(config.options, opts);
+    }
+    configureLogger(config.options);
+    if (!config.options.target) {
+        throw new Error(errors_1.ERRORS.ERR_CONFIG_FACTORY_TARGET_MISSING);
+    }
+    return config;
+}
+exports.createConfig = createConfig;
+/**
+ * Checks if a String only target/config is provided.
+ * This can be just the host or with the optional path.
+ *
+ * @example
+ *      app.use('/api', proxy('http://localhost:9000'));
+ *      app.use(proxy('http://localhost:9000/api'));
+ *
+ * @param  {String}  context [description]
+ * @return {Boolean}         [description]
+ */
+function isStringShortHand(context) {
+    if (_.isString(context)) {
+        return !!url.parse(context).host;
+    }
+}
+/**
+ * Checks if a Object only config is provided, without a context.
+ * In this case the all paths will be proxied.
+ *
+ * @example
+ *     app.use('/api', proxy({target:'http://localhost:9000'}));
+ *
+ * @param  {Object}  context [description]
+ * @param  {*}       opts    [description]
+ * @return {Boolean}         [description]
+ */
+function isContextless(context, opts) {
+    return _.isPlainObject(context) && _.isEmpty(opts);
+}
+function configureLogger(options) {
+    if (options.logLevel) {
+        logger.setLevel(options.logLevel);
+    }
+    if (options.logProvider) {
+        logger.setProvider(options.logProvider);
+    }
+}

package/dist/context-matcher.js

@@ -0,0 +1,81 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const isGlob = require("is-glob");
+const _ = require("lodash");
+const micromatch = require("micromatch");
+const url = require("url");
+const errors_1 = require("./errors");
+function match(context, uri, req) {
+    // single path
+    if (isStringPath(context)) {
+        return matchSingleStringPath(context, uri);
+    }
+    // single glob path
+    if (isGlobPath(context)) {
+        return matchSingleGlobPath(context, uri);
+    }
+    // multi path
+    if (Array.isArray(context)) {
+        if (context.every(isStringPath)) {
+            return matchMultiPath(context, uri);
+        }
+        if (context.every(isGlobPath)) {
+            return matchMultiGlobPath(context, uri);
+        }
+        throw new Error(errors_1.ERRORS.ERR_CONTEXT_MATCHER_INVALID_ARRAY);
+    }
+    // custom matching
+    if (_.isFunction(context)) {
+        const pathname = getUrlPathName(uri);
+        return context(pathname, req);
+    }
+    throw new Error(errors_1.ERRORS.ERR_CONTEXT_MATCHER_GENERIC);
+}
+exports.match = match;
+/**
+ * @param  {String} context '/api'
+ * @param  {String} uri     'http://example.org/api/b/c/d.html'
+ * @return {Boolean}
+ */
+function matchSingleStringPath(context, uri) {
+    const pathname = getUrlPathName(uri);
+    return pathname.indexOf(context) === 0;
+}
+function matchSingleGlobPath(pattern, uri) {
+    const pathname = getUrlPathName(uri);
+    const matches = micromatch([pathname], pattern);
+    return matches && matches.length > 0;
+}
+function matchMultiGlobPath(patternList, uri) {
+    return matchSingleGlobPath(patternList, uri);
+}
+/**
+ * @param  {String} contextList ['/api', '/ajax']
+ * @param  {String} uri     'http://example.org/api/b/c/d.html'
+ * @return {Boolean}
+ */
+function matchMultiPath(contextList, uri) {
+    let isMultiPath = false;
+    for (const context of contextList) {
+        if (matchSingleStringPath(context, uri)) {
+            isMultiPath = true;
+            break;
+        }
+    }
+    return isMultiPath;
+}
+/**
+ * Parses URI and returns RFC 3986 path
+ *
+ * @param  {String} uri from req.url
+ * @return {String}     RFC 3986 path
+ */
+function getUrlPathName(uri) {
+    return uri && url.parse(uri).pathname;
+}
+function isStringPath(context) {
+    return _.isString(context) && !isGlob(context);
+}
+function isGlobPath(context) {
+    return isGlob(context);
+}

package/dist/errors.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+var ERRORS;
+(function (ERRORS) {
+    ERRORS["ERR_CONFIG_FACTORY_TARGET_MISSING"] = "[HPM] Missing \"target\" option. Example: {target: \"http://www.example.org\"}";
+    ERRORS["ERR_CONTEXT_MATCHER_GENERIC"] = "[HPM] Invalid context. Expecting something like: \"/api\" or [\"/api\", \"/ajax\"]";
+    ERRORS["ERR_CONTEXT_MATCHER_INVALID_ARRAY"] = "[HPM] Invalid context. Expecting something like: [\"/api\", \"/ajax\"] or [\"/api/**\", \"!**.html\"]";
+    ERRORS["ERR_PATH_REWRITER_CONFIG"] = "[HPM] Invalid pathRewrite config. Expecting object with pathRewrite config or a rewrite function";
+})(ERRORS = exports.ERRORS || (exports.ERRORS = {}));

package/dist/handlers.js

@@ -0,0 +1,70 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const _ = require("lodash");
+const logger_1 = require("./logger");
+const logger = logger_1.getInstance();
+function init(proxy, option) {
+    const handlers = getHandlers(option);
+    for (const eventName of Object.keys(handlers)) {
+        proxy.on(eventName, handlers[eventName]);
+    }
+    logger.debug('[HPM] Subscribed to http-proxy events:', Object.keys(handlers));
+}
+exports.init = init;
+function getHandlers(options) {
+    // https://github.com/nodejitsu/node-http-proxy#listening-for-proxy-events
+    const proxyEvents = [
+        'error',
+        'proxyReq',
+        'proxyReqWs',
+        'proxyRes',
+        'open',
+        'close'
+    ];
+    const handlers = {};
+    for (const event of proxyEvents) {
+        // 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().
+        const eventName = _.camelCase('on ' + event);
+        const fnHandler = _.get(options, eventName);
+        if (_.isFunction(fnHandler)) {
+            handlers[event] = fnHandler;
+        }
+    }
+    // add default error handler in absence of error handler
+    if (!_.isFunction(handlers.error)) {
+        handlers.error = defaultErrorHandler;
+    }
+    // add default close handler in absence of close handler
+    if (!_.isFunction(handlers.close)) {
+        handlers.close = logClose;
+    }
+    return handlers;
+}
+exports.getHandlers = getHandlers;
+function defaultErrorHandler(err, req, res) {
+    const host = req.headers && req.headers.host;
+    const code = err.code;
+    if (res.writeHead && !res.headersSent) {
+        if (/HPE_INVALID/.test(code)) {
+            res.writeHead(502);
+        }
+        else {
+            switch (code) {
+                case 'ECONNRESET':
+                case 'ENOTFOUND':
+                case 'ECONNREFUSED':
+                    res.writeHead(504);
+                    break;
+                default:
+                    res.writeHead(500);
+            }
+        }
+    }
+    res.end('Error occured while trying to proxy to: ' + host + req.url);
+}
+function logClose(req, socket, head) {
+    // view disconnected websocket connections
+    logger.info('[HPM] Client disconnected');
+}