npm - http-proxy-middleware - Versions diffs - 0.17.1 → 0.17.4 - Mend

http-proxy-middleware 0.17.1 → 0.17.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (51) hide show

package/CHANGELOG.md +13 -0
package/README.md +22 -8
package/lib/handlers.js +13 -1
package/lib/index.js +17 -6
package/lib/logger.js +2 -2
package/package.json +13 -9
package/.editorconfig +0 -18
package/.jscsrc +0 -8
package/.npmignore +0 -2
package/.travis.yml +0 -16
package/CONTRIBUTING.md +0 -61
package/ISSUE_TEMPLATE.md +0 -21
package/coverage/coverage.json +0 -1
package/coverage/lcov-report/base.css +0 -213
package/coverage/lcov-report/http-proxy-middleware/index.html +0 -93
package/coverage/lcov-report/http-proxy-middleware/index.js.html +0 -80
package/coverage/lcov-report/http-proxy-middleware/lib/config-factory.js.html +0 -443
package/coverage/lcov-report/http-proxy-middleware/lib/context-matcher.js.html +0 -347
package/coverage/lcov-report/http-proxy-middleware/lib/handlers.js.html +0 -251
package/coverage/lcov-report/http-proxy-middleware/lib/index.html +0 -171
package/coverage/lcov-report/http-proxy-middleware/lib/index.js.html +0 -437
package/coverage/lcov-report/http-proxy-middleware/lib/logger.js.html +0 -539
package/coverage/lcov-report/http-proxy-middleware/lib/path-rewriter.js.html +0 -281
package/coverage/lcov-report/http-proxy-middleware/lib/router.js.html +0 -224
package/coverage/lcov-report/index.html +0 -106
package/coverage/lcov-report/prettify.css +0 -1
package/coverage/lcov-report/prettify.js +0 -1
package/coverage/lcov-report/sort-arrow-sprite.png +0 -0
package/coverage/lcov-report/sorter.js +0 -158
package/coverage/lcov.info +0 -647
package/examples/README.md +0 -33
package/examples/browser-sync/index.js +0 -29
package/examples/connect/index.js +0 -29
package/examples/express/index.js +0 -28
package/examples/websocket/index.html +0 -96
package/examples/websocket/index.js +0 -41
package/recipes/README.md +0 -110
package/recipes/basic.md +0 -32
package/recipes/context-matching.md +0 -99
package/recipes/corporate-proxy.md +0 -21
package/recipes/delay.md +0 -37
package/recipes/logLevel.md +0 -40
package/recipes/logProvider.md +0 -77
package/recipes/modify-post.md +0 -74
package/recipes/pathRewrite.md +0 -93
package/recipes/proxy-events.md +0 -74
package/recipes/router.md +0 -83
package/recipes/servers.md +0 -252
package/recipes/shorthand.md +0 -63
package/recipes/virtual-hosts.md +0 -18
package/recipes/websocket.md +0 -41

package/examples/express/index.js DELETED Viewed

@@ -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 DELETED Viewed

@@ -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>

package/examples/websocket/index.js DELETED Viewed

@@ -1,41 +0,0 @@
-/**
- * Module dependencies.
- */
-var express = require('express');
-var proxy = require('../../index'); // require('http-proxy-middleware');
-/**
- * Configure proxy middleware
- */
-var wsProxy = proxy('/', {
-                target: 'http://echo.websocket.org',
-                // pathRewrite: {
-                //  '^/websocket' : '/socket',          // rewrite path.
-                //  '^/removepath' : ''                 // remove path.
-                // },
-                changeOrigin: true,                     // for vhosted sites, changes host header to match to target's host
-                ws: true,                               // enable websocket proxy
-                logLevel: 'debug'
-            });
-var app = express();
-app.use('/', express.static(__dirname));                // demo page
-app.use(wsProxy);                                       // add the proxy to express
-var server = app.listen(3000);
-server.on('upgrade', wsProxy.upgrade);                  // optional: upgrade externally
-console.log('[DEMO] Server: listening on port 3000');
-console.log('[DEMO] Opening: http://localhost:3000');
-require('opn')('http://localhost:3000');
-/**
- * Example:
- * Open http://localhost:3000 in WebSocket compatible browser.
- * In browser console:
- * 1. `var socket = new WebSocket('ws://localhost:3000');`          // create new WebSocket
- * 2. `socket.onmessage = function (msg) {console.log(msg)};`       // listen to socket messages
- * 3. `socket.send('hello world');`                                 // send message
- * >  {data: "hello world"}                                         // server should echo back your message.
- **/

package/recipes/README.md DELETED Viewed

