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

package/dist/middleware/permission.middleware.js

@@ -1,74 +1,74 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.checkRole = exports.checkLogin = exports.checkPermission = void 0;
-const exceptions_1 = require("../libs/crud-pro/exceptions");
-function checkPermission(codeList) {
-    return async (ctx, next) => {
-        const userSession = ctx.userSession;
-        //  只有登录用户才会有功能点权限，所以必须登录
-        if (!userSession.isLogin()) {
-            return {
-                success: false,
-                message: '用户未登录, 请先登录',
-                code: exceptions_1.Exceptions.NOT_LOGIN,
-            };
-        }
-        // 查询当前用户是否用此功能点的权限
-        const hasPermission = userSession.hasAnyPermission(codeList);
-        if (!hasPermission) {
-            let message;
-            const loginName = userSession.getSessionInfo().loginName;
-            if (loginName === 'devopsviewer') {
-                message = "开放体验账号不支持这些操作：新增、修改、删除、上传";
-            }
-            else {
-                message = '缺少权限: ' + JSON.stringify(codeList);
-            }
-            return {
-                success: false,
-                message: message,
-                code: exceptions_1.Exceptions.NO_AUTH,
-            };
-        }
-        await next();
-    };
-}
-exports.checkPermission = checkPermission;
-function checkRole(codeList) {
-    return async (ctx, next) => {
-        const userSession = ctx.userSession;
-        //  只有登录用户才会有功能点权限，所以必须登录
-        if (!userSession.isLogin()) {
-            return {
-                success: false,
-                message: '用户未登录, 请先登录',
-                code: exceptions_1.Exceptions.NOT_LOGIN,
-            };
-        }
-        // 查询当前用户是否用此功能点的权限
-        const hasRole = userSession.hasAnyRole(codeList);
-        if (!hasRole) {
-            return {
-                success: false,
-                message: '缺少角色权限: ' + JSON.stringify(codeList),
-                code: exceptions_1.Exceptions.NO_AUTH,
-            };
-        }
-        await next();
-    };
-}
-exports.checkRole = checkRole;
-function checkLogin() {
-    return async (ctx, next) => {
-        const userSession = ctx.userSession;
-        if (!userSession.isLogin()) {
-            return {
-                success: false,
-                message: '用户未登录, 请先登录',
-                code: exceptions_1.Exceptions.NOT_LOGIN,
-            };
-        }
-        await next();
-    };
-}
-exports.checkLogin = checkLogin;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.checkRole = exports.checkLogin = exports.checkPermission = void 0;
+const exceptions_1 = require("../libs/crud-pro/exceptions");
+function checkPermission(codeList) {
+    return async (ctx, next) => {
+        const userSession = ctx.userSession;
+        //  只有登录用户才会有功能点权限，所以必须登录
+        if (!userSession.isLogin()) {
+            return {
+                success: false,
+                message: '用户未登录, 请先登录',
+                code: exceptions_1.Exceptions.NOT_LOGIN,
+            };
+        }
+        // 查询当前用户是否用此功能点的权限
+        const hasPermission = userSession.hasAnyPermission(codeList);
+        if (!hasPermission) {
+            let message;
+            const loginName = userSession.getSessionInfo().loginName;
+            if (loginName === 'devopsviewer') {
+                message = '开放体验账号不支持这些操作：新增、修改、删除、上传';
+            }
+            else {
+                message = '缺少权限: ' + JSON.stringify(codeList);
+            }
+            return {
+                success: false,
+                message: message,
+                code: exceptions_1.Exceptions.NO_AUTH,
+            };
+        }
+        await next();
+    };
+}
+exports.checkPermission = checkPermission;
+function checkRole(codeList) {
+    return async (ctx, next) => {
+        const userSession = ctx.userSession;
+        //  只有登录用户才会有功能点权限，所以必须登录
+        if (!userSession.isLogin()) {
+            return {
+                success: false,
+                message: '用户未登录, 请先登录',
+                code: exceptions_1.Exceptions.NOT_LOGIN,
+            };
+        }
+        // 查询当前用户是否用此功能点的权限
+        const hasRole = userSession.hasAnyRole(codeList);
+        if (!hasRole) {
+            return {
+                success: false,
+                message: '缺少角色权限: ' + JSON.stringify(codeList),
+                code: exceptions_1.Exceptions.NO_AUTH,
+            };
+        }
+        await next();
+    };
+}
+exports.checkRole = checkRole;
+function checkLogin() {
+    return async (ctx, next) => {
+        const userSession = ctx.userSession;
+        if (!userSession.isLogin()) {
+            return {
+                success: false,
+                message: '用户未登录, 请先登录',
+                code: exceptions_1.Exceptions.NOT_LOGIN,
+            };
+        }
+        await next();
+    };
+}
+exports.checkLogin = checkLogin;

