http-proxy-middleware 1.0.3 → 1.1.0

package/CHANGELOG.md

@@ -1,5 +1,24 @@
 # Changelog
 
+## [v1.1.0](https://github.com/chimurai/http-proxy-middleware/releases/tag/v1.1.0)
+
+- fix(errorHandler): fix confusing error message ([#509](https://github.com/chimurai/http-proxy-middleware/pull/509))
+- fix(proxy): close proxy when server closes ([#508](https://github.com/chimurai/http-proxy-middleware/pull/508))
+- refactor(lodash): remove lodash ([#459](https://github.com/chimurai/http-proxy-middleware/pull/459)) ([#507](https://github.com/chimurai/http-proxy-middleware/pull/507)) ([TrySound](https://github.com/TrySound))
+- fix(ETIMEDOUT): return 504 on ETIMEDOUT ([#480](https://github.com/chimurai/http-proxy-middleware/pull/480)) ([aremishevsky](https://github.com/aremishevsky))
+
+## [v1.0.6](https://github.com/chimurai/http-proxy-middleware/releases/tag/v1.0.6)
+
+- chore(deps): lodash 4.17.20 ([#475](https://github.com/chimurai/http-proxy-middleware/pull/475))
+
+## [v1.0.5](https://github.com/chimurai/http-proxy-middleware/releases/tag/v1.0.6)
+
+- chore(deps): lodash 4.17.19 ([#454](https://github.com/chimurai/http-proxy-middleware/pull/454))
+
+## [v1.0.4](https://github.com/chimurai/http-proxy-middleware/releases/tag/v1.0.4)
+
+- chore(deps): http-proxy 1.18.1 ([#442](https://github.com/chimurai/http-proxy-middleware/pull/442))
+
 ## [v1.0.3](https://github.com/chimurai/http-proxy-middleware/releases/tag/v1.0.3)
 
 - build(package): exclude build artifact tsconfig.tsbuildinfo ([#415](https://github.com/chimurai/http-proxy-middleware/pull/415))

package/README.md

@@ -132,13 +132,13 @@ const options = {
   ws: true, // proxy websockets
   pathRewrite: {
     '^/api/old-path': '/api/new-path', // rewrite path
-    '^/api/remove/path': '/path' // remove base path
+    '^/api/remove/path': '/path', // remove base path
   },
   router: {
     // when request.headers.host == 'dev.localhost:3000',
     // override target 'http://www.example.org' to 'http://localhost:8000'
-    'dev.localhost:3000': 'http://localhost:8000'
-  }
+    'dev.localhost:3000': 'http://localhost:8000',
+  },
 };
 
 // create the proxy (without context)
@@ -194,12 +194,12 @@ Providing an alternative way to decide which requests should be proxied; In case
   /**
    * @return {Boolean}
    */
-  const filter = function(pathname, req) {
+  const filter = function (pathname, req) {
     return pathname.match('^/api') && req.method === 'GET';
   };
 
   const apiProxy = createProxyMiddleware(filter, {
-    target: 'http://www.example.org'
+    target: 'http://www.example.org',
   });
   ```
 
@@ -285,7 +285,7 @@ Providing an alternative way to decide which requests should be proxied; In case
       debug: logger.debug,
       info: logger.info,
       warn: logger.warn,
-      error: logger.error
+      error: logger.error,
     };
     return myCustomProvider;
   }
@@ -300,7 +300,7 @@ Subscribe to [http-proxy events](https://github.com/nodejitsu/node-http-proxy#li
   ```javascript
   function onError(err, req, res) {
     res.writeHead(500, {
-      'Content-Type': 'text/plain'
+      'Content-Type': 'text/plain',
     });
     res.end('Something went wrong. And we are reporting a custom error message.');
   }
@@ -417,7 +417,7 @@ The following options are provided by the underlying [http-proxy](https://github
       res,
       {
         target: 'http://localhost:4003/',
-        buffer: streamify(req.rawBody)
+        buffer: streamify(req.rawBody),
       },
       next
     );
@@ -540,4 +540,4 @@ $ yarn cover
 
 The MIT License (MIT)
 
-Copyright (c) 2015-2020 Steven Chim
+Copyright (c) 2015-2021 Steven Chim

package/dist/config-factory.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-const _ = require("lodash");
+exports.createConfig = void 0;
+const isPlainObj = require("is-plain-obj");
 const url = require("url");
 const errors_1 = require("./errors");
 const logger_1 = require("./logger");
@@ -9,12 +10,12 @@ function createConfig(context, opts) {
     // structure of config object to be returned
     const config = {
         context: undefined,
-        options: {}
+        options: {},
     };
     // app.use('/api', proxy({target:'http://localhost:9000'}));
     if (isContextless(context, opts)) {
         config.context = '/';
-        config.options = _.assign(config.options, context);
+        config.options = Object.assign(config.options, context);
         // app.use('/api', proxy('http://localhost:9000'));
         // app.use(proxy('http://localhost:9000/api'));
     }
@@ -22,7 +23,7 @@ function createConfig(context, opts) {
         const oUrl = url.parse(context);
         const target = [oUrl.protocol, '//', oUrl.host].join('');
         config.context = oUrl.pathname || '/';
-        config.options = _.assign(config.options, { target }, opts);
+        config.options = Object.assign(config.options, { target }, opts);
         if (oUrl.protocol === 'ws:' || oUrl.protocol === 'wss:') {
             config.options.ws = true;
         }
@@ -30,7 +31,7 @@ function createConfig(context, opts) {
     }
     else {
         config.context = context;
-        config.options = _.assign(config.options, opts);
+        config.options = Object.assign(config.options, opts);
     }
     configureLogger(config.options);
     if (!config.options.target) {
@@ -51,7 +52,7 @@ exports.createConfig = createConfig;
  * @return {Boolean}         [description]
  */
 function isStringShortHand(context) {
-    if (_.isString(context)) {
+    if (typeof context === 'string') {
         return !!url.parse(context).host;
     }
 }
@@ -67,7 +68,7 @@ function isStringShortHand(context) {
  * @return {Boolean}         [description]
  */
 function isContextless(context, opts) {
-    return _.isPlainObject(context) && _.isEmpty(opts);
+    return isPlainObj(context) && (opts == null || Object.keys(opts).length === 0);
 }
 function configureLogger(options) {
     if (options.logLevel) {

package/dist/context-matcher.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.match = void 0;
 const isGlob = require("is-glob");
-const _ = require("lodash");
 const micromatch = require("micromatch");
 const url = require("url");
 const errors_1 = require("./errors");
@@ -25,7 +25,7 @@ function match(context, uri, req) {
         throw new Error(errors_1.ERRORS.ERR_CONTEXT_MATCHER_INVALID_ARRAY);
     }
     // custom matching
-    if (_.isFunction(context)) {
+    if (typeof context === 'function') {
         const pathname = getUrlPathName(uri);
         return context(pathname, req);
     }
@@ -74,7 +74,7 @@ function getUrlPathName(uri) {
     return uri && url.parse(uri).pathname;
 }
 function isStringPath(context) {
-    return _.isString(context) && !isGlob(context);
+    return typeof context === 'string' && !isGlob(context);
 }
 function isGlobPath(context) {
     return isGlob(context);

package/dist/errors.js

@@ -1,5 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.ERRORS = void 0;
 var ERRORS;
 (function (ERRORS) {
     ERRORS["ERR_CONFIG_FACTORY_TARGET_MISSING"] = "[HPM] Missing \"target\" option. Example: {target: \"http://www.example.org\"}";

package/dist/handlers.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-const _ = require("lodash");
+exports.getHandlers = exports.init = void 0;
+const camelcase = require("camelcase");
 const logger_1 = require("./logger");
 const logger = logger_1.getInstance();
 function init(proxy, option) {
@@ -19,18 +20,18 @@ function getHandlers(options) {
         // 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)) {
+        const eventName = camelcase('on ' + event);
+        const fnHandler = options ? options[eventName] : null;
+        if (typeof fnHandler === 'function') {
             handlers[event] = fnHandler;
         }
     }
     // add default error handler in absence of error handler
-    if (!_.isFunction(handlers.error)) {
+    if (typeof handlers.error !== 'function') {
         handlers.error = defaultErrorHandler;
     }
     // add default close handler in absence of close handler
-    if (!_.isFunction(handlers.close)) {
+    if (typeof handlers.close !== 'function') {
         handlers.close = logClose;
     }
     return handlers;
@@ -48,6 +49,7 @@ function defaultErrorHandler(err, req, res) {
                 case 'ECONNRESET':
                 case 'ENOTFOUND':
                 case 'ECONNREFUSED':
+                case 'ETIMEDOUT':
                     res.writeHead(504);
                     break;
                 default:
@@ -55,7 +57,7 @@ function defaultErrorHandler(err, req, res) {
             }
         }
     }
-    res.end('Error occured while trying to proxy to: ' + host + req.url);
+    res.end(`Error occured while trying to proxy: ${host}${req.url}`);
 }
 function logClose(req, socket, head) {
     // view disconnected websocket connections

package/dist/http-proxy-middleware.d.ts

@@ -3,6 +3,7 @@ export declare class HttpProxyMiddleware {
     private logger;
     private config;
     private wsInternalSubscribed;
+    private serverOnCloseSubscribed;
     private proxyOptions;
     private proxy;
     private pathRewriter;

package/dist/http-proxy-middleware.js

@@ -9,8 +9,8 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.HttpProxyMiddleware = void 0;
 const httpProxy = require("http-proxy");
-const _ = require("lodash");
 const config_factory_1 = require("./config-factory");
 const contextMatcher = require("./context-matcher");
 const handlers = require("./handlers");
@@ -21,8 +21,10 @@ class HttpProxyMiddleware {
     constructor(context, opts) {
         this.logger = logger_1.getInstance();
         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* () {
+            var _a, _b;
             if (this.shouldProxy(this.config.context, req)) {
                 try {
                     const activeProxyOptions = yield this.prepareProxyRequest(req);
@@ -35,12 +37,28 @@ class HttpProxyMiddleware {
             else {
                 next();
             }
+            /**
+             * Get the server object to subscribe to server events;
+             * 'upgrade' for websocket and 'close' for graceful shutdown
+             *
+             * NOTE:
+             * req.socket: node >= 13
+             * req.connection: node < 13 (Remove this when node 12/13 support is dropped)
+             */
+            const server = (_b = ((_a = req.socket) !== null && _a !== void 0 ? _a : req.connection)) === null || _b === void 0 ? void 0 : _b.server;
+            if (server && !this.serverOnCloseSubscribed) {
+                server.on('close', () => {
+                    this.logger.info('[HPM] server close signal received: closing proxy server');
+                    this.proxy.close();
+                });
+                this.serverOnCloseSubscribed = true;
+            }
             if (this.proxyOptions.ws === true) {
                 // use initial request to access the server object to subscribe to http upgrade event
-                this.catchUpgradeRequest(req.connection.server);
+                this.catchUpgradeRequest(server);
             }
         });
-        this.catchUpgradeRequest = server => {
+        this.catchUpgradeRequest = (server) => {
             if (!this.wsInternalSubscribed) {
                 server.on('upgrade', this.handleUpgrade);
                 // prevent duplicate upgrade handling;
@@ -81,7 +99,7 @@ class HttpProxyMiddleware {
             req.url = req.originalUrl || req.url;
             // store uri before it gets rewritten for logging
             const originalPath = req.url;
-            const newProxyOptions = _.assign({}, this.proxyOptions);
+            const newProxyOptions = Object.assign({}, this.proxyOptions);
             // Apply in order:
             // 1. option.router
             // 2. option.pathRewrite

package/dist/index.js

@@ -1,5 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.createProxyMiddleware = void 0;
 const http_proxy_middleware_1 = require("./http-proxy-middleware");
 function createProxyMiddleware(context, options) {
     const { middleware } = new http_proxy_middleware_1.HttpProxyMiddleware(context, options);

package/dist/logger.js

@@ -1,6 +1,7 @@
 "use strict";
+/* eslint-disable prefer-rest-params */
 Object.defineProperty(exports, "__esModule", { value: true });
-const _ = require("lodash");
+exports.getArrow = exports.getInstance = void 0;
 const util = require("util");
 let loggerInstance;
 const defaultProvider = {
@@ -9,7 +10,7 @@ const defaultProvider = {
     debug: console.log,
     info: console.info,
     warn: console.warn,
-    error: console.error
+    error: console.error,
 };
 // log level 'weight'
 var LEVELS;
@@ -68,7 +69,7 @@ class Logger {
     }
     isValidProvider(fnProvider) {
         const result = true;
-        if (fnProvider && !_.isFunction(fnProvider)) {
+        if (fnProvider && typeof fnProvider !== 'function') {
             throw new Error('[HPM] Log provider config error. Expecting a function.');
         }
         return result;
@@ -96,9 +97,8 @@ class Logger {
     }
     // make sure logged messages and its data are return interpolated
     // make it possible for additional log data, such date/time or custom prefix.
-    _interpolate() {
-        const fn = _.spread(util.format);
-        const result = fn(_.slice(arguments));
+    _interpolate(format, ...args) {
+        const result = util.format(format, ...args);
         return result;
     }
 }

package/dist/path-rewriter.d.ts

@@ -4,4 +4,4 @@
  * @param {Object} rewriteConfig
  * @return {Function} Function to rewrite paths; This function should accept `path` (request.url) as parameter
  */
-export declare function createPathRewriter(rewriteConfig: any): (...args: any[]) => any;
+export declare function createPathRewriter(rewriteConfig: any): any;

package/dist/path-rewriter.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-const _ = require("lodash");
+exports.createPathRewriter = void 0;
+const isPlainObj = require("is-plain-obj");
 const errors_1 = require("./errors");
 const logger_1 = require("./logger");
 const logger = logger_1.getInstance();
@@ -15,7 +16,7 @@ function createPathRewriter(rewriteConfig) {
     if (!isValidRewriteConfig(rewriteConfig)) {
         return;
     }
-    if (_.isFunction(rewriteConfig)) {
+    if (typeof rewriteConfig === 'function') {
         const customRewriteFn = rewriteConfig;
         return customRewriteFn;
     }
@@ -25,27 +26,25 @@ function createPathRewriter(rewriteConfig) {
     }
     function rewritePath(path) {
         let result = path;
-        _.forEach(rulesCache, rule => {
+        for (const rule of rulesCache) {
             if (rule.regex.test(path)) {
                 result = result.replace(rule.regex, rule.value);
                 logger.debug('[HPM] Rewriting path from "%s" to "%s"', path, result);
-                return false;
+                break;
             }
-        });
+        }
         return result;
     }
 }
 exports.createPathRewriter = createPathRewriter;
 function isValidRewriteConfig(rewriteConfig) {
-    if (_.isFunction(rewriteConfig)) {
+    if (typeof rewriteConfig === 'function') {
         return true;
     }
-    else if (!_.isEmpty(rewriteConfig) && _.isPlainObject(rewriteConfig)) {
-        return true;
+    else if (isPlainObj(rewriteConfig)) {
+        return Object.keys(rewriteConfig).length !== 0;
     }
-    else if (_.isUndefined(rewriteConfig) ||
-        _.isNull(rewriteConfig) ||
-        _.isEqual(rewriteConfig, {})) {
+    else if (rewriteConfig === undefined || rewriteConfig === null) {
         return false;
     }
     else {
@@ -54,14 +53,14 @@ function isValidRewriteConfig(rewriteConfig) {
 }
 function parsePathRewriteRules(rewriteConfig) {
     const rules = [];
-    if (_.isPlainObject(rewriteConfig)) {
-        _.forIn(rewriteConfig, (value, key) => {
+    if (isPlainObj(rewriteConfig)) {
+        for (const [key] of Object.entries(rewriteConfig)) {
             rules.push({
                 regex: new RegExp(key),
-                value: rewriteConfig[key]
+                value: rewriteConfig[key],
             });
             logger.info('[HPM] Proxy rewrite rule created: "%s" ~> "%s"', key, rewriteConfig[key]);
-        });
+        }
     }
     return rules;
 }

package/dist/router.js

@@ -9,17 +9,18 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-const _ = require("lodash");
+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 (_.isPlainObject(router)) {
+        if (isPlainObj(router)) {
             newTarget = getTargetFromProxyTable(req, router);
         }
-        else if (_.isFunction(router)) {
+        else if (typeof router === 'function') {
             newTarget = yield router(req);
         }
         return newTarget;
@@ -31,13 +32,13 @@ function getTargetFromProxyTable(req, table) {
     const host = req.headers.host;
     const path = req.url;
     const hostAndPath = host + path;
-    _.forIn(table, (value, key) => {
+    for (const [key] of Object.entries(table)) {
         if (containsPath(key)) {
             if (hostAndPath.indexOf(key) > -1) {
                 // match 'localhost:3000/api'
                 result = table[key];
                 logger.debug('[HPM] Router table match: "%s"', key);
-                return false;
+                break;
             }
         }
         else {
@@ -45,10 +46,10 @@ function getTargetFromProxyTable(req, table) {
                 // match 'localhost:3000'
                 result = table[key];
                 logger.debug('[HPM] Router table match: "%s"', host);
-                return false;
+                break;
             }
         }
-    });
+    }
     return result;
 }
 function containsPath(v) {

package/dist/types.js

@@ -1,2 +1,3 @@
 "use strict";
+/* eslint-disable @typescript-eslint/no-empty-interface */
 Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "http-proxy-middleware",
-  "version": "1.0.3",
+  "version": "1.1.0",
   "description": "The one-liner node.js proxy middleware for connect, express and browser-sync",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -9,18 +9,16 @@
   ],
   "scripts": {
     "clean": "rm -rf dist && rm -rf coverage",
-    "lint": "yarn lint:prettier && yarn lint:tslint",
-    "lint:prettier": "prettier --check \"**/*.{js,ts,md}\"",
-    "lint:tslint": "yarn tslint -c tslint.json '{lib,test}/**/*.ts'",
-    "lint:fix": "prettier --write \"**/*.{js,ts,md}\"",
+    "lint": "yarn prettier && yarn eslint",
+    "lint:fix": "yarn prettier:fix && yarn eslint:fix",
+    "eslint": "eslint '{src,test}/**/*.ts'",
+    "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}\"",
     "build": "tsc",
     "pretest": "yarn build",
     "test": "jest",
-    "precover": "yarn clean && yarn build",
-    "cover": "jest --coverage",
-    "precoveralls": "yarn clean && yarn build",
-    "coveralls": "jest --coverage --coverageReporters=text-lcov | coveralls",
-    "postcoveralls": "yarn clean",
+    "coverage": "jest --coverage --coverageReporters=lcov",
     "prepare": "yarn clean && yarn build && rm dist/tsconfig.tsbuildinfo"
   },
   "repository": {
@@ -50,37 +48,40 @@
   },
   "homepage": "https://github.com/chimurai/http-proxy-middleware#readme",
   "devDependencies": {
-    "@commitlint/cli": "^8.3.5",
-    "@commitlint/config-conventional": "^8.3.4",
-    "@types/express": "^4.17.2",
+    "@commitlint/cli": "^12.0.1",
+    "@commitlint/config-conventional": "^12.0.1",
+    "@types/express": "^4.17.3",
     "@types/is-glob": "^4.0.1",
-    "@types/jest": "^25.1.3",
-    "@types/lodash": "^4.14.149",
+    "@types/jest": "^26.0.22",
     "@types/micromatch": "^4.0.1",
-    "@types/node": "^13.7.4",
-    "@types/supertest": "^2.0.8",
-    "browser-sync": "^2.26.7",
+    "@types/node": "^14.14.37",
+    "@types/supertest": "^2.0.10",
+    "@types/ws": "^7.4.0",
+    "@typescript-eslint/eslint-plugin": "^4.19.0",
+    "@typescript-eslint/parser": "^4.19.0",
+    "browser-sync": "^2.26.14",
     "connect": "^3.7.0",
-    "coveralls": "^3.0.5",
+    "eslint": "^7.23.0",
+    "eslint-config-prettier": "^8.1.0",
+    "eslint-plugin-prettier": "^3.3.1",
     "express": "^4.17.1",
-    "husky": "^4.2.3",
-    "jest": "^25.1.0",
-    "lint-staged": "^10.0.7",
-    "mockttp": "^0.19.3",
-    "open": "^7.0.2",
-    "prettier": "^1.19.1",
-    "supertest": "^4.0.2",
-    "ts-jest": "^25.2.0",
-    "tslint": "^6.0.0",
-    "tslint-config-prettier": "^1.18.0",
-    "typescript": "^3.8.2",
-    "ws": "^7.2.1"
+    "husky": "^4.3.0",
+    "jest": "^26.6.3",
+    "lint-staged": "^10.5.4",
+    "mockttp": "^1.2.0",
+    "open": "^7.4.2",
+    "prettier": "^2.2.1",
+    "supertest": "^6.1.3",
+    "ts-jest": "^26.5.4",
+    "typescript": "^4.2.3",
+    "ws": "^7.4.4"
   },
   "dependencies": {
-    "@types/http-proxy": "^1.17.3",
-    "http-proxy": "^1.18.0",
+    "@types/http-proxy": "^1.17.5",
+    "camelcase": "^6.2.0",
+    "http-proxy": "^1.18.1",
     "is-glob": "^4.0.1",
-    "lodash": "^4.17.15",
+    "is-plain-obj": "^3.0.0",
     "micromatch": "^4.0.2"
   },
   "engines": {