midway-fatcms 0.0.1-beta.25 → 0.0.1-beta.28

package/src/service/anyapi/AnyApiService.ts

@@ -1,186 +0,0 @@
-import { Inject, Provide } from '@midwayjs/core';
-import { Context } from '@midwayjs/koa';
-import { KeysOfSimpleSQL } from '@/libs/crud-pro/models/keys';
-import { SystemTables } from '@/models/SystemTables';
-import { LRUCache } from 'lru-cache';
-import { BizException } from '@/models/devops';
-import { CurdMixService } from '../curd/CurdMixService';
-import { ISysAnyApiEntity } from '@/models/SystemEntities';
-import { AnyApiSandboxService, IRunInSandboxParams } from './AnyApiSandboxService';
-import { parseJsonObject } from '@/libs/utils/functions';
-import * as _ from 'lodash';
-import { MixinUtils } from '@/libs/crud-pro/utils/MixinUtils';
-import { WorkbenchService } from '../WorkbenchService';
-import { validateByCfgString } from '@/libs/crud-pro/utils/ValidateUtils';
-import { API_BASE_TYPE, ApiBaseService } from '../base/ApiBaseService';
-import { GLOBAL_STATIC_CONFIG } from '@/libs/global-config/global-config';
-
-const lruCache = new LRUCache<string, any>({
-  max: 500,
-  ttl: 1000 * 60,
-  ttlAutopurge: true,
-});
-
-@Provide()
-export class AnyApiService extends ApiBaseService {
-  @Inject()
-  protected ctx: Context;
-
-  @Inject()
-  private curdMixService: CurdMixService;
-
-  @Inject()
-  private anyApiSandboxService: AnyApiSandboxService;
-
-  @Inject()
-  protected workbenchService: WorkbenchService;
-
-  async executeAnyApiMethod(methodCode: string, headers: any, body: any, query: any) {
-    const anyApi = await this.getAnyApiMethod(methodCode);
-    if (!anyApi || anyApi.status !== 1) {
-      throw new BizException('接口不存在或已下线：' + methodCode);
-    }
-
-    const isSupport = await this.workbenchService.isSupportCurrentWorkbench(anyApi.workbench_code_array);
-    if (!isSupport) {
-      throw new BizException('此接口不支持在当前站点打开：' + methodCode);
-    }
-
-    await super.beforeCheckApiAccessibility(API_BASE_TYPE.PROXY_API, anyApi);
-
-    if (!anyApi.func_code) {
-      throw new BizException('没有配置代码：' + methodCode);
-    }
-
-    if (!this.checkFuncCode(anyApi.func_code)) {
-      throw new BizException('接口代码校验失败：不满足形式： class HttpController { async handleRequest(params){} }; ');
-    }
-
-    const allParams: IRunInSandboxParams = { headers, body, query };
-    allParams.params = this.toAnyApiParams(anyApi, allParams); // 组合参数
-
-    // 执行代码
-    const funcRes = await this.executeFunctionCode(anyApi, allParams);
-    return funcRes;
-  }
-
-  private async getAnyApiMethod(methodCode: string): Promise<ISysAnyApiEntity> {
-    // 开发环境，不使用缓存
-    if (this.isEnableDebug()) {
-      return this._getAnyApiMethod(methodCode);
-    }
-
-    // 线上环境可以使用缓存
-    let anyApi = lruCache.get(methodCode);
-    if (!anyApi) {
-      anyApi = await this._getAnyApiMethod(methodCode);
-      lruCache.set(methodCode, anyApi);
-    }
-    return anyApi;
-  }
-
-  private async _getAnyApiMethod(methodCode: string): Promise<ISysAnyApiEntity> {
-    const { SystemDbName, SystemDbType } = GLOBAL_STATIC_CONFIG.getConfig();
-
-    const res = await this.curdMixService.executeCrudByCfg(
-      { condition: { method: methodCode } },
-      {
-        sqlTable: SystemTables.sys_anyapi,
-        method: `get_sys_anyapi_${methodCode}`,
-        sqlSimpleName: KeysOfSimpleSQL.SIMPLE_QUERY_ONE,
-        sqlDatabase: SystemDbName,
-        sqlDbType: SystemDbType,
-        updateCfg: {},
-      }
-    );
-    const obj: ISysAnyApiEntity = res.getOneObj();
-    if (!obj) {
-      return null;
-    }
-    obj.parsedOthers = parseJsonObject(obj.others);
-    return obj;
-  }
-
-  /**
-   * 构造参数
-   * @param anyApi
-   * @param allParams
-   * @private
-   */
-  private toAnyApiParams(anyApi: ISysAnyApiEntity, allParams: IRunInSandboxParams): any {
-    if (!anyApi.req_params) {
-      return {};
-    }
-
-    const configs = anyApi.parsedOthers?.req_params || [];
-    const params = {};
-    for (let i = 0; i < configs.length; i++) {
-      const { name, fromType, fromKey, validate_required, validate_cfg_list, valueType, defaultValue } = configs[i];
-      const value = _.get(allParams, [fromType, fromKey], defaultValue);
-      if (validate_required && MixinUtils.isEmpty(value)) {
-        throw new BizException(`参数校验失败：${name} 不能为空`);
-      }
-
-      // 参数校验
-      if (Array.isArray(validate_cfg_list)) {
-        for (let j = 0; j < validate_cfg_list.length; j++) {
-          const validateCfg = validate_cfg_list[j];
-          validateByCfgString(validateCfg, value, name);
-        }
-      }
-
-      // 格式转换
-      params[name] = MixinUtils.parseValueByType(value, valueType);
-    }
-    return params;
-  }
-
-  /**
-   * 运行代码
-   * @param anyApiEntity
-   * @param allParams
-   * @private
-   */
-  private async executeFunctionCode(anyApiEntity: ISysAnyApiEntity, allParams: IRunInSandboxParams): Promise<any> {
-    return this.anyApiSandboxService.runInSandbox(anyApiEntity, allParams);
-  }
-
-  private checkFuncCode(func_code: string): boolean {
-    if (!func_code) {
-      return false;
-    }
-
-    const lineHasKey = (lineTrim: string, target: string): boolean => {
-      const words = lineTrim.split(/[\s{}();]/);
-      for (let i = 0; i < words.length; i++) {
-        const word = words[i];
-        if (word && word === target) {
-          return true;
-        }
-      }
-      return false;
-    };
-
-    let hasClass = false;
-    let hasMethod = false;
-    const lines = func_code.split('\n');
-    for (let i = 0; i < lines.length; i++) {
-      const line = lines[i];
-      if (line) {
-        const lineTrim = line.trim();
-        if (lineTrim) {
-          if (lineHasKey(lineTrim, 'class') && lineHasKey(lineTrim, 'HttpController')) {
-            hasClass = true;
-          }
-          if (lineHasKey(lineTrim, 'async') && lineHasKey(lineTrim, 'handleRequest')) {
-            hasMethod = true;
-          }
-          if (lineTrim.startsWith('handleRequest')) {
-            hasMethod = true;
-          }
-        }
-      }
-    }
-    return hasMethod && hasClass;
-  }
-}