@@ -1,110 +0,0 @@
-# Recipes
-Common usages of `http-proxy-middleware`.
-# Configuration example
-Overview of `http-proxy-middleware` specific options.
-http-proxy-middleware uses Nodejitsu's [http-proxy](https://github.com/nodejitsu/node-http-proxy) to do the actual proxying. All of its [options](https://github.com/nodejitsu/node-http-proxy#options) are exposed via http-proxy-middleware's configuration object.
-```javascript
-var proxy = require("http-proxy-middleware");
-var winston = require('winston');
-/**
- * Context matching: decide which path(s) should be proxied. (wildcards supported)
- **/
-var context = '/api';
-/**
- * Proxy options
- */
-var options = {
-    // hostname to the target server
-    target: 'http://localhost:3000',
-    // set correct host headers for name-based virtual hosted sites
-    changeOrigin: true,
-    // enable websocket proxying
-    ws: true,
-    // additional request headers
-    headers: {
-        'x-powered-by': 'foobar'
-    },
-    // rewrite paths
-    pathRewrite: {
-        '^/old/api': '/new/api',    // rewrite path
-        '^/remove/api': ''          // remove path
-    },
-    // re-target based on the request's host header and/or path
-    router: {
-      // host[/path]                 :  <new target>
-      // /path                       :  <new target>
-        'integration.localhost:8000' : 'http://localhost:8001',  // host only
-        'staging.localhost:8000'     : 'http://localhost:8002',  // host only
-        'localhost:8000/api'         : 'http://localhost:8003',  // host + path
-        '/rest'                      : 'http://localhost:8004'   // path only
-    },
-    // control logging
-    logLevel: 'silent',
-    // use a different lib for logging;
-    // i.e., write logs to file or server
-    logProvider: function (provider) {
-        return winston;
-    },
-    // subscribe to http-proxy's error event
-    onError: function onError(err, req, res) {
-        res.writeHead(500, {'Content-Type': 'text/plain'});
-        res.end('Something went wrong.');
-    },
-    // subscribe to http-proxy's proxyRes event
-    onProxyRes: function (proxyRes, req, res) {
-        proxyRes.headers['x-added'] = 'foobar';
-        delete proxyRes.headers['x-removed'];
-    },
-    // subscribe to http-proxy's proxyReq event
-    onProxyReq: function (proxyReq, req, res) {
-        // add custom header to request
-        proxyReq.setHeader('x-powered-by', 'foobar');
-    }
-    /**
-     * The following options are provided by Nodejitsu's http-proxy
-     */
-    // target
-    // forward
-    // agent
-    // ssl
-    // ws
-    // xfwd
-    // secure
-    // toProxy
-    // prependPath
-    // ignorePath
-    // localAddress
-    // changeOrigin
-    // auth
-    // hostRewrite
-    // autoRewrite
-    // protocolRewrite
-    // headers
-};
-/**
- * Create the proxy middleware, so it can be used in a server.
- */
-var apiProxy = proxy(context, options);
-```

package/recipes/basic.md DELETED Viewed

@@ -1,32 +0,0 @@
-# Basic usage
-This example will create a basic proxy middleware.
-```javascript
-var proxy = require("http-proxy-middleware");
-var apiProxy = proxy('/api', {target: 'http://localhost:3000'});
-//                          \____/  \________________________________/
-//                            |                     |
-//                          context              options
-```
-## Alternative configuration
-The proxy behavior of the following examples are **exactly** the same; Just different ways to configure it.
-```javascript
-app.use(proxy('/api', {target: 'http://localhost:3000', changeOrigin:true}));
-```
-```javascript
-app.use(proxy('http://localhost:3000/api', {changeOrigin:true}));
-```
-```javascript
-app.use('/api', proxy('http://localhost:3000', {changeOrigin:true}));
-```
-```javascript
-app.use('/api', proxy({target: 'http://localhost:3000', changeOrigin:true}));
-```

package/recipes/context-matching.md DELETED Viewed

