http-proxy-middleware 0.17.0 → 0.17.3

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # Changelog
 
+## [v0.17.3](https://github.com/chimurai/http-proxy-middleware/releases/tag/v0.17.3)
+- fix(onError): improve default proxy error handling. http status codes (504, 502 and 500). ([#132](https://github.com/chimurai/http-proxy-middleware/pull/132)) ([graingert](https://github.com/graingert))
+
+## [v0.17.2](https://github.com/chimurai/http-proxy-middleware/releases/tag/v0.17.2)
+- feat(logging): improve error message & add link to Node errors page. ([#106](https://github.com/chimurai/http-proxy-middleware/pull/106)) ([cloudmu](https://github.com/cloudmu))
+- feat(pathRewrite): path can be empty string. ([#110](https://github.com/chimurai/http-proxy-middleware/pull/110)) ([sunnylqm](https://github.com/sunnylqm))
+- bug(websocket): memory leak when option 'ws:true' is used. ([#114](https://github.com/chimurai/http-proxy-middleware/pull/114)) ([julbra](https://github.com/julbra))
+- chore(package.json): reduce package size. ([#109](https://github.com/chimurai/http-proxy-middleware/pull/109))
+
+## [v0.17.1](https://github.com/chimurai/http-proxy-middleware/releases/tag/v0.17.1)
+- fix(Express sub Router): 404 on non-proxy routes  ([#94](https://github.com/chimurai/http-proxy-middleware/issues/94))
+
 ## [v0.17.0](https://github.com/chimurai/http-proxy-middleware/releases/tag/v0.17.0)
 - fix(context matching): Use [RFC 3986 path](https://tools.ietf.org/html/rfc3986#section-3.3) in context matching. (excludes query parameters)
 

package/README.md

@@ -3,6 +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)
 
 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).
 
@@ -106,10 +107,10 @@ var options = {
         changeOrigin: true,               // needed for virtual hosted sites
         ws: true,                         // proxy websockets
         pathRewrite: {
-            '^/old/api' : '/new/api',     // rewrite path
-            '^/remove/api' : '/api'       // remove path
+            '^/api/old-path' : '/api/new-path',     // rewrite path
+            '^/api/remove/path' : '/path'           // remove base path
         },
-        proxyTable: {
+        router: {
             // when request.headers.host == 'dev.localhost:3000',
             // override target 'http://www.example.org' to 'http://localhost:8000'
             'dev.localhost:3000' : 'http://localhost:8000'
@@ -303,15 +304,29 @@ The following options are provided by the underlying [http-proxy](https://github
 *  **option.xfwd**: true/false, adds x-forward headers
 *  **option.secure**: true/false, if you want to verify the SSL Certs
 *  **option.toProxy**: true/false, passes the absolute URL as the `path` (useful for proxying to proxies)
-*  **option.prependPath**: true/false, Default: true - specify whether you want to prepend the target's path to the proxy path>
-*  **option.ignorePath**: true/false, Default: false - specify whether you want to ignore the proxy path of the incoming request>
+*  **option.prependPath**: true/false, Default: true - specify whether you want to prepend the target's path to the proxy path
+*  **option.ignorePath**: true/false, Default: false - specify whether you want to ignore the proxy path of the incoming request (note: you will have to append / manually if required).
 *  **option.localAddress** : Local interface string to bind for outgoing connections
-*  **option.changeOrigin**: true/false, adds host to request header.
+*  **option.changeOrigin**: true/false, Default: false - changes the origin of the host header to the target URL
 *  **option.auth** : Basic authentication i.e. 'user:password' to compute an Authorization header.
 *  **option.hostRewrite**: rewrites the location hostname on (301/302/307/308) redirects.
 *  **option.autoRewrite**: rewrites the location host/port on (301/302/307/308) redirects based on requested host/port. Default: false.
 *  **option.protocolRewrite**: rewrites the location protocol on (301/302/307/308) redirects to 'http' or 'https'. Default: null.
+*  **option.cookieDomainRewrite**: rewrites domain of `set-cookie` headers. Possible values:
+   * `false` (default): disable cookie rewriting
+   * String: new domain, for example `cookieDomainRewrite: "new.domain"`. To remove the domain, use `cookieDomainRewrite: ""`.
+   * Object: mapping of domains to new domains, use `"*"` to match all domains.  
+     For example keep one domain unchanged, rewrite one domain and remove other domains:
+     ```
+     cookieDomainRewrite: {
+       "unchanged.domain": "unchanged.domain",
+       "old.domain": "new.domain",
+       "*": ""
+     }
+     ```
 *  **option.headers**: object, adds [request headers](https://en.wikipedia.org/wiki/List_of_HTTP_header_fields#Request_fields). (Example: `{host:'www.example.org'}`)
+*  **option.proxyTimeout**: timeout (in millis) when proxy receives no response from target
+
 
 
 ## Shorthand

package/lib/handlers.js

@@ -48,9 +48,21 @@ function getProxyEventHandlers(opts) {
 
 function defaultErrorHandler(err, req, res) {
     var host = (req.headers && req.headers.host);
+    var code = err.code;
 
     if (res.writeHead && !res.headersSent) {
-        res.writeHead(500);
+        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);

package/lib/index.js

@@ -13,6 +13,7 @@ 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;
 
@@ -35,10 +36,7 @@ function HttpProxyMiddleware(context, opts) {
     return middleware;
 
     function middleware(req, res, next) {
-        // https://github.com/chimurai/http-proxy-middleware/issues/17
-        req.url = req.originalUrl;
-
-        if (contextMatcher.match(config.context, req.url, req)) {
+        if (shouldProxy(config.context, req)) {
             var activeProxyOptions = prepareProxyRequest(req);
             proxy.web(req, res, activeProxyOptions);
         } else {
@@ -46,22 +44,42 @@ function HttpProxyMiddleware(context, opts) {
         }
 
         if (proxyOptions.ws === true) {
+            // use initial request to access the server object to subscribe to http upgrade event
             catchUpgradeRequest(req.connection.server);
         }
     }
 
     function catchUpgradeRequest(server) {
-        server.on('upgrade', wsUpgradeDebounced);
+        // 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;
+        }
     }
 
     function handleUpgrade(req, socket, head) {
-        if (contextMatcher.match(config.context, req.url, req)) {
+        // set to initialized when used externally
+        wsInitialized = true;
+
+        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
+     * @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:
@@ -69,6 +87,10 @@ function HttpProxyMiddleware(context, opts) {
           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);
@@ -107,7 +129,7 @@ function HttpProxyMiddleware(context, opts) {
         if (pathRewriter) {
             var path = pathRewriter(req.url, req);
 
-            if (path) {
+            if (typeof path === 'string') {
                 req.url =  path;
             } else {
                 logger.info('[HPM] pathRewrite: No rewritten path found. (%s)', req.url);
@@ -116,9 +138,10 @@ function HttpProxyMiddleware(context, opts) {
     }
 
     function logError(err, req, res) {
-        var hostname = (req.hostname || req.host) || (req.headers && req.headers.host); // (node0.10 || node 4/5) || (websocket)
-        var targetUri = (proxyOptions.target.host || proxyOptions.target) + req.url;
+        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
 
-        logger.error('[HPM] PROXY ERROR: %s. %s -> %s', err.code, hostname, targetUri);
+        logger.error('[HPM] Error occurred while trying to proxy request %s from %s to %s (%s) (%s)', req.url, hostname, target, err.code, errReference);
     }
 };

package/lib/logger.js

@@ -143,9 +143,9 @@ function Logger() {
 
 /**
  * -> normal proxy
- * => proxyTable
+ * => router
  * ~> pathRewrite
- * ≈> proxyTable + pathRewrite
+ * ≈> router + pathRewrite
  */
 function getArrow(originalPath, newPath, originalTarget, newTarget) {
     var arrow = ['>'];

package/package.json

@@ -1,8 +1,12 @@
 {
   "name": "http-proxy-middleware",
-  "version": "0.17.0",
+  "version": "0.17.3",
   "description": "The one-liner node.js proxy middleware for connect, express and browser-sync",
   "main": "index.js",
+  "files": [
+    "index.js",
+    "lib"
+  ],
   "scripts": {
     "clean": "rm -rf coverage",
     "test": "mocha --recursive --colors --reporter spec",
@@ -35,22 +39,22 @@
   },
   "homepage": "https://github.com/chimurai/http-proxy-middleware",
   "devDependencies": {
-    "browser-sync": "^2.13.0",
+    "browser-sync": "^2.18.2",
     "chai": "^3.5.0",
-    "connect": "^3.4.1",
-    "coveralls": "^2.11.9",
-    "express": "^4.13.4",
-    "istanbul": "^0.4.3",
+    "connect": "^3.5.0",
+    "coveralls": "^2.11.15",
+    "express": "^4.14.0",
+    "istanbul": "^0.4.5",
     "istanbul-coveralls": "^1.0.3",
-    "mocha": "^2.5.3",
+    "mocha": "^3.2.0",
     "mocha-lcov-reporter": "1.2.0",
     "opn": "^4.0.2",
-    "ws": "^1.1.0"
+    "ws": "^1.1.1"
   },
   "dependencies": {
-    "http-proxy": "^1.13.3",
-    "is-glob": "^2.0.1",
-    "lodash": "^4.13.1",
-    "micromatch": "^2.3.8"
+    "http-proxy": "^1.16.2",
+    "is-glob": "^3.1.0",
+    "lodash": "^4.17.2",
+    "micromatch": "^2.3.11"
   }
 }

package/.editorconfig

@@ -1,18 +0,0 @@
-# http://editorconfig.org
-
-root = true
-
-[*]
-charset = utf-8
-end_of_line = lf
-indent_style = space
-indent_size = 4
-insert_final_newline = true
-trim_trailing_whitespace = true
-
-[*.md]
-trim_trailing_whitespace = false
-
-# Matches the exact files either package.json or .travis.yml
-[{package.json,.travis.yml}]
-indent_size = 2

package/.jscsrc

@@ -1,8 +0,0 @@
-{
-    "preset": "google",
-    "validateIndentation": 4,
-    "maximumLineLength": {
-        "value": 120,
-        "allExcept": ["comments", "regex"]
-    },
-}

package/.npmignore

@@ -1,28 +0,0 @@
-# Logs
-logs
-*.log
-
-# Runtime data
-pids
-*.pid
-*.seed
-
-# Directory for instrumented libs generated by jscoverage/JSCover
-lib-cov
-
-# Coverage directory used by tools like istanbul
-coverage
-
-# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
-.grunt
-
-# Compiled binary addons (http://nodejs.org/api/addons.html)
-build/Release
-
-# Dependency directory
-# Commenting this out is preferred by some people, see
-# https://www.npmjs.org/doc/misc/npm-faq.html#should-i-check-my-node_modules-folder-into-git-
-node_modules
-
-# Users Environment Variables
-.lock-wscript

package/.travis.yml

@@ -1,16 +0,0 @@
-language: node_js
-node_js:
-- 'stable'
-- '5'
-- '4'
-- '0.12'
-- '0.11'
-- '0.10'
-before_install:
-# https://github.com/npm/npm/issues/11283
-- npm set progress=false
-after_success: npm run coveralls
-env:
-  global:
-    # COVERALLS_REPO_TOKEN=
-      secure: "I8mDH0n2DQHAPvUFEV/ZNmrMNYTJxgywg8+P3yuCAWwQkZeXQi0DWG+6VUpOylaRhL/4kCdZK9gnJD2MfrqvNqVLDUqBK3tTmZVoyqqJEdE0UdEHcPncAPmxWrG98sDjqFN9r4nWeizHvyA1fNRQHRN56Zy+DcQWjgEhHJaYeNA="

package/CONTRIBUTING.md

@@ -1,61 +0,0 @@
-# Contributing
-
-We love contributors! Your help is welcome to make this project better!
-
-Some simple guidelines we'd like you to follow.
-
-## Got Questions or Problems?
-
-If you have questions about http-proxy-middle usage; Please check if your question hasn't been already answered on [Stack Overflow](http://stackoverflow.com/search?q=%22http-proxy-middleware%22) or in our [issue archive](https://github.com/chimurai/http-proxy-middleware/issues?utf8=%E2%9C%93&q=is%3Aissue+), [examples](https://github.com/chimurai/http-proxy-middleware/tree/master/examples) and [recipes](https://github.com/chimurai/http-proxy-middleware/tree/master/recipes).
-
-Since Nodejitsu's `http-proxy` is providing the actual proxy functionality; You might find your answer in their [documentation](https://github.com/nodejitsu/node-http-proxy), [issue archive](https://github.com/nodejitsu/node-http-proxy/issues?utf8=%E2%9C%93&q=is%3Aissue) or [examples](https://github.com/nodejitsu/node-http-proxy/tree/master/examples).
-
-Feel free to [ask a question](https://github.com/chimurai/http-proxy-middleware/issues) if the above resources didn't answer your question.
-
-Tips on how to ask: http://stackoverflow.com/help/how-to-ask
-
-## Report Issues
-
-If you think you've found an issue, please submit it to the [Github issue tracker](https://github.com/chimurai/http-proxy-middleware/issues).
-
-"*[It doesn't work](https://goo.gl/GzkkTg)*" is not very useful for anyone.
-A good issue report should have a well described **problem description** and proxy **configuration**. A great issue report includes a **minimal example**.
-
-Properly format your code example for easier reading: [Code and Syntax Highlighting](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet#code-and-syntax-highlighting).
-
-The quality of your issue report will determine how quickly and deeply we'll delve into it. Some simple pointers for reporting an issue:
-
-#### Problem Description
-
-- describe the problem
-- steps taken (request urls)
-- found
-- expected
-
-#### Configuration / Setup
-
-- http-proxy-middleware version
-- http-proxy-middleware configuration
-
-It might be useful to provide server information in which http-proxy-middleware is used and the target server information to which requests are being proxied.
-
-- server + version (express, connect, browser-sync, etc...)
-    + server port number
-- target server
-    + target server port number
-
-### Minimal example
-
-Provide a minimal example to exclude external factors. This will greatly help identifying the issue.
-
-Tips on how to create a minimal example: http://stackoverflow.com/help/mcve
-
-## New Feature?
-
-Request a new feature by submitting an issue into our [Github issue tracker](https://github.com/chimurai/http-proxy-middleware/issues).
-
-PRs are welcome. Please discuss it in our [Github issue tracker](https://github.com/chimurai/http-proxy-middleware/issues) before you start working on it, to avoid wasting your time and effort in case we are already (planning to) working on it.
-
-## Documentation
-
-Feel free to send PRs to improve the documentation, [examples](https://github.com/chimurai/http-proxy-middleware/tree/master/examples) and [recipes](https://github.com/chimurai/http-proxy-middleware/tree/master/recipes).

package/ISSUE_TEMPLATE.md

@@ -1,21 +0,0 @@
-### Expected behavior
-
-### Actual behavior
-
-### Setup
-
-* http-proxy-middleware: _version_
-* server: _connect/express/browser-sync..._ + _version_
-* other relevant modules
-
-#### proxy middleware configuration
-```javascript
-var apiProxy = proxy('/api', {target:'http://www.example.org', changeOrigin:true});
-```
-#### server mounting
-```javascript
-var app = express();
-
-app.use(apiProxy);
-app.listen(3000);
-```

package/examples/README.md

@@ -1,33 +0,0 @@
-# Examples
-
-View working examples of `http-proxy-middleware` implemented in popular servers.
-
-To run and view the [examples](https://github.com/chimurai/http-proxy-middleware/tree/master/examples); Clone the `http-proxy-middleware` repo and install the dependencies:
-
-```bash
-$ git clone https://github.com/chimurai/http-proxy-middleware.git
-$ cd http-proxy-middleware
-$ npm install
-```
-
-Run the example from root folder:
-
-```bash
-$ node examples/browser-sync
-```
-
-```bash
-$ node examples/connect
-```
-
-```bash
-$ node examples/express
-```
-
-```bash
-$ node examples/websocket
-```
-
-## Server recipes
-
-You can find more server implementations with `http-proxy-middleware` in the [server recipes](https://github.com/chimurai/http-proxy-middleware/tree/master/recipes/servers.md)

package/examples/browser-sync/index.js

@@ -1,29 +0,0 @@
-/**
- * Module dependencies.
- */
-var browserSync = require('browser-sync').create();
-var proxy = require('../../index'); // require('http-proxy-middleware');
-
-/**
- * Configure proxy middleware
- */
-var jsonPlaceholderProxy = proxy('/users', {
-    target: 'http://jsonplaceholder.typicode.com',
-    changeOrigin: true,             // for vhosted sites, changes host header to match to target's host
-    logLevel: 'debug'
-});
-
-/**
- * Add the proxy to browser-sync
- */
-browserSync.init({
-    server: {
-        baseDir: './',
-        port: 3000,
-        middleware: [jsonPlaceholderProxy],
-    },
-    startPath: '/users'
-});
-
-console.log('[DEMO] Server: listening on port 3000');
-console.log('[DEMO] Opening: http://localhost:3000/users');

package/examples/connect/index.js

@@ -1,29 +0,0 @@
-/**
- * Module dependencies.
- */
-var http = require('http');
-var connect = require('connect');
-var proxy = require('../../index'); // require('http-proxy-middleware');
-
-/**
- * Configure proxy middleware
- */
-var jsonPlaceholderProxy = proxy({
-    target: 'http://jsonplaceholder.typicode.com',
-    changeOrigin: true,             // for vhosted sites, changes host header to match to target's host
-    logLevel: 'debug'
-});
-
-var app = connect();
-
-/**
- * Add the proxy to connect
- */
-app.use('/users', jsonPlaceholderProxy);
-
-http.createServer(app).listen(3000);
-
-console.log('[DEMO] Server: listening on port 3000');
-console.log('[DEMO] Opening: http://localhost:3000/users');
-
-require('opn')('http://localhost:3000/users');

package/examples/express/index.js

@@ -1,28 +0,0 @@
-/**
- * Module dependencies.
- */
-var express = require('express');
-var proxy = require('../../index'); // require('http-proxy-middleware');
-
-/**
- * Configure proxy middleware
- */
-var jsonPlaceholderProxy = proxy({
-    target: 'http://jsonplaceholder.typicode.com',
-    changeOrigin: true,             // for vhosted sites, changes host header to match to target's host
-    logLevel: 'debug'
-});
-
-var app = express();
-
-/**
- * Add the proxy to express
- */
-app.use('/users', jsonPlaceholderProxy);
-
-app.listen(3000);
-
-console.log('[DEMO] Server: listening on port 3000');
-console.log('[DEMO] Opening: http://localhost:3000/users');
-
-require('opn')('http://localhost:3000/users');

package/examples/websocket/index.html

@@ -1,96 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
-<head>
-    <meta charset="UTF-8">
-    <title>http-proxy-middleware - WebSocket example</title>
-    <style>
-        fieldset {
-            border: 0;
-        }
-        label {
-            display: inline-block;
-            width: 5em;
-            vertical-align: top;
-        }
-        code {
-            background-color: #eee;
-        }
-    </style>
-</head>
-
-<body>
-
-    <h2>WebSocket demo</h2>
-
-    <p>
-        Proxy <code>ws://localhost:3000</code> to <code>ws://echo.websocket.org</code>
-    </p>
-
-    <fieldset id="configuration">
-        <p>
-            <label for="location">location:</label>
-            <input id="location" type="text" value="ws://localhost:3000">
-            <button id="connect">connect</button>
-            <button id="disconnect" disabled="disabled">disconnect</button>
-        </p>
-    </fieldset>
-    <fieldset id="messaging" disabled="disabled">
-        <p>
-            <label for="message">message:</label>
-            <input type="text" id="message" value="Hello WebSocket">
-            <button id="send">send</button>
-        </p>
-        <p>
-            <label for="logger">log:</label>
-            <textarea id="logger" cols="30" rows="10"></textarea>
-        </p>
-    </fieldset>
-
-    <script>
-    window.onload = function () {
-        // elements
-        var configuration = document.getElementById('configuration');
-        var location      = document.getElementById('location');
-        var connect       = document.getElementById('connect');
-        var disconnect    = document.getElementById('disconnect');
-        var messaging     = document.getElementById('messaging');
-        var message       = document.getElementById('message');
-        var send          = document.getElementById('send');
-        var logger        = document.getElementById('logger');
-
-        // ws
-        var socket;
-
-        connect.onclick = function () {
-            connect.disabled = true;
-            disconnect.disabled = false;
-            messaging.disabled = false;
-
-            socket = new WebSocket(location.value);
-            socket.onopen    = function () { log('CONNECTED'); };
-            socket.onclose   = function () { log('DISCONNECTED'); };
-            socket.onerror   = function () { log('SOCKET ERROR OCCURED'); };
-            socket.onmessage = function (msg) { log('RECEIVED:' + msg.data); };
-        }
-
-        disconnect.onclick = function () {
-            connect.disabled = false;
-            disconnect.disabled = true;
-            messaging.disabled = true;
-            socket.close();
-        }
-
-        send.onclick = function () {
-            log('SEND: ' + message.value);
-            socket.send(message.value);
-        };
-
-        function log (message) {
-            logger.value = logger.value + message + '\n'
-        }
-
-    }
-    </script>
-
-</body>
-</html>