http-proxy-middleware 1.2.0 → 1.3.1

package/CHANGELOG.md

@@ -1,5 +1,18 @@
 # Changelog
 
+## [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

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

@@ -28,8 +28,8 @@ function responseInterceptor(interceptor) {
             // concat data stream
             _proxyRes.on('data', (chunk) => (buffer = Buffer.concat([buffer, chunk])));
             _proxyRes.on('end', () => __awaiter(this, void 0, void 0, function* () {
-                // set original content type from upstream
-                res.setHeader('content-type', originalProxyRes.headers['content-type'] || '');
+                // 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)
@@ -70,3 +70,28 @@ function decompress(proxyRes, contentEncoding) {
     }
     return _proxyRes;
 }
+/**
+ * Copy original headers
+ * https://github.com/apache/superset/blob/9773aba522e957ed9423045ca153219638a85d2f/superset-frontend/webpack.proxy-config.js#L78
+ */
+function copyHeaders(originalResponse, response) {
+    response.statusCode = originalResponse.statusCode;
+    response.statusMessage = originalResponse.statusMessage;
+    if (response.setHeader) {
+        let keys = Object.keys(originalResponse.headers);
+        // ignore chunked, brotli, gzip, deflate headers
+        keys = keys.filter((key) => !['content-encoding', 'transfer-encoding'].includes(key));
+        keys.forEach((key) => {
+            let value = originalResponse.headers[key];
+            if (key === 'set-cookie') {
+                // remove cookie domain
+                value = Array.isArray(value) ? value : [value];
+                value = value.map((x) => x.replace(/Domain=[^;]+?/i, ''));
+            }
+            response.setHeader(key, value);
+        });
+    }
+    else {
+        response.headers = originalResponse.headers;
+    }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "http-proxy-middleware",
-  "version": "1.2.0",
+  "version": "1.3.1",
   "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,12 @@
     "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",
     "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 +61,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",