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

package/src/middleware/permission.middleware.ts

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

package/src/middleware/rediscache.middleware.ts

@@ -0,0 +1,91 @@
+import { NextFunction, Context } from '@midwayjs/koa';
+import { RedisService } from '@midwayjs/redis';
+import * as _ from 'lodash';
+import * as md5 from 'md5';
+import { RedisKeys } from '@/models/RedisKeys';
+import { CommonException } from '@/libs/crud-pro/exceptions';
+
+const getRedisService = async (ctx: Context): Promise<RedisService> => {
+  const service = await ctx.requestContext.getAsync(RedisService);
+  if (!service) {
+    return await ctx.requestContext.getAsync('redisService');
+  }
+};
+
+const createError = () => {
+  return new CommonException('redis_cache_middleware_error_config', 'redisCache中间件的第一个参数必须是一个字符串数组, 并且以“query.”或“body.”开头');
+};
+
+const checkCacheKeyConfigList = (cacheKeyConfigList: string[]) => {
+  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: Context, cacheKeyConfigList: string[]): string => {
+  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: string) => {
+    const value = _.get(newCtx, key);
+    return { key, value };
+  });
+  const strArrayStr = JSON.stringify(strArray);
+  const strMd5 = md5(strArrayStr);
+  return RedisKeys.REDIS_LOCK_MIDDILEWARE + strMd5;
+};
+
+function toCacheDataString(resData: any): string {
+  throw new Error('Function not implemented.');
+}
+
+function parseCacheData(cacheData: string): any {
+  throw new Error('Function not implemented.');
+}
+
+function redisCache(cacheKeyConfigList: string[], cacheTimeSecond: number) {
+  return async (ctx: Context, next: NextFunction) => {
+    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);
+    }
+  };
+}
+
+export { redisCache };

package/src/middleware/redislock.middleware.ts

@@ -0,0 +1,83 @@
+import { NextFunction, Context } from '@midwayjs/koa';
+import { RedisService } from '@midwayjs/redis';
+import * as _ from 'lodash';
+import * as md5 from 'md5';
+import { RedisKeys } from '@/models/RedisKeys';
+import { CommonException } from '@/libs/crud-pro/exceptions';
+
+const getRedisService = async (ctx: Context): Promise<RedisService> => {
+  const service = await ctx.requestContext.getAsync(RedisService);
+  if (!service) {
+    return await ctx.requestContext.getAsync('redisService');
+  }
+};
+
+const createError = () => {
+  return new CommonException('redis_lock_middleware_error_config', 'redisLock中间件的第一个参数必须是一个字符串数组, 并且以“query.”或“body.”开头');
+};
+
+const checkLockKeyConfigList = (lockKeyConfigList: string[]) => {
+  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: Context, lockKeyConfigList: string[]): string => {
+  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: string) => {
+    const value = _.get(newCtx, key);
+    return { key, value };
+  });
+  const strArrayStr = JSON.stringify(strArray);
+  const strMd5 = md5(strArrayStr);
+  return RedisKeys.REDIS_LOCK_MIDDILEWARE + strMd5;
+};
+
+function redisLock(lockKeyConfigList: string[], lockTimeSecond: number) {
+  return async (ctx: Context, next: NextFunction) => {
+    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); // 正常运行完成，立即释放锁。
+    }
+  };
+}
+
+export { redisLock };

package/src/middleware/tx.middleware.ts

@@ -1,30 +1,30 @@
-import { Middleware, IMiddleware } from '@midwayjs/core';
-import { NextFunction, Context } from '@midwayjs/koa';
-
-/**
- * 事务中间件
- */
-@Middleware()
-export class TxMiddleware implements IMiddleware<Context, NextFunction> {
-  resolve() {
-    return async (ctx: Context, next: NextFunction) => {
-      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(): string {
-    return 'TxMiddleware';
-  }
-}
+import { Middleware, IMiddleware } from '@midwayjs/core';
+import { NextFunction, Context } from '@midwayjs/koa';
+
+/**
+ * 事务中间件
+ */
+@Middleware()
+export class TxMiddleware implements IMiddleware<Context, NextFunction> {
+  resolve() {
+    return async (ctx: Context, next: NextFunction) => {
+      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(): string {
+    return 'TxMiddleware';
+  }
+}

package/src/models/AsyncTaskModel.ts

@@ -0,0 +1,85 @@
+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 type SysAsyncTaskPartial = Partial<SysAsyncTaskEntity>;
+
+export enum SysAsyncTaskStatus {
+  PENDING = 'PENDING', // 等待中，还未进入排队
+  RUNNING = 'RUNNING', // 运行中
+  SUCCEEDED = 'SUCCEEDED', // 终止状态：全部成功
+  PART_SUCCEEDED = 'PART_SUCCEEDED', // 终止状态：部分成功
+  FAILED = 'FAILED', // 终止状态：失败
+  CANCELLED = 'CANCELLED', // 取消
+  PAUSED = 'PAUSED', // 暂停
+}
+
+/**
+ * 导出的文件名后缀
+ */
+export 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 const HEADER_KEY_RUN_BY_ASYNC_TASK_ID = 'run-by-async-task-id';
+export const HEADER_KEY_RUN_BY_ASYNC_TASK_WORKBENCH_CODE = 'run-by-async-task-workbenchcode';

package/src/models/RedisKeys.ts

@@ -0,0 +1,16 @@
+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@@',
+};
+
+export { RedisKeys };