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

package/src/middleware/global.middleware.ts

@@ -1,278 +1,293 @@
-import { Middleware, IMiddleware } from '@midwayjs/core';
-import { NextFunction, Context } from '@midwayjs/koa';
-import * as _ from 'lodash';
-import { Transaction } from '../libs/crud-pro/models/Transaction';
-import { UserSessionService } from '../service/UserSessionService';
-import { WorkbenchService } from '../service/WorkbenchService';
-import { ISessionInfo, UserSessionInfo } from '../models/userSession';
-import { ICommonResult, CommonResult } from '../libs/utils/common-dto';
-import {isEnableDebug, isEnableSuperAdmin} from '../libs/utils/fatcms-request';
-import { ContextLogger } from '../models/contextLogger';
-import { Stream } from 'node:stream';
-import {VisitStatService} from "../service/VisitStatService";
-
-function isFunction(fun: any): boolean {
-  return typeof fun === 'function';
-}
-
-function isObject(obj: any): boolean {
-  return obj && typeof obj === 'object';
-}
-
-function isArrayBuffer(obj): boolean {
-  if (!obj) {
-    return false;
-  }
-  return obj instanceof ArrayBuffer || Object.prototype.toString.call(obj) === '[object ArrayBuffer]';
-}
-
-function isBlob(obj) {
-  return obj?.constructor?.name === 'Blob';
-}
-
-function isStream(obj) {
-  return obj && obj instanceof Stream;
-}
-
-/**
- * 专门对ExecuteSqlContext对象进行处理
- * @param res
- */
-function handleExecuteSqlContext(res: any): ICommonResult {
-  // ExecuteSqlContext
-  if (res && isFunction(res.getResMessage) && isFunction(res.getResModel)) {
-    const message = res.getResMessage();
-    return { success: true, message: message, data: res.getResModel() };
-  }
-  return res;
-}
-
-/**
- * 处理空数据
- * @param res
- */
-function handleNullRes(res: any): ICommonResult {
-  if (res === null || typeof res === 'undefined') {
-    return { success: false, message: '接口没有返回任何数据', data: null };
-  }
-  return res;
-}
-
-/**
- * 处理普通数组数据
- * @param res
- */
-function handleArrayRes(res: any): ICommonResult {
-  if (Array.isArray(res) && res.length) {
-    return { success: true, data: res };
-  }
-  return res;
-}
-
-function addDebugInfoFromContext(debugInfo: any, ctx: Context): void {
-  const userSession: UserSessionInfo = ctx.userSession;
-  const contextLogger: ContextLogger = ctx.contextLogger;
-  if (isObject(userSession)) {
-    const sessionInfo = userSession.getSessionInfo();
-    _.set(debugInfo, 'sessionInfo', sessionInfo);
-  }
-  if (isObject(contextLogger)) {
-    _.set(debugInfo, 'logList', contextLogger.getLogList());
-  }
-}
-
-/**
- * 处理调试信息
- * @param beforeRes 上一个输出
- * @param ctx
- * @param originRes 最原始的输出
- */
-function handleDebugRes(beforeRes: any, ctx: Context, originRes: any): ICommonResult {
-  const isDebug = isEnableDebug(ctx);
-
-  if (!isDebug) {
-    // 没有开启debug模式
-    if (beforeRes && beforeRes.debugInfo) {
-      delete beforeRes.debugInfo;
-    }
-    return beforeRes;
-  }
-
-  // 开启了debug模式
-  const debugInfo = {};
-
-  addDebugInfoFromContext(debugInfo, ctx);
-
-  //debugInfo3. 响应中本身就有debugInfo
-  if (isObject(originRes)) {
-    if (typeof originRes.debugInfo === 'string') {
-      _.set(debugInfo, 'debugInfo', originRes.debugInfo);
-    }
-    if (isObject(beforeRes.debugInfo)) {
-      Object.assign(debugInfo, originRes.debugInfo);
-    }
-
-    if (isFunction(originRes.getReqModel)) {
-      _.set(debugInfo, 'reqMode', originRes.getReqModel());
-    }
-    if (isObject(originRes.cfgModel)) {
-      _.set(debugInfo, 'cfgMode', originRes.cfgModel);
-    }
-  }
-
-  // debugInfo处理完毕
-  const nextRes: any = {};
-  if (isObject(beforeRes)) {
-    Object.assign(nextRes, beforeRes);
-  }
-  nextRes.debugInfo = debugInfo;
-  return nextRes as ICommonResult;
-}
-
-async function getUserSessionService(ctx: Context): Promise<UserSessionService> {
-  return ctx.requestContext.getAsync(UserSessionService);
-}
-
-async function getWorkbenchService(ctx: Context): Promise<WorkbenchService> {
-  return ctx.requestContext.getAsync(WorkbenchService);
-}
-
-async function getVisitStatService(ctx: Context): Promise<VisitStatService> {
-  return ctx.requestContext.getAsync(VisitStatService);
-}
-
-
-
-/**
- * 检查是否是超级管理员
- * @param ctx
- * @param sessionInfo
- */
-function checkIsSuperAdmin(ctx: Context, sessionInfo: ISessionInfo): boolean {
-  if (!sessionInfo || !sessionInfo.loginName) {
-    return false;
-  }
-
-  if (!isEnableSuperAdmin(ctx)) {
-    return false;
-  }
-
-  const currentLoginName = sessionInfo.loginName;
-  const superAdminList = ctx.app.getConfig('superAdminList');
-
-  if (Array.isArray(superAdminList)) {
-    for (let i = 0; i < superAdminList.length; i++) {
-      const element = superAdminList[i];
-      const login_name = _.get(element, 'login_name');
-      if (login_name && login_name === currentLoginName) {
-        return true;
-      }
-    }
-  }
-  return false;
-}
-
-function handleDebugError(e: any, ctx: Context): ICommonResult {
-  ctx.logger.error('GlobalMiddleware', e);
-
-  let errorStack = null;
-  let errorCode = null;
-  let errorMessage = '' + e;
-
-  if (isObject(e)) {
-    if (e.message) {
-      errorMessage = e.message;
-    }
-    if (e.code) {
-      errorCode = e.code;
-    }
-    errorStack = e.stack;
-  }
-
-  const res = CommonResult.errorRes(errorMessage, errorCode);
-  if (isEnableDebug(ctx)) {
-    const debugInfo = { errorStack };
-    addDebugInfoFromContext(debugInfo, ctx);
-    res.debugInfo = debugInfo;
-  }
-
-  return res;
-}
-
-
-async function trackRequest(ctx: Context) {
-  try {
-    const visitStatService = await getVisitStatService(ctx);
-    await visitStatService.trackRequest(ctx.path, 'path');
-  } catch (e) {
-    console.error('trackRequestError', e);
-  }
-}
-
-/**
- * 全局中间件
- */
-@Middleware()
-export class GlobalMiddleware implements IMiddleware<Context, NextFunction> {
-
-  match(ctx: Context): boolean {
-    const path: string = ctx.path;
-    return !(path.startsWith('/ns/static/'));
-  }
-
-  resolve() {
-    return async (ctx: Context, next: NextFunction) => {
-      ctx.contextLogger = new ContextLogger(ctx);
-      ctx.transaction = new Transaction();
-
-      try {
-
-        // 支持的站点
-        const workbenchService = await getWorkbenchService(ctx);
-        const isSupportTheHost = await workbenchService.isSupportCurrentHostForForMiddleware();
-        if (isSupportTheHost !== true) {
-          return isSupportTheHost;
-        }
-
-        const sessionService = await getUserSessionService(ctx);
-        const sessionInfo = await sessionService.getCurrentUserSessionForMiddleware();
-        const isSuperAdmin = checkIsSuperAdmin(ctx, sessionInfo);
-
-        ctx.userSession = new UserSessionInfo(sessionInfo, isSuperAdmin);
-        ctx.workbenchInfo = await workbenchService.getCurrentHostWorkbenchInfo();
-
-        // 数据埋点
-        await trackRequest(ctx)
-
-        const res0 = await next();
-
-        // 基本数据类型：需要搞成字符串
-        if (['bigint', 'symbol'].includes(typeof res0)) {
-          return res0.toString();
-        }
-
-        // 基本数据类型: 交给KOA处理的
-        if (!res0 || ['string', 'number', 'boolean'].includes(typeof res0) || Buffer.isBuffer(res0) || isArrayBuffer(res0) || isStream(res0) || isBlob(res0)) {
-          return res0;
-        }
-
-
-        // 其他：普通的JSON数据
-        let res = handleExecuteSqlContext(res0);
-        res = handleNullRes(res);
-        res = handleArrayRes(res);
-        res = handleDebugRes(res, ctx, res0);
-
-        return res;
-      } catch (e) {
-        return handleDebugError(e, ctx);
-      } finally {
-        await ctx.transaction.releaseTx();
-      }
-    };
-  }
-
-  static getName(): string {
-    return 'GlobalMiddleware';
-  }
-}
+import { Middleware, IMiddleware } from '@midwayjs/core';
+import { NextFunction, Context } from '@midwayjs/koa';
+import * as _ from 'lodash';
+import { Transaction } from '@/libs/crud-pro/models/Transaction';
+import { UserSessionService } from '@/service/UserSessionService';
+import { WorkbenchService } from '@/service/WorkbenchService';
+import { ISessionInfo, UserSessionInfo } from '@/models/userSession';
+import { ICommonResult, CommonResult } from '@/libs/utils/common-dto';
+import { isEnableDebug, isEnableSuperAdmin } from '@/libs/utils/fatcms-request';
+import { ContextLogger } from '@/models/contextLogger';
+import { Stream } from 'node:stream';
+import { VisitStatService } from '@/service/VisitStatService';
+
+function isFunction(fun: any): boolean {
+  return typeof fun === 'function';
+}
+
+function isObject(obj: any): boolean {
+  return obj && typeof obj === 'object';
+}
+
+function isArrayBuffer(obj: any): boolean {
+  if (!obj) {
+    return false;
+  }
+  return obj instanceof ArrayBuffer || Object.prototype.toString.call(obj) === '[object ArrayBuffer]';
+}
+
+function isBlob(obj: any): boolean {
+  return obj?.constructor?.name === 'Blob';
+}
+
+function isStream(obj: any): boolean {
+  return obj && obj instanceof Stream;
+}
+
+async function getUserSessionService(ctx: Context): Promise<UserSessionService> {
+  return ctx.requestContext.getAsync(UserSessionService);
+}
+
+async function getWorkbenchService(ctx: Context): Promise<WorkbenchService> {
+  return ctx.requestContext.getAsync(WorkbenchService);
+}
+
+async function getVisitStatService(ctx: Context): Promise<VisitStatService> {
+  return ctx.requestContext.getAsync(VisitStatService);
+}
+
+/**
+ * 专门对ExecuteSqlContext对象进行处理
+ * @param res
+ */
+function handleExecuteSqlContext(res: any): ICommonResult {
+  // ExecuteSqlContext
+  if (res && isFunction(res.getResMessage) && isFunction(res.getResModel)) {
+    const message = res.getResMessage();
+    return { success: true, message: message, data: res.getResModel() };
+  }
+  return res;
+}
+
+/**
+ * 处理空数据
+ * @param res
+ */
+function handleNullRes(res: any): ICommonResult {
+  if (res === null || typeof res === 'undefined') {
+    return { success: false, message: '接口没有返回任何数据', data: null };
+  }
+  return res;
+}
+
+/**
+ * 处理普通数组数据
+ * @param res
+ */
+function handleArrayRes(res: any): ICommonResult {
+  if (Array.isArray(res) && res.length) {
+    return { success: true, data: res };
+  }
+  return res;
+}
+
+function addDebugInfoFromContext(debugInfo: any, ctx: Context): void {
+  const userSession: UserSessionInfo = ctx.userSession;
+  const contextLogger: ContextLogger = ctx.contextLogger;
+  if (isObject(userSession)) {
+    const sessionInfo = userSession.getSessionInfo();
+    _.set(debugInfo, 'sessionInfo', sessionInfo);
+  }
+  if (isObject(contextLogger)) {
+    _.set(debugInfo, 'logList', contextLogger.getLogList());
+  }
+}
+
+/**
+ * 处理调试信息
+ * @param beforeRes 上一个输出
+ * @param ctx
+ * @param originRes 最原始的输出
+ */
+function handleDebugRes(beforeRes: any, ctx: Context, originRes: any): ICommonResult {
+  const isDebug = isEnableDebug(ctx);
+
+  if (!isDebug) {
+    // 没有开启debug模式
+    if (beforeRes && beforeRes.debugInfo) {
+      delete beforeRes.debugInfo;
+    }
+    return beforeRes;
+  }
+
+  // 开启了debug模式
+  const debugInfo = {};
+
+  addDebugInfoFromContext(debugInfo, ctx);
+
+  //debugInfo3. 响应中本身就有debugInfo
+  if (isObject(originRes)) {
+    if (typeof originRes.debugInfo === 'string') {
+      _.set(debugInfo, 'debugInfo', originRes.debugInfo);
+    }
+    if (isObject(beforeRes.debugInfo)) {
+      Object.assign(debugInfo, originRes.debugInfo);
+    }
+
+    if (isFunction(originRes.getReqModel)) {
+      _.set(debugInfo, 'reqMode', originRes.getReqModel());
+    }
+    if (isObject(originRes.cfgModel)) {
+      _.set(debugInfo, 'cfgMode', originRes.cfgModel);
+    }
+  }
+
+  // debugInfo处理完毕
+  const nextRes: any = {};
+  if (isObject(beforeRes)) {
+    Object.assign(nextRes, beforeRes);
+  }
+  nextRes.debugInfo = debugInfo;
+  return nextRes as ICommonResult;
+}
+
+/**
+ * 检查是否是超级管理员
+ * @param ctx
+ * @param sessionInfo
+ */
+function checkIsSuperAdmin(ctx: Context, sessionInfo: ISessionInfo): boolean {
+  if (!sessionInfo || !sessionInfo.loginName) {
+    return false;
+  }
+
+  if (!isEnableSuperAdmin(ctx)) {
+    return false;
+  }
+
+  const currentLoginName = sessionInfo.loginName;
+  const superAdminList = ctx.app.getConfig('superAdminList');
+
+  if (Array.isArray(superAdminList)) {
+    for (let i = 0; i < superAdminList.length; i++) {
+      const element = superAdminList[i];
+      const login_name = _.get(element, 'login_name');
+      if (login_name && login_name === currentLoginName) {
+        return true;
+      }
+    }
+  }
+  return false;
+}
+
+/**
+ * 处理调试错误
+ * @param e
+ * @param ctx
+ * @returns
+ */
+function handleDebugError(e: any, ctx: Context): ICommonResult {
+  ctx.logger.error('GlobalMiddleware', e);
+
+  let errorStack = null;
+  let errorCode = null;
+  let errorMessage = '' + e;
+
+  if (isObject(e)) {
+    if (e.message) {
+      errorMessage = e.message;
+    }
+    if (e.code) {
+      errorCode = e.code;
+    }
+    errorStack = e.stack;
+  }
+
+  const res = CommonResult.errorRes(errorMessage, errorCode);
+  if (isEnableDebug(ctx)) {
+    const debugInfo = { errorStack };
+    addDebugInfoFromContext(debugInfo, ctx);
+    res.debugInfo = debugInfo;
+  }
+
+  return res;
+}
+
+/**
+ * 数据埋点
+ * @param ctx
+ */
+async function trackRequest(ctx: Context) {
+  try {
+    const visitStatService = await getVisitStatService(ctx);
+    await visitStatService.trackRequest(ctx.path, 'path');
+  } catch (e) {
+    console.error('trackRequestError', e);
+  }
+}
+
+/**
+ * 这些路径不需要配置用户信息等操作
+ */
+const excludePathPrefix = ['/ns/static/', '/ns/api/helpers'];
+
+/**
+ * 全局中间件
+ */
+@Middleware()
+export class GlobalMiddleware implements IMiddleware<Context, NextFunction> {
+  match(ctx: Context): boolean {
+    const path: string = ctx.path;
+    for (let i = 0; i < excludePathPrefix.length; i++) {
+      const excludePathPrefix1 = excludePathPrefix[i];
+      if (path.startsWith(excludePathPrefix1)) {
+        return false;
+      }
+    }
+    return true;
+  }
+
+  resolve() {
+    return async (ctx: Context, next: NextFunction) => {
+      ctx.contextLogger = new ContextLogger(ctx);
+      ctx.transaction = new Transaction();
+
+      try {
+        // 支持的站点
+        const workbenchService = await getWorkbenchService(ctx);
+        const isSupportTheHost = await workbenchService.isSupportCurrentHostForForMiddleware();
+        if (isSupportTheHost !== true) {
+          return isSupportTheHost;
+        }
+
+        const sessionService = await getUserSessionService(ctx);
+        const sessionInfo = await sessionService.getCurrentUserSessionForMiddleware();
+        const isSuperAdmin = checkIsSuperAdmin(ctx, sessionInfo);
+
+        ctx.userSession = new UserSessionInfo(sessionInfo, isSuperAdmin);
+        ctx.workbenchInfo = await workbenchService.getCurrentHostWorkbenchInfo();
+
+        // 数据埋点
+        await trackRequest(ctx);
+
+        const res0 = await next();
+
+        // 基本数据类型：需要搞成字符串
+        if (['bigint', 'symbol'].includes(typeof res0)) {
+          return res0.toString();
+        }
+
+        // 基本数据类型: 交给KOA处理的
+        if (!res0 || ['string', 'number', 'boolean'].includes(typeof res0) || Buffer.isBuffer(res0) || isArrayBuffer(res0) || isStream(res0) || isBlob(res0)) {
+          return res0;
+        }
+
+        // 其他：普通的JSON数据
+        let res = handleExecuteSqlContext(res0);
+        res = handleNullRes(res);
+        res = handleArrayRes(res);
+        res = handleDebugRes(res, ctx, res0);
+
+        return res;
+      } catch (e) {
+        return handleDebugError(e, ctx);
+      } finally {
+        await ctx.transaction.releaseTx();
+      }
+    };
+  }
+
+  static getName(): string {
+    return 'GlobalMiddleware';
+  }
+}