package/src/service/asyncTask/AsyncTaskRunnerService.ts

@@ -1,266 +0,0 @@
-import { Inject, Provide } from '@midwayjs/core';
-import { Context, IMidwayKoaContext } from '@midwayjs/koa';
-import { BaseService } from '@/service/base/BaseService';
-import { IScheduleService } from '@/interface';
-import { CurdProService } from '@/service/curd/CurdProService';
-import { ISysAsyncTaskHandler, SysAsyncTaskEntity, SysAsyncTaskPartial, SysAsyncTaskStatus } from '@/models/AsyncTaskModel';
-import { GLOBAL_STATIC_CONFIG } from '@/libs/global-config/global-config';
-import { SystemTables } from '@/models/SystemTables';
-import { KeysOfSimpleSQL } from '@/libs/crud-pro/models/keys';
-import { errorToString } from '@/libs/utils/errorToString';
-import { ANONYMOUS_CONTEXT } from '@/schedule';
-import { RedisKeys } from '@/models/RedisKeys';
-import { getCurrentFullMoment } from '@/libs/utils/functions';
-import { ExportExcelAsyncTaskHandler } from './handler/ExportExcelAsyncTaskHandler';
-
-const END_STATUS_LIST = [SysAsyncTaskStatus.PART_SUCCEEDED, SysAsyncTaskStatus.SUCCEEDED, SysAsyncTaskStatus.FAILED, SysAsyncTaskStatus.CANCELLED, SysAsyncTaskStatus.PAUSED];
-
-class AsyncTaskRunner {
-  isBusy = false;
-  taskHandlerMap: Map<string, ISysAsyncTaskHandler> = new Map();
-
-  async executeTaskList(taskList: SysAsyncTaskEntity[]) {
-    if (!taskList || taskList.length === 0) {
-      return;
-    }
-
-    this.isBusy = true;
-
-    for (let i = 0; i < taskList.length; i++) {
-      const taskElement = taskList[i];
-      taskElement.task_status = SysAsyncTaskStatus.RUNNING;
-
-      try {
-        // 1. 更新当前这个任务的状态
-        await this.updateTaskStatus(taskElement, {
-          task_status: taskElement.task_status,
-          started_at: getCurrentFullMoment(),
-          updated_at: getCurrentFullMoment(),
-        });
-
-        // 任务状态的设置在自定义的执行器里面。
-        await this.executeTask(taskElement);
-
-        // 当前不是终止状态，并且没有异常就设置成成功。
-        if (!END_STATUS_LIST.includes(taskElement.task_status)) {
-          taskElement.task_status = SysAsyncTaskStatus.SUCCEEDED;
-        }
-      } catch (error) {
-        taskElement.task_status = SysAsyncTaskStatus.FAILED;
-        taskElement.error_message = errorToString(error);
-      }
-
-      try {
-        // 2. 更新当前这个任务的状态
-        await this.updateTaskStatus(taskElement, {
-          task_status: taskElement.task_status,
-          error_message: taskElement.error_message,
-          updated_at: getCurrentFullMoment(),
-          completed_at: getCurrentFullMoment(),
-        });
-      } catch (error) {
-        ANONYMOUS_CONTEXT.getApp().getCoreLogger().error('[AsyncTaskRunner] executeTaskList error', error);
-      }
-    }
-
-    this.isBusy = false;
-  }
-
-  private async executeTask(taskElement: SysAsyncTaskEntity) {
-    const taskType = taskElement.task_type;
-    const taskHandler = this.taskHandlerMap.get(taskType);
-    if (!taskHandler) {
-      throw new Error('TaskHandler not found , taskType = ' + taskType);
-    }
-    const updateTaskStatus = (updatePartials: SysAsyncTaskPartial) => {
-      return this.updateTaskStatus(taskElement, updatePartials);
-    };
-    await taskHandler.execute({ task: taskElement, updateTaskStatus });
-  }
-
-  /**
-   * 更新任务状态或任务进度
-   * @param taskElement
-   * @param updatePartials
-   * @private
-   */
-  private async updateTaskStatus(taskElement: SysAsyncTaskEntity, updatePartials: SysAsyncTaskPartial) {
-    if (!updatePartials) {
-      throw new Error('updatePartials not found');
-    }
-    return await ANONYMOUS_CONTEXT.runServiceAtAnonymousContext(async (ctx: IMidwayKoaContext) => {
-      const curdProService: CurdProService = await ctx.requestContext.getAsync('curdProService');
-      const { SystemDbName, SystemDbType } = GLOBAL_STATIC_CONFIG.getConfig();
-
-      const res = await curdProService.executeCrudByCfg(
-        {
-          condition: {
-            id: taskElement.id,
-          },
-          data: updatePartials,
-        },
-        {
-          sqlTable: SystemTables.sys_async_tasks,
-          sqlSimpleName: KeysOfSimpleSQL.SIMPLE_UPDATE,
-          sqlDatabase: SystemDbName,
-          sqlDbType: SystemDbType,
-        }
-      );
-      return res.getResModel().affected;
-    });
-  }
-
-  /**
-   * 获取当前进程可以处理的任务类型。
-   */
-  public getHandlerTaskTypeList(): string[] {
-    const keys = this.taskHandlerMap.keys();
-    return [...keys];
-  }
-}
-
-/**
- * 业务可以扩展
- */
-export const ASYNC_TASK_RUNNER = new AsyncTaskRunner();
-
-//内置的异步任务处理器：EXCEL导出
-ASYNC_TASK_RUNNER.taskHandlerMap.set('EXCEL_EXPORT', new ExportExcelAsyncTaskHandler());
-
-/**
- * Redis锁
- */
-const ASYNC_TASK_LOCK = RedisKeys.ASYNC_TASK_LOCK;
-
-/**
- * 上次检查异步任务的时间点
- */
-const ASYNC_TASK_RUNTIME_OBJ = {
-  LAST_CHECK_ASYNC_TASK_UPDATE_TIME: 0,
-};
-
-@Provide()
-export class AsyncTaskRunnerService extends BaseService implements IScheduleService {
-  @Inject()
-  protected ctx: Context;
-
-  @Inject()
-  private curdProService: CurdProService;
-
-  async fetchPendingTasks(): Promise<void> {
-    const { SystemDbName, SystemDbType } = GLOBAL_STATIC_CONFIG.getConfig();
-
-    // 只获取本进程能够处理的任务类型。
-    const taskTypeList = ASYNC_TASK_RUNNER.getHandlerTaskTypeList();
-    if (taskTypeList.length === 0) {
-      return Promise.resolve();
-    }
-
-    // 查询等待处理的任务。
-    const queryRes = await this.curdProService.executeCrudByCfg(
-      {
-        condition: {
-          task_status: SysAsyncTaskStatus.PENDING,
-          task_type: {
-            $in: taskTypeList,
-          },
-        },
-        orderBy: 'id+',
-        limit: 10,
-      },
-      {
-        sqlTable: SystemTables.sys_async_tasks,
-        sqlSimpleName: KeysOfSimpleSQL.SIMPLE_QUERY_PAGE,
-        sqlDatabase: SystemDbName,
-        sqlDbType: SystemDbType,
-      }
-    );
-
-    const taskList = queryRes.getResRows();
-
-    if (taskList.length === 0) {
-      return Promise.resolve();
-    }
-    const taskIds = taskList.map(elem => elem.id).filter(Boolean);
-
-    // 将状态更新为处理中。防止其它进程重复处理。
-    await this.curdProService.executeCrudByCfg(
-      {
-        condition: {
-          id: {
-            $in: taskIds,
-          },
-        },
-        data: {
-          task_status: SysAsyncTaskStatus.RUNNING,
-        },
-      },
-      {
-        sqlTable: SystemTables.sys_async_tasks,
-        sqlSimpleName: KeysOfSimpleSQL.SIMPLE_UPDATE,
-        sqlDatabase: SystemDbName,
-        sqlDbType: SystemDbType,
-      }
-    );
-
-    // 开始执行。
-    ASYNC_TASK_RUNNER.executeTaskList(taskList).then(() => {
-      console.log('[AsyncTaskRunnerService] ASYNC_TASK_RUNNER finished taskIds ==> ' + JSON.stringify(taskIds));
-    });
-  }
-
-  async runBySchedule() {
-    // 1. 当前很忙
-    if (ASYNC_TASK_RUNNER.isBusy) {
-      return Promise.resolve();
-    }
-
-    // 2. 发现了新任务
-    const isExistNewTask = await this.isExistNewTask();
-    if (!isExistNewTask) {
-      return Promise.resolve();
-    }
-
-    // 这里的过期时间1分钟即可。fetchPendingTasks函数不可能超过一分钟。
-    // 因为这里只是从数据库中获取一批任务，放到自己的任务队列里。还没触发执行。
-    const lock = await this.redisService.set(ASYNC_TASK_LOCK, 1, 'EX', 60, 'NX');
-    if (lock !== 'OK') {
-      return Promise.resolve();
-    }
-
-    try {
-      await this.fetchPendingTasks();
-    } catch (e) {
-      console.error('[AsyncTaskRunnerService] fetchPendingTasks error', errorToString(e));
-    }
-
-    await this.redisService.del(ASYNC_TASK_LOCK);
-
-    return Promise.resolve();
-  }
-
-  /**
-   * 是否存在新任务
-   * @private
-   */
-  private async isExistNewTask(): Promise<boolean> {
-    // 刚启动，没有检查过。
-    if (!ASYNC_TASK_RUNTIME_OBJ.LAST_CHECK_ASYNC_TASK_UPDATE_TIME) {
-      ASYNC_TASK_RUNTIME_OBJ.LAST_CHECK_ASYNC_TASK_UPDATE_TIME = Date.now();
-      return true;
-    }
-
-    //Redis没有任何内容
-    const updateTime = await this.redisService.get(RedisKeys.ASYNC_TASK_UPDATE_TIME);
-    if (!updateTime) {
-      ASYNC_TASK_RUNTIME_OBJ.LAST_CHECK_ASYNC_TASK_UPDATE_TIME = Date.now();
-      return false;
-    }
-
-    const updateTimeNumber = Number.parseInt(updateTime, 10);
-
-    const isExistNewTask: boolean = updateTimeNumber > ASYNC_TASK_RUNTIME_OBJ.LAST_CHECK_ASYNC_TASK_UPDATE_TIME;
-    ASYNC_TASK_RUNTIME_OBJ.LAST_CHECK_ASYNC_TASK_UPDATE_TIME = updateTimeNumber;
-    return isExistNewTask;
-  }
-}

