midway-fatcms 0.0.1-beta.7 → 0.0.1-beta.70

package/src/service/asyncTask/handler/ExportExcelByInnerHttpHandler.ts

@@ -0,0 +1,159 @@
+import * as _ from 'lodash';
+import axios from 'axios';
+import { IMidwayKoaContext } from '@midwayjs/koa';
+import { IExcelAsyncTaskHandler, IExcelHeaderInfo } from './ExcelInfoModel';
+import { HEADER_KEY_RUN_BY_ASYNC_TASK_ID, HEADER_KEY_RUN_BY_ASYNC_TASK_WORKBENCH_CODE, SysAsyncTaskContext } from '@/models/AsyncTaskModel';
+import { IStdCrudExportInputParams, ITableProQueryParams } from '@/models/bizmodels';
+import { IRequestModel } from '@/libs/crud-pro/interfaces';
+import { ANONYMOUS_CONTEXT } from '@/schedule';
+import { parseJsonObject } from '@/libs/utils/functions';
+import { GLOBAL_STATIC_CONFIG } from '@/libs/global-config/global-config';
+
+function pickData(a: any, key: string) {
+  if (a && typeof a.getResModel === 'function') {
+    const s = a.getResModel();
+    return s[key];
+  }
+  if (!a) {
+    throw 'ExportExcelByInnerHttpHandler返回数据不存在';
+  }
+  return _.get(a, `data.${key}`);
+}
+
+/**
+ * 多实例，每个任务一个实例。
+ * 导出Excel。请求任务级别的。
+ * 使用内部HTTP接口导出
+ */
+class ExportExcelByInnerHttpHandler implements IExcelAsyncTaskHandler {
+  protected asyncTaskContext: SysAsyncTaskContext;
+  protected ctx: IMidwayKoaContext;
+  protected inputParams: IStdCrudExportInputParams;
+  protected appCode: string;
+  public constructor(asyncTaskContext: SysAsyncTaskContext, inputParams: IStdCrudExportInputParams, ctx: IMidwayKoaContext) {
+    this.ctx = ctx;
+    this.inputParams = inputParams;
+    this.asyncTaskContext = asyncTaskContext;
+    this.appCode = this.inputParams.appCode;
+  }
+
+  async getPageSize(): Promise<number> {
+    const maxPageSizeOfExportExcel = GLOBAL_STATIC_CONFIG.getConfig().maxPageSizeOfExportExcel;
+    if (typeof this.inputParams.pageSize === 'number') {
+      return Math.min(this.inputParams.pageSize, maxPageSizeOfExportExcel);
+    }
+    return 1000;
+  }
+
+  /**
+   * 获取Excel表的表头
+   * @returns 表头信息
+   */
+  async getExcelHeader(): Promise<IExcelHeaderInfo[]> {
+    const columns = this.inputParams.columns;
+    if (!columns) {
+      throw new Error('导出Excel的表头信息不存在');
+    }
+    if (!Array.isArray(columns) || columns.length === 0) {
+      throw new Error('导出Excel的表头信息不是数组');
+    }
+    return columns
+      .map(cc => {
+        let { title, dataIndex } = cc;
+        if (!dataIndex) {
+          return null;
+        }
+        if (!title) {
+          title = '字段_' + dataIndex;
+        }
+        return { title, dataIndex };
+      })
+      .filter(Boolean);
+  }
+
+  private async sendRequest(params: any): Promise<any> {
+    const port = ANONYMOUS_CONTEXT.getApp().getConfig().koa.port;
+    let queryApi = this.inputParams.innerHttpUrl; // 以斜杠开头
+    if (!queryApi.startsWith('/')) {
+      queryApi = '/' + queryApi;
+    }
+
+    const asyncTaskId = this.asyncTaskContext.task.id;
+    const createdUserSession = parseJsonObject(this.asyncTaskContext.task.created_user_session);
+    const workbenchCode = createdUserSession.workbenchCode;
+
+    params[HEADER_KEY_RUN_BY_ASYNC_TASK_ID] = asyncTaskId;
+    params[HEADER_KEY_RUN_BY_ASYNC_TASK_WORKBENCH_CODE] = workbenchCode;
+
+    const headers = this.inputParams.headers || {};
+    headers[HEADER_KEY_RUN_BY_ASYNC_TASK_ID] = asyncTaskId;
+    headers[HEADER_KEY_RUN_BY_ASYNC_TASK_WORKBENCH_CODE] = workbenchCode;
+
+    const response = await axios({
+      method: 'POST',
+      url: `http://127.0.0.1:${port}${queryApi}`,
+      data: params,
+      headers: headers,
+      responseType: 'json',
+      validateStatus: () => true,
+    });
+    if (response.status !== 200) {
+      throw new Error('导出Excel请求错误失败，状态码：' + response.status);
+    }
+    return response.data;
+  }
+
+  /**
+   * 获取要导出的数量总数
+   * @returns 数据总量
+   */
+  async getTotalCount(): Promise<number> {
+    const selectedRowKeys: string[] | number[] = this.inputParams?.selectedRowKeys || [];
+    if (Array.isArray(selectedRowKeys) && selectedRowKeys.length > 0) {
+      return selectedRowKeys.length;
+    }
+
+    const lastQueryParams: ITableProQueryParams = this.inputParams?.lastQueryParams;
+    const res = await this.sendRequest({
+      condition: lastQueryParams?.condition || {},
+      orderBy: lastQueryParams?.orderBy,
+      pageSize: 1,
+      pageNo: 1,
+    });
+    return pickData(res, 'total_count');
+  }
+
+  /**
+   * 获取要导出Excel的数据的内容
+   * @param pageNo 页号，从1开始
+   * @param pageSize 每页数量
+   * @returns
+   */
+  async getExcelDataList(pageNo: number, pageSize: number): Promise<any[]> {
+    const selectedRowKeys: string[] | number[] = this.inputParams?.selectedRowKeys || [];
+    const lastQueryParams: ITableProQueryParams = this.inputParams?.lastQueryParams;
+    const primaryKey: string = this.inputParams.primaryKey || 'id';
+
+    const params: IRequestModel = {
+      condition: lastQueryParams?.condition || {},
+      pageSize: pageSize,
+      pageNo: pageNo,
+      orderBy: lastQueryParams?.orderBy,
+    };
+
+    if (Array.isArray(selectedRowKeys) && selectedRowKeys.length > 0) {
+      params.condition[primaryKey] = {
+        $in: selectedRowKeys,
+      };
+    }
+    const res = await this.sendRequest({
+      condition: lastQueryParams?.condition || {},
+      orderBy: lastQueryParams?.orderBy,
+      pageSize: pageSize,
+      pageNo: pageNo,
+    });
+    return pickData(res, 'rows');
+  }
+}
+
+export { ExportExcelByInnerHttpHandler };

