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

package/dist/service/WorkbenchService.d.ts

@@ -1,20 +1,59 @@
-import { Context } from '@midwayjs/koa';
-import { BaseService } from './base/BaseService';
-import { IWorkbenchEntity } from '../models/SystemEntities';
-import { IScheduleService } from '../interface';
-export declare class WorkbenchService extends BaseService implements IScheduleService {
-    ctx: Context;
-    private curdProService;
-    clearCache(): void;
-    runBySchedule(): Promise<void>;
-    getAllWorkbenchInfoList(isForceRefresh?: boolean): Promise<IWorkbenchEntity[]>;
-    getAllWorkbenchInfoMap(isForceRefresh?: boolean): Promise<Record<any, IWorkbenchEntity>>;
-    isMatchWorkbenchCode(workbench_code_array: string | string[], workbench_code: string): boolean;
-    /**
-     * 获取当前请求的域名所对应的站点信息
-     */
-    getCurrentHostWorkbenchInfo(): Promise<IWorkbenchEntity>;
-    private getCurrentHost;
-    isSupportCurrentWorkbench(workbench_code_array: string | string[]): Promise<boolean>;
-    isSupportCurrentHostForForMiddleware(): Promise<string | boolean>;
-}
+import { Context } from '@midwayjs/koa';
+import { BaseService } from './base/BaseService';
+import { IWorkbenchEntity } from '../models/SystemEntities';
+import { IScheduleService } from '../interface';
+export declare class WorkbenchService extends BaseService implements IScheduleService {
+    ctx: Context;
+    private curdProService;
+    private cacheServiceFactory;
+    private fatcmsTargetWorkbenchCode;
+    clearCache(): Promise<void>;
+    runBySchedule(): Promise<void>;
+    private getWorkbenchCachedObj;
+    /**
+     * 获取所有站点列表
+     * @returns
+     */
+    getAllWorkbenchInfoList(): Promise<IWorkbenchEntity[]>;
+    /**
+     * 获取所有站点列表，以map的形式返回。其中key为站点域名，value为站点信息
+     * @returns
+     */
+    getAllWorkbenchInfoMap(): Promise<Record<string, IWorkbenchEntity>>;
+    /**
+     * 检查站点编码是否匹配
+     * @param workbench_code_array 站点编码数组
+     * @param workbench_code 站点编码
+     * @returns
+     */
+    isMatchWorkbenchCode(workbench_code_array: string | string[], workbench_code: string): boolean;
+    /**
+     * 根据站点编码获取站点信息
+     * @param workbenchCode 站点编码
+     * @returns
+     */
+    private getWorkbenchInfoByCode;
+    /**
+     * 根据域名获取站点信息
+     * @param host 域名
+     * @returns
+     */
+    private getWorkbenchInfoByHost;
+    /**
+     * 获取当前请求的域名所对应的站点信息
+     */
+    getCurrentHostWorkbenchInfo(): Promise<IWorkbenchEntity>;
+    /**
+     * 获取当前请求的域名
+     * @returns
+     */
+    private getCurrentHost;
+    isSupportCurrentWorkbench(workbench_code_array: string | string[]): Promise<boolean>;
+    isSupportCurrentHostForForMiddleware(): Promise<string | boolean>;
+    /**
+     * 根据站点，配置接口报名单模式
+     * @param workbenchInfo
+     * @param path
+     */
+    isSupportTheNodePathByWorkbenchInfo(workbenchInfo: IWorkbenchEntity, path: string): boolean;
+}

package/dist/service/WorkbenchService.js