package/src/service/asyncTask/AsyncTaskService.ts

@@ -1,21 +0,0 @@
-import { Inject, Provide } from '@midwayjs/core';
-import { Context } from '@midwayjs/koa';
-import { BaseService } from '@/service/base/BaseService';
-import { runScheduleTaskOnce } from '@/schedule';
-import { INNER_SCHEDULE_NAMES } from '@/schedule/scheduleNames';
-import { RedisKeys } from '@/models/RedisKeys';
-
-@Provide()
-export class AsyncTaskService extends BaseService {
-  @Inject()
-  protected ctx: Context;
-
-  async startTask() {
-    await this.redisService.set(RedisKeys.ASYNC_TASK_UPDATE_TIME, `${Date.now()}`);
-    runScheduleTaskOnce(INNER_SCHEDULE_NAMES.asyncTaskRunnerService).then(schedule => {
-      console.log(schedule);
-    });
-  }
-
-  async cancelTask(id: number) {}
-}

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

@@ -1,11 +0,0 @@
-export interface IExcelHeaderInfo {
-  title: string;
-  dataIndex: string;
-}
-
-export interface IExcelAsyncTaskHandler {
-  getExcelHeader(): Promise<IExcelHeaderInfo[]>;
-  getPageSize(): Promise<number>;
-  getTotalCount(): Promise<number>;
-  getExcelDataList(pageNo: number, pageSize: number): Promise<any[]>;
-}