midway-fatcms 0.0.1-beta.6 → 0.0.1-beta.61

package/src/service/WorkbenchService.ts

@@ -1,160 +1,220 @@
-import { Inject, Provide } from '@midwayjs/core';
-import { Context } from '@midwayjs/koa';
-import { KeysOfSimpleSQL } from '../libs/crud-pro/models/keys';
-import {SystemDbName, SystemDbType, SystemTables} from '../models/SystemTables';
-import { BaseService } from './base/BaseService';
-// import { LRUCache } from 'lru-cache';
-import { CurdProService } from './curd/CurdProService';
-import { CommonException } from '../libs/crud-pro/exceptions';
-import { parseJsonObject } from '../libs/utils/functions';
-import { IWorkbenchEntity } from '../models/SystemEntities';
-import { IScheduleService } from '../interface';
-import { getDebugWorkbenchCode } from '../libs/utils/fatcms-request';
-import { MixinUtils } from '../libs/crud-pro/utils/MixinUtils';
-//
-// const lruCache = new LRUCache<string, any>({
-//   max: 500,
-//   ttl: 1000 * 60 * 60,
-//   ttlAutopurge: true,
-// });
-
-const lruCache = new Map<string, any>();
-
-const CACHE_KEY_WORKBENCH_LIST = 'CACHE_KEY_WORKBENCH_LIST';
-const CACHE_KEY_DOMAIN_MAP = 'CACHE_KEY_DOMAIN_MAP';
-
-
-@Provide()
-export class WorkbenchService extends BaseService implements IScheduleService {
-  @Inject()
-  ctx: Context;
-
-  @Inject()
-  private curdProService: CurdProService;
-
-  public clearCache() {
-    lruCache.set(CACHE_KEY_WORKBENCH_LIST, null);
-    lruCache.set(CACHE_KEY_DOMAIN_MAP, null);
-  }
-
-  public async runBySchedule() {
-    await this.getAllWorkbenchInfoMap(true);
-  }
-
-  public async getAllWorkbenchInfoList(isForceRefresh?: boolean): Promise<IWorkbenchEntity[]> {
-    let listData = lruCache.get(CACHE_KEY_WORKBENCH_LIST);
-    if (!listData || isForceRefresh === true) {
-      const reqJson = { condition: {}, pageSize: 1000, limit: 1000 };
-      const res = await this.curdProService.executeCrudByCfg(reqJson, {
-        sqlTable: SystemTables.sys_workbench,
-        sqlSimpleName: KeysOfSimpleSQL.SIMPLE_QUERY,
-        sqlDatabase: SystemDbName,
-        sqlDdType: SystemDbType,
-      });
-      listData = res.getResRows();
-      lruCache.set(CACHE_KEY_WORKBENCH_LIST, listData);
-    }
-    return listData;
-  }
-
-  public async getAllWorkbenchInfoMap(isForceRefresh?: boolean): Promise<Record<any, IWorkbenchEntity>> {
-    let listData: any[];
-    let domainMap = lruCache.get(CACHE_KEY_DOMAIN_MAP);
-    if (!domainMap || isForceRefresh === true) {
-      listData = await this.getAllWorkbenchInfoList(isForceRefresh);
-      const domainMap1 = MixinUtils.toMap(listData, (e: any) => e.workbench_domain); // 主域名。其他两个域名。
-      const domainMap2 = MixinUtils.toMap(listData, (e: any) => e.workbench_domain2);
-      const domainMap3 = MixinUtils.toMap(listData, (e: any) => e.workbench_domain3);
-      domainMap = {...domainMap1, ...domainMap2, ...domainMap3};
-      lruCache.set(CACHE_KEY_DOMAIN_MAP, domainMap);
-    }
-    return domainMap;
-  }
-
-  public isMatchWorkbenchCode(workbench_code_array: string | string[], workbench_code: string): boolean {
-    if (workbench_code_array === '*') {
-      return true;
-    }
-    const supportWorkbenchArray = parseJsonObject(workbench_code_array)
-      .map(s => s.trim())
-      .filter(Boolean);
-
-    return supportWorkbenchArray.includes('*') || supportWorkbenchArray.includes(workbench_code);
-  }
-
-  /**
-   * 获取当前请求的域名所对应的站点信息
-   */
-  public async getCurrentHostWorkbenchInfo(): Promise<IWorkbenchEntity> {
-    // 本地调试模式
-    if (this.isEnableDebug() && this.isLocalEnv()) {
-      const debugWorkbenchCode = getDebugWorkbenchCode(this.ctx);
-      if (!debugWorkbenchCode) {
-        throw new CommonException('本地环境调试时需要使用ModHeader浏览器插件，指定站点编码');
-      }
-      const list = await this.getAllWorkbenchInfoList();
-      for (let i = 0; i < list.length; i++) {
-        const workbenchInfo = list[i];
-        if (workbenchInfo.workbench_code === debugWorkbenchCode) {
-          return workbenchInfo;
-        }
-      }
-      return null;
-    }
-
-    //正式环境： 根据域名获取站点配置
-    const host = this.getCurrentHost();
-    const domainMap = await this.getAllWorkbenchInfoMap();
-    return domainMap[host];
-  }
-
-  private getCurrentHost(): string {
-    const host = this.ctx.request.host;
-    if (!host) {
-      throw new CommonException('GET_CURRENT_HOST_ERROR','获取当前域名失败');
-    }
-    return host;
-  }
-
-
-  public async isSupportCurrentWorkbench(workbench_code_array: string | string[]): Promise<boolean> {
-    // 本地调试模式
-    if (this.isEnableDebug() && this.isLocalEnv()) {
-      return true;
-    }
-
-    if (!workbench_code_array) {
-      throw new CommonException('IS_SUPPORT_CURRENT_WORKBENCH', '未配置支持的站点字段');
-    }
-
-    const workbench = await this.getCurrentHostWorkbenchInfo();
-    if (!workbench) {
-      throw new CommonException('WORKBENCH_IS_NOT_FOUND', '站点未找到');
-    }
-
-    const curWorkbenchCode = workbench.workbench_code;
-    return this.isMatchWorkbenchCode(workbench_code_array, curWorkbenchCode);
-  }
-
-  public async isSupportCurrentHostForForMiddleware(): Promise<string | boolean> {
-    // 本地调试模式
-    if (this.isEnableDebug() && this.isLocalEnv()) {
-      return true;
-    }
-
-    const host = this.getCurrentHost();
-
-    const workbenchInfo = await this.getCurrentHostWorkbenchInfo();
-
-    if (!workbenchInfo || workbenchInfo.status !== 1) {
-      this.logInfo(`域名不存在 host=${host}`);
-      const infos = {
-        host,
-        errorInfo: `ERR_FATCMS_REFUSED <br/> 域名配置不存在 host=${host}`,
-      };
-      this.ctx.status = 404;
-      return this.ctx.render('404_workbench', infos);
-    }
-    return true;
-  }
-}
+import { Inject, Provide, Config } from '@midwayjs/core';
+import { Context } from '@midwayjs/koa';
+import { KeysOfSimpleSQL } from '@/libs/crud-pro/models/keys';
+import { SystemTables } from '@/models/SystemTables';
+import { BaseService } from './base/BaseService';
+// import { LRUCache } from 'lru-cache';
+import { CurdProService } from './curd/CurdProService';
+import { CommonException } from '@/libs/crud-pro/exceptions';
+import { parseJsonObject } from '@/libs/utils/functions';
+import { IWorkbenchEntity } from '@/models/SystemEntities';
+import { IScheduleService } from '@/interface';
+import { getDebugWorkbenchCode } from '@/libs/utils/fatcms-request';
+import { MixinUtils } from '@/libs/crud-pro/utils/MixinUtils';
+import { GLOBAL_STATIC_CONFIG } from '@/libs/global-config/global-config';
+import { HEADER_KEY_RUN_BY_ASYNC_TASK_WORKBENCH_CODE } from '@/models/AsyncTaskModel';
+//
+// const lruCache = new LRUCache<string, any>({
+//   max: 500,
+//   ttl: 1000 * 60 * 60,
+//   ttlAutopurge: true,
+// });
+
+const lruCache = new Map<string, any>();
+
+const CACHE_KEY_WORKBENCH_LIST = 'CACHE_KEY_WORKBENCH_LIST';
+const CACHE_KEY_DOMAIN_MAP = 'CACHE_KEY_DOMAIN_MAP';
+
+@Provide()
+export class WorkbenchService extends BaseService implements IScheduleService {
+  @Inject()
+  ctx: Context;
+
+  @Inject()
+  private curdProService: CurdProService;
+
+  @Config('fatcmsTargetWorkbenchCode')
+  private fatcmsTargetWorkbenchCode: string;
+
+  public clearCache() {
+    lruCache.set(CACHE_KEY_WORKBENCH_LIST, null);
+    lruCache.set(CACHE_KEY_DOMAIN_MAP, null);
+  }
+
+  public async runBySchedule() {
+    await this.getAllWorkbenchInfoMap(true);
+  }
+
+  /**
+   * 获取所有站点列表
+   * @param isForceRefresh 是否强制刷新缓存
+   * @returns
+   */
+  public async getAllWorkbenchInfoList(isForceRefresh?: boolean): Promise<IWorkbenchEntity[]> {
+    const { SystemDbName, SystemDbType } = GLOBAL_STATIC_CONFIG.getConfig();
+
+    let listData = lruCache.get(CACHE_KEY_WORKBENCH_LIST);
+    if (!listData || isForceRefresh === true) {
+      const reqJson = { condition: {}, pageSize: 1000, limit: 1000 };
+      const res = await this.curdProService.executeCrudByCfg(reqJson, {
+        sqlTable: SystemTables.sys_workbench,
+        sqlSimpleName: KeysOfSimpleSQL.SIMPLE_QUERY,
+        sqlDatabase: SystemDbName,
+        sqlDbType: SystemDbType,
+      });
+      listData = res.getResRows();
+      lruCache.set(CACHE_KEY_WORKBENCH_LIST, listData);
+    }
+    return listData;
+  }
+
+  /**
+   * 获取所有站点列表，以map的形式返回。其中key为站点域名，value为站点信息
+   * @param isForceRefresh 是否强制刷新缓存
+   * @returns
+   */
+  public async getAllWorkbenchInfoMap(isForceRefresh?: boolean): Promise<Record<any, IWorkbenchEntity>> {
+    let listData: any[];
+    let domainMap = lruCache.get(CACHE_KEY_DOMAIN_MAP);
+    if (!domainMap || isForceRefresh === true) {
+      listData = await this.getAllWorkbenchInfoList(isForceRefresh);
+      const domainMap1 = MixinUtils.toMap(listData, (e: any) => e.workbench_domain); // 主域名。其他两个域名。
+      const domainMap2 = MixinUtils.toMap(listData, (e: any) => e.workbench_domain2);
+      const domainMap3 = MixinUtils.toMap(listData, (e: any) => e.workbench_domain3);
+      domainMap = { ...domainMap1, ...domainMap2, ...domainMap3 };
+      lruCache.set(CACHE_KEY_DOMAIN_MAP, domainMap);
+    }
+    return domainMap;
+  }
+
+  /**
+   * 检查站点编码是否匹配
+   * @param workbench_code_array 站点编码数组
+   * @param workbench_code 站点编码
+   * @returns
+   */
+  public isMatchWorkbenchCode(workbench_code_array: string | string[], workbench_code: string): boolean {
+    if (workbench_code_array === '*') {
+      return true;
+    }
+    const supportWorkbenchArray = parseJsonObject(workbench_code_array)
+      .map(s => s.trim())
+      .filter(Boolean);
+
+    return supportWorkbenchArray.includes('*') || supportWorkbenchArray.includes(workbench_code);
+  }
+
+  /**
+   * 根据站点编码获取站点信息
+   * @param workbenchCode 站点编码
+   * @returns
+   */
+  private async getWorkbenchInfoByCode(workbenchCode: string): Promise<IWorkbenchEntity> {
+    const list = await this.getAllWorkbenchInfoList();
+    for (let i = 0; i < list.length; i++) {
+      const workbenchInfo = list[i];
+      if (workbenchInfo.workbench_code === workbenchCode) {
+        return workbenchInfo;
+      }
+    }
+    return null;
+  }
+
+  /**
+   * 根据域名获取站点信息
+   * @param host 域名
+   * @returns
+   */
+  private async getWorkbenchInfoByHost(host: string): Promise<IWorkbenchEntity> {
+    const domainMap = await this.getAllWorkbenchInfoMap();
+    return domainMap[host];
+  }
+
+  /**
+   * 获取当前请求的域名所对应的站点信息
+   */
+  public async getCurrentHostWorkbenchInfo(): Promise<IWorkbenchEntity> {
+    // 本地调试模式
+    if (this.isEnableDebug() && this.isLocalEnv()) {
+      const debugWorkbenchCode = getDebugWorkbenchCode(this.ctx);
+      if (!debugWorkbenchCode) {
+        throw new CommonException('本地环境调试时需要使用ModHeader浏览器插件，指定站点编码');
+      }
+      return await this.getWorkbenchInfoByCode(debugWorkbenchCode);
+    }
+
+    // 内部异步任务，指定了workbench code
+    const asyncTaskWorkbenchCode = this.ctx.headers[HEADER_KEY_RUN_BY_ASYNC_TASK_WORKBENCH_CODE];
+    if (asyncTaskWorkbenchCode && typeof asyncTaskWorkbenchCode === 'string') {
+      return await this.getWorkbenchInfoByCode(asyncTaskWorkbenchCode);
+    }
+
+    // 只有一个workbench的场景。对于后台系统。不需要配置域名的场景。
+    const fatcmsTargetWorkbenchCode = this.fatcmsTargetWorkbenchCode;
+    if (typeof fatcmsTargetWorkbenchCode === 'string' && fatcmsTargetWorkbenchCode.length > 3) {
+      return await this.getWorkbenchInfoByCode(fatcmsTargetWorkbenchCode);
+    }
+
+    //正式环境： 根据域名获取站点配置
+    const host = this.getCurrentHost();
+    const workbenchInfo = await this.getWorkbenchInfoByHost(host);
+    if (workbenchInfo) {
+      return workbenchInfo;
+    }
+    // 最后兜底
+    return await this.getWorkbenchInfoByHost('*');
+  }
+
+  /**
+   * 获取当前请求的域名
+   * @returns
+   */
+  private getCurrentHost(): string {
+    const host = this.ctx.request.host;
+    if (!host) {
+      throw new CommonException('GET_CURRENT_HOST_ERROR', '获取当前域名失败');
+    }
+    return host;
+  }
+
+  public async isSupportCurrentWorkbench(workbench_code_array: string | string[]): Promise<boolean> {
+    // 本地调试模式
+    if (this.isEnableDebug() && this.isLocalEnv()) {
+      return true;
+    }
+
+    if (!workbench_code_array) {
+      throw new CommonException('IS_SUPPORT_CURRENT_WORKBENCH', '未配置支持的站点字段');
+    }
+
+    const workbench = await this.getCurrentHostWorkbenchInfo();
+    if (!workbench) {
+      throw new CommonException('WORKBENCH_IS_NOT_FOUND', '站点未找到');
+    }
+
+    const curWorkbenchCode = workbench.workbench_code;
+    return this.isMatchWorkbenchCode(workbench_code_array, curWorkbenchCode);
+  }
+
+  public async isSupportCurrentHostForForMiddleware(): Promise<string | boolean> {
+    // 本地调试模式
+    if (this.isEnableDebug() && this.isLocalEnv()) {
+      return true;
+    }
+
+    const host = this.getCurrentHost();
+
+    const workbenchInfo = await this.getCurrentHostWorkbenchInfo();
+
+    if (!workbenchInfo || workbenchInfo.status !== 1) {
+      this.logInfo(`域名不存在 host=${host}`);
+      const infos = {
+        host,
+        errorInfo: `ERR_FATCMS_REFUSED <br/> 域名配置不存在 host=${host}`,
+      };
+      this.ctx.status = 404;
+      return this.ctx.render('404_workbench', infos);
+    }
+    return true;
+  }
+}