@@ -1,99 +0,0 @@
-# Context matching
-Determine which requests should be proxied.
-Context matching is optional and is useful in cases where you are not able to use the regular [middleware mounting](http://expressjs.com/en/4x/api.html#app.use).
-The [RFC 3986 `path`](https://tools.ietf.org/html/rfc3986#section-3.3) is used for context matching.
-```
-         foo://example.com:8042/over/there?name=ferret#nose
-         \_/   \______________/\_________/ \_________/ \__/
-          |           |            |            |        |
-       scheme     authority       path        query   fragment
-```
-`http-proxy-middleware` offers several ways to do this:
-<!-- MarkdownTOC autolink=true bracket=round -->
-- [Path](#path)
-- [Multi Path](#multi-path)
-- [Wildcard](#wildcard)
-- [Multi Wildcard](#multi-wildcard)
-- [Wildcard / Exclusion](#wildcard--exclusion)
-- [Custom filtering](#custom-filtering)
-<!-- /MarkdownTOC -->
-## Path
-This will match paths starting with `/api`
-```javascript
-var proxy = require("http-proxy-middleware");
-var apiProxy = proxy('/api', {target: 'http://localhost:3000'});
-// `/api/foo/bar` -> `http://localhost:3000/api/foo/bar`
-```
-## Multi Path
-This will match paths starting with `/api` or `/rest`
-```javascript
-var proxy = require("http-proxy-middleware");
-var apiProxy = proxy(['/api', '/rest'], {target: 'http://localhost:3000'});
-// `/api/foo/bar` -> `http://localhost:3000/api/foo/bar`
-// `/rest/lorum/ipsum` -> `http://localhost:3000/rest/lorum/ipsum`
-```
-## Wildcard
-This will match paths starting with `/api/` and should also end with `.json`
-```javascript
-var proxy = require("http-proxy-middleware");
-var apiProxy = proxy('/api/**/*.json', {target: 'http://localhost:3000'});
-```
-## Multi Wildcard
-Multiple wildcards can be used.
-```javascript
-var proxy = require("http-proxy-middleware");
-var apiProxy = proxy(['/api/**/*.json', '/rest/**'], {target: 'http://localhost:3000'});
-```
-## Wildcard / Exclusion
-This example will create a proxy with wildcard context matching.
-```javascript
-var proxy = require("http-proxy-middleware");
-var apiProxy = proxy(['foo/*.js', '!bar.js'], {target: 'http://localhost:3000'});
-```
-## Custom filtering
-Write your custom context matching function to have full control on the matching behavior.
-The request `pathname` and `req` object are provided to determine which requests should be proxied or not.
-```javascript
-var proxy = require("http-proxy-middleware");
-var filter = function (pathname, req) {
-    return (pathname.match('^/api') && req.method === 'GET');
-};
-var apiProxy = proxy(filter, {target: 'http://localhost:3000'});
-```

package/recipes/corporate-proxy.md DELETED Viewed

@@ -1,21 +0,0 @@
-# Corporate Proxy Support
-This example will create a basic proxy middleware with corporate proxy support.
-Provide a custom `http.agent` with [https-proxy-agent](https://github.com/TooTallNate/node-https-proxy-agent) to connect to the corporate proxy server.
-```javascript
-var HttpsProxyAgent = require('https-proxy-agent');
-var proxy = require("http-proxy-middleware");
-// corporate proxy to connect to
-var proxyServer = process.env.HTTPS_PROXY ||
-                  process.env.HTTP_PROXY;
-var options = {
-    target: 'http://localhost:3000',
-    agent: new HttpsProxyAgent(proxyServer)
-};
-var apiProxy = proxy('/api', options);
-```

package/recipes/delay.md DELETED Viewed

@@ -1,37 +0,0 @@
-# Delay proxied request/response
-Sometimes we need the ability to delay request to backend server or response from it back to client to test long execution time of particular url or all of them. With DevTool's [network throttling](https://developers.google.com/web/tools/chrome-devtools/profile/network-performance/network-conditions?hl=en) we can test slowdown of all request, not separately.
-But we can handle each request individually via our proxy, and add delay to its execution time.
-Let's assume that we want slow down the access to backend's `/api/get-me-something` resource. Delay request time by 2 seconds and increase response time by 5 seconds.
-For achieving it just put additional route handler to your app before proxy handler:
-```javascript
-const myProxy = proxy({
-  target: 'http://www.example.com',
-  changeOrigin: true
-});
-const proxyDelay = function (req, res, next) {
-  if (req.originalUrl === '/api/get-me-something') {
-    // Delay request by 2 seconds
-    setTimeout(next, 2000);
-    // Delay response completion by 5 seconds
-    const endOriginal = res.end;
-    res.end = function (...args) {
-      setTimeout(function () {
-        endOriginal.apply(res, args);
-      }, 5000);
-    };
-  } else {
-    next();
-  }
-};
-app.use('/api', proxyDelay, myProxy);
-```
-And you will see result in devtools similar to this:
-![http-proxy-delay](https://cloud.githubusercontent.com/assets/576077/15839924/49ebe256-2bfb-11e6-8591-ef0101670885.png)

package/recipes/logLevel.md DELETED Viewed

@@ -1,40 +0,0 @@
-# Log Level
-Control the amount of logging of http-proxy-middleware.
-Possible values:
-* `debug`
-* `info`
-* `warn` (default)
-* `error`
-* `silent`
-## Level: debug
-Log everyting.
-```javascript
-var proxy = require("http-proxy-middleware");
-var options = {
-    target: 'http://localhost:3000',
-    logLevel: 'debug'
-};
-var apiProxy = proxy('/api', options);
-```
-## Level: silent
-Suppress all logging.
-```javascript
-var proxy = require("http-proxy-middleware");
-var options = {
-    target: 'http://localhost:3000',
-    logLevel: 'silent'
-};
-var apiProxy = proxy('/api', options);
-```

package/recipes/logProvider.md DELETED Viewed

@@ -1,77 +0,0 @@
-# Log Provider
-Configure your own logger with the `logProvider` option.
-In this example [winston](https://www.npmjs.com/package/winston) is configured to do the actual logging.
-```javascript
-var winston = require('winston');
-var proxy = require("http-proxy-middleware");
-var options = {
-    target: 'http://localhost:3000',
-    logProvider: function (provider) {
-        return winston;
-    }
-};
-var apiProxy = proxy('/api', options);
-```
-## Winston
-Configure your own logger with the `logProvider` option.
-In this example [winston](https://www.npmjs.com/package/winston) is configured to do the actual logging. Map the logging api if needed.
-```javascript
-var winston = require('winston');
-var proxy = require("http-proxy-middleware");
-var logProvider = function (provider) {
-    return {
-        log   : winston.log,
-        debug : winston.debug,
-        info  : winston.info,
-        warn  : winston.warn,
-        error : winston.error
-    };
-};
-var options = {
-    target: 'http://localhost:3000',
-    logProvider: logProvider
-};
-var apiProxy = proxy('/api', options);
-```
-# Winston Multi Transport
-Configure your own logger with the `logProvider` option.
-In this example [winston](https://www.npmjs.com/package/winston) is configured to do the actual logging.
-```javascript
-var winston = require('winston');
-var proxy = require("http-proxy-middleware");
-var logProvider = function (provider) {
-    var logger = new (winston.Logger)({
-        transports: [
-            new (winston.transports.Console)(),
-            new (winston.transports.File)({ filename: 'somefile.log' })
-        ]
-    });
-    return logger;
-};
-var options = {
-    target: 'http://localhost:3000',
-    logProvider: logProvider
-};
-var apiProxy = proxy('/api', options);
-```

package/recipes/modify-post.md DELETED Viewed

@@ -1,74 +0,0 @@
-##Modify Post Parameters:
-The code example below illustrates how to modify POST body data prior to forwarding to the proxy target.
-Key to this example is the *"OnProxyReq"* event handler  that creates a new POST body that can be manipulated to format the POST data as required.  For example: inject new POST parameters that should only be visible server side.
-This example uses the *"body-parser"* module in the main app to create a req.body object with the decoded POST parameters.   Side note - the code below will allow *"http-proxy-middleware"* to work with *"body-parser"*.
-Since this only modifys the request body stream the original POST body parameters remain in tact, so any POST data changes will not be sent back in the response to the client.
-## Example:
-    'use strict';
-    var express = require('express');
-    var ProxyMiddleware = require('http-proxy-middleware');
-    var router = express.Router();
-    var proxy_filter = function (path, req) {
-        return path.match('^/docs') && ( req.method === 'GET' || req.method === 'POST' );
-    };
-    var proxy_options = {
-        target: 'http://localhost:8080',
-        pathRewrite: {
-            '^/docs' : '/java/rep/server1' // Host path & target path conversion
-        },
-        onError(err, req, res) {
-            res.writeHead(500, {
-                'Content-Type': 'text/plain'
-            });
-            res.end('Something went wrong. And we are reporting a custom error message.' + err);
-        },
-        onProxyReq(proxyReq, req, res) {
-            if ( req.method == "POST" && req.body ) {
-                // Add req.body logic here if needed....
-               // ....
-                // Remove body-parser body object from the request
-                if ( req.body ) delete req.body;
-                // Make any needed POST parameter changes
-                let body = new Object();
-                body.filename = 'reports/statistics/summary_2016.pdf';
-                body.routeid = 's003b012d002';
-                body.authid = 'bac02c1d-258a-4177-9da6-862580154960';
-                // URI encode JSON object
-                body = Object.keys( body ).map(function( key ) {
-                    return encodeURIComponent( key ) + '=' + encodeURIComponent( body[ key ])
-                }).join('&');
-                // Update header
-                proxyReq.setHeader( 'content-type', 'application/x-www-form-urlencoded' );
-                proxyReq.setHeader( 'content-length', body.length );
-                // Write out body changes to the proxyReq stream
-                proxyReq.write( body );
-                proxyReq.end();
-            }
-        }
-    };
-    // Proxy configuration
-    var proxy = ProxyMiddleware( proxy_filter, proxy_options );
-    /* GET home page. */
-    router.get('/', function(req, res, next) {
-        res.render('index', { title: 'Node.js Express Proxy Test' });
-    });
-    router.all('/docs', proxy );
-    module.exports = router;