@@ -1,155 +1,249 @@
-"use strict";
-var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
-    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
-    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
-    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
-    return c > 3 && r && Object.defineProperty(target, key, r), r;
-};
-var __metadata = (this && this.__metadata) || function (k, v) {
-    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.WorkbenchService = void 0;
-const core_1 = require("@midwayjs/core");
-const keys_1 = require("../libs/crud-pro/models/keys");
-const SystemTables_1 = require("../models/SystemTables");
-const BaseService_1 = require("./base/BaseService");
-// import { LRUCache } from 'lru-cache';
-const CurdProService_1 = require("./curd/CurdProService");
-const exceptions_1 = require("../libs/crud-pro/exceptions");
-const functions_1 = require("../libs/utils/functions");
-const fatcms_request_1 = require("../libs/utils/fatcms-request");
-const MixinUtils_1 = require("../libs/crud-pro/utils/MixinUtils");
-const global_config_1 = require("../libs/global-config/global-config");
-//
-// const lruCache = new LRUCache<string, any>({
-//   max: 500,
-//   ttl: 1000 * 60 * 60,
-//   ttlAutopurge: true,
-// });
-const lruCache = new Map();
-const CACHE_KEY_WORKBENCH_LIST = 'CACHE_KEY_WORKBENCH_LIST';
-const CACHE_KEY_DOMAIN_MAP = 'CACHE_KEY_DOMAIN_MAP';
-let WorkbenchService = class WorkbenchService extends BaseService_1.BaseService {
-    clearCache() {
-        lruCache.set(CACHE_KEY_WORKBENCH_LIST, null);
-        lruCache.set(CACHE_KEY_DOMAIN_MAP, null);
-    }
-    async runBySchedule() {
-        await this.getAllWorkbenchInfoMap(true);
-    }
-    async getAllWorkbenchInfoList(isForceRefresh) {
-        const { SystemDbName, SystemDbType } = global_config_1.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_1.SystemTables.sys_workbench,
-                sqlSimpleName: keys_1.KeysOfSimpleSQL.SIMPLE_QUERY,
-                sqlDatabase: SystemDbName,
-                sqlDdType: SystemDbType,
-            });
-            listData = res.getResRows();
-            lruCache.set(CACHE_KEY_WORKBENCH_LIST, listData);
-        }
-        return listData;
-    }
-    async getAllWorkbenchInfoMap(isForceRefresh) {
-        let listData;
-        let domainMap = lruCache.get(CACHE_KEY_DOMAIN_MAP);
-        if (!domainMap || isForceRefresh === true) {
-            listData = await this.getAllWorkbenchInfoList(isForceRefresh);
-            const domainMap1 = MixinUtils_1.MixinUtils.toMap(listData, (e) => e.workbench_domain); // 主域名。其他两个域名。
-            const domainMap2 = MixinUtils_1.MixinUtils.toMap(listData, (e) => e.workbench_domain2);
-            const domainMap3 = MixinUtils_1.MixinUtils.toMap(listData, (e) => e.workbench_domain3);
-            domainMap = { ...domainMap1, ...domainMap2, ...domainMap3 };
-            lruCache.set(CACHE_KEY_DOMAIN_MAP, domainMap);
-        }
-        return domainMap;
-    }
-    isMatchWorkbenchCode(workbench_code_array, workbench_code) {
-        if (workbench_code_array === '*') {
-            return true;
-        }
-        const supportWorkbenchArray = (0, functions_1.parseJsonObject)(workbench_code_array)
-            .map(s => s.trim())
-            .filter(Boolean);
-        return supportWorkbenchArray.includes('*') || supportWorkbenchArray.includes(workbench_code);
-    }
-    /**
-     * 获取当前请求的域名所对应的站点信息
-     */
-    async getCurrentHostWorkbenchInfo() {
-        // 本地调试模式
-        if (this.isEnableDebug() && this.isLocalEnv()) {
-            const debugWorkbenchCode = (0, fatcms_request_1.getDebugWorkbenchCode)(this.ctx);
-            if (!debugWorkbenchCode) {
-                throw new exceptions_1.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];
-    }
-    getCurrentHost() {
-        const host = this.ctx.request.host;
-        if (!host) {
-            throw new exceptions_1.CommonException('GET_CURRENT_HOST_ERROR', '获取当前域名失败');
-        }
-        return host;
-    }
-    async isSupportCurrentWorkbench(workbench_code_array) {
-        // 本地调试模式
-        if (this.isEnableDebug() && this.isLocalEnv()) {
-            return true;
-        }
-        if (!workbench_code_array) {
-            throw new exceptions_1.CommonException('IS_SUPPORT_CURRENT_WORKBENCH', '未配置支持的站点字段');
-        }
-        const workbench = await this.getCurrentHostWorkbenchInfo();
-        if (!workbench) {
-            throw new exceptions_1.CommonException('WORKBENCH_IS_NOT_FOUND', '站点未找到');
-        }
-        const curWorkbenchCode = workbench.workbench_code;
-        return this.isMatchWorkbenchCode(workbench_code_array, curWorkbenchCode);
-    }
-    async isSupportCurrentHostForForMiddleware() {
-        // 本地调试模式
-        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;
-    }
-};
-__decorate([
-    (0, core_1.Inject)(),
-    __metadata("design:type", Object)
-], WorkbenchService.prototype, "ctx", void 0);
-__decorate([
-    (0, core_1.Inject)(),
-    __metadata("design:type", CurdProService_1.CurdProService)
-], WorkbenchService.prototype, "curdProService", void 0);
-WorkbenchService = __decorate([
-    (0, core_1.Provide)()
-], WorkbenchService);
-exports.WorkbenchService = WorkbenchService;
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WorkbenchService = void 0;
+const core_1 = require("@midwayjs/core");
+const keys_1 = require("../libs/crud-pro/models/keys");
+const SystemTables_1 = require("../models/SystemTables");
+const BaseService_1 = require("./base/BaseService");
+// import { LRUCache } from 'lru-cache';
+const CurdProService_1 = require("./curd/CurdProService");
+const exceptions_1 = require("../libs/crud-pro/exceptions");
+const functions_1 = require("../libs/utils/functions");
+const fatcms_request_1 = require("../libs/utils/fatcms-request");
+const MixinUtils_1 = require("../libs/crud-pro/utils/MixinUtils");
+const global_config_1 = require("../libs/global-config/global-config");
+const AsyncTaskModel_1 = require("../models/AsyncTaskModel");
+const format_url_1 = require("../libs/utils/format-url");
+const CacheServiceFactory_1 = require("../service/base/cache/CacheServiceFactory");
+const bizmodels_1 = require("../models/bizmodels");
+let WorkbenchService = class WorkbenchService extends BaseService_1.BaseService {
+    async clearCache() {
+        await this.cacheServiceFactory.removeItemCache({
+            cacheKey: bizmodels_1.CacheNameEnum.CurdMixByWorkbench,
+            cacheName: bizmodels_1.CacheNameEnum.CurdMixByWorkbench,
+        });
+        await this.cacheServiceFactory.removeItemCache({
+            cacheKey: bizmodels_1.CacheNameEnum.GetWorkbenchCachedObj,
+            cacheName: bizmodels_1.CacheNameEnum.GetWorkbenchCachedObj,
+        });
+    }
+    async runBySchedule() {
+        await this.getWorkbenchCachedObj(true);
+    }
+    async getWorkbenchCachedObj(isForceRefresh) {
+        return this.cacheServiceFactory.getJsonObjectCache({
+            cacheKey: bizmodels_1.CacheNameEnum.GetWorkbenchCachedObj,
+            cacheName: bizmodels_1.CacheNameEnum.GetWorkbenchCachedObj,
+            refreshCache: isForceRefresh,
+            getter: async () => {
+                const { SystemDbName, SystemDbType } = global_config_1.GLOBAL_STATIC_CONFIG.getConfig();
+                const reqJson = { condition: {}, pageSize: 1000, limit: 1000 };
+                const res = await this.curdProService.executeCrudByCfg(reqJson, {
+                    sqlTable: SystemTables_1.SystemTables.sys_workbench,
+                    sqlSimpleName: keys_1.KeysOfSimpleSQL.SIMPLE_QUERY,
+                    sqlDatabase: SystemDbName,
+                    sqlDbType: SystemDbType,
+                });
+                const listData = res.getResRows();
+                const domainMap1 = MixinUtils_1.MixinUtils.toMap(listData, (e) => e.workbench_domain); // 主域名。其他两个域名。
+                const domainMap2 = MixinUtils_1.MixinUtils.toMap(listData, (e) => e.workbench_domain2);
+                const domainMap3 = MixinUtils_1.MixinUtils.toMap(listData, (e) => e.workbench_domain3);
+                const domainMap = { ...domainMap1, ...domainMap2, ...domainMap3 };
+                const cacheObj = {
+                    workbenchList: listData,
+                    workbenchDomainMap: domainMap
+                };
+                return cacheObj;
+            },
+        });
+    }
+    /**
+     * 获取所有站点列表
+     * @returns
+     */
+    async getAllWorkbenchInfoList() {
+        const cachedObj = await this.getWorkbenchCachedObj();
+        return cachedObj.workbenchList;
+    }
+    /**
+     * 获取所有站点列表，以map的形式返回。其中key为站点域名，value为站点信息
+     * @returns
+     */
+    async getAllWorkbenchInfoMap() {
+        const cachedObj = await this.getWorkbenchCachedObj();
+        return cachedObj.workbenchDomainMap;
+    }
+    /**
+     * 检查站点编码是否匹配
+     * @param workbench_code_array 站点编码数组
+     * @param workbench_code 站点编码
+     * @returns
+     */
+    isMatchWorkbenchCode(workbench_code_array, workbench_code) {
+        if (workbench_code_array === '*') {
+            return true;
+        }
+        const supportWorkbenchArray = (0, functions_1.parseJsonObject)(workbench_code_array)
+            .map(s => s.trim())
+            .filter(Boolean);
+        return supportWorkbenchArray.includes('*') || supportWorkbenchArray.includes(workbench_code);
+    }
+    /**
+     * 根据站点编码获取站点信息
+     * @param workbenchCode 站点编码
+     * @returns
+     */
+    async getWorkbenchInfoByCode(workbenchCode) {
+        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
+     */
+    async getWorkbenchInfoByHost(host) {
+        const domainMap = await this.getAllWorkbenchInfoMap();
+        return domainMap[host];
+    }
+    /**
+     * 获取当前请求的域名所对应的站点信息
+     */
+    async getCurrentHostWorkbenchInfo() {
+        // 本地调试模式
+        if (this.isEnableDebug() && this.isLocalEnv()) {
+            const debugWorkbenchCode = (0, fatcms_request_1.getDebugWorkbenchCode)(this.ctx);
+            if (!debugWorkbenchCode) {
+                throw new exceptions_1.CommonException('本地环境调试时需要使用ModHeader浏览器插件，指定站点编码');
+            }
+            return await this.getWorkbenchInfoByCode(debugWorkbenchCode);
+        }
+        // 内部异步任务，指定了workbench code
+        const asyncTaskWorkbenchCode = this.ctx.headers[AsyncTaskModel_1.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
+     */
+    getCurrentHost() {
+        let host = this.ctx.request.host;
+        if (!host) {
+            throw new exceptions_1.CommonException('GET_CURRENT_HOST_ERROR', '获取当前域名失败');
+        }
+        host = (0, format_url_1.formatHost)(host);
+        return host;
+    }
+    async isSupportCurrentWorkbench(workbench_code_array) {
+        // 本地调试模式
+        if (this.isEnableDebug() && this.isLocalEnv()) {
+            return true;
+        }
+        if (!workbench_code_array) {
+            throw new exceptions_1.CommonException('IS_SUPPORT_CURRENT_WORKBENCH', '未配置支持的站点字段');
+        }
+        const workbench = await this.getCurrentHostWorkbenchInfo();
+        if (!workbench) {
+            throw new exceptions_1.CommonException('WORKBENCH_IS_NOT_FOUND', '站点未找到');
+        }
+        const curWorkbenchCode = workbench.workbench_code;
+        return this.isMatchWorkbenchCode(workbench_code_array, curWorkbenchCode);
+    }
+    async isSupportCurrentHostForForMiddleware() {
+        // 本地调试模式
+        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
+     */
+    isSupportTheNodePathByWorkbenchInfo(workbenchInfo, path) {
+        // 非node api路径，直接返回true
+        if (!path.startsWith('/ns/')) {
+            return true;
+        }
+        const configObj = (0, functions_1.parseJsonObject)(workbenchInfo === null || workbenchInfo === void 0 ? void 0 : 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;
+    }
+};
+__decorate([
+    (0, core_1.Inject)(),
+    __metadata("design:type", Object)
+], WorkbenchService.prototype, "ctx", void 0);
+__decorate([
+    (0, core_1.Inject)(),
+    __metadata("design:type", CurdProService_1.CurdProService)
+], WorkbenchService.prototype, "curdProService", void 0);
+__decorate([
+    (0, core_1.Inject)(),
+    __metadata("design:type", CacheServiceFactory_1.CacheServiceFactory)
+], WorkbenchService.prototype, "cacheServiceFactory", void 0);
+__decorate([
+    (0, core_1.Config)('fatcmsTargetWorkbenchCode'),
+    __metadata("design:type", String)
+], WorkbenchService.prototype, "fatcmsTargetWorkbenchCode", void 0);
+WorkbenchService = __decorate([
+    (0, core_1.Provide)()
+], WorkbenchService);
+exports.WorkbenchService = WorkbenchService;

package/dist/service/anyapi/AnyApiSandboxService.d.ts

@@ -1,15 +1,15 @@
-import { Context } from '@midwayjs/koa';
-import { BaseService } from '../base/BaseService';
-import { ISysAnyApiEntity } from '../../models/SystemEntities';
-export interface IRunInSandboxParams {
-    body: any;
-    query: any;
-    headers: any;
-    params?: any;
-}
-export declare class AnyApiSandboxService extends BaseService {
-    protected ctx: Context;
-    private curdMixService;
-    runInSandbox(anyApi: ISysAnyApiEntity, allParams: IRunInSandboxParams): Promise<unknown>;
-    private toBindCodeString;
-}
+import { Context } from '@midwayjs/koa';
+import { BaseService } from '../base/BaseService';
+import { ISysAnyApiEntity } from '../../models/SystemEntities';
+export interface IRunInSandboxParams {
+    body: any;
+    query: any;
+    headers: any;
+    params?: any;
+}
+export declare class AnyApiSandboxService extends BaseService {
+    protected ctx: Context;
+    private curdMixService;
+    runInSandbox(anyApi: ISysAnyApiEntity, allParams: IRunInSandboxParams): Promise<unknown>;
+    private toBindCodeString;
+}