package/src/service/asyncTask/handler/ExportExcelByStdCrudHandler.ts

@@ -0,0 +1,158 @@
+import * as _ from 'lodash';
+import { IMidwayKoaContext } from '@midwayjs/koa';
+import { IExcelAsyncTaskHandler, IExcelHeaderInfo } from './ExcelInfoModel';
+import { SysAsyncTaskContext } from '@/models/AsyncTaskModel';
+import { CrudStdService, SPECIAL_SETTING_KEY, ICrudStdActionParams, IRequestModelCrudProExt } from '@/service/crudstd/CrudStdService';
+import { ICrudStdAppInfo, IStdCrudExportInputParams, ITableProQueryParams } from '@/models/bizmodels';
+import { KeysOfSimpleSQL } from '@/libs/crud-pro/models/keys';
+import { ExecuteContext } from '@/libs/crud-pro/models/ExecuteContext';
+import { GLOBAL_STATIC_CONFIG } from '@/libs/global-config/global-config';
+
+function pickData(a: any, key: string) {
+  if (a && typeof a.getResModel === 'function') {
+    const s = a.getResModel();
+    return s[key];
+  }
+  if (!a) {
+    throw 'executeStdQuery返回数据不存在';
+  }
+  return _.get(a, `data.${key}`);
+}
+
+/**
+ * 多实例，每个任务一个实例。
+ * 导出Excel。请求任务级别的。
+ * 使用标准CtdCrudApp导出
+ */
+class ExportExcelByStdCrudHandler implements IExcelAsyncTaskHandler {
+  protected asyncTaskContext: SysAsyncTaskContext;
+  protected ctx: IMidwayKoaContext;
+  protected inputParams: IStdCrudExportInputParams;
+  protected appCode: string;
+  protected crudStdAppInfo: ICrudStdAppInfo;
+  public constructor(asyncTaskContext: SysAsyncTaskContext, inputParams: IStdCrudExportInputParams, ctx: IMidwayKoaContext) {
+    this.ctx = ctx;
+    this.inputParams = inputParams;
+    this.asyncTaskContext = asyncTaskContext;
+    this.appCode = this.inputParams.appCode;
+  }
+
+  async getPageSize(): Promise<number> {
+    const maxPageSizeOfExportExcel = GLOBAL_STATIC_CONFIG.getConfig().maxPageSizeOfExportExcel;
+    if (typeof this.inputParams.pageSize === 'number') {
+      return Math.min(this.inputParams.pageSize, maxPageSizeOfExportExcel);
+    }
+    return 1000;
+  }
+
+  /**
+   * 获取应用信息
+   * @returns CrudStdService服务实例
+   */
+  private async getCrudStdService(): Promise<CrudStdService> {
+    return await this.ctx.requestContext.getAsync(CrudStdService);
+  }
+
+  /**
+   * 获取应用的配置信息
+   * @returns 应用的配置信息
+   */
+  private async getCrudStdAppInfo(): Promise<ICrudStdAppInfo> {
+    if (!this.crudStdAppInfo) {
+      const appCode = this.inputParams.appCode;
+      if (!appCode) {
+        throw new Error('inputParams appCode is required');
+      }
+      const service = await this.getCrudStdService();
+      this.crudStdAppInfo = await service.getParsedCrudStdAppInfo(appCode);
+    }
+    return this.crudStdAppInfo;
+  }
+
+  /**
+   * 获取Excel表的表头
+   * @returns 表头信息
+   */
+  async getExcelHeader(): Promise<IExcelHeaderInfo[]> {
+    const crudStdAppInfo = await this.getCrudStdAppInfo();
+    const stdCrudCfgObj = crudStdAppInfo.stdCrudCfgObj;
+    const tableColumns = stdCrudCfgObj.tableColumns || [];
+    return tableColumns.map(cc => {
+      return cc;
+    });
+  }
+
+  /**
+   * 获取要导出的数量总数
+   * @returns 数据总量
+   */
+  async getTotalCount(): Promise<number> {
+    const selectedRowKeys: string[] | number[] = this.inputParams?.selectedRowKeys || [];
+    if (Array.isArray(selectedRowKeys) && selectedRowKeys.length > 0) {
+      return selectedRowKeys.length;
+    }
+
+    const lastQueryParams: ITableProQueryParams = this.inputParams?.lastQueryParams;
+    const filterValue = _.get(lastQueryParams, 'filterValue');
+
+    const crudStdService = await this.getCrudStdService();
+    const appCode = this.appCode;
+    const params: IRequestModelCrudProExt = {
+      condition: lastQueryParams?.condition || {},
+      filterValue,
+      pageSize: 1,
+      pageNo: 1,
+    };
+
+    if (!this.ctx.innerHeaders) {
+      this.ctx.innerHeaders = {};
+    }
+    Object.assign(this.ctx.innerHeaders, this.inputParams.headers || {});
+
+    const stdAction: ICrudStdActionParams = {
+      appCode: appCode,
+      settingKey: SPECIAL_SETTING_KEY.QUERY_LIST,
+    };
+
+    const a: ExecuteContext = await crudStdService.executeStdQuery(stdAction, params, KeysOfSimpleSQL.SIMPLE_QUERY_PAGE);
+    return pickData(a, 'total_count');
+  }
+
+  /**
+   * 获取要导出Excel的数据的内容
+   * @param pageNo 页号，从1开始
+   * @param pageSize 每页数量
+   * @returns
+   */
+  async getExcelDataList(pageNo: number, pageSize: number): Promise<any[]> {
+    const selectedRowKeys: string[] | number[] = this.inputParams.selectedRowKeys || [];
+    const primaryKey: string = this.inputParams.primaryKey || 'id';
+    const lastQueryParams: ITableProQueryParams = this.inputParams.lastQueryParams;
+    const filterValue = _.get(lastQueryParams, 'filterValue');
+
+    const crudStdService = await this.getCrudStdService();
+    const appCode = this.appCode;
+    const params: IRequestModelCrudProExt = {
+      condition: lastQueryParams?.condition || {},
+      filterValue: filterValue,
+      pageSize: pageSize,
+      pageNo: pageNo,
+      orderBy: lastQueryParams?.orderBy,
+    };
+    if (Array.isArray(selectedRowKeys) && selectedRowKeys.length > 0) {
+      params.condition[primaryKey] = {
+        $in: selectedRowKeys,
+      };
+    }
+
+    const stdAction: ICrudStdActionParams = {
+      appCode: appCode,
+      settingKey: SPECIAL_SETTING_KEY.QUERY_LIST,
+    };
+
+    const a: ExecuteContext = await crudStdService.executeStdQuery(stdAction, params, KeysOfSimpleSQL.SIMPLE_QUERY_PAGE);
+    return pickData(a, 'rows');
+  }
+}
+
+export { ExportExcelByStdCrudHandler };