package/dist/middleware/rediscache.middleware.d.ts

@@ -0,0 +1,3 @@
+import { NextFunction, Context } from '@midwayjs/koa';
+declare function redisCache(cacheKeyConfigList: string[], cacheTimeSecond: number): (ctx: Context, next: NextFunction) => Promise<any>;
+export { redisCache };

package/dist/middleware/rediscache.middleware.js

@@ -0,0 +1,77 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.redisCache = void 0;
+const redis_1 = require("@midwayjs/redis");
+const _ = require("lodash");
+const md5 = require("md5");
+const RedisKeys_1 = require("../models/RedisKeys");
+const exceptions_1 = require("../libs/crud-pro/exceptions");
+const getRedisService = async (ctx) => {
+    const service = await ctx.requestContext.getAsync(redis_1.RedisService);
+    if (!service) {
+        return await ctx.requestContext.getAsync('redisService');
+    }
+};
+const createError = () => {
+    return new exceptions_1.CommonException('redis_cache_middleware_error_config', 'redisCache中间件的第一个参数必须是一个字符串数组, 并且以“query.”或“body.”开头');
+};
+const checkCacheKeyConfigList = (cacheKeyConfigList) => {
+    if (!Array.isArray(cacheKeyConfigList)) {
+        throw createError();
+    }
+    for (let i = 0; i < cacheKeyConfigList.length; i++) {
+        const cacheKeyConfig = cacheKeyConfigList[i];
+        if (typeof cacheKeyConfig !== 'string') {
+            throw createError();
+        }
+        if (!cacheKeyConfig.startsWith('query.') && !cacheKeyConfig.startsWith('body.')) {
+            throw createError();
+        }
+    }
+};
+// {middleware:[redisCache(['query.id'， 'body.id'])]}
+const toCacheKey = (ctx, cacheKeyConfigList) => {
+    checkCacheKeyConfigList(cacheKeyConfigList);
+    const path = ctx.path;
+    const query = ctx.query || {};
+    const body = ctx.request.body || {};
+    const newCtx = { path, query, body };
+    // 至少要根据path缓存
+    const cacheKeyConfigList2 = ['path', ...cacheKeyConfigList];
+    const strArray = cacheKeyConfigList2.map((key) => {
+        const value = _.get(newCtx, key);
+        return { key, value };
+    });
+    const strArrayStr = JSON.stringify(strArray);
+    const strMd5 = md5(strArrayStr);
+    return RedisKeys_1.RedisKeys.REDIS_LOCK_MIDDILEWARE + strMd5;
+};
+function toCacheDataString(resData) {
+    throw new Error('Function not implemented.');
+}
+function parseCacheData(cacheData) {
+    throw new Error('Function not implemented.');
+}
+function redisCache(cacheKeyConfigList, cacheTimeSecond) {
+    return async (ctx, next) => {
+        const redisService = await getRedisService(ctx);
+        const cacheKey = toCacheKey(ctx, cacheKeyConfigList);
+        let cacheTime = typeof cacheTimeSecond === 'number' ? cacheTimeSecond : 60; // 默认缓存1分钟
+        cacheTime = Math.max(cacheTimeSecond, 1); // 至少缓存1秒。
+        cacheTime = Math.min(cacheTimeSecond, 60 * 60); // 最长缓存1小时
+        const cacheData = await redisService.get(cacheKey);
+        if (cacheData) {
+            return parseCacheData(cacheData);
+        }
+        try {
+            const resData = await next();
+            const resDataStr = toCacheDataString(resData);
+            await redisService.set(cacheKey, resDataStr, 'EX', cacheTime);
+            return resData;
+        }
+        catch (e) {
+            console.error('redisCache', e);
+        }
+    };
+}
+exports.redisCache = redisCache;

package/dist/middleware/redislock.middleware.d.ts

@@ -0,0 +1,7 @@
+import { NextFunction, Context } from '@midwayjs/koa';
+declare function redisLock(lockKeyConfigList: string[], lockTimeSecond: number): (ctx: Context, next: NextFunction) => Promise<{
+    success: boolean;
+    message: string;
+    code: string;
+}>;
+export { redisLock };

package/dist/middleware/redislock.middleware.js

@@ -0,0 +1,72 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.redisLock = void 0;
+const redis_1 = require("@midwayjs/redis");
+const _ = require("lodash");
+const md5 = require("md5");
+const RedisKeys_1 = require("../models/RedisKeys");
+const exceptions_1 = require("../libs/crud-pro/exceptions");
+const getRedisService = async (ctx) => {
+    const service = await ctx.requestContext.getAsync(redis_1.RedisService);
+    if (!service) {
+        return await ctx.requestContext.getAsync('redisService');
+    }
+};
+const createError = () => {
+    return new exceptions_1.CommonException('redis_lock_middleware_error_config', 'redisLock中间件的第一个参数必须是一个字符串数组, 并且以“query.”或“body.”开头');
+};
+const checkLockKeyConfigList = (lockKeyConfigList) => {
+    if (!Array.isArray(lockKeyConfigList)) {
+        throw createError();
+    }
+    for (let i = 0; i < lockKeyConfigList.length; i++) {
+        const lockKeyConfig = lockKeyConfigList[i];
+        if (typeof lockKeyConfig !== 'string') {
+            throw createError();
+        }
+        if (!lockKeyConfig.startsWith('query.') && !lockKeyConfig.startsWith('body.')) {
+            throw createError();
+        }
+    }
+};
+// {middleware:[redisLock(['query.id'， 'body.id'])]}
+const toLockKey = (ctx, lockKeyConfigList) => {
+    checkLockKeyConfigList(lockKeyConfigList);
+    const path = ctx.path;
+    const query = ctx.query || {};
+    const body = ctx.request.body || {};
+    const newCtx = { path, query, body };
+    // 至少要根据path锁
+    const lockKeyConfigList2 = ['path', ...lockKeyConfigList];
+    const strArray = lockKeyConfigList2.map((key) => {
+        const value = _.get(newCtx, key);
+        return { key, value };
+    });
+    const strArrayStr = JSON.stringify(strArray);
+    const strMd5 = md5(strArrayStr);
+    return RedisKeys_1.RedisKeys.REDIS_LOCK_MIDDILEWARE + strMd5;
+};
+function redisLock(lockKeyConfigList, lockTimeSecond) {
+    return async (ctx, next) => {
+        const redisService = await getRedisService(ctx);
+        const lockKey = toLockKey(ctx, lockKeyConfigList);
+        let lockTime = typeof lockTimeSecond === 'number' ? lockTimeSecond : 60; // 默认锁住1分钟（失败的情况）
+        lockTime = Math.max(lockTimeSecond, 1); // 至少锁一秒 （失败的情况）
+        lockTime = Math.min(lockTimeSecond, 5 * 60); // 最长锁 5分钟（失败的情况）
+        const lock = await redisService.set(lockKey, 1, 'EX', lockTime, 'NX');
+        if (lock !== 'OK') {
+            return {
+                success: false,
+                message: '您请求的接口当前正在处理中，请稍后再试',
+                code: 'redis_lock_middleware_error_locked',
+            };
+        }
+        try {
+            await next();
+        }
+        finally {
+            await redisService.del(lockKey); // 正常运行完成，立即释放锁。
+        }
+    };
+}
+exports.redisLock = redisLock;

package/dist/middleware/tx.middleware.d.ts

@@ -1,9 +1,9 @@
-import { IMiddleware } from '@midwayjs/core';
-import { NextFunction, Context } from '@midwayjs/koa';
-/**
- * 事务中间件
- */
-export declare class TxMiddleware implements IMiddleware<Context, NextFunction> {
-    resolve(): (ctx: Context, next: NextFunction) => Promise<any>;
-    static getName(): string;
-}
+import { IMiddleware } from '@midwayjs/core';
+import { NextFunction, Context } from '@midwayjs/koa';
+/**
+ * 事务中间件
+ */
+export declare class TxMiddleware implements IMiddleware<Context, NextFunction> {
+    resolve(): (ctx: Context, next: NextFunction) => Promise<any>;
+    static getName(): string;
+}

package/dist/middleware/tx.middleware.js

@@ -1,40 +1,40 @@
-"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;
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.TxMiddleware = void 0;
-const core_1 = require("@midwayjs/core");
-/**
- * 事务中间件
- */
-let TxMiddleware = class TxMiddleware {
-    resolve() {
-        return async (ctx, next) => {
-            const transaction = ctx.transaction;
-            try {
-                await transaction.beginTx();
-                const res = await next();
-                await transaction.commitTx();
-                return res;
-            }
-            catch (e) {
-                ctx.contextLogger.error('ReportMiddleware', e);
-                await transaction.rollbackTx();
-            }
-            finally {
-                await transaction.releaseTx();
-            }
-        };
-    }
-    static getName() {
-        return 'TxMiddleware';
-    }
-};
-TxMiddleware = __decorate([
-    (0, core_1.Middleware)()
-], TxMiddleware);
-exports.TxMiddleware = TxMiddleware;
+"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;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TxMiddleware = void 0;
+const core_1 = require("@midwayjs/core");
+/**
+ * 事务中间件
+ */
+let TxMiddleware = class TxMiddleware {
+    resolve() {
+        return async (ctx, next) => {
+            const transaction = ctx.transaction;
+            try {
+                await transaction.beginTx();
+                const res = await next();
+                await transaction.commitTx();
+                return res;
+            }
+            catch (e) {
+                ctx.contextLogger.error('ReportMiddleware', e);
+                await transaction.rollbackTx();
+            }
+            finally {
+                await transaction.releaseTx();
+            }
+        };
+    }
+    static getName() {
+        return 'TxMiddleware';
+    }
+};
+TxMiddleware = __decorate([
+    (0, core_1.Middleware)()
+], TxMiddleware);
+exports.TxMiddleware = TxMiddleware;

package/dist/models/AsyncTaskModel.d.ts

@@ -0,0 +1,74 @@
+export interface SysAsyncTaskEntity {
+    id: number;
+    task_uuid: string;
+    task_name: string;
+    task_description: string | null;
+    task_type: string;
+    task_status: SysAsyncTaskStatus;
+    input_params: any;
+    output_result: any | null;
+    input_file_path: string | null;
+    input_file_format: SysAsyncFileFormat | null;
+    input_file_size: number | null;
+    output_file_path: string | null;
+    output_file_format: SysAsyncFileFormat | null;
+    output_file_size: number | null;
+    input_total_records: number | null;
+    output_total_records: number | null;
+    processed_records: number;
+    progress: number;
+    error_message: string | null;
+    error_records: any | null;
+    created_by: string | null;
+    priority: number;
+    retry_count: number;
+    max_retries: number;
+    parent_task_id: number | null;
+    created_at: Date | string | null;
+    started_at: Date | string | null;
+    updated_at: Date | string | null;
+    expired_at: Date | string | null;
+    completed_at: Date | string | null;
+    created_user_session: string;
+}
+export declare type SysAsyncTaskPartial = Partial<SysAsyncTaskEntity>;
+export declare enum SysAsyncTaskStatus {
+    PENDING = "PENDING",
+    RUNNING = "RUNNING",
+    SUCCEEDED = "SUCCEEDED",
+    PART_SUCCEEDED = "PART_SUCCEEDED",
+    FAILED = "FAILED",
+    CANCELLED = "CANCELLED",
+    PAUSED = "PAUSED"
+}
+/**
+ * 导出的文件名后缀
+ */
+export declare enum SysAsyncFileFormat {
+    XLSX = "xlsx",
+    CSV = "csv",
+    JSON = "json",
+    PDF = "pdf",
+    TXT = "txt",
+    XML = "xml",
+    ZIP = "zip",
+    HTML = "html",
+    PNG = "png",
+    JPG = "jpg"
+}
+export interface ISysAsyncTaskHandler {
+    execute(asyncTaskContext: SysAsyncTaskContext): Promise<void>;
+}
+export interface SysAsyncTaskContext {
+    task: SysAsyncTaskEntity;
+    updateTaskStatus: (sysAsyncTaskPartial: SysAsyncTaskPartial) => any;
+}
+export interface SysAsyncTaskHandlerConfig {
+    taskType: string;
+    handler: ISysAsyncTaskHandler;
+    maxRetries?: number;
+    priority?: number;
+    expireSeconds?: number;
+}
+export declare const HEADER_KEY_RUN_BY_ASYNC_TASK_ID = "run-by-async-task-id";
+export declare const HEADER_KEY_RUN_BY_ASYNC_TASK_WORKBENCH_CODE = "run-by-async-task-workbenchcode";

package/dist/models/AsyncTaskModel.js

@@ -0,0 +1,31 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HEADER_KEY_RUN_BY_ASYNC_TASK_WORKBENCH_CODE = exports.HEADER_KEY_RUN_BY_ASYNC_TASK_ID = exports.SysAsyncFileFormat = exports.SysAsyncTaskStatus = void 0;
+var SysAsyncTaskStatus;
+(function (SysAsyncTaskStatus) {
+    SysAsyncTaskStatus["PENDING"] = "PENDING";
+    SysAsyncTaskStatus["RUNNING"] = "RUNNING";
+    SysAsyncTaskStatus["SUCCEEDED"] = "SUCCEEDED";
+    SysAsyncTaskStatus["PART_SUCCEEDED"] = "PART_SUCCEEDED";
+    SysAsyncTaskStatus["FAILED"] = "FAILED";
+    SysAsyncTaskStatus["CANCELLED"] = "CANCELLED";
+    SysAsyncTaskStatus["PAUSED"] = "PAUSED";
+})(SysAsyncTaskStatus = exports.SysAsyncTaskStatus || (exports.SysAsyncTaskStatus = {}));
+/**
+ * 导出的文件名后缀
+ */
+var SysAsyncFileFormat;
+(function (SysAsyncFileFormat) {
+    SysAsyncFileFormat["XLSX"] = "xlsx";
+    SysAsyncFileFormat["CSV"] = "csv";
+    SysAsyncFileFormat["JSON"] = "json";
+    SysAsyncFileFormat["PDF"] = "pdf";
+    SysAsyncFileFormat["TXT"] = "txt";
+    SysAsyncFileFormat["XML"] = "xml";
+    SysAsyncFileFormat["ZIP"] = "zip";
+    SysAsyncFileFormat["HTML"] = "html";
+    SysAsyncFileFormat["PNG"] = "png";
+    SysAsyncFileFormat["JPG"] = "jpg";
+})(SysAsyncFileFormat = exports.SysAsyncFileFormat || (exports.SysAsyncFileFormat = {}));
+exports.HEADER_KEY_RUN_BY_ASYNC_TASK_ID = 'run-by-async-task-id';
+exports.HEADER_KEY_RUN_BY_ASYNC_TASK_WORKBENCH_CODE = 'run-by-async-task-workbenchcode';

package/dist/models/RedisKeys.d.ts

@@ -0,0 +1,15 @@
+declare const RedisKeys: {
+    ASYNC_TASK_LOCK: string;
+    ASYNC_TASK_TIMEOUT_LOCK: string;
+    ASYNC_TASK_UPDATE_TIME: string;
+    USER_SESSION_PREFIX: string;
+    USER_SESSION_ASYNC_TASK_ID_PREFIX: string;
+    USER_ACTION_TIME_LIMIT_PREFIX: string;
+    VISIT_STAT_LOCK_PREFIX: string;
+    VISIT_STAT_DATE_PREFIX: string;
+    LINK_TO_CUSTOM_PREFIX: string;
+    CURD_MIX_BY_DICT_PREFIX: string;
+    QUERY_ENUM_INFO_PREFIX: string;
+    REDIS_LOCK_MIDDILEWARE: string;
+};
+export { RedisKeys };

package/dist/models/RedisKeys.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RedisKeys = void 0;
+const RedisKeys = {
+    ASYNC_TASK_LOCK: 'FatAsyncTaskLock',
+    ASYNC_TASK_TIMEOUT_LOCK: 'FatAsyncTaskTimeoutLock',
+    ASYNC_TASK_UPDATE_TIME: 'FatAsyncTaskUpdateTime',
+    USER_SESSION_PREFIX: 'FatUserSession_',
+    USER_SESSION_ASYNC_TASK_ID_PREFIX: 'FatUserSessionAsyncTaskId_',
+    USER_ACTION_TIME_LIMIT_PREFIX: 'FatUserActionTimeLimit_',
+    VISIT_STAT_LOCK_PREFIX: 'FatVsLock_',
+    VISIT_STAT_DATE_PREFIX: 'FatVsDate_',
+    LINK_TO_CUSTOM_PREFIX: 'FatLinkToCustom@@',
+    CURD_MIX_BY_DICT_PREFIX: 'FatCurdMixByDict@@',
+    QUERY_ENUM_INFO_PREFIX: 'FatQueryEnum@@',
+    REDIS_LOCK_MIDDILEWARE: 'FatRedisLock@@',
+};
+exports.RedisKeys = RedisKeys;