midway-fatcms 0.0.3 → 0.0.4

package/dist/middleware/global.middleware.js

@@ -1,310 +1,310 @@
-"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.GlobalMiddleware = void 0;
-const core_1 = require("@midwayjs/core");
-const _ = require("lodash");
-const Transaction_1 = require("../libs/crud-pro/models/Transaction");
-const UserSessionService_1 = require("../service/UserSessionService");
-const WorkbenchService_1 = require("../service/WorkbenchService");
-const userSession_1 = require("../models/userSession");
-const common_dto_1 = require("../libs/utils/common-dto");
-const fatcms_request_1 = require("../libs/utils/fatcms-request");
-const contextLogger_1 = require("../models/contextLogger");
-const node_stream_1 = require("node:stream");
-const VisitStatService_1 = require("../service/VisitStatService");
-const WorkbenchInfoTools_1 = require("../models/WorkbenchInfoTools");
-const errorToString_1 = require("../libs/utils/errorToString");
-function isFunction(fun) {
-    return typeof fun === 'function';
-}
-function isObject(obj) {
-    return obj && typeof obj === 'object';
-}
-function isArrayBuffer(obj) {
-    if (!obj) {
-        return false;
-    }
-    return obj instanceof ArrayBuffer || Object.prototype.toString.call(obj) === '[object ArrayBuffer]';
-}
-function isBlob(obj) {
-    var _a;
-    return ((_a = obj === null || obj === void 0 ? void 0 : obj.constructor) === null || _a === void 0 ? void 0 : _a.name) === 'Blob';
-}
-function isStream(obj) {
-    return obj && obj instanceof node_stream_1.Stream;
-}
-async function getUserSessionService(ctx) {
-    return ctx.requestContext.getAsync(UserSessionService_1.UserSessionService);
-}
-async function getWorkbenchService(ctx) {
-    return ctx.requestContext.getAsync(WorkbenchService_1.WorkbenchService);
-}
-async function getVisitStatService(ctx) {
-    return ctx.requestContext.getAsync(VisitStatService_1.VisitStatService);
-}
-/**
- * 专门对ExecuteSqlContext对象进行处理
- * @param res
- */
-function handleExecuteSqlContext(res) {
-    // 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) {
-    if (res === null || typeof res === 'undefined') {
-        return { success: false, message: '接口没有返回任何数据', data: null };
-    }
-    return res;
-}
-/**
- * 处理普通数组数据
- * @param res
- */
-function handleArrayRes(res) {
-    if (Array.isArray(res)) {
-        return { success: true, data: res };
-    }
-    return res;
-}
-function addDebugInfoFromContext(debugInfo, ctx) {
-    const userSession = ctx.userSession;
-    const 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, ctx, originRes) {
-    const isDebug = (0, fatcms_request_1.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 = {};
-    if (isObject(beforeRes)) {
-        Object.assign(nextRes, beforeRes);
-    }
-    nextRes.debugInfo = debugInfo;
-    return nextRes;
-}
-/**
- * 检查是否是超级管理员
- * @param ctx
- * @param sessionInfo
- */
-function checkIsSuperAdmin(ctx, sessionInfo) {
-    if (!sessionInfo || !sessionInfo.loginName) {
-        return false;
-    }
-    if (!(0, fatcms_request_1.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, ctx) {
-    let errorMessage = (0, errorToString_1.errorToString)(e);
-    ctx.logger.error('GlobalMiddleware handleDebugError ', errorMessage);
-    let errorStack = null;
-    let errorCode = null;
-    if (isObject(e)) {
-        if (e.message) {
-            errorMessage = e.message;
-        }
-        if (e.code) {
-            errorCode = e.code;
-        }
-        errorStack = e.stack;
-    }
-    const res = common_dto_1.CommonResult.errorRes(errorMessage, errorCode);
-    if ((0, fatcms_request_1.isEnableDebug)(ctx)) {
-        const debugInfo = { errorStack };
-        addDebugInfoFromContext(debugInfo, ctx);
-        res.debugInfo = debugInfo;
-    }
-    return res;
-}
-/**
- * 数据埋点
- * @param ctx
- */
-async function trackRequest(ctx) {
-    try {
-        const visitStatService = await getVisitStatService(ctx);
-        await visitStatService.trackRequest(ctx.path, 'path');
-    }
-    catch (e) {
-        console.error('trackRequestError', e);
-    }
-}
-/**
- * 这些路径不需要配置用户信息等操作
- */
-const excludePathPrefix = ['/ns/static/'];
-/**
- * 全局中间件
- *
- * 作为应用的核心中间件，自动应用于所有请求（除特定排除路径外）。
- *
- * 核心职责：
- * 1. 用户会话管理：初始化用户登录状态、权限信息、超级管理员标识
- * 2. 多租户/工作台隔离：验证请求来源站点的合法性，实现多租户数据隔离
- * 3. 事务上下文：为每个请求创建数据库事务对象，确保数据一致性
- * 4. 日志追踪：创建请求级别的日志记录器，便于问题排查
- * 5. 响应格式统一：将各种类型的业务返回值转换为统一的响应格式
- * 6. 调试信息注入：开发环境下自动注入请求日志、SQL执行记录等调试信息
- * 7. 访问统计：自动记录接口访问PV/UV数据
- * 8. 异常捕获：全局捕获业务异常，返回统一的错误响应
- *
- * 应用场景：
- * - SaaS多租户系统：根据域名/请求头自动识别租户，隔离数据访问
- * - 企业内部系统：统一的用户鉴权、权限控制、操作日志记录
- * - API网关：请求预处理、响应后处理、流量统计
- * - 微服务：提供统一的上下文传递（用户、租户、追踪ID等）
- *
- * 自动应用：
- * 此中间件已配置为全局中间件，无需在路由中手动引入。
- * 所有请求会自动经过此中间件处理（除 excludePathPrefix 中定义的路径）。
- */
-let GlobalMiddleware = class GlobalMiddleware {
-    /**
-     * 匹配规则：决定哪些请求需要经过此中间件
-     * @param ctx Koa上下文
-     * @returns true表示需要处理，false表示跳过
-     */
-    match(ctx) {
-        const path = 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, next) => {
-            // 初始化请求上下文
-            ctx.contextLogger = new contextLogger_1.ContextLogger(ctx);
-            ctx.transaction = new Transaction_1.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 userSession_1.UserSessionInfo(sessionInfo, isSuperAdmin);
-                ctx.workbenchInfo = await workbenchService.getCurrentHostWorkbenchInfo();
-                ctx.workbenchInfoTools = new WorkbenchInfoTools_1.WorkbenchInfoTools(ctx.workbenchInfo);
-                // 校验是否支持该路径
-                const isSupportTheNodePath = workbenchService.isSupportTheNodePathByWorkbenchInfo(ctx.workbenchInfo, ctx.path);
-                if (!isSupportTheNodePath) {
-                    return common_dto_1.CommonResult.errorRes('非法访问！此站点不支持该路径！', 'NOT_SUPPORT_PATH');
-                }
-                // 数据埋点
-                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() {
-        return 'GlobalMiddleware';
-    }
-};
-GlobalMiddleware = __decorate([
-    (0, core_1.Middleware)()
-], GlobalMiddleware);
-exports.GlobalMiddleware = GlobalMiddleware;
+"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.GlobalMiddleware = void 0;
+const core_1 = require("@midwayjs/core");
+const _ = require("lodash");
+const Transaction_1 = require("../libs/crud-pro/models/Transaction");
+const UserSessionService_1 = require("../service/UserSessionService");
+const WorkbenchService_1 = require("../service/WorkbenchService");
+const userSession_1 = require("../models/userSession");
+const common_dto_1 = require("../libs/utils/common-dto");
+const fatcms_request_1 = require("../libs/utils/fatcms-request");
+const contextLogger_1 = require("../models/contextLogger");
+const node_stream_1 = require("node:stream");
+const VisitStatService_1 = require("../service/VisitStatService");
+const WorkbenchInfoTools_1 = require("../models/WorkbenchInfoTools");
+const errorToString_1 = require("../libs/utils/errorToString");
+function isFunction(fun) {
+    return typeof fun === 'function';
+}
+function isObject(obj) {
+    return obj && typeof obj === 'object';
+}
+function isArrayBuffer(obj) {
+    if (!obj) {
+        return false;
+    }
+    return obj instanceof ArrayBuffer || Object.prototype.toString.call(obj) === '[object ArrayBuffer]';
+}
+function isBlob(obj) {
+    var _a;
+    return ((_a = obj === null || obj === void 0 ? void 0 : obj.constructor) === null || _a === void 0 ? void 0 : _a.name) === 'Blob';
+}
+function isStream(obj) {
+    return obj && obj instanceof node_stream_1.Stream;
+}
+async function getUserSessionService(ctx) {
+    return ctx.requestContext.getAsync(UserSessionService_1.UserSessionService);
+}
+async function getWorkbenchService(ctx) {
+    return ctx.requestContext.getAsync(WorkbenchService_1.WorkbenchService);
+}
+async function getVisitStatService(ctx) {
+    return ctx.requestContext.getAsync(VisitStatService_1.VisitStatService);
+}
+/**
+ * 专门对ExecuteSqlContext对象进行处理
+ * @param res
+ */
+function handleExecuteSqlContext(res) {
+    // 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) {
+    if (res === null || typeof res === 'undefined') {
+        return { success: false, message: '接口没有返回任何数据', data: null };
+    }
+    return res;
+}
+/**
+ * 处理普通数组数据
+ * @param res
+ */
+function handleArrayRes(res) {
+    if (Array.isArray(res)) {
+        return { success: true, data: res };
+    }
+    return res;
+}
+function addDebugInfoFromContext(debugInfo, ctx) {
+    const userSession = ctx.userSession;
+    const 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, ctx, originRes) {
+    const isDebug = (0, fatcms_request_1.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 = {};
+    if (isObject(beforeRes)) {
+        Object.assign(nextRes, beforeRes);
+    }
+    nextRes.debugInfo = debugInfo;
+    return nextRes;
+}
+/**
+ * 检查是否是超级管理员
+ * @param ctx
+ * @param sessionInfo
+ */
+function checkIsSuperAdmin(ctx, sessionInfo) {
+    if (!sessionInfo || !sessionInfo.loginName) {
+        return false;
+    }
+    if (!(0, fatcms_request_1.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, ctx) {
+    let errorMessage = (0, errorToString_1.errorToString)(e);
+    ctx.logger.error('GlobalMiddleware handleDebugError ', errorMessage);
+    let errorStack = null;
+    let errorCode = null;
+    if (isObject(e)) {
+        if (e.message) {
+            errorMessage = e.message;
+        }
+        if (e.code) {
+            errorCode = e.code;
+        }
+        errorStack = e.stack;
+    }
+    const res = common_dto_1.CommonResult.errorRes(errorMessage, errorCode);
+    if ((0, fatcms_request_1.isEnableDebug)(ctx)) {
+        const debugInfo = { errorStack };
+        addDebugInfoFromContext(debugInfo, ctx);
+        res.debugInfo = debugInfo;
+    }
+    return res;
+}
+/**
+ * 数据埋点
+ * @param ctx
+ */
+async function trackRequest(ctx) {
+    try {
+        const visitStatService = await getVisitStatService(ctx);
+        await visitStatService.trackRequest(ctx.path, 'path');
+    }
+    catch (e) {
+        console.error('trackRequestError', e);
+    }
+}
+/**
+ * 这些路径不需要配置用户信息等操作
+ */
+const excludePathPrefix = ['/ns/static/'];
+/**
+ * 全局中间件
+ *
+ * 作为应用的核心中间件，自动应用于所有请求（除特定排除路径外）。
+ *
+ * 核心职责：
+ * 1. 用户会话管理：初始化用户登录状态、权限信息、超级管理员标识
+ * 2. 多租户/工作台隔离：验证请求来源站点的合法性，实现多租户数据隔离
+ * 3. 事务上下文：为每个请求创建数据库事务对象，确保数据一致性
+ * 4. 日志追踪：创建请求级别的日志记录器，便于问题排查
+ * 5. 响应格式统一：将各种类型的业务返回值转换为统一的响应格式
+ * 6. 调试信息注入：开发环境下自动注入请求日志、SQL执行记录等调试信息
+ * 7. 访问统计：自动记录接口访问PV/UV数据
+ * 8. 异常捕获：全局捕获业务异常，返回统一的错误响应
+ *
+ * 应用场景：
+ * - SaaS多租户系统：根据域名/请求头自动识别租户，隔离数据访问
+ * - 企业内部系统：统一的用户鉴权、权限控制、操作日志记录
+ * - API网关：请求预处理、响应后处理、流量统计
+ * - 微服务：提供统一的上下文传递（用户、租户、追踪ID等）
+ *
+ * 自动应用：
+ * 此中间件已配置为全局中间件，无需在路由中手动引入。
+ * 所有请求会自动经过此中间件处理（除 excludePathPrefix 中定义的路径）。
+ */
+let GlobalMiddleware = class GlobalMiddleware {
+    /**
+     * 匹配规则：决定哪些请求需要经过此中间件
+     * @param ctx Koa上下文
+     * @returns true表示需要处理，false表示跳过
+     */
+    match(ctx) {
+        const path = 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, next) => {
+            // 初始化请求上下文
+            ctx.contextLogger = new contextLogger_1.ContextLogger(ctx);
+            ctx.transaction = new Transaction_1.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 userSession_1.UserSessionInfo(sessionInfo, isSuperAdmin);
+                ctx.workbenchInfo = await workbenchService.getCurrentHostWorkbenchInfo();
+                ctx.workbenchInfoTools = new WorkbenchInfoTools_1.WorkbenchInfoTools(ctx.workbenchInfo);
+                // 校验是否支持该路径
+                const isSupportTheNodePath = workbenchService.isSupportTheNodePathByWorkbenchInfo(ctx.workbenchInfo, ctx.path);
+                if (!isSupportTheNodePath) {
+                    return common_dto_1.CommonResult.errorRes('非法访问！此站点不支持该路径！', 'NOT_SUPPORT_PATH');
+                }
+                // 数据埋点
+                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() {
+        return 'GlobalMiddleware';
+    }
+};
+GlobalMiddleware = __decorate([
+    (0, core_1.Middleware)()
+], GlobalMiddleware);
+exports.GlobalMiddleware = GlobalMiddleware;