midway-fatcms 0.0.1-beta.22 → 0.0.1-beta.24

package/src/service/proxyapi/ProxyApiService.ts

@@ -1,262 +1,262 @@
-import { Inject, Provide } from '@midwayjs/core';
-import { Context } from '@midwayjs/koa';
-import * as _ from 'lodash';
-import { getRouteTrie } from './RouteTrie';
-import { RouteHandler } from './RouteHandler';
-import { Exceptions } from '../../libs/crud-pro/exceptions';
-import { BizException } from '../../models/devops';
-import { CurdProService } from '../curd/CurdProService';
-import { IProxyApiEntity } from '../../models/SystemEntities';
-import axios, { AxiosResponse, AxiosResponseHeaders, RawAxiosResponseHeaders, ResponseType } from 'axios';
-import { getDebugProxyTarget, isEnableDebug } from '../../libs/utils/fatcms-request';
-import { BALANCE_STRATEGY, stringHashMod } from './ProxyApiUtils';
-import { WeightedRandom } from './WeightedRandom';
-import { WeightedRoundRobin } from './WeightedRoundRobin';
-import { ProxyApiLoadService } from './ProxyApiLoadService';
-import { API_BASE_TYPE, ApiBaseService } from '../base/ApiBaseService';
-
-/**
- * 接口代理
- */
-@Provide()
-export class ProxyApiService extends ApiBaseService {
-  @Inject()
-  protected ctx: Context;
-
-  @Inject()
-  protected curdProService: CurdProService;
-
-  @Inject()
-  protected proxyApiLoadService: ProxyApiLoadService;
-
-  /**
-   * 转发请求
-   * @param current_workbench_code 当前站点
-   * @param upstream_path : 形如/[upstream_code]/[api_path]
-   */
-  public async handleProxyRequest(current_workbench_code: string, upstream_path: string) {
-    const routeTrie = getRouteTrie(current_workbench_code);
-    const ss = routeTrie.findLongestMatch(upstream_path);
-    if (!ss) {
-      throw new BizException('路径没有匹配到', Exceptions.CFG_NOT_FOUND);
-    }
-    const handler: RouteHandler = _.get(ss, 'handler');
-    const cfgInfo = handler?.cfgInfo;
-    if (!cfgInfo) {
-      throw new BizException('路径配置没有匹配到', Exceptions.CFG_NOT_FOUND);
-    }
-    return this._handleProxyRequestForCfg(cfgInfo, upstream_path);
-  }
-
-  /**
-   * 转发请求
-   * @param proxyApiEntity
-   * @param upstream_path
-   * @private
-   */
-  private async _handleProxyRequestForCfg(proxyApiEntity: IProxyApiEntity, upstream_path: string) {
-    await super.beforeCheckApiAccessibility(API_BASE_TYPE.PROXY_API, proxyApiEntity);
-
-    const targetList = proxyApiEntity.targetList;
-    if (!Array.isArray(targetList) || targetList.length === 0) {
-      throw new BizException('目标服务器找不到', Exceptions.CFG_NOT_FOUND);
-    }
-
-    const ctx = this.ctx;
-    const targetBaseUrl = this.selectTargetByBalanceStrategy(proxyApiEntity, ctx);
-    if (!targetBaseUrl) {
-      throw new BizException('目标服务器找不到', Exceptions.CFG_NOT_FOUND);
-    }
-
-    const newPath = this.toNewPathByMapping(upstream_path, proxyApiEntity);
-
-    const targetUrl = new URL(newPath, targetBaseUrl);
-    targetUrl.search = new URLSearchParams(ctx.query as any).toString();
-    // const response_type: ResponseType = (proxyApiEntity.response_type || 'stream') as any;
-    const response_type: ResponseType = 'stream';
-
-    try {
-      const headers = {
-        ...ctx.headers,
-        host: targetUrl.host, // 设置正确的 host
-        'content-length': ctx.get('content-length'),
-      };
-
-      this.setRequestHeaders(headers, proxyApiEntity);
-
-      const response = await axios({
-        method: ctx.method,
-        url: targetUrl.toString(),
-        data: ctx.request.body,
-        headers: headers,
-        responseType: response_type,
-        timeout: proxyApiEntity.timeout_ms || 5 * 60 * 1000,
-        validateStatus: () => true,
-      });
-      ctx.status = response.status;
-      const resHeaders = this.toResHeaders(response.headers);
-      ctx.set({
-        ...resHeaders,
-        'cache-control': 'no-store', // 禁用缓存
-        'x-proxy-server': 'fatcms-server', // 添加代理标识
-      });
-      if (response_type === 'stream') {
-        return this.handleResponseTypeStream(response, ctx);
-      } else if (response_type === 'json') {
-        return this.handleResponseTypeJSON(response, ctx);
-      } else {
-        this.ctx.body = response.data;
-        return null;
-      }
-    } catch (e) {
-      ctx.contextLogger.error('Proxy request failed ', e);
-      ctx.status = 500;
-      ctx.body = { success: false, message: 'Proxy request failed => ' + e.message };
-    }
-    return null;
-  }
-
-  /**
-   * 处理JSON响应
-   * @param response
-   * @param ctx
-   * @private
-   */
-  private handleResponseTypeJSON(response: AxiosResponse, ctx: Context) {
-    return Promise.resolve(response.data);
-  }
-
-  /**
-   * 处理stream响应
-   * @param response
-   * @param ctx
-   * @private
-   */
-  private handleResponseTypeStream(response: AxiosResponse, ctx: Context) {
-    // 流式传输处理
-    return new Promise<void>((resolve, reject) => {
-      response.data
-        .on('data', chunk => {
-          ctx.res.write(chunk);
-        })
-        .on('end', () => {
-          ctx.res.end();
-          resolve();
-        })
-        .on('error', err => {
-          ctx.res.destroy(err);
-          reject(err);
-        });
-
-      // 处理客户端断开连接
-      ctx.req.on('close', () => {
-        response.data.destroy();
-        reject(new Error('Client disconnected'));
-      });
-    });
-  }
-
-  /**
-   * 获取响应的headers数据
-   * @param headers
-   * @private
-   */
-  private toResHeaders(headers: RawAxiosResponseHeaders | AxiosResponseHeaders): any {
-    if (!headers) {
-      return {};
-    }
-    if (typeof headers.toJSON === 'function') {
-      return headers.toJSON(false);
-    }
-    return headers;
-  }
-
-  /**
-   * 获取转发到目的服务器的路径
-   * @param upstream_path
-   * @param proxyApiEntity
-   * @private
-   */
-  private toNewPathByMapping(upstream_path: string, proxyApiEntity: IProxyApiEntity) {
-    const result = upstream_path.substring(proxyApiEntity.upstream_code.length + 1);
-    this.logInfo('toNewPathByMapping', { upstream_path, result });
-    return result;
-  }
-
-  /**
-   * 根据负载均衡策略，选择目标服务器
-   * @param proxyApiEntity
-   * @param ctx
-   * @private
-   */
-  private selectTargetByBalanceStrategy(proxyApiEntity: IProxyApiEntity, ctx: Context): string {
-    const targetList = proxyApiEntity.targetList;
-    const strategy = proxyApiEntity.balanceStrategy;
-
-    if (isEnableDebug(ctx)) {
-      // 在调试模式下，可以强制指定某台机器。
-      const targetOrigin: string = getDebugProxyTarget(ctx);
-      if (typeof targetOrigin === 'string' && targetOrigin.startsWith('http')) {
-        return targetOrigin;
-      }
-    }
-
-    if (!targetList || targetList.length === 0) {
-      return null;
-    }
-
-    if (strategy === BALANCE_STRATEGY.WEIGHTED_RANDOM) {
-      const weightedRandom: WeightedRandom = proxyApiEntity.weightedRandom;
-      const ss = weightedRandom.next();
-      return ss ? ss.origin : null;
-    } else if (strategy === BALANCE_STRATEGY.WEIGHTED_ROUND_ROBIN) {
-      const weightedRoundRobin: WeightedRoundRobin = proxyApiEntity.weightedRoundRobin;
-      const ss = weightedRoundRobin.next();
-      return ss ? ss.origin : null;
-    } else if (strategy === BALANCE_STRATEGY.USER_SESSION_HASH) {
-      // 根据用户sessionId hash
-      const sessionId = ctx.userSession.getSessionValue('sessionId') || Math.random();
-      proxyApiEntity.targetIndex = stringHashMod(`${sessionId}`, targetList.length);
-    } else if (strategy === BALANCE_STRATEGY.USER_ACCOUNT_HASH) {
-      // 根据用户accountId hash
-      const accountId = ctx.userSession.getSessionValue('accountId') || Math.random();
-      proxyApiEntity.targetIndex = stringHashMod(`${accountId}`, targetList.length);
-    } else if (strategy === BALANCE_STRATEGY.IP_HASH) {
-      // 根据用户IP地址hash
-      const ip = ctx.headers['x-real-ip'] || ctx.headers['x-forwarded-for'] || Math.random();
-      proxyApiEntity.targetIndex = stringHashMod(`${ip}`, targetList.length);
-    } else if (strategy === BALANCE_STRATEGY.RANDOM) {
-      // 随机
-      proxyApiEntity.targetIndex = stringHashMod(`${Math.random()}`, targetList.length);
-    } else {
-      // 默认，轮训
-      proxyApiEntity.targetIndex = (proxyApiEntity.targetIndex + 1) % targetList.length;
-    }
-
-    const ss = targetList[proxyApiEntity.targetIndex];
-    return ss ? ss.origin : null;
-  }
-
-  private setRequestHeaders(headers: any, proxyApiEntity: IProxyApiEntity) {
-    const ctx = this.ctx;
-
-    if (proxyApiEntity.pass_real_ip) {
-      headers['x-real-ip'] = ctx.headers['x-real-ip'];
-      headers['x-forwarded-for'] = ctx.headers['x-forwarded-for'];
-    }
-
-    if (proxyApiEntity.user_context) {
-      const isLogin = this.ctx.userSession.isLogin();
-      const sessionInfo = this.ctx.userSession.getSessionInfo();
-      headers['x-fatcms-user'] = JSON.stringify({ ...sessionInfo, isLogin });
-    }
-
-    if (proxyApiEntity.change_host && proxyApiEntity.change_host.length > 0) {
-      headers.host = proxyApiEntity.change_host;
-    }
-
-    if (proxyApiEntity.change_origin && proxyApiEntity.change_origin.length > 0) {
-      headers.origin = proxyApiEntity.change_origin;
-    }
-  }
-}
+import { Inject, Provide } from '@midwayjs/core';
+import { Context } from '@midwayjs/koa';
+import * as _ from 'lodash';
+import { getRouteTrie } from './RouteTrie';
+import { RouteHandler } from './RouteHandler';
+import { Exceptions } from '../../libs/crud-pro/exceptions';
+import { BizException } from '../../models/devops';
+import { CurdProService } from '../curd/CurdProService';
+import { IProxyApiEntity } from '../../models/SystemEntities';
+import axios, { AxiosResponse, AxiosResponseHeaders, RawAxiosResponseHeaders, ResponseType } from 'axios';
+import { getDebugProxyTarget, isEnableDebug } from '../../libs/utils/fatcms-request';
+import { BALANCE_STRATEGY, stringHashMod } from './ProxyApiUtils';
+import { WeightedRandom } from './WeightedRandom';
+import { WeightedRoundRobin } from './WeightedRoundRobin';
+import { ProxyApiLoadService } from './ProxyApiLoadService';
+import { API_BASE_TYPE, ApiBaseService } from '../base/ApiBaseService';
+
+/**
+ * 接口代理
+ */
+@Provide()
+export class ProxyApiService extends ApiBaseService {
+  @Inject()
+  protected ctx: Context;
+
+  @Inject()
+  protected curdProService: CurdProService;
+
+  @Inject()
+  protected proxyApiLoadService: ProxyApiLoadService;
+
+  /**
+   * 转发请求
+   * @param current_workbench_code 当前站点
+   * @param upstream_path : 形如/[upstream_code]/[api_path]
+   */
+  public async handleProxyRequest(current_workbench_code: string, upstream_path: string) {
+    const routeTrie = getRouteTrie(current_workbench_code);
+    const ss = routeTrie.findLongestMatch(upstream_path);
+    if (!ss) {
+      throw new BizException('路径没有匹配到', Exceptions.CFG_NOT_FOUND);
+    }
+    const handler: RouteHandler = _.get(ss, 'handler');
+    const cfgInfo = handler?.cfgInfo;
+    if (!cfgInfo) {
+      throw new BizException('路径配置没有匹配到', Exceptions.CFG_NOT_FOUND);
+    }
+    return this._handleProxyRequestForCfg(cfgInfo, upstream_path);
+  }
+
+  /**
+   * 转发请求
+   * @param proxyApiEntity
+   * @param upstream_path
+   * @private
+   */
+  private async _handleProxyRequestForCfg(proxyApiEntity: IProxyApiEntity, upstream_path: string) {
+    await super.beforeCheckApiAccessibility(API_BASE_TYPE.PROXY_API, proxyApiEntity);
+
+    const targetList = proxyApiEntity.targetList;
+    if (!Array.isArray(targetList) || targetList.length === 0) {
+      throw new BizException('目标服务器找不到', Exceptions.CFG_NOT_FOUND);
+    }
+
+    const ctx = this.ctx;
+    const targetBaseUrl = this.selectTargetByBalanceStrategy(proxyApiEntity, ctx);
+    if (!targetBaseUrl) {
+      throw new BizException('目标服务器找不到', Exceptions.CFG_NOT_FOUND);
+    }
+
+    const newPath = this.toNewPathByMapping(upstream_path, proxyApiEntity);
+
+    const targetUrl = new URL(newPath, targetBaseUrl);
+    targetUrl.search = new URLSearchParams(ctx.query as any).toString();
+    // const response_type: ResponseType = (proxyApiEntity.response_type || 'stream') as any;
+    const response_type: ResponseType = 'stream';
+
+    try {
+      const headers = {
+        ...ctx.headers,
+        host: targetUrl.host, // 设置正确的 host
+        'content-length': ctx.get('content-length'),
+      };
+
+      this.setRequestHeaders(headers, proxyApiEntity);
+
+      const response = await axios({
+        method: ctx.method,
+        url: targetUrl.toString(),
+        data: ctx.request.body,
+        headers: headers,
+        responseType: response_type,
+        timeout: proxyApiEntity.timeout_ms || 5 * 60 * 1000,
+        validateStatus: () => true,
+      });
+      ctx.status = response.status;
+      const resHeaders = this.toResHeaders(response.headers);
+      ctx.set({
+        ...resHeaders,
+        'cache-control': 'no-store', // 禁用缓存
+        'x-proxy-server': 'fatcms-server', // 添加代理标识
+      });
+      if (response_type === 'stream') {
+        return this.handleResponseTypeStream(response, ctx);
+      } else if (response_type === 'json') {
+        return this.handleResponseTypeJSON(response, ctx);
+      } else {
+        this.ctx.body = response.data;
+        return null;
+      }
+    } catch (e) {
+      ctx.contextLogger.error('Proxy request failed ', e);
+      ctx.status = 500;
+      ctx.body = { success: false, message: 'Proxy request failed => ' + e.message };
+    }
+    return null;
+  }
+
+  /**
+   * 处理JSON响应
+   * @param response
+   * @param ctx
+   * @private
+   */
+  private handleResponseTypeJSON(response: AxiosResponse, ctx: Context) {
+    return Promise.resolve(response.data);
+  }
+
+  /**
+   * 处理stream响应
+   * @param response
+   * @param ctx
+   * @private
+   */
+  private handleResponseTypeStream(response: AxiosResponse, ctx: Context) {
+    // 流式传输处理
+    return new Promise<void>((resolve, reject) => {
+      response.data
+        .on('data', chunk => {
+          ctx.res.write(chunk);
+        })
+        .on('end', () => {
+          ctx.res.end();
+          resolve();
+        })
+        .on('error', err => {
+          ctx.res.destroy(err);
+          reject(err);
+        });
+
+      // 处理客户端断开连接
+      ctx.req.on('close', () => {
+        response.data.destroy();
+        reject(new Error('Client disconnected'));
+      });
+    });
+  }
+
+  /**
+   * 获取响应的headers数据
+   * @param headers
+   * @private
+   */
+  private toResHeaders(headers: RawAxiosResponseHeaders | AxiosResponseHeaders): any {
+    if (!headers) {
+      return {};
+    }
+    if (typeof headers.toJSON === 'function') {
+      return headers.toJSON(false);
+    }
+    return headers;
+  }
+
+  /**
+   * 获取转发到目的服务器的路径
+   * @param upstream_path
+   * @param proxyApiEntity
+   * @private
+   */
+  private toNewPathByMapping(upstream_path: string, proxyApiEntity: IProxyApiEntity) {
+    const result = upstream_path.substring(proxyApiEntity.upstream_code.length + 1);
+    this.logInfo('toNewPathByMapping', { upstream_path, result });
+    return result;
+  }
+
+  /**
+   * 根据负载均衡策略，选择目标服务器
+   * @param proxyApiEntity
+   * @param ctx
+   * @private
+   */
+  private selectTargetByBalanceStrategy(proxyApiEntity: IProxyApiEntity, ctx: Context): string {
+    const targetList = proxyApiEntity.targetList;
+    const strategy = proxyApiEntity.balanceStrategy;
+
+    if (isEnableDebug(ctx)) {
+      // 在调试模式下，可以强制指定某台机器。
+      const targetOrigin: string = getDebugProxyTarget(ctx);
+      if (typeof targetOrigin === 'string' && targetOrigin.startsWith('http')) {
+        return targetOrigin;
+      }
+    }
+
+    if (!targetList || targetList.length === 0) {
+      return null;
+    }
+
+    if (strategy === BALANCE_STRATEGY.WEIGHTED_RANDOM) {
+      const weightedRandom: WeightedRandom = proxyApiEntity.weightedRandom;
+      const ss = weightedRandom.next();
+      return ss ? ss.origin : null;
+    } else if (strategy === BALANCE_STRATEGY.WEIGHTED_ROUND_ROBIN) {
+      const weightedRoundRobin: WeightedRoundRobin = proxyApiEntity.weightedRoundRobin;
+      const ss = weightedRoundRobin.next();
+      return ss ? ss.origin : null;
+    } else if (strategy === BALANCE_STRATEGY.USER_SESSION_HASH) {
+      // 根据用户sessionId hash
+      const sessionId = ctx.userSession.getSessionValue('sessionId') || Math.random();
+      proxyApiEntity.targetIndex = stringHashMod(`${sessionId}`, targetList.length);
+    } else if (strategy === BALANCE_STRATEGY.USER_ACCOUNT_HASH) {
+      // 根据用户accountId hash
+      const accountId = ctx.userSession.getSessionValue('accountId') || Math.random();
+      proxyApiEntity.targetIndex = stringHashMod(`${accountId}`, targetList.length);
+    } else if (strategy === BALANCE_STRATEGY.IP_HASH) {
+      // 根据用户IP地址hash
+      const ip = ctx.headers['x-real-ip'] || ctx.headers['x-forwarded-for'] || Math.random();
+      proxyApiEntity.targetIndex = stringHashMod(`${ip}`, targetList.length);
+    } else if (strategy === BALANCE_STRATEGY.RANDOM) {
+      // 随机
+      proxyApiEntity.targetIndex = stringHashMod(`${Math.random()}`, targetList.length);
+    } else {
+      // 默认，轮训
+      proxyApiEntity.targetIndex = (proxyApiEntity.targetIndex + 1) % targetList.length;
+    }
+
+    const ss = targetList[proxyApiEntity.targetIndex];
+    return ss ? ss.origin : null;
+  }
+
+  private setRequestHeaders(headers: any, proxyApiEntity: IProxyApiEntity) {
+    const ctx = this.ctx;
+
+    if (proxyApiEntity.pass_real_ip) {
+      headers['x-real-ip'] = ctx.headers['x-real-ip'];
+      headers['x-forwarded-for'] = ctx.headers['x-forwarded-for'];
+    }
+
+    if (proxyApiEntity.user_context) {
+      const isLogin = this.ctx.userSession.isLogin();
+      const sessionInfo = this.ctx.userSession.getSessionInfo();
+      headers['x-fatcms-user'] = JSON.stringify({ ...sessionInfo, isLogin });
+    }
+
+    if (proxyApiEntity.change_host && proxyApiEntity.change_host.length > 0) {
+      headers.host = proxyApiEntity.change_host;
+    }
+
+    if (proxyApiEntity.change_origin && proxyApiEntity.change_origin.length > 0) {
+      headers.origin = proxyApiEntity.change_origin;
+    }
+  }
+}

