midway-fatcms 0.0.2 → 0.0.3

package/src/service/WorkbenchService.ts

@@ -1,279 +1,279 @@
-import { Config, Inject, Provide } 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 { CurdProService } from './curd/CurdProService';
-import { CommonException } from '@/libs/crud-pro/exceptions';
-import { parseJsonObject } from '@/libs/utils/functions';
-import { IWorkbenchConfig, 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';
-import { formatHost } from '@/libs/utils/format-url';
-import { CacheServiceFactory } from "@/service/base/cache/CacheServiceFactory";
-import { CacheNameEnum } from "@/models/bizmodels";
-
-
-interface IWorkbenchCachedObj {
-  workbenchList: IWorkbenchEntity[];
-  workbenchDomainMap: Record<string, IWorkbenchEntity>; // key是domain
-}
-
-@Provide()
-export class WorkbenchService extends BaseService implements IScheduleService {
-  @Inject()
-  ctx: Context;
-
-  @Inject()
-  private curdProService: CurdProService;
-
-  @Inject()
-  private cacheServiceFactory: CacheServiceFactory;
-
-  @Config('fatcmsTargetWorkbenchCode')
-  private fatcmsTargetWorkbenchCode: string;
-
-
-  public async clearCache() {
-
-    await this.cacheServiceFactory.removeItemCache({
-      cacheKey: CacheNameEnum.CurdMixByWorkbench,
-      cacheName: CacheNameEnum.CurdMixByWorkbench,
-    });
-
-    await this.cacheServiceFactory.removeItemCache({
-      cacheKey: CacheNameEnum.GetWorkbenchCachedObj,
-      cacheName: CacheNameEnum.GetWorkbenchCachedObj,
-    });
-
-    await this.getWorkbenchCachedObj(true);
-  }
-
-  public async runBySchedule() {
-    await this.getWorkbenchCachedObj(true);
-  }
-
-  private async getWorkbenchCachedObj(isForceRefresh?: boolean): Promise<IWorkbenchCachedObj> {
-    return this.cacheServiceFactory.getJsonObjectCache({
-      cacheKey: CacheNameEnum.GetWorkbenchCachedObj,
-      cacheName: CacheNameEnum.GetWorkbenchCachedObj,
-      refreshCache: isForceRefresh,
-      getter: async () => {
-        const { SystemDbName, SystemDbType } = GLOBAL_STATIC_CONFIG.getConfig();
-        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,
-        });
-        const listData = res.getResRows();
-
-        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);
-        const domainMap = { ...domainMap1, ...domainMap2, ...domainMap3 };
-        const cacheObj: IWorkbenchCachedObj = {
-          workbenchList: listData,
-          workbenchDomainMap: domainMap
-        }
-        return cacheObj;
-      },
-    });
-  }
-
-  /**
-   * 获取所有站点列表
-   * @returns
-   */
-  public async getAllWorkbenchInfoList(): Promise<IWorkbenchEntity[]> {
-    const cachedObj = await this.getWorkbenchCachedObj();
-    return cachedObj.workbenchList;
-  }
-
-  /**
-   * 获取所有站点列表，以map的形式返回。其中key为站点域名，value为站点信息
-   * @returns
-   */
-  public async getAllWorkbenchInfoMap(): Promise<Record<string, IWorkbenchEntity>> {
-    const cachedObj = await this.getWorkbenchCachedObj();
-    return cachedObj.workbenchDomainMap;
-  }
-
-  /**
-   * 检查站点编码是否匹配
-   * @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 {
-    let host = this.ctx.request.host;
-    if (!host) {
-      throw new CommonException('GET_CURRENT_HOST_ERROR', '获取当前域名失败');
-    }
-
-    host = formatHost(host);
-    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;
-  }
-
-
-  /**
-   * 根据站点，配置接口报名单模式
-   * @param workbenchInfo
-   * @param path
-   */
-  public isSupportTheNodePathByWorkbenchInfo(workbenchInfo: IWorkbenchEntity, path: string): boolean {
-
-    // 非node api路径，直接返回true
-    if (!path.startsWith('/ns/')) {
-      return true;
-    }
-
-    const configObj: IWorkbenchConfig = parseJsonObject(workbenchInfo?.config_content);
-    // 为开启校验开关。开关为true时，才校验。
-    if (!configObj || !configObj.nodeApiWhiteEnable) {
-      return true;
-    }
-    let isOkByList = false;
-    const { nodeApiWhiteList, nodeApiWhitePrefix } = configObj;
-    if (Array.isArray(nodeApiWhiteList) && nodeApiWhiteList.length > 0) {
-      isOkByList = nodeApiWhiteList.includes(path);
-    }
-
-    if (isOkByList) {
-      return true;
-    }
-
-    let isOkByPrefix = false;
-    if (Array.isArray(nodeApiWhitePrefix) && nodeApiWhitePrefix.length > 0) {
-      isOkByPrefix = nodeApiWhitePrefix.some((prefix) => path.startsWith(prefix));
-    }
-    return isOkByPrefix;
-
-  }
-
-
-
-
-
-}
+import { Config, Inject, Provide } 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 { CurdProService } from './curd/CurdProService';
+import { CommonException } from '@/libs/crud-pro/exceptions';
+import { parseJsonObject } from '@/libs/utils/functions';
+import { IWorkbenchConfig, 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';
+import { formatHost } from '@/libs/utils/format-url';
+import { CacheServiceFactory } from "@/service/base/cache/CacheServiceFactory";
+import { CacheNameEnum } from "@/models/bizmodels";
+
+
+interface IWorkbenchCachedObj {
+  workbenchList: IWorkbenchEntity[];
+  workbenchDomainMap: Record<string, IWorkbenchEntity>; // key是domain
+}
+
+@Provide()
+export class WorkbenchService extends BaseService implements IScheduleService {
+  @Inject()
+  ctx: Context;
+
+  @Inject()
+  private curdProService: CurdProService;
+
+  @Inject()
+  private cacheServiceFactory: CacheServiceFactory;
+
+  @Config('fatcmsTargetWorkbenchCode')
+  private fatcmsTargetWorkbenchCode: string;
+
+
+  public async clearCache() {
+
+    await this.cacheServiceFactory.removeItemCache({
+      cacheKey: CacheNameEnum.CurdMixByWorkbench,
+      cacheName: CacheNameEnum.CurdMixByWorkbench,
+    });
+
+    await this.cacheServiceFactory.removeItemCache({
+      cacheKey: CacheNameEnum.GetWorkbenchCachedObj,
+      cacheName: CacheNameEnum.GetWorkbenchCachedObj,
+    });
+
+    await this.getWorkbenchCachedObj(true);
+  }
+
+  public async runBySchedule() {
+    await this.getWorkbenchCachedObj(true);
+  }
+
+  private async getWorkbenchCachedObj(isForceRefresh?: boolean): Promise<IWorkbenchCachedObj> {
+    return this.cacheServiceFactory.getJsonObjectCache({
+      cacheKey: CacheNameEnum.GetWorkbenchCachedObj,
+      cacheName: CacheNameEnum.GetWorkbenchCachedObj,
+      refreshCache: isForceRefresh,
+      getter: async () => {
+        const { SystemDbName, SystemDbType } = GLOBAL_STATIC_CONFIG.getConfig();
+        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,
+        });
+        const listData = res.getResRows();
+
+        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);
+        const domainMap = { ...domainMap1, ...domainMap2, ...domainMap3 };
+        const cacheObj: IWorkbenchCachedObj = {
+          workbenchList: listData,
+          workbenchDomainMap: domainMap
+        }
+        return cacheObj;
+      },
+    });
+  }
+
+  /**
+   * 获取所有站点列表
+   * @returns
+   */
+  public async getAllWorkbenchInfoList(): Promise<IWorkbenchEntity[]> {
+    const cachedObj = await this.getWorkbenchCachedObj();
+    return cachedObj.workbenchList;
+  }
+
+  /**
+   * 获取所有站点列表，以map的形式返回。其中key为站点域名，value为站点信息
+   * @returns
+   */
+  public async getAllWorkbenchInfoMap(): Promise<Record<string, IWorkbenchEntity>> {
+    const cachedObj = await this.getWorkbenchCachedObj();
+    return cachedObj.workbenchDomainMap;
+  }
+
+  /**
+   * 检查站点编码是否匹配
+   * @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 {
+    let host = this.ctx.request.host;
+    if (!host) {
+      throw new CommonException('GET_CURRENT_HOST_ERROR', '获取当前域名失败');
+    }
+
+    host = formatHost(host);
+    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;
+  }
+
+
+  /**
+   * 根据站点，配置接口报名单模式
+   * @param workbenchInfo
+   * @param path
+   */
+  public isSupportTheNodePathByWorkbenchInfo(workbenchInfo: IWorkbenchEntity, path: string): boolean {
+
+    // 非node api路径，直接返回true
+    if (!path.startsWith('/ns/')) {
+      return true;
+    }
+
+    const configObj: IWorkbenchConfig = parseJsonObject(workbenchInfo?.config_content);
+    // 为开启校验开关。开关为true时，才校验。
+    if (!configObj || !configObj.nodeApiWhiteEnable) {
+      return true;
+    }
+    let isOkByList = false;
+    const { nodeApiWhiteList, nodeApiWhitePrefix } = configObj;
+    if (Array.isArray(nodeApiWhiteList) && nodeApiWhiteList.length > 0) {
+      isOkByList = nodeApiWhiteList.includes(path);
+    }
+
+    if (isOkByList) {
+      return true;
+    }
+
+    let isOkByPrefix = false;
+    if (Array.isArray(nodeApiWhitePrefix) && nodeApiWhitePrefix.length > 0) {
+      isOkByPrefix = nodeApiWhitePrefix.some((prefix) => path.startsWith(prefix));
+    }
+    return isOkByPrefix;
+
+  }
+
+
+
+
+
+}

package/src/service/base/BaseService.ts

@@ -112,6 +112,11 @@ export class BaseService {
     this.getContextLogger().debug(msg, ...args);
   }
 
+  protected isProdEnv(): boolean {
+    const env = this.ctx.app.env;
+    return env === 'prod' || env === 'production';
+  }
+
   protected isLocalEnv(): boolean {
     return isLocalEnv(this.ctx);
   }