@midwayjs/http-proxy 3.0.0

package/README.md

@@ -0,0 +1,35 @@
+## HTTP 代理组件
+
+HTTP 代理组件
+
+适用于 `@midwayjs/faas` 、`@midwayjs/web` 、`@midwayjs/koa` 和 `@midwayjs/express` 多种框架的 HTTP 代理组件，支持GET、POST等多种请求方法。
+
+### Usage
+
+1. 安装依赖
+```shell
+tnpm i @midwayjs/http-proxy --save
+```
+2. 在 configuration 中引入组件,
+```ts
+import * as proxy from '@midwayjs/http-proxy';
+@Configuration({
+  imports: [
+    // ...other components
+    proxy
+  ],
+})
+export class AutoConfiguration {}
+```
+
+### 配置
+
+```ts
+export const httpProxy = [
+  {
+    host: 'http://127.0.0.1',
+    match: /\/assets\/(.*)/,
+    target: 'http://127.0.0.1/$1',
+  }
+]
+```

package/dist/config/config.default.d.ts

@@ -0,0 +1,3 @@
+import { HttpProxyConfig } from '..';
+export declare const httpProxy: HttpProxyConfig;
+//# sourceMappingURL=config.default.d.ts.map

package/dist/config/config.default.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.httpProxy = void 0;
+exports.httpProxy = null;
+//# sourceMappingURL=config.default.js.map

package/dist/configuration.d.ts

@@ -0,0 +1,7 @@
+import { MidwayApplicationManager } from '@midwayjs/core';
+export declare class HttpProxyConfiguration {
+    applicationManager: MidwayApplicationManager;
+    httpProxy: any;
+    onReady(): Promise<void>;
+}
+//# sourceMappingURL=configuration.d.ts.map

package/dist/configuration.js

@@ -0,0 +1,47 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HttpProxyConfiguration = void 0;
+const decorator_1 = require("@midwayjs/decorator");
+const DefaultConfig = require("./config/config.default");
+const core_1 = require("@midwayjs/core");
+const middleware_1 = require("./middleware");
+let HttpProxyConfiguration = class HttpProxyConfiguration {
+    async onReady() {
+        if (this.httpProxy) {
+            this.applicationManager
+                .getApplications(['koa', 'faas', 'express', 'egg'])
+                .forEach(app => {
+                app.useMiddleware(middleware_1.HttpProxyMiddleware);
+            });
+        }
+    }
+};
+__decorate([
+    (0, decorator_1.Inject)(),
+    __metadata("design:type", core_1.MidwayApplicationManager)
+], HttpProxyConfiguration.prototype, "applicationManager", void 0);
+__decorate([
+    (0, decorator_1.Config)('httpProxy'),
+    __metadata("design:type", Object)
+], HttpProxyConfiguration.prototype, "httpProxy", void 0);
+HttpProxyConfiguration = __decorate([
+    (0, decorator_1.Configuration)({
+        namespace: 'upload',
+        importConfigs: [
+            {
+                default: DefaultConfig,
+            },
+        ],
+    })
+], HttpProxyConfiguration);
+exports.HttpProxyConfiguration = HttpProxyConfiguration;
+//# sourceMappingURL=configuration.js.map

package/dist/index.d.ts

@@ -0,0 +1,4 @@
+export { HttpProxyConfiguration as Configuration } from './configuration';
+export * from './interface';
+export * from './middleware';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -0,0 +1,22 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Configuration = void 0;
+var configuration_1 = require("./configuration");
+Object.defineProperty(exports, "Configuration", { enumerable: true, get: function () { return configuration_1.HttpProxyConfiguration; } });
+__exportStar(require("./interface"), exports);
+__exportStar(require("./middleware"), exports);
+//# sourceMappingURL=index.js.map

package/dist/interface.d.ts

@@ -0,0 +1,9 @@
+export interface HttpProxyConfig {
+    match: RegExp;
+    host?: string;
+    target?: string;
+    ignoreHeaders?: {
+        [key: string]: boolean;
+    };
+}
+//# sourceMappingURL=interface.d.ts.map

package/dist/interface.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=interface.js.map

package/dist/middleware.d.ts

@@ -0,0 +1,14 @@
+/// <reference types="node" />
+import { IMiddleware, IMidwayLogger } from '@midwayjs/core';
+import { HttpProxyConfig } from './interface';
+export declare class HttpProxyMiddleware implements IMiddleware<any, any> {
+    httpProxy: HttpProxyConfig | HttpProxyConfig[];
+    logger: IMidwayLogger;
+    resolve(app: any): (req: any, res: any, next: any) => Promise<any>;
+    execProxy(ctx: any, req: any, res: any, next: any, isExpress: any): Promise<any>;
+    getProxyList(url: any): undefined | {
+        proxy: HttpProxyConfig;
+        url: URL;
+    };
+}
+//# sourceMappingURL=middleware.d.ts.map

package/dist/middleware.js