package/src/service/base/ApiBaseService.ts

@@ -1,42 +1,42 @@
-import { Provide } from '@midwayjs/core';
-import { BaseService } from './BaseService';
-import { IApiBaseEntity } from '../../models/SystemEntities';
-import { BizException } from '../../models/devops';
-import { Exceptions } from '../../libs/crud-pro/exceptions';
-import { tryAcquireToken } from './ApiRateLimiter';
-
-export const API_BASE_TYPE = {
-  PROXY_API: 'PROXY_API',
-  ANY_API: 'ANY_API',
-  CRUD_METHOD: 'CRUD_METHOD',
-};
-
-@Provide()
-export class ApiBaseService extends BaseService {
-  /**
-   * 前置校验
-   * @param apiBaseType
-   * @param entity
-   */
-  public async beforeCheckApiAccessibility(apiBaseType: string, entity: IApiBaseEntity) {
-    // 权限校验
-    const isPermSuccess = this.ctx.userSession.isAuthPass(entity.auth_type as any, entity.auth_config);
-    if (!isPermSuccess) {
-      throw new BizException('权限校验失败', Exceptions.NO_AUTH);
-    }
-    //服务降级
-    if (entity.fallback_enable === 1) {
-      throw new BizException(entity.fallback_message || '此服务暂时不支持访问', 'FALLBACK_ENABLE');
-    }
-
-    // 限流令牌桶
-    if (entity.limit_enabled === 1) {
-      const accountId = this.ctx.userSession.getSessionInfo().accountId;
-      const apiId = apiBaseType + '_' + entity.id;
-      const isAcquire = tryAcquireToken(apiId, accountId, entity.limit_max, entity.limit_rate);
-      if (!isAcquire) {
-        throw new BizException('频繁访问此接口，被限流', 'LIMIT_ENABLED');
-      }
-    }
-  }
-}
+import { Provide } from '@midwayjs/core';
+import { BaseService } from './BaseService';
+import { IApiBaseEntity } from '@/models/SystemEntities';
+import { BizException } from '@/models/devops';
+import { Exceptions } from '@/libs/crud-pro/exceptions';
+import { tryAcquireToken } from './ApiRateLimiter';
+
+export const API_BASE_TYPE = {
+  PROXY_API: 'PROXY_API',
+  ANY_API: 'ANY_API',
+  CRUD_METHOD: 'CRUD_METHOD',
+};
+
+@Provide()
+export class ApiBaseService extends BaseService {
+  /**
+   * 前置校验
+   * @param apiBaseType
+   * @param entity
+   */
+  public async beforeCheckApiAccessibility(apiBaseType: string, entity: IApiBaseEntity) {
+    // 权限校验
+    const isPermSuccess = this.ctx.userSession.isAuthPass(entity.auth_type as any, entity.auth_config);
+    if (!isPermSuccess) {
+      throw new BizException('权限校验失败', Exceptions.NO_AUTH);
+    }
+    //服务降级
+    if (entity.fallback_enable === 1) {
+      throw new BizException(entity.fallback_message || '此服务暂时不支持访问', 'FALLBACK_ENABLE');
+    }
+
+    // 限流令牌桶
+    if (entity.limit_enabled === 1) {
+      const accountId = this.ctx.userSession.getSessionInfo().accountId;
+      const apiId = apiBaseType + '_' + entity.id;
+      const isAcquire = tryAcquireToken(apiId, accountId, entity.limit_max, entity.limit_rate);
+      if (!isAcquire) {
+        throw new BizException('频繁访问此接口，被限流', 'LIMIT_ENABLED');
+      }
+    }
+  }
+}

