http-proxy-middleware 1.0.0 → 1.0.4

package/CHANGELOG.md

@@ -1,8 +1,24 @@
 # Changelog
 
+## [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))
+
+## [v1.0.2](https://github.com/chimurai/http-proxy-middleware/releases/tag/v1.0.2)
+
+- fix(router): handle rejected promise in custom router ([#410](https://github.com/chimurai/http-proxy-middleware/pull/413)) ([bforbis](https://github.com/bforbis))
+
+## [v1.0.1](https://github.com/chimurai/http-proxy-middleware/releases/tag/v1.0.1)
+
+- fix(typescript): fix proxyRes and router types ([#410](https://github.com/chimurai/http-proxy-middleware/issues/410)) ([dylang](https://github.com/dylang))
+
 ## [v1.0.0](https://github.com/chimurai/http-proxy-middleware/releases/tag/v1.0.0)
 
-- feat(createProxyMiddleware): explicit import http-proxy-middleware (BREAKING CHANGE)([#400](https://github.com/chimurai/http-proxy-middleware/issues/400#issuecomment-587162378))
+- feat(createProxyMiddleware): explicit import http-proxy-middleware ([BREAKING CHANGE](https://github.com/chimurai/http-proxy-middleware/releases))([#400](https://github.com/chimurai/http-proxy-middleware/issues/400#issuecomment-587162378))
 - feat(typescript): export http-proxy-middleware types ([#400](https://github.com/chimurai/http-proxy-middleware/issues/400))
 - fix(typescript): ES6 target - TS1192 ([#400](https://github.com/chimurai/http-proxy-middleware/issues/400#issuecomment-587064349))
 

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',
   });
   ```
 
@@ -228,7 +228,6 @@ Providing an alternative way to decide which requests should be proxied; In case
     if (should_add_something) path += "something";
     return path;
   }
-
   ```
 
 - **option.router**: object/function, re-target `option.target` for specific requests.
@@ -243,11 +242,20 @@ Providing an alternative way to decide which requests should be proxied; In case
       '/rest'                      : 'http://localhost:8004'   // path only
   }
 
-  // Custom router function
+  // Custom router function (string target)
   router: function(req) {
       return 'http://localhost:8004';
   }
 
+  // Custom router function (target object)
+  router: function(req) {
+      return {
+          protocol: 'https:', // The : is required
+          host: 'localhost',
+          port: 8004
+      };
+  }
+
   // Asynchronous router function which returns promise
   router: async function(req) {
       const url = await doSomeIO();
@@ -277,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;
   }
@@ -292,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.');
   }
@@ -409,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
     );

package/dist/config-factory.js

@@ -9,7 +9,7 @@ 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)) {

package/dist/http-proxy-middleware.js

@@ -24,8 +24,13 @@ class HttpProxyMiddleware {
         // 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* () {
             if (this.shouldProxy(this.config.context, req)) {
-                const activeProxyOptions = yield this.prepareProxyRequest(req);
-                this.proxy.web(req, res, activeProxyOptions);
+                try {
+                    const activeProxyOptions = yield this.prepareProxyRequest(req);
+                    this.proxy.web(req, res, activeProxyOptions);
+                }
+                catch (err) {
+                    next(err);
+                }
             }
             else {
                 next();
@@ -35,7 +40,7 @@ class HttpProxyMiddleware {
                 this.catchUpgradeRequest(req.connection.server);
             }
         });
-        this.catchUpgradeRequest = server => {
+        this.catchUpgradeRequest = (server) => {
             if (!this.wsInternalSubscribed) {
                 server.on('upgrade', this.handleUpgrade);
                 // prevent duplicate upgrade handling;

package/dist/logger.js

@@ -9,7 +9,7 @@ const defaultProvider = {
     debug: console.log,
     info: console.info,
     warn: console.warn,
-    error: console.error
+    error: console.error,
 };
 // log level 'weight'
 var LEVELS;

package/dist/path-rewriter.js

@@ -25,7 +25,7 @@ function createPathRewriter(rewriteConfig) {
     }
     function rewritePath(path) {
         let result = path;
-        _.forEach(rulesCache, rule => {
+        _.forEach(rulesCache, (rule) => {
             if (rule.regex.test(path)) {
                 result = result.replace(rule.regex, rule.value);
                 logger.debug('[HPM] Rewriting path from "%s" to "%s"', path, result);
@@ -58,7 +58,7 @@ function parsePathRewriteRules(rewriteConfig) {
         _.forIn(rewriteConfig, (value, key) => {
             rules.push({
                 regex: new RegExp(key),
-                value: rewriteConfig[key]
+                value: rewriteConfig[key],
             });
             logger.info('[HPM] Proxy rewrite rule created: "%s" ~> "%s"', key, rewriteConfig[key]);
         });

package/dist/types.d.ts

@@ -16,12 +16,12 @@ export interface Options extends httpProxy.ServerOptions {
         [regexp: string]: string;
     } | ((path: string, req: Request) => string) | ((path: string, req: Request) => Promise<string>);
     router?: {
-        [hostOrPath: string]: string;
-    } | ((req: Request) => string) | ((req: Request) => Promise<string>);
+        [hostOrPath: string]: httpProxy.ServerOptions['target'];
+    } | ((req: Request) => httpProxy.ServerOptions['target']) | ((req: Request) => Promise<httpProxy.ServerOptions['target']>);
     logLevel?: 'debug' | 'info' | 'warn' | 'error' | 'silent';
     logProvider?(provider: LogProvider): LogProvider;
     onError?(err: Error, req: Request, res: Response): void;
-    onProxyRes?(proxyRes: http.ServerResponse, req: Request, res: Response): void;
+    onProxyRes?(proxyRes: http.IncomingMessage, req: Request, res: Response): void;
     onProxyReq?(proxyReq: http.ClientRequest, req: Request, res: Response): void;
     onProxyReqWs?(proxyReq: http.ClientRequest, req: Request, socket: net.Socket, options: httpProxy.ServerOptions, head: any): void;
     onOpen?(proxySocket: net.Socket): void;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "http-proxy-middleware",
-  "version": "1.0.0",
+  "version": "1.0.4",
   "description": "The one-liner node.js proxy middleware for connect, express and browser-sync",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -15,13 +15,9 @@
     "lint:fix": "prettier --write \"**/*.{js,ts,md}\"",
     "build": "tsc",
     "pretest": "yarn build",
-    "test": "jest --runInBand",
-    "precover": "yarn clean && yarn build",
-    "cover": "jest --runInBand --coverage",
-    "precoveralls": "yarn clean && yarn build",
-    "coveralls": "jest --runInBand --coverage --coverageReporters=text-lcov | coveralls",
-    "postcoveralls": "yarn clean",
-    "prepare": "yarn clean && yarn build"
+    "test": "jest",
+    "coverage": "jest --coverage --coverageReporters=lcov",
+    "prepare": "yarn clean && yarn build && rm dist/tsconfig.tsbuildinfo"
   },
   "repository": {
     "type": "git",
@@ -50,31 +46,34 @@
   },
   "homepage": "https://github.com/chimurai/http-proxy-middleware#readme",
   "devDependencies": {
-    "@commitlint/cli": "^8.0.0",
-    "@commitlint/config-conventional": "^8.0.0",
-    "@types/express": "^4.17.0",
-    "@types/is-glob": "^4.0.0",
-    "@types/jest": "^25.1.2",
-    "@types/lodash": "^4.14.149",
+    "@commitlint/cli": "^8.3.5",
+    "@commitlint/config-conventional": "^8.3.4",
+    "@types/express": "^4.17.3",
+    "@types/is-glob": "^4.0.1",
+    "@types/jest": "^25.2.1",
+    "@types/lodash": "^4.14.150",
     "@types/micromatch": "^4.0.1",
-    "@types/node": "^12.6.2",
+    "@types/node": "^13.13.5",
+    "@types/supertest": "^2.0.9",
     "browser-sync": "^2.26.7",
-    "connect": "^3.6.6",
-    "coveralls": "^3.0.5",
-    "express": "^4.16.4",
-    "husky": "^3.0.0",
-    "jest": "^25.1.0",
-    "open": "^7.0.2",
-    "prettier": "^1.19.1",
-    "ts-jest": "^25.2.0",
-    "tslint": "^6.0.0",
+    "connect": "^3.7.0",
+    "express": "^4.17.1",
+    "husky": "^4.2.5",
+    "jest": "^26.0.1",
+    "lint-staged": "^10.2.2",
+    "mockttp": "^0.20.1",
+    "open": "^7.0.3",
+    "prettier": "^2.0.5",
+    "supertest": "^4.0.2",
+    "ts-jest": "^25.5.0",
+    "tslint": "^6.1.2",
     "tslint-config-prettier": "^1.18.0",
-    "typescript": "^3.7.5",
-    "ws": "^7.1.0"
+    "typescript": "^3.8.3",
+    "ws": "^7.2.5"
   },
   "dependencies": {
-    "@types/http-proxy": "^1.17.3",
-    "http-proxy": "^1.18.0",
+    "@types/http-proxy": "^1.17.4",
+    "http-proxy": "^1.18.1",
     "is-glob": "^4.0.1",
     "lodash": "^4.17.15",
     "micromatch": "^4.0.2"
@@ -84,7 +83,8 @@
   },
   "husky": {
     "hooks": {
-      "commit-msg": "commitlint -E HUSKY_GIT_PARAMS"
+      "commit-msg": "commitlint -E HUSKY_GIT_PARAMS",
+      "pre-commit": "lint-staged"
     }
   },
   "commitlint": {