egg-http-proxy-plus 1.0.2 → 2.0.0

package/README.md

@@ -1,33 +1,38 @@
+<div style="text-align: center;" align="center">
+
 # egg-http-proxy-plus
-fork from egg-http-proxy
 
+</div>
+
+<div style="text-align: center;" align="center">
+
+支持转发文件上传接口，支持自定义匹配方法，ctx 透传
+
+</div>
+
+<div style="text-align: center;" align="center">
 
 [![NPM version][npm-image]][npm-url]
+[![Codacy Badge][codacy-image]][codacy-url]
 [![build status][travis-image]][travis-url]
 [![Test coverage][codecov-image]][codecov-url]
-[![David deps][david-image]][david-url]
-[![Known Vulnerabilities][snyk-image]][snyk-url]
 [![npm download][download-image]][download-url]
+[![License][license-image]][license-url]
 
-[npm-image]: https://img.shields.io/npm/v/egg-http-proxy-plus.svg?style=flat-square
-[npm-url]: https://npmjs.org/package/egg-http-proxy-plus
-[travis-image]: https://travis-ci.org/saqqdy/egg-http-proxy-plus.svg?branch=master
-[travis-url]: https://travis-ci.org/saqqdy/egg-http-proxy-plus
-[codecov-image]: https://img.shields.io/codecov/c/github/saqqdy/egg-http-proxy-plus.svg?style=flat-square
-[codecov-url]: https://codecov.io/github/saqqdy/egg-http-proxy-plus?branch=master
-[david-image]: https://img.shields.io/david/saqqdy/egg-http-proxy-plus.svg?style=flat-square
-[david-url]: https://david-dm.org/saqqdy/egg-http-proxy-plus
-[snyk-image]: https://snyk.io/test/npm/egg-http-proxy-plus/badge.svg?style=flat-square
-[snyk-url]: https://snyk.io/test/npm/egg-http-proxy-plus
-[download-image]: https://img.shields.io/npm/dm/egg-http-proxy-plus.svg?style=flat-square
-[download-url]: https://npmjs.org/package/egg-http-proxy-plus
+[![Sonar][sonar-image]][sonar-url]
+
+</div>
 
 Configure proxy middleware for egg. Use [http-proxy-middleware](https://github.com/chimurai/http-proxy-middleware).
 
 ## Install
 
 ```bash
+# use npm
 $ npm i egg-http-proxy-plus --save
+
+# use yarn
+$ yarn add egg-http-proxy-plus
 ```
 
 ## Usage
@@ -36,22 +41,29 @@ $ npm i egg-http-proxy-plus --save
 // {app_root}/config/plugin.js
 exports.httpProxyPlus = {
   enable: true,
-  package: 'egg-http-proxy-plus',
-};
+  package: 'egg-http-proxy-plus'
+}
 ```
 
 ## Configuration
 
-Proxy `/api` requests to `http://www.example.org`:
+### Proxy `/api` requests to `http://www.example.org`
 
 ```js
 // {app_root}/config/config.default.js
 exports.httpProxyPlus = {
   '/api': 'http://www.example.org'
-};
+}
+// or
+exports.httpProxyPlus = [
+  {
+    origin: '/api',
+    options: 'http://www.example.org'
+  }
+]
 ```
 
-A request to `/api/users` will now proxy the request to `http://www.example.org/api/users`.
+#### A request to `/api/users` will now proxy the request to `http://www.example.org/api/users`
 
 If you don't want `/api` to be passed along, we need to rewrite the path:
 