package/src/service/anyapi/AnyApiSandboxService.ts

@@ -1,121 +1,121 @@
-import { Inject, Provide } from '@midwayjs/core';
-import { Context } from '@midwayjs/koa';
-import * as vm from 'node:vm';
-import { LRUCache } from 'lru-cache';
-import { BaseService } from '../base/BaseService';
-import { CurdMixService } from '../curd/CurdMixService';
-import { ISysAnyApiEntity } from '../../models/SystemEntities';
-import axios from 'axios';
-import * as _ from 'lodash';
-import * as moment from 'moment';
-import * as nodemailer from 'nodemailer';
-
-const scriptCacheOptions = {
-  max: 500,
-  ttl: 1000 * 60 * 5,
-  allowStale: false,
-  updateAgeOnGet: true,
-  updateAgeOnHas: true,
-};
-
-const scriptCache = new LRUCache<string, vm.Script>(scriptCacheOptions);
-
-function getCompiledScript(anyApi: ISysAnyApiEntity, code: string): vm.Script {
-  const { id, func_code_md5 } = anyApi;
-  const cacheKey = id + '_' + func_code_md5;
-  const oldScript = scriptCache.get(cacheKey);
-  if (oldScript) {
-    return oldScript;
-  }
-  const script = new vm.Script(code);
-  scriptCache.set(cacheKey, script);
-  return script;
-}
-
-export interface IRunInSandboxParams {
-  body: any;
-  query: any;
-  headers: any;
-  params?: any;
-}
-
-@Provide()
-export class AnyApiSandboxService extends BaseService {
-  @Inject()
-  protected ctx: Context;
-
-  @Inject()
-  private curdMixService: CurdMixService;
-
-  public async runInSandbox(anyApi: ISysAnyApiEntity, allParams: IRunInSandboxParams) {
-    const { func_code, method } = anyApi;
-
-    return new Promise((resolve, reject) => {
-      const logger = this.getPrefixContextLogger(`[AnyApiSandboxService][method=${method}]`);
-      // 创建一个沙盒上下文
-      const proc = process;
-      const newContext = {
-        sandbox: {
-          allParams,
-          logger,
-          moment,
-          axios,
-          nodemailer,
-          _,
-          userSession: this.ctx.userSession,
-          ctx: this.ctx,
-          curdMixService: this.curdMixService,
-          redisService: this.redisService,
-          publicOSSService: this.getPublicOSSService(),
-          privateOSSService: this.getPrivateOSSService(),
-          returnSuccess: resolve,
-          returnError: reject,
-          processInfo: {
-            version: proc.version,
-            versions: proc.versions,
-            env: process.env,
-            argv: process.argv,
-            cwd: process.cwd(),
-          },
-        },
-        console: logger,
-        JSON: JSON,
-      };
-
-      const nextLine100 = new Array(10).fill('\n').join('');
-      const bindCode = this.toBindCodeString('httpController', newContext, 'sandbox');
-      const code = `
-      (async () => {
-        ${nextLine100}${func_code}; // 必须有一个 class HttpController { async handleRequest(params){} }
-        ${nextLine100}
-        try {
-          const httpController = new HttpController();
-          ${bindCode}
-          const res = await httpController.handleRequest(sandbox.allParams.params);
-          sandbox.returnSuccess(res);
-        } catch (e) {
-          sandbox.returnError(e)
-        }
-      })(); `;
-
-      try {
-        const script = getCompiledScript(anyApi, code);
-        script.runInNewContext(newContext, {
-          filename: 'method',
-          timeout: anyApi.timeout_ms || 1000 * 60 * 5,
-        });
-      } catch (e) {
-        reject(e);
-      }
-    });
-  }
-
-  private toBindCodeString(toName: string, newContext: any, fromName: any): string {
-    const keys = Object.keys(newContext[fromName]);
-    return keys
-      .map(key => {
-        return `${toName}.${key} = ${fromName}.${key};\n`;
-      })
-      .join('');
-  }
-}
+import { Inject, Provide } from '@midwayjs/core';
+import { Context } from '@midwayjs/koa';
+import * as vm from 'node:vm';
+import { LRUCache } from 'lru-cache';
+import { BaseService } from '../base/BaseService';
+import { CurdMixService } from '../curd/CurdMixService';
+import { ISysAnyApiEntity } from '../../models/SystemEntities';
+import axios from 'axios';
+import * as _ from 'lodash';
+import * as moment from 'moment';
+import * as nodemailer from 'nodemailer';
+
+const scriptCacheOptions = {
+  max: 500,
+  ttl: 1000 * 60 * 5,
+  allowStale: false,
+  updateAgeOnGet: true,
+  updateAgeOnHas: true,
+};
+
+const scriptCache = new LRUCache<string, vm.Script>(scriptCacheOptions);
+
+function getCompiledScript(anyApi: ISysAnyApiEntity, code: string): vm.Script {
+  const { id, func_code_md5 } = anyApi;
+  const cacheKey = id + '_' + func_code_md5;
+  const oldScript = scriptCache.get(cacheKey);
+  if (oldScript) {
+    return oldScript;
+  }
+  const script = new vm.Script(code);
+  scriptCache.set(cacheKey, script);
+  return script;
+}
+
+export interface IRunInSandboxParams {
+  body: any;
+  query: any;
+  headers: any;
+  params?: any;
+}
+
+@Provide()
+export class AnyApiSandboxService extends BaseService {
+  @Inject()
+  protected ctx: Context;
+
+  @Inject()
+  private curdMixService: CurdMixService;
+
+  public async runInSandbox(anyApi: ISysAnyApiEntity, allParams: IRunInSandboxParams) {
+    const { func_code, method } = anyApi;
+
+    return new Promise((resolve, reject) => {
+      const logger = this.getPrefixContextLogger(`[AnyApiSandboxService][method=${method}]`);
+      // 创建一个沙盒上下文
+      const proc = process;
+      const newContext = {
+        sandbox: {
+          allParams,
+          logger,
+          moment,
+          axios,
+          nodemailer,
+          _,
+          userSession: this.ctx.userSession,
+          ctx: this.ctx,
+          curdMixService: this.curdMixService,
+          redisService: this.redisService,
+          publicOSSService: this.getPublicOSSService(),
+          privateOSSService: this.getPrivateOSSService(),
+          returnSuccess: resolve,
+          returnError: reject,
+          processInfo: {
+            version: proc.version,
+            versions: proc.versions,
+            env: process.env,
+            argv: process.argv,
+            cwd: process.cwd(),
+          },
+        },
+        console: logger,
+        JSON: JSON,
+      };
+
+      const nextLine100 = new Array(10).fill('\n').join('');
+      const bindCode = this.toBindCodeString('httpController', newContext, 'sandbox');
+      const code = `
+      (async () => {
+        ${nextLine100}${func_code}; // 必须有一个 class HttpController { async handleRequest(params){} }
+        ${nextLine100}
+        try {
+          const httpController = new HttpController();
+          ${bindCode}
+          const res = await httpController.handleRequest(sandbox.allParams.params);
+          sandbox.returnSuccess(res);
+        } catch (e) {
+          sandbox.returnError(e)
+        }
+      })(); `;
+
+      try {
+        const script = getCompiledScript(anyApi, code);
+        script.runInNewContext(newContext, {
+          filename: 'method',
+          timeout: anyApi.timeout_ms || 1000 * 60 * 5,
+        });
+      } catch (e) {
+        reject(e);
+      }
+    });
+  }
+
+  private toBindCodeString(toName: string, newContext: any, fromName: any): string {
+    const keys = Object.keys(newContext[fromName]);
+    return keys
+      .map(key => {
+        return `${toName}.${key} = ${fromName}.${key};\n`;
+      })
+      .join('');
+  }
+}