@@ -0,0 +1,133 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HttpProxyMiddleware = void 0;
+const decorator_1 = require("@midwayjs/decorator");
+const axios_1 = require("axios");
+let HttpProxyMiddleware = class HttpProxyMiddleware {
+    resolve(app) {
+        if (app.getFrameworkType() === decorator_1.MidwayFrameworkType.WEB_EXPRESS) {
+            return async (req, res, next) => {
+                return this.execProxy(req, req, res, next, true);
+            };
+        }
+        else {
+            return async (ctx, next) => {
+                var _a;
+                const req = ((_a = ctx.request) === null || _a === void 0 ? void 0 : _a.req) || ctx.request;
+                return this.execProxy(ctx, req, ctx, next, false);
+            };
+        }
+    }
+    async execProxy(ctx, req, res, next, isExpress) {
+        var _a, _b, _c;
+        const proxyInfo = this.getProxyList(ctx.url);
+        if (!proxyInfo) {
+            return next();
+        }
+        const { proxy, url } = proxyInfo;
+        const reqHeaders = {};
+        for (const key of Object.keys(req.headers)) {
+            if (((_a = proxy.ignoreHeaders) === null || _a === void 0 ? void 0 : _a[key]) || ctx.header[key] === undefined) {
+                continue;
+            }
+            reqHeaders[key.toLowerCase()] = ctx.header[key];
+        }
+        // X-Forwarded-For
+        const forwarded = req.headers['x-forwarded-for'];
+        reqHeaders['x-forwarded-for'] = forwarded
+            ? `${forwarded}, ${ctx.ip}`
+            : ctx.ip;
+        reqHeaders['host'] = url.host;
+        const method = req.method.toUpperCase();
+        const targetRes = res.res || res;
+        const isStream = targetRes.on && targetRes.writable;
+        const reqOptions = {
+            method,
+            url: url.href,
+            headers: reqHeaders,
+            responseType: isStream ? 'stream' : 'arrayBuffer',
+        };
+        if (method === 'POST' || method === 'PUT') {
+            reqOptions.data = (_b = req.body) !== null && _b !== void 0 ? _b : (_c = ctx.request) === null || _c === void 0 ? void 0 : _c.body;
+            if (req.headers['content-type'] === 'application/x-www-form-urlencoded' &&
+                typeof reqOptions.data !== 'string') {
+                reqOptions.data = Object.keys(reqOptions.data)
+                    .map(key => `${encodeURIComponent(key)}=${encodeURIComponent(reqOptions.data[key])}`)
+                    .join('&');
+            }
+        }
+        const proxyResponse = await (0, axios_1.default)(reqOptions).catch(err => {
+            if (!err || !err.response) {
+                throw err || new Error('proxy unknown error');
+            }
+            return err.response;
+        });
+        res.type = proxyResponse.headers['content-type'];
+        Object.keys(proxyResponse.headers).forEach(key => {
+            res.set(key, proxyResponse.headers[key]);
+        });
+        res.status = proxyResponse.status;
+        if (isStream) {
+            await new Promise(resolve => {
+                proxyResponse.data.on('finish', resolve);
+                proxyResponse.data.pipe(targetRes);
+            });
+        }
+        else {
+            res.body = proxyResponse.data;
+        }
+    }
+    getProxyList(url) {
+        if (!this.httpProxy) {
+            return;
+        }
+        const proxyList = [].concat(this.httpProxy);
+        for (const proxy of proxyList) {
+            if (!proxy.match) {
+                continue;
+            }
+            if (!proxy.match.test(url)) {
+                continue;
+            }
+            if (proxy.host) {
+                if (url[0] === '/') {
+                    url = proxy.host + url;
+                }
+                const urlObj = new URL(url);
+                return {
+                    proxy,
+                    url: urlObj,
+                };
+            }
+            else if (proxy.target) {
+                const newURL = url.replace(proxy.match, proxy.target);
+                return {
+                    proxy,
+                    url: new URL(newURL),
+                };
+            }
+        }
+    }
+};
+__decorate([
+    (0, decorator_1.Config)('httpProxy'),
+    __metadata("design:type", Object)
+], HttpProxyMiddleware.prototype, "httpProxy", void 0);
+__decorate([
+    (0, decorator_1.Logger)(),
+    __metadata("design:type", Object)
+], HttpProxyMiddleware.prototype, "logger", void 0);
+HttpProxyMiddleware = __decorate([
+    (0, decorator_1.Middleware)()
+], HttpProxyMiddleware);
+exports.HttpProxyMiddleware = HttpProxyMiddleware;
+//# sourceMappingURL=middleware.js.map

package/index.d.ts

@@ -0,0 +1,8 @@
+import { HttpProxyConfig } from './dist/index';
+export * from './dist/index';
+
+declare module '@midwayjs/core' {
+  interface MidwayConfig {
+    httpProxy?: Partial<HttpProxyConfig> | Partial<HttpProxyConfig>[];
+  }
+}

package/package.json

@@ -0,0 +1,37 @@
+{
+  "name": "@midwayjs/http-proxy",
+  "version": "3.0.0",
+  "description": "Midway Component for http proxy",
+  "main": "dist/index.js",
+  "typings": "index.d.ts",
+  "scripts": {
+    "build": "tsc",
+    "test": "node --require=ts-node/register ../../node_modules/.bin/jest --runInBand",
+    "cov": "node --require=ts-node/register ../../node_modules/.bin/jest --runInBand --coverage --forceExit",
+    "ci": "npm run test"
+  },
+  "keywords": [],
+  "author": "",
+  "files": [
+    "dist/**/*.js",
+    "dist/**/*.d.ts",
+    "index.d.ts"
+  ],
+  "engines": {
+    "node": ">=12"
+  },
+  "license": "MIT",
+  "dependencies": {
+    "axios": "^0.26.0"
+  },
+  "devDependencies": {
+    "@midwayjs/core": "^3.1.7-alpha.0",
+    "@midwayjs/decorator": "^3.0.10",
+    "@midwayjs/express": "^3.1.7-alpha.0",
+    "@midwayjs/faas": "^3.1.7-alpha.0",
+    "@midwayjs/koa": "^3.1.7-alpha.0",
+    "@midwayjs/mock": "^3.1.7-alpha.0",
+    "@midwayjs/serverless-app": "^3.1.7-alpha.0",
+    "@midwayjs/web": "^3.1.7-alpha.0"
+  }
+}