befly 3.9.38 → 3.9.40

package/sync/syncMenu.ts

@@ -1,9 +1,9 @@
-/**
+/**
  * SyncMenu 命令 - 同步菜单数据到数据库
  * 说明：扫描 addon 的 views 目录和项目的 menus.json，同步菜单数据
  *
  * 流程：
- * 1. 扫描所有 addon 的 views 目录下的 meta.json 文件
+ * 1. 扫描所有 addon 的 views 目录下的 index.vue，并从 definePage({ meta }) 解析菜单元信息
  * 2. 根据目录层级构建菜单树（无层级限制）
  * 3. 读取项目的 menus.json 文件（手动配置的菜单）
  * 4. 根据菜单的 path 字段检查是否存在
@@ -13,27 +13,137 @@
  * 注：state 字段由框架自动管理（1=正常，2=禁用，0=删除）
  */
 
-import { existsSync } from 'node:fs';
-import { readdir, readFile } from 'node:fs/promises';
-import { join } from 'pathe';
+import type { SyncMenuOptions, MenuConfig } from "../types/sync.js";
+
+import { existsSync } from "node:fs";
+import { readdir, readFile } from "node:fs/promises";
 
-import { Connect } from '../lib/connect.js';
-import { DbHelper } from '../lib/dbHelper.js';
-import { RedisHelper } from '../lib/redisHelper.js';
-import { RedisKeys } from 'befly-shared/redisKeys';
-import { scanAddons, getAddonDir } from 'befly-shared/addonHelper';
-import { Logger } from '../lib/logger.js';
-import { projectDir } from '../paths.js';
-import { beflyConfig } from '../befly.config.js';
+import { join } from "pathe";
 
-import type { SyncMenuOptions, MenuConfig } from '../types/index.js';
+import { beflyConfig } from "../befly.config.js";
+import { CacheKeys } from "../lib/cacheKeys.js";
+import { Connect } from "../lib/connect.js";
+import { DbHelper } from "../lib/dbHelper.js";
+import { Logger } from "../lib/logger.js";
+import { RedisHelper } from "../lib/redisHelper.js";
+import { projectDir } from "../paths.js";
+import { scanAddons, getAddonDir } from "../utils/addonHelper.js";
 
 /**
  * 清理目录名中的数字后缀
  * 如：login_1 → login, index_2 → index
  */
 function cleanDirName(name: string): string {
-    return name.replace(/_\d+$/, '');
+    return name.replace(/_\d+$/, "");
+}
+
+type ViewDirMeta = {
+    title: string;
+    order?: number;
+};
+
+function normalizeMenuPath(path: string): string {
+    // 约束：统一 path 形态，避免隐藏菜单匹配、DB 同步出现重复
+    // - 必须以 / 开头
+    // - 折叠多个 /
+    // - 去掉尾随 /（根 / 除外）
+    let result = path;
+
+    if (!result) {
+        return "/";
+    }
+
+    if (!result.startsWith("/")) {
+        result = `/${result}`;
+    }
+
+    result = result.replace(/\/+/g, "/");
+
+    if (result.length > 1) {
+        result = result.replace(/\/+$/, "");
+    }
+
+    return result;
+}
+
+function normalizeMenuTree(menus: MenuConfig[]): MenuConfig[] {
+    // 递归规范化并按 path 去重（同 path 的 children 合并）
+    const map = new Map<string, MenuConfig>();
+
+    for (const menu of menus) {
+        const menuPath = menu.path ? normalizeMenuPath(menu.path) : "";
+        const cloned: MenuConfig = {
+            name: menu.name,
+            path: menuPath,
+            sort: menu.sort
+        };
+
+        if (menu.children && menu.children.length > 0) {
+            cloned.children = normalizeMenuTree(menu.children);
+        }
+
+        if (!menuPath) {
+            // path 缺失的菜单无法参与同步/去重，直接丢弃
+            continue;
+        }
+
+        const existing = map.get(menuPath);
+        if (existing) {
+            if (cloned.children && cloned.children.length > 0) {
+                existing.children = existing.children || [];
+                existing.children.push(...cloned.children);
+                existing.children = normalizeMenuTree(existing.children);
+            }
+            if (typeof cloned.sort === "number") {
+                existing.sort = cloned.sort;
+            }
+            if (cloned.name) {
+                existing.name = cloned.name;
+            }
+        } else {
+            map.set(menuPath, cloned);
+        }
+    }
+
+    const result = Array.from(map.values());
+    result.sort((a, b) => (a.sort || 1) - (b.sort || 1));
+    return result;
+}
+
+function extractScriptSetupBlock(vueContent: string): string | null {
+    // 只取第一个 <script ... setup ...> 块
+    const openTag = /<script\b[^>]*\bsetup\b[^>]*>/i.exec(vueContent);
+    if (!openTag) {
+        return null;
+    }
+
+    const start = openTag.index + openTag[0].length;
+    const closeIndex = vueContent.indexOf("</script>", start);
+    if (closeIndex < 0) {
+        return null;
+    }
+
+    return vueContent.slice(start, closeIndex);
+}
+
+function extractDefinePageMetaFromScriptSetup(scriptSetup: string): ViewDirMeta | null {
+    // 简化约束：
+    // - 每个页面只有一个 definePage
+    // - title 是纯字符串字面量
+    // - order 是数字字面量（可选）
+    // - 不考虑变量/表达式/多段 meta 组合
+
+    const titleMatch = scriptSetup.match(/definePage\s*\([\s\S]*?meta\s*:\s*\{[\s\S]*?title\s*:\s*(["'`])([^"'`]+)\1/);
+    if (!titleMatch) {
+        return null;
+    }
+
+    const orderMatch = scriptSetup.match(/definePage\s*\([\s\S]*?meta\s*:\s*\{[\s\S]*?order\s*:\s*(\d+)/);
+
+    return {
+        title: titleMatch[2],
+        order: orderMatch ? Number(orderMatch[1]) : undefined
+    };
 }
 
 /**
@@ -43,7 +153,7 @@ function cleanDirName(name: string): string {
  * @param parentPath 父级路径
  * @returns 菜单数组
  */
-async function scanViewsDir(viewsDir: string, prefix: string, parentPath: string = ''): Promise<MenuConfig[]> {
+async function scanViewsDir(viewsDir: string, prefix: string, parentPath: string = ""): Promise<MenuConfig[]> {
     if (!existsSync(viewsDir)) {
         return [];
     }
@@ -53,43 +163,59 @@ async function scanViewsDir(viewsDir: string, prefix: string, parentPath: string
 
     for (const entry of entries) {
         // 只处理目录，忽略 components 目录
-        if (!entry.isDirectory() || entry.name === 'components') {
+        if (!entry.isDirectory() || entry.name === "components") {
             continue;
         }
 
         const dirPath = join(viewsDir, entry.name);
-        const metaPath = join(dirPath, 'meta.json');
+        const indexVuePath = join(dirPath, "index.vue");
 
-        // 没有 meta.json 的目录不处理
-        if (!existsSync(metaPath)) {
+        // 没有 index.vue 的目录不处理
+        if (!existsSync(indexVuePath)) {
             continue;
         }
 
-        // 读取 meta.json
-        let meta: { name: string; order?: number };
+        // 从 index.vue 中解析 definePage({ meta })
+        let meta: ViewDirMeta | null = null;
         try {
-            const content = await readFile(metaPath, 'utf-8');
-            meta = JSON.parse(content);
+            const content = await readFile(indexVuePath, "utf-8");
+
+            const scriptSetup = extractScriptSetupBlock(content);
+            if (!scriptSetup) {
+                Logger.warn({ path: indexVuePath }, "index.vue 缺少 <script setup>，已跳过该目录菜单同步");
+                continue;
+            }
+
+            meta = extractDefinePageMetaFromScriptSetup(scriptSetup);
+            if (!meta?.title) {
+                Logger.warn({ path: indexVuePath }, "index.vue 未声明 definePage({ meta: { title, order? } })，已跳过该目录菜单同步");
+                continue;
+            }
         } catch (error: any) {
-            Logger.warn({ err: error, path: metaPath }, '读取 meta.json 失败');
+            Logger.warn({ err: error, path: indexVuePath }, "读取 index.vue 失败");
+            continue;
+        }
+
+        // 没有 definePage meta 的目录不处理
+        if (!meta?.title) {
             continue;
         }
 
         // 计算路径：清理数字后缀，index 目录特殊处理
         const cleanName = cleanDirName(entry.name);
         let menuPath: string;
-        if (cleanName === 'index') {
-            // index 目录路径为父级路径，根级别则为 /
-            menuPath = parentPath || '/';
+        if (cleanName === "index") {
+            // index 目录路径为父级路径；根级别用空字符串（避免 addon prefix 拼出尾随 /）
+            menuPath = parentPath;
         } else {
             menuPath = parentPath ? `${parentPath}/${cleanName}` : `/${cleanName}`;
         }
 
         // 添加 addon 前缀
-        const fullPath = prefix ? `${prefix}${menuPath}` : menuPath;
+        const fullPath = prefix ? (menuPath ? `${prefix}${menuPath}` : prefix) : menuPath || "/";
 
         const menu: MenuConfig = {
-            name: meta.name,
+            name: meta.title,
             path: fullPath,
             sort: meta.order || 1
         };
@@ -186,7 +312,7 @@ function collectPaths(menus: MenuConfig[]): Set<string> {
  * 递归同步单个菜单（无层级限制）
  */
 async function syncMenuRecursive(helper: any, menu: MenuConfig, pid: number, existingMenuMap: Map<string, any>): Promise<number> {
-    const existing = existingMenuMap.get(menu.path || '');
+    const existing = existingMenuMap.get(menu.path || "");
     let menuId: number;
 
     if (existing) {
@@ -196,7 +322,7 @@ async function syncMenuRecursive(helper: any, menu: MenuConfig, pid: number, exi
 
         if (needUpdate) {
             await helper.updData({
-                table: 'addon_admin_menu',
+                table: "addon_admin_menu",
                 where: { id: existing.id },
                 data: {
                     pid: pid,
@@ -207,11 +333,11 @@ async function syncMenuRecursive(helper: any, menu: MenuConfig, pid: number, exi
         }
     } else {
         menuId = await helper.insData({
-            table: 'addon_admin_menu',
+            table: "addon_admin_menu",
             data: {
                 pid: pid,
                 name: menu.name,
-                path: menu.path || '',
+                path: menu.path || "",
                 sort: menu.sort || 1
             }
         });
@@ -231,7 +357,7 @@ async function syncMenuRecursive(helper: any, menu: MenuConfig, pid: number, exi
  */
 async function syncMenus(helper: any, menus: MenuConfig[]): Promise<void> {
     const allExistingMenus = await helper.getAll({
-        table: 'addon_admin_menu'
+        table: "addon_admin_menu"
     });
     const existingMenuMap = new Map<string, any>();
     for (const menu of allExistingMenus.lists) {
@@ -244,7 +370,7 @@ async function syncMenus(helper: any, menus: MenuConfig[]): Promise<void> {
         try {
             await syncMenuRecursive(helper, menu, 0, existingMenuMap);
         } catch (error: any) {
-            Logger.error({ err: error, menu: menu.name }, '同步菜单失败');
+            Logger.error({ err: error, menu: menu.name }, "同步菜单失败");
             throw error;
         }
     }
@@ -255,15 +381,15 @@ async function syncMenus(helper: any, menus: MenuConfig[]): Promise<void> {
  */
 async function deleteObsoleteRecords(helper: any, configPaths: Set<string>): Promise<void> {
     const allRecords = await helper.getAll({
-        table: 'addon_admin_menu',
-        fields: ['id', 'path'],
+        table: "addon_admin_menu",
+        fields: ["id", "path"],
         where: { state$gte: 0 }
     });
 
     for (const record of allRecords.lists) {
         if (record.path && !configPaths.has(record.path)) {
             await helper.delForce({
-                table: 'addon_admin_menu',
+                table: "addon_admin_menu",
                 where: { id: record.id }
             });
         }
@@ -281,8 +407,8 @@ async function loadMenuConfigs(): Promise<Array<{ menus: MenuConfig[]; source: s
 
     for (const addonName of addonNames) {
         try {
-            const addonDir = getAddonDir(addonName, '');
-            const viewsDir = join(addonDir, 'views');
+            const addonDir = getAddonDir(addonName, "");
+            const viewsDir = join(addonDir, "views");
 
             if (existsSync(viewsDir)) {
                 const prefix = `/addon/${addonName}`;
@@ -295,24 +421,24 @@ async function loadMenuConfigs(): Promise<Array<{ menus: MenuConfig[]; source: s
                 }
             }
         } catch (error: any) {
-            Logger.warn({ err: error, addon: addonName }, '扫描 addon views 目录失败');
+            Logger.warn({ err: error, addon: addonName }, "扫描 addon views 目录失败");
         }
     }
 
     // 2. 读取项目的 menus.json
-    const menusJsonPath = join(projectDir, 'menus.json');
+    const menusJsonPath = join(projectDir, "menus.json");
     if (existsSync(menusJsonPath)) {
         try {
-            const content = await readFile(menusJsonPath, 'utf-8');
+            const content = await readFile(menusJsonPath, "utf-8");
             const projectMenus = JSON.parse(content);
             if (Array.isArray(projectMenus) && projectMenus.length > 0) {
                 allMenus.push({
                     menus: projectMenus,
-                    source: 'project'
+                    source: "project"
                 });
             }
         } catch (error: any) {
-            Logger.warn({ err: error }, '读取项目 menus.json 失败');
+            Logger.warn({ err: error }, "读取项目 menus.json 失败");
         }
     }
 
@@ -325,7 +451,7 @@ async function loadMenuConfigs(): Promise<Array<{ menus: MenuConfig[]; source: s
 export async function syncMenuCommand(options: SyncMenuOptions = {}): Promise<void> {
     try {
         if (options.plan) {
-            Logger.debug('[计划] 同步菜单配置到数据库（plan 模式不执行）');
+            Logger.debug("[计划] 同步菜单配置到数据库（plan 模式不执行）");
             return;
         }
 
@@ -335,11 +461,15 @@ export async function syncMenuCommand(options: SyncMenuOptions = {}): Promise<vo
         // 2. 合并菜单配置
         let mergedMenus = mergeMenuConfigs(allMenus);
 
+        // 2.1 规范化并去重（防止尾随 / 或多 / 导致隐藏菜单与 DB 同步异常）
+        mergedMenus = normalizeMenuTree(mergedMenus);
+
         // 3. 过滤隐藏菜单（根据 hiddenMenus 配置）
         const hiddenMenus = (beflyConfig as any).hiddenMenus || [];
         if (Array.isArray(hiddenMenus) && hiddenMenus.length > 0) {
-            const hiddenSet = new Set(hiddenMenus);
+            const hiddenSet = new Set(hiddenMenus.map((item: string) => normalizeMenuPath(item)));
             mergedMenus = filterHiddenMenus(mergedMenus, hiddenSet);
+            mergedMenus = normalizeMenuTree(mergedMenus);
         }
 
         // 连接数据库
@@ -348,10 +478,10 @@ export async function syncMenuCommand(options: SyncMenuOptions = {}): Promise<vo
         const helper = new DbHelper({ redis: new RedisHelper() } as any, Connect.getSql());
 
         // 3. 检查表是否存在
-        const exists = await helper.tableExists('addon_admin_menu');
+        const exists = await helper.tableExists("addon_admin_menu");
 
         if (!exists) {
-            Logger.debug('表 addon_admin_menu 不存在，跳过菜单同步');
+            Logger.debug("表 addon_admin_menu 不存在，跳过菜单同步");
             return;
         }
 
@@ -366,21 +496,26 @@ export async function syncMenuCommand(options: SyncMenuOptions = {}): Promise<vo
 
         // 7. 获取最终菜单数据（用于缓存）
         const allMenusData = await helper.getAll({
-            table: 'addon_admin_menu',
-            orderBy: ['sort#ASC', 'id#ASC']
+            table: "addon_admin_menu"
         });
 
         // 8. 缓存菜单数据到 Redis
         try {
             const redisHelper = new RedisHelper();
-            await redisHelper.setObject(RedisKeys.menusAll(), allMenusData.lists);
+            await redisHelper.setObject(CacheKeys.menusAll(), allMenusData.lists);
         } catch (error: any) {
-            Logger.warn({ err: error }, 'Redis 缓存菜单数据失败');
+            Logger.warn({ err: error }, "Redis 缓存菜单数据失败");
         }
     } catch (error: any) {
-        Logger.error({ err: error }, '菜单同步失败');
+        Logger.error({ err: error }, "菜单同步失败");
         throw error;
     } finally {
         await Connect.disconnect();
     }
 }
+
+// 仅测试用（避免将内部扫描逻辑变成稳定 API）
+export const __test__ = {
+    scanViewsDir: scanViewsDir,
+    normalizeMenuPath: normalizeMenuPath
+};