@@ -60,9 +72,55 @@ If you don't want `/api` to be passed along, we need to rewrite the path:
 exports.httpProxyPlus = {
   '/api': {
     target: 'http://www.example.org',
-    pathRewrite: {'^/api' : ''}
+    pathRewrite: { '^/api': '' }
   }
-};
+}
+// or
+exports.httpProxyPlus = [
+  {
+    origin: '/api',
+    options: {
+      target: 'http://www.example.org',
+      pathRewrite: { '^/api': '' }
+      // ...
+    }
+  }
+]
+```
+
+#### custom matching
+
+For full control you can provide a custom function to determine which requests should be proxied or not.
+
+```js
+// {app_root}/config/config.default.js
+exports.httpProxyPlus = [
+  {
+    origin(pathname, req) {
+      return pathname.match('^/api') && req.method === 'GET'
+    },
+    options: {}
+  }
+]
+```
+
+#### http-proxy events
+
+Pay attention to the fourth parameter, the plug-in transparently transmits the ctx context
+
+```js
+// {app_root}/config/config.default.js
+exports.httpProxyPlus = {
+  '/api': {
+    target: 'http://www.example.org',
+    onProxyReq(proxyReq, req, res, ctx) {
+      if (req.method.toLowerCase() === 'post') {
+        const token = ctx.cookies.get('access_token')
+        token && proxyReq.setHeader('authorization', token)
+      }
+    }
+  }
+}
 ```
 
 For more advanced usages, checkout [http-proxy-middleware](https://github.com/chimurai/http-proxy-middleware#options) options documentation.
@@ -74,3 +132,20 @@ Please open an issue [here](https://github.com/saqqdy/egg-http-proxy-plus/issues
 ## License
 
 [MIT](LICENSE)
+
+
+[npm-image]: https://img.shields.io/npm/v/egg-http-proxy-plus.svg?style=flat-square
+[npm-url]: https://npmjs.org/package/egg-http-proxy-plus
+[codacy-image]: https://app.codacy.com/project/badge/Grade/f70d4880e4ad4f40aa970eb9ee9d0696
+[codacy-url]: https://www.codacy.com/gh/saqqdy/egg-http-proxy-plus/dashboard?utm_source=github.com&utm_medium=referral&utm_content=saqqdy/egg-http-proxy-plus&utm_campaign=Badge_Grade
+[travis-image]: https://travis-ci.com/saqqdy/egg-http-proxy-plus.svg?branch=master
+[travis-url]: https://travis-ci.com/saqqdy/egg-http-proxy-plus
+[codecov-image]: https://img.shields.io/codecov/c/github/saqqdy/egg-http-proxy-plus.svg?style=flat-square
+[codecov-url]: https://codecov.io/github/saqqdy/egg-http-proxy-plus?branch=master
+[download-image]: https://img.shields.io/npm/dm/egg-http-proxy-plus.svg?style=flat-square
+[download-url]: https://npmjs.org/package/egg-http-proxy-plus
+[license-image]: https://img.shields.io/badge/License-MIT-blue.svg
+[license-url]: LICENSE
+[sonar-image]: https://sonarcloud.io/api/project_badges/quality_gate?project=saqqdy_egg-http-proxy-plus
+[sonar-url]: https://sonarcloud.io/dashboard?id=saqqdy_egg-http-proxy-plus
+

package/app/middleware/httpProxyPlus.js

@@ -1,62 +1,55 @@
-const proxy = require('http-proxy-middleware')
-const c2k = require('koa2-connect')
+const { createProxyMiddleware } = require('http-proxy-middleware')
+const c2k = require('koa-connect')
 const pathMatching = require('egg-path-matching')
-const getType = obj => {
-	const type = {
-		'[object Array]': 'array',
-		'[object Boolean]': 'boolean',
-		'[object Date]': 'date',
-		'[object Function]': 'function',
-		'[object Number]': 'number',
-		'[object Object]': 'object',
-		'[object RegExp]': 'regexp',
-		'[object String]': 'string'
-	}
-	if (obj === null) return obj + ''
-	return typeof obj === 'object' || typeof obj === 'function' ? type[Object.prototype.toString.call(obj)] || 'object' : typeof obj
-}
+const { getType } = require('js-cool')
+
 module.exports = options => {
-	return async function httpProxyPlus(ctx, next) {
+	return async (ctx, next) => {
 		const path = ctx.request.originalUrl || ctx.request.url
 		const optType = getType(options)
-		if (optType === 'array') {
-			options.forEach(context => {
-				let proxyOptions = context.options || {}
-				if (typeof proxyOptions === 'string') proxyOptions = { target: proxyOptions }
-				const { onProxyReq = null, onProxyRes = null } = Object.assign({}, proxyOptions)
-				if (onProxyReq) proxyOptions.onProxyReq = (...args) => onProxyReq.call(null, ctx, ...args)
-				if (onProxyRes) proxyOptions.onProxyRes = (...args) => onProxyRes.call(null, ctx, ...args)
-				if (getType(context.origin) === 'function') {
-					// custom matching
-					const isMatch = context.origin(path.split('?')[0], ctx.req)
-					isMatch && c2k(proxy(context.origin, proxyOptions))(ctx, next)
-					return isMatch
+		if (optType === 'object') {
+			options = Object.keys(options).map(context => ({
+				origin: context,
+				options: options[context]
+			}))
+		}
+		for (const context of options) {
+			let proxyOptions = context.options || {},
+				isMatch
+			if (typeof proxyOptions === 'string') proxyOptions = { target: proxyOptions }
+			const { onProxyReq = null, onProxyRes = null } = proxyOptions
+			proxyOptions = {
+				...proxyOptions,
+				// eslint-disable-next-line no-unused-vars
+				onProxyReq(proxyReq, req, res, context = ctx) {
+					if (onProxyReq && typeof onProxyReq === 'function') {
+						onProxyReq(proxyReq, req, res, ctx)
+					}
+					const { rawBody, body: requestBody } = ctx.request
+					if (requestBody && rawBody) {
+						proxyReq.setHeader('Content-Length', Buffer.byteLength(rawBody))
+						proxyReq.write(rawBody)
+						proxyReq.end()
+					}
+					return proxyReq
+				},
+				// eslint-disable-next-line no-unused-vars
+				onProxyRes(proxyRes, req, res, context = ctx) {
+					if (onProxyRes && typeof onProxyRes === 'function') {
+						onProxyRes(proxyRes, req, res, ctx)
+					}
+					return proxyRes
 				}
+			}
+			if (getType(context.origin) === 'function') {
+				// custom matching
+				isMatch = context.origin(path.split('?')[0], ctx.req)
+			} else {
 				// context.origin配置的数组、字符串
 				const match = pathMatching({ match: context.origin })
-				const isMatch = match({ path })
-				if (isMatch) {
-					c2k(proxy(context.origin, proxyOptions))(ctx, next)
-				}
-				return isMatch
-			})
-		} else if (optType === 'object') {
-			;[('enable', 'match', 'ignore')].forEach(el => {
-				if (options.hasOwnProperty(el)) delete options[el]
-			})
-			Object.keys(options).some(async context => {
-				const match = pathMatching({ match: context })
-				const isMatch = match({ path })
-				if (isMatch) {
-					let proxyOptions = options[context]
-					if (typeof proxyOptions === 'string') proxyOptions = { target: proxyOptions }
-					const { onProxyReq = null, onProxyRes = null } = Object.assign({}, proxyOptions)
-					if (onProxyReq) proxyOptions.onProxyReq = (...args) => onProxyReq.call(null, ctx, ...args)
-					if (onProxyRes) proxyOptions.onProxyRes = (...args) => onProxyRes.call(null, ctx, ...args)
-					await c2k(proxy(context, proxyOptions))(ctx, next)
-				}
-				return isMatch
-			})
+				isMatch = match({ path })
+			}
+			isMatch && (await c2k(createProxyMiddleware(context.origin, proxyOptions))(ctx, next))
 		}
 		await next()
 	}

package/package.json

@@ -1,67 +1,107 @@
 {
 	"name": "egg-http-proxy-plus",
-	"version": "1.0.2",
 	"description": "powerfull proxy middleware plugin for egg",
+	"version": "2.0.0",
+	"packageManager": "pnpm@8.5.1",
 	"eggPlugin": {
 		"name": "httpProxyPlus"
 	},
-	"keywords": [
-		"egg",
-		"eggPlugin",
-		"egg-plugin",
-		"proxy",
-		"http-proxy",
-		"http-proxy-plus",
-		"http-proxy-middleware"
+	"files": [
+		"app",
+		"config",
+		"app.js",
+		"index.d.ts"
 	],
+	"scripts": {
+		"test": "pnpm run lint -- --fix && egg-bin pkgfiles && pnpm run test-local",
+		"test-local": "egg-bin test",
+		"cov": "egg-bin cov",
+		"lint": "eslint .",
+		"ci": "egg-bin pkgfiles --check && pnpm run lint && pnpm run cov",
+		"pkgfiles": "egg-bin pkgfiles",
+		"pub": "tscjs scripts/publish",
+		"unpub": "tscjs scripts/unpublish",
+		"sync": "tscjs scripts/sync",
+		"workflow:publish-test": "zx scripts/workflow.mjs",
+		"dist": "run-s eslint prettier",
+		"autod": "autod",
+		"eslint": "eslint --fix --ext .ts,.js ./",
+		"prettier": "prettier --write \"**/*.{js,ts,json,md}\""
+	},
 	"dependencies": {
 		"egg-path-matching": "^1.0.1",
-		"http-proxy-middleware": "0.20.0",
-		"koa2-connect": "^1.0.2"
+		"http-proxy-middleware": "^2.0.6",
+		"js-cool": "^4.0.0",
+		"koa-connect": "^2.1.0"
 	},
 	"devDependencies": {
-		"autod": "^3.1.1",
+		"@eslint-sets/eslint-config-basic": "^5.2.0",
+		"autod": "^3.1.2",
 		"autod-egg": "^1.1.0",
-		"egg": "^2.29.1",
-		"egg-bin": "^4.15.0",
-		"egg-ci": "^1.18.0",
-		"egg-mock": "^4.0.1",
-		"egg-path-matching": "^1.0.1",
-		"eslint": "^7.15.0",
-		"eslint-config-egg": "^9.0.0",
-		"express": "^4.17.1",
-		"prettier": "^2.2.1",
-		"webstorm-disable-index": "^1.2.0"
+		"egg": "^3.16.0",
+		"egg-bin": "^6.4.0",
+		"egg-ci": "^2.2.0",
+		"egg-mock": "^5.10.6",
+		"eslint": "^8.40.0",
+		"eslint-config-egg": "^12.2.1",
+		"eslint-plugin-jsdoc": "^44.2.4",
+		"load-yml": "^1.3.0",
+		"npm-run-all": "^4.1.5",
+		"prettier": "^2.8.8",
+		"prettier-config-common": "^1.4.0",
+		"reinstaller": "^3.0.0",
+		"tsnd": "^1.1.0",
+		"zx": "^7.2.2"
+	},
+	"peerDependencyRules": {
+		"http-proxy-middleware": ">=2",
+		"js-cool": ">=2 <=4"
 	},
 	"engines": {
-		"node": ">=8.0.0"
+		"node": ">=12.0.0"
 	},
-	"scripts": {
-		"test": "npm run lint -- --fix && egg-bin pkgfiles && npm run test-local",
-		"test-local": "egg-bin test",
-		"cov": "egg-bin cov",
-		"lint": "eslint .",
-		"ci": "egg-bin pkgfiles --check && npm run lint && npm run cov",
-		"pkgfiles": "egg-bin pkgfiles",
-		"autod": "autod"
+	"resolutions": {
+		"fsevents": ">= 2.0.0"
 	},
-	"files": [
-		"app",
-		"config",
-		"app.js",
-		"index.d.ts"
+	"pnpm": {
+		"peerDependencyRules": {
+			"ignoreMissing": [
+				"@babel/core",
+				"@types/node",
+				"webpack",
+				"typescript",
+				"mocha"
+			],
+			"allowedVersions": {
+				"eslint": ">= 8.0.0",
+				"fsevents": ">= 2.0.0"
+			}
+		}
+	},
+	"keywords": [
+		"egg",
+		"eggPlugin",
+		"egg-plugin",
+		"proxy",
+		"http-proxy",
+		"http-proxy-plus",
+		"http-proxy-middleware"
 	],
-	"ci": {
-		"version": "8, 9"
+	"publishConfig": {
+		"registry": "https://registry.npmjs.org",
+		"access": "public"
 	},
-	"repository": {
-		"type": "git",
-		"url": "git+https://github.com/saqqdy/egg-http-proxy-plus.git"
+	"ci": {
+		"version": "12, 14, 16, 18"
 	},
+	"license": "MIT",
+	"author": "saqqdy <https://github.com/saqqdy>",
+	"homepage": "https://github.com/saqqdy/egg-http-proxy-plus#readme",
 	"bugs": {
 		"url": "https://github.com/saqqdy/egg-http-proxy-plus/issues"
 	},
-	"homepage": "https://github.com/saqqdy/egg-http-proxy-plus#readme",
-	"author": "saqqdy <saqqdy@qq.com>",
-	"license": "MIT"
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/saqqdy/egg-http-proxy-plus.git"
+	}
 }

package/index.d.ts

@@ -1,19 +0,0 @@
-import 'egg'
-import * as httpProxyMiddleware from 'http-proxy-middleware'
-
-declare module 'egg' {
-	interface ProxyConfigMap {
-		[url: string]: string | httpProxyMiddleware.Config
-	}
-
-	type ProxyConfigArrayItem = {
-		path?: string | string[]
-		context?: string | string[] | httpProxyMiddleware.Filter
-	} & httpProxyMiddleware.Config
-
-	type ProxyConfigArray = ProxyConfigArrayItem[]
-
-	interface EggAppConfig {
-		httpProxyPlus: ProxyConfigMap | ProxyConfigArray
-	}
-}