package/src/service/base/ApiRateLimiter.ts

@@ -1,59 +1,59 @@
-import { LRUCache } from 'lru-cache';
-
-// 定义 TokenBucket 类
-class TokenBucket {
-  private capacity: number;
-  private fillRate: number;
-  private tokens: number;
-  private lastRefillTime: number;
-
-  constructor(capacity: number, fillRate: number) {
-    this.capacity = capacity;
-    this.fillRate = fillRate;
-    this.tokens = capacity;
-    this.lastRefillTime = Date.now();
-  }
-
-  private refill(): void {
-    const now = Date.now();
-    const elapsedTime = (now - this.lastRefillTime) / 1000;
-    const newTokens = elapsedTime * this.fillRate;
-    this.tokens = Math.min(this.capacity, this.tokens + newTokens);
-    this.lastRefillTime = now;
-  }
-
-  public tryAcquire(tokensNeeded = 1): boolean {
-    this.refill();
-    if (this.tokens >= tokensNeeded) {
-      this.tokens -= tokensNeeded;
-      return true;
-    }
-    return false;
-  }
-}
-
-// 定义一个全局的 Map 来存储不同接口和用户组合的令牌桶
-const apiUserBuckets = new LRUCache<string, TokenBucket>({
-  max: 500,
-  ttl: 1000 * 60 * 5,
-  ttlAutopurge: true,
-});
-
-/**
- * 对接口ID ， 每个用户ID 进行限流。
- * @param apiId 接口ID
- * @param userId 用户ID
- * @param limit_max 限流令牌桶最大值，最大容量
- * @param limit_rate 每秒产生的令牌数量
- * @return {Boolean} 返回token是否可以用。不能被处理就返回false
- */
-function tryAcquireToken(apiId: string, userId: string, limit_max: number, limit_rate: number): boolean {
-  const key = `${apiId}-${userId}`;
-  if (!apiUserBuckets.has(key)) {
-    apiUserBuckets.set(key, new TokenBucket(limit_max, limit_rate));
-  }
-  const bucket = apiUserBuckets.get(key)!;
-  return bucket.tryAcquire();
-}
-
-export { tryAcquireToken };
+import { LRUCache } from 'lru-cache';
+
+// 定义 TokenBucket 类
+class TokenBucket {
+  private capacity: number;
+  private fillRate: number;
+  private tokens: number;
+  private lastRefillTime: number;
+
+  constructor(capacity: number, fillRate: number) {
+    this.capacity = capacity;
+    this.fillRate = fillRate;
+    this.tokens = capacity;
+    this.lastRefillTime = Date.now();
+  }
+
+  private refill(): void {
+    const now = Date.now();
+    const elapsedTime = (now - this.lastRefillTime) / 1000;
+    const newTokens = elapsedTime * this.fillRate;
+    this.tokens = Math.min(this.capacity, this.tokens + newTokens);
+    this.lastRefillTime = now;
+  }
+
+  public tryAcquire(tokensNeeded = 1): boolean {
+    this.refill();
+    if (this.tokens >= tokensNeeded) {
+      this.tokens -= tokensNeeded;
+      return true;
+    }
+    return false;
+  }
+}
+
+// 定义一个全局的 Map 来存储不同接口和用户组合的令牌桶
+const apiUserBuckets = new LRUCache<string, TokenBucket>({
+  max: 500,
+  ttl: 1000 * 60 * 5,
+  ttlAutopurge: true,
+});
+
+/**
+ * 对接口ID ， 每个用户ID 进行限流。
+ * @param apiId 接口ID
+ * @param userId 用户ID
+ * @param limit_max 限流令牌桶最大值，最大容量
+ * @param limit_rate 每秒产生的令牌数量
+ * @return {Boolean} 返回token是否可以用。不能被处理就返回false
+ */
+function tryAcquireToken(apiId: string, userId: string, limit_max: number, limit_rate: number): boolean {
+  const key = `${apiId}-${userId}`;
+  if (!apiUserBuckets.has(key)) {
+    apiUserBuckets.set(key, new TokenBucket(limit_max, limit_rate));
+  }
+  const bucket = apiUserBuckets.get(key)!;
+  return bucket.tryAcquire();
+}
+
+export { tryAcquireToken };