package/src/service/proxyapi/ProxyApiUtils.ts

@@ -1,32 +1,32 @@
-import * as md5 from 'md5';
-
-export const BALANCE_STRATEGY = {
-  ROUND_ROBIN: 'ROUND_ROBIN', //轮询
-  WEIGHTED_ROUND_ROBIN: 'WEIGHTED_ROUND_ROBIN', //加权轮询
-  RANDOM: 'RANDOM', // 随机
-  WEIGHTED_RANDOM: 'WEIGHTED_RANDOM', // 加权随机
-  IP_HASH: 'IP_HASH', // 源地址哈希
-  USER_ACCOUNT_HASH: 'USER_ACCOUNT_HASH', //  根据用户accountId hash
-  USER_SESSION_HASH: 'USER_SESSION_HASH', //  根据用户sessionId hash
-};
-
-/**
- * 字符串Hash之后取模
- * @param str
- * @param mod
- */
-export function stringHashMod(str: string, mod: number): number {
-  if (!str) {
-    throw new Error('stringHashMod str is required');
-  }
-  const md5Str = md5(str);
-  let sum = 0;
-  for (let i = 0; i < md5Str.length; i++) {
-    const md5StrElement = md5Str.charCodeAt(i);
-    sum = sum + md5StrElement;
-    if (sum >= Number.MAX_SAFE_INTEGER - 10000000) {
-      sum = sum % 10000000;
-    }
-  }
-  return sum % mod;
-}
+import * as md5 from 'md5';
+
+export const BALANCE_STRATEGY = {
+  ROUND_ROBIN: 'ROUND_ROBIN', //轮询
+  WEIGHTED_ROUND_ROBIN: 'WEIGHTED_ROUND_ROBIN', //加权轮询
+  RANDOM: 'RANDOM', // 随机
+  WEIGHTED_RANDOM: 'WEIGHTED_RANDOM', // 加权随机
+  IP_HASH: 'IP_HASH', // 源地址哈希
+  USER_ACCOUNT_HASH: 'USER_ACCOUNT_HASH', //  根据用户accountId hash
+  USER_SESSION_HASH: 'USER_SESSION_HASH', //  根据用户sessionId hash
+};
+
+/**
+ * 字符串Hash之后取模
+ * @param str
+ * @param mod
+ */
+export function stringHashMod(str: string, mod: number): number {
+  if (!str) {
+    throw new Error('stringHashMod str is required');
+  }
+  const md5Str = md5(str);
+  let sum = 0;
+  for (let i = 0; i < md5Str.length; i++) {
+    const md5StrElement = md5Str.charCodeAt(i);
+    sum = sum + md5StrElement;
+    if (sum >= Number.MAX_SAFE_INTEGER - 10000000) {
+      sum = sum % 10000000;
+    }
+  }
+  return sum % mod;
+}

package/src/service/proxyapi/RouteHandler.ts

@@ -1,8 +1,8 @@
-class RouteHandler {
-  cfgInfo: any;
-  constructor(cfgInfo: any) {
-    this.cfgInfo = cfgInfo;
-  }
-}
-
-export { RouteHandler };
+class RouteHandler {
+  cfgInfo: any;
+  constructor(cfgInfo: any) {
+    this.cfgInfo = cfgInfo;
+  }
+}
+
+export { RouteHandler };