http-proxy-middleware 1.2.1-alpha.1 → 2.0.0

package/CHANGELOG.md

@@ -1,5 +1,22 @@
 # Changelog
 
+## [v2.0.0](https://github.com/chimurai/http-proxy-middleware/releases/tag/v2.0.0)
+
+- chore(package): drop node 10 [BREAKING CHANGE] ([#577](https://github.com/chimurai/http-proxy-middleware/pull/577))
+
+## [v1.3.1](https://github.com/chimurai/http-proxy-middleware/releases/tag/v1.3.1)
+
+- fix(fix-request-body): make sure the content-type exists ([#578](https://github.com/chimurai/http-proxy-middleware/pull/578)) ([oufeng](https://github.com/oufeng))
+
+## [v1.3.0](https://github.com/chimurai/http-proxy-middleware/releases/tag/v1.3.0)
+
+- docs(response interceptor): align with nodejs default utf8 ([#567](https://github.com/chimurai/http-proxy-middleware/pull/567))
+- feat: try to proxy body even after body-parser middleware ([#492](https://github.com/chimurai/http-proxy-middleware/pull/492)) ([midgleyc](https://github.com/midgleyc))
+
+## [v1.2.1](https://github.com/chimurai/http-proxy-middleware/releases/tag/v1.2.1)
+
+- fix(response interceptor): proxy original response headers ([#563](https://github.com/chimurai/http-proxy-middleware/pull/563))
+
 ## [v1.2.0](https://github.com/chimurai/http-proxy-middleware/releases/tag/v1.2.0)
 
 - feat(handler): response interceptor ([#520](https://github.com/chimurai/http-proxy-middleware/pull/520))

package/README.md

@@ -1,6 +1,6 @@
 # http-proxy-middleware
 
-[![GitHub Workflow Status (branch)](https://img.shields.io/github/workflow/status/chimurai/http-proxy-middleware/Test/master?style=flat-square)](https://github.com/chimurai/http-proxy-middleware/actions?query=branch%3Amaster)
+[![GitHub Workflow Status (branch)](https://img.shields.io/github/workflow/status/chimurai/http-proxy-middleware/CI/master?style=flat-square)](https://github.com/chimurai/http-proxy-middleware/actions?query=branch%3Amaster)
 [![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?style=flat-square)](https://snyk.io/test/npm/http-proxy-middleware)
@@ -69,6 +69,7 @@ _All_ `http-proxy` [options](https://github.com/nodejitsu/node-http-proxy#option
   - [app.use\(path, proxy\)](#appusepath-proxy)
 - [WebSocket](#websocket)
   - [External WebSocket upgrade](#external-websocket-upgrade)
+- [Intercept and manipulate requests](#intercept-and-manipulate-requests)
 - [Intercept and manipulate responses](#intercept-and-manipulate-responses)
 - [Working examples](#working-examples)
 - [Recipes](#recipes)
@@ -482,6 +483,25 @@ const server = app.listen(3000);
 server.on('upgrade', wsProxy.upgrade); // <-- subscribe to http 'upgrade'
 ```
 
+## Intercept and manipulate requests
+
+Intercept requests from downstream by defining `onProxyReq` in `createProxyMiddleware`.
+
+Currently the only pre-provided request interceptor is `fixRequestBody`, which is used to fix proxied POST requests when `bodyParser` is applied before this middleware.
+
+Example:
+
+```javascript
+const { createProxyMiddleware, fixRequestBody } = require('http-proxy-middleware');
+
+const proxy = createProxyMiddleware({
+  /**
+   * Fix bodyParser
+   **/
+  onProxyReq: fixRequestBody,
+});
+```
+
 ## Intercept and manipulate responses
 
 Intercept responses from upstream with `responseInterceptor`. (Make sure to set `selfHandleResponse: true`)
@@ -507,7 +527,7 @@ const proxy = createProxyMiddleware({
    * Intercept response and replace 'Hello' with 'Goodbye'
    **/
   onProxyRes: responseInterceptor(async (responseBuffer, proxyRes, req, res) => {
-    const response = responseBuffer.toString('utf-8'); // convert buffer to string
+    const response = responseBuffer.toString('utf8'); // convert buffer to string
     return response.replace('Hello', 'Goodbye'); // manipulate response and return the result
   }),
 });

package/dist/handlers/fix-request-body.d.ts

@@ -0,0 +1,7 @@
+/// <reference types="node" />
+import { ClientRequest } from 'http';
+import type { Request } from '../types';
+/**
+ * Fix proxied body if bodyParser is involved.
+ */
+export declare function fixRequestBody(proxyReq: ClientRequest, req: Request): void;

package/dist/handlers/fix-request-body.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.fixRequestBody = void 0;
+const querystring = require("querystring");
+/**
+ * Fix proxied body if bodyParser is involved.
+ */
+function fixRequestBody(proxyReq, req) {
+    if (!req.body || !Object.keys(req.body).length) {
+        return;
+    }
+    const contentType = proxyReq.getHeader('Content-Type');
+    const writeBody = (bodyData) => {
+        // deepcode ignore ContentLengthInCode: bodyParser fix
+        proxyReq.setHeader('Content-Length', Buffer.byteLength(bodyData));
+        proxyReq.write(bodyData);
+    };
+    if (contentType && contentType.includes('application/json')) {
+        writeBody(JSON.stringify(req.body));
+    }
+    if (contentType === 'application/x-www-form-urlencoded') {
+        writeBody(querystring.stringify(req.body));
+    }
+}
+exports.fixRequestBody = fixRequestBody;

package/dist/handlers/public.d.ts

@@ -1 +1,2 @@
 export { responseInterceptor } from './response-interceptor';
+export { fixRequestBody } from './fix-request-body';

package/dist/handlers/public.js

@@ -1,5 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.responseInterceptor = void 0;
+exports.fixRequestBody = exports.responseInterceptor = void 0;
 var response_interceptor_1 = require("./response-interceptor");
 Object.defineProperty(exports, "responseInterceptor", { enumerable: true, get: function () { return response_interceptor_1.responseInterceptor; } });
+var fix_request_body_1 = require("./fix-request-body");
+Object.defineProperty(exports, "fixRequestBody", { enumerable: true, get: function () { return fix_request_body_1.fixRequestBody; } });

package/dist/handlers/response-interceptor.js

@@ -1,13 +1,4 @@
 "use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.responseInterceptor = void 0;
 const zlib = require("zlib");
@@ -19,27 +10,25 @@ const zlib = require("zlib");
  * NOTE: must set options.selfHandleResponse=true (prevent automatic call of res.end())
  */
 function responseInterceptor(interceptor) {
-    return function proxyRes(proxyRes, req, res) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const originalProxyRes = proxyRes;
-            let buffer = Buffer.from('', 'utf8');
-            // decompress proxy response
-            const _proxyRes = decompress(proxyRes, proxyRes.headers['content-encoding']);
-            // concat data stream
-            _proxyRes.on('data', (chunk) => (buffer = Buffer.concat([buffer, chunk])));
-            _proxyRes.on('end', () => __awaiter(this, void 0, void 0, function* () {
-                // copy original headers
-                copyHeaders(proxyRes, res);
-                // call interceptor with intercepted response (buffer)
-                const interceptedBuffer = Buffer.from(yield interceptor(buffer, originalProxyRes, req, res));
-                // set correct content-length (with double byte character support)
-                res.setHeader('content-length', Buffer.byteLength(interceptedBuffer, 'utf8'));
-                res.write(interceptedBuffer);
-                res.end();
-            }));
-            _proxyRes.on('error', (error) => {
-                res.end(`Error fetching proxied request: ${error.message}`);
-            });
+    return async function proxyRes(proxyRes, req, res) {
+        const originalProxyRes = proxyRes;
+        let buffer = Buffer.from('', 'utf8');
+        // decompress proxy response
+        const _proxyRes = decompress(proxyRes, proxyRes.headers['content-encoding']);
+        // concat data stream
+        _proxyRes.on('data', (chunk) => (buffer = Buffer.concat([buffer, chunk])));
+        _proxyRes.on('end', async () => {
+            // copy original headers
+            copyHeaders(proxyRes, res);
+            // call interceptor with intercepted response (buffer)
+            const interceptedBuffer = Buffer.from(await interceptor(buffer, originalProxyRes, req, res));
+            // set correct content-length (with double byte character support)
+            res.setHeader('content-length', Buffer.byteLength(interceptedBuffer, 'utf8'));
+            res.write(interceptedBuffer);
+            res.end();
+        });
+        _proxyRes.on('error', (error) => {
+            res.end(`Error fetching proxied request: ${error.message}`);
         });
     };
 }
@@ -88,10 +77,6 @@ function copyHeaders(originalResponse, response) {
                 value = Array.isArray(value) ? value : [value];
                 value = value.map((x) => x.replace(/Domain=[^;]+?/i, ''));
             }
-            else if (key === 'location') {
-                // set redirects to use local URL
-                // value = (value || '').replace(target, ''); // TODO
-            }
             response.setHeader(key, value);
         });
     }

package/dist/http-proxy-middleware.js

@@ -1,13 +1,4 @@
 "use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.HttpProxyMiddleware = void 0;
 const httpProxy = require("http-proxy");
@@ -23,11 +14,11 @@ class HttpProxyMiddleware {
         this.wsInternalSubscribed = false;
         this.serverOnCloseSubscribed = false;
         // https://github.com/Microsoft/TypeScript/wiki/'this'-in-TypeScript#red-flags-for-this
-        this.middleware = (req, res, next) => __awaiter(this, void 0, void 0, function* () {
+        this.middleware = async (req, res, next) => {
             var _a, _b;
             if (this.shouldProxy(this.config.context, req)) {
                 try {
-                    const activeProxyOptions = yield this.prepareProxyRequest(req);
+                    const activeProxyOptions = await this.prepareProxyRequest(req);
                     this.proxy.web(req, res, activeProxyOptions);
                 }
                 catch (err) {
@@ -57,7 +48,7 @@ class HttpProxyMiddleware {
                 // use initial request to access the server object to subscribe to http upgrade event
                 this.catchUpgradeRequest(server);
             }
-        });
+        };
         this.catchUpgradeRequest = (server) => {
             if (!this.wsInternalSubscribed) {
                 server.on('upgrade', this.handleUpgrade);
@@ -66,13 +57,13 @@ class HttpProxyMiddleware {
                 this.wsInternalSubscribed = true;
             }
         };
-        this.handleUpgrade = (req, socket, head) => __awaiter(this, void 0, void 0, function* () {
+        this.handleUpgrade = async (req, socket, head) => {
             if (this.shouldProxy(this.config.context, req)) {
-                const activeProxyOptions = yield this.prepareProxyRequest(req);
+                const activeProxyOptions = await this.prepareProxyRequest(req);
                 this.proxy.ws(req, socket, head, activeProxyOptions);
                 this.logger.info('[HPM] Upgrading to WebSocket');
             }
-        });
+        };
         /**
          * Determine whether request should be proxied.
          *
@@ -93,7 +84,7 @@ class HttpProxyMiddleware {
          * @param {Object} req
          * @return {Object} proxy options
          */
-        this.prepareProxyRequest = (req) => __awaiter(this, void 0, void 0, function* () {
+        this.prepareProxyRequest = async (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;
@@ -103,30 +94,30 @@ class HttpProxyMiddleware {
             // Apply in order:
             // 1. option.router
             // 2. option.pathRewrite
-            yield this.applyRouter(req, newProxyOptions);
-            yield this.applyPathRewrite(req, this.pathRewriter);
+            await this.applyRouter(req, newProxyOptions);
+            await this.applyPathRewrite(req, this.pathRewriter);
             // debug logging for both http(s) and websockets
             if (this.proxyOptions.logLevel === 'debug') {
                 const arrow = logger_1.getArrow(originalPath, req.url, this.proxyOptions.target, newProxyOptions.target);
                 this.logger.debug('[HPM] %s %s %s %s', req.method, originalPath, arrow, newProxyOptions.target);
             }
             return newProxyOptions;
-        });
+        };
         // Modify option.target when router present.
-        this.applyRouter = (req, options) => __awaiter(this, void 0, void 0, function* () {
+        this.applyRouter = async (req, options) => {
             let newTarget;
             if (options.router) {
-                newTarget = yield Router.getTarget(req, options);
+                newTarget = await Router.getTarget(req, options);
                 if (newTarget) {
                     this.logger.debug('[HPM] Router new target: %s -> "%s"', options.target, newTarget);
                     options.target = newTarget;
                 }
             }
-        });
+        };
         // rewrite path
-        this.applyPathRewrite = (req, pathRewriter) => __awaiter(this, void 0, void 0, function* () {
+        this.applyPathRewrite = async (req, pathRewriter) => {
             if (pathRewriter) {
-                const path = yield pathRewriter(req.url, req);
+                const path = await pathRewriter(req.url, req);
                 if (typeof path === 'string') {
                     req.url = path;
                 }
@@ -134,7 +125,7 @@ class HttpProxyMiddleware {
                     this.logger.info('[HPM] pathRewrite: No rewritten path found. (%s)', req.url);
                 }
             }
-        });
+        };
         this.logError = (err, req, res, target) => {
             var _a;
             const hostname = ((_a = req.headers) === null || _a === void 0 ? void 0 : _a.host) || req.hostname || req.host; // (websocket) || (node0.10 || node 4/5)

package/dist/router.js

@@ -1,30 +1,19 @@
 "use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getTarget = void 0;
 const isPlainObj = require("is-plain-obj");
 const logger_1 = require("./logger");
 const logger = logger_1.getInstance();
-function getTarget(req, config) {
-    return __awaiter(this, void 0, void 0, function* () {
-        let newTarget;
-        const router = config.router;
-        if (isPlainObj(router)) {
-            newTarget = getTargetFromProxyTable(req, router);
-        }
-        else if (typeof router === 'function') {
-            newTarget = yield router(req);
-        }
-        return newTarget;
-    });
+async function getTarget(req, config) {
+    let newTarget;
+    const router = config.router;
+    if (isPlainObj(router)) {
+        newTarget = getTargetFromProxyTable(req, router);
+    }
+    else if (typeof router === 'function') {
+        newTarget = await router(req);
+    }
+    return newTarget;
 }
 exports.getTarget = getTarget;
 function getTargetFromProxyTable(req, table) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "http-proxy-middleware",
-  "version": "1.2.1-alpha.1",
+  "version": "2.0.0",
   "description": "The one-liner node.js proxy middleware for connect, express and browser-sync",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -15,11 +15,13 @@
     "eslint:fix": "yarn eslint --fix",
     "prettier": "prettier --list-different \"**/*.{js,ts,md,yml,json,html}\"",
     "prettier:fix": "prettier --write \"**/*.{js,ts,md,yml,json,html}\"",
+    "prebuild": "yarn clean",
     "build": "tsc",
     "pretest": "yarn build",
     "test": "jest",
+    "precoverage": "yarn build",
     "coverage": "jest --coverage --coverageReporters=lcov",
-    "prepare": "yarn clean && yarn build && rm dist/tsconfig.tsbuildinfo"
+    "prepare": "yarn build && rm dist/tsconfig.tsbuildinfo"
   },
   "repository": {
     "type": "git",
@@ -60,6 +62,7 @@
     "@types/ws": "^7.4.0",
     "@typescript-eslint/eslint-plugin": "^4.19.0",
     "@typescript-eslint/parser": "^4.19.0",
+    "body-parser": "^1.19.0",
     "browser-sync": "^2.26.14",
     "connect": "^3.7.0",
     "eslint": "^7.23.0",
@@ -85,7 +88,7 @@
     "micromatch": "^4.0.2"
   },
   "engines": {
-    "node": ">=8.0.0"
+    "node": ">=12.0.0"
   },
   "husky": {
     "hooks": {