whistle.mockbubu 2.0.0 → 2.1.0

package/lib/uiServer/router/files/api-list-router.js

@@ -0,0 +1,150 @@
+/**
+ * 文件名: api-list-router.js
+ * 功能: API 列表路由（轮询查询）
+ * 依赖: utils.js, util.js
+ *
+ * 职责:
+ * - 增量轮询查询（从内存缓冲区获取新数据）
+ * - 首次轮询查询（返回完整列表）
+ *
+ * 路由:
+ * - POST /cgi-bin/mockbubu/api-list - 增量轮询查询
+ * - GET /cgi-bin/mockbubu/check-api-list - 检测更新状态（保留兼容性）
+ *
+ * 轮询说明：
+ * - 前端定时轮询 /api-list，传递 startTime
+ * - startTime=0 时返回完整列表（第一次轮询）
+ * - startTime>0 时返回增量数据（仅新捕获的数据）
+ * - 返回的数据已从暂存区清空（取出即清空）
+ */
+
+const { POLLING_CONFIG, LOG_PREFIX } = require('../../../constants')
+const {
+  getApiListUpdated,
+} = require('../../../utils/utils')
+const {
+  createSuccessResponse,
+  handleFilterList,
+  getFullDataList,
+} = require('../../utils/util')
+const { wrapRouteHandler } = require('../../utils/router-helpers')
+
+module.exports = (router) => {
+  /**
+   * 获取已保存文件列表（首屏加载）
+   *
+   * 功能:
+   * - 只返回已保存的文件（从文件系统加载）
+   * - 不包含暂存区数据
+   * - 首屏加载时调用一次
+   *
+   * 响应:
+   * ```javascript
+   * {
+   *   code: 200,
+   *   data: [
+   *     {
+   *       id: 'fileId',
+   *       url: 'https://api.example.com/users',
+   *       method: 'GET',
+   *       status: 200,
+   *       mock: true,
+   *       locked: false,
+   *       session: {...}  // 完整会话数据
+   *     }
+   *   ],
+   *   msg: '操作成功'
+   * }
+   * ```
+   */
+  router.post('/cgi-bin/mockbubu/api-list-saved', wrapRouteHandler(async (ctx) => {
+    const { storageAdapter, groupManager } = ctx
+    const currentGroupId = await groupManager.getCurrentGroupId()
+
+    console.log(`${LOG_PREFIX.API_LIST} 获取已保存文件列表 | groupId: ${currentGroupId}`)
+
+    const savedFiles = await getFullDataList(storageAdapter, groupManager, currentGroupId)
+    console.log(`${LOG_PREFIX.API_LIST} 已保存文件: ${savedFiles.length} 条`)
+
+    const filteredList = handleFilterList(savedFiles, ctx.request.body)
+    ctx.body = createSuccessResponse(filteredList || [])
+  }, '获取已保存文件列表'))
+
+  /**
+   * 增量轮询查询（只返回暂存区数据）
+   *
+   * 功能:
+   * - 只返回暂存区的增量数据（未保存的捕获数据）
+   * - 不返回已保存文件（已保存文件通过 /api-list-saved 获取）
+   * - 取出即清空（从暂存区删除已返回的数据）
+   *
+   * 请求体:
+   * ```javascript
+   * {
+   *   startTime: number,   // 必填，轮询起始时间戳（0 表示首次）
+   *   keyword: 'string',   // 可选，搜索关键词
+   *   mock: boolean,       // 可选，筛选 mock 状态
+   *   locked: boolean      // 可选，筛选锁定状态
+   * }
+   * ```
+   *
+   * 响应:
+   * ```javascript
+   * {
+   *   code: 200,
+   *   data: [
+   *     {
+   *       url: 'https://api.example.com/users',
+   *       method: 'GET',
+   *       status: 200,
+   *       session: {...}  // 完整会话数据
+   *     }
+   *   ],
+   *   msg: '操作成功'
+   * }
+   * ```
+   */
+  router.post('/cgi-bin/mockbubu/api-list', wrapRouteHandler(async (ctx) => {
+    const { groupManager, memoryBuffer } = ctx
+    const currentGroupId = await groupManager.getCurrentGroupId()
+    const { startTime = POLLING_CONFIG.INITIAL_START_TIME } = ctx.request.body
+
+    // console.log(`${LOG_PREFIX.API_LIST} 轮询查询（暂存区） | startTime: ${startTime} | groupId: ${currentGroupId}`)
+
+    // 从内存缓冲区获取增量数据（取出即清空）
+    const incrementalData = memoryBuffer.getAndClear(currentGroupId, startTime)
+
+    // console.log(`${LOG_PREFIX.API_LIST} 暂存区返回 ${incrementalData.length} 条数据`)
+
+    // 只返回暂存区数据，不包含已保存文件
+    ctx.body = createSuccessResponse(incrementalData || [])
+  }, '增量轮询查询（暂存区）'))
+
+  /**
+   * 检测 API 列表是否有更新
+   *
+   * 功能:
+   * - 检查是否有新的 API 被捕获
+   * - 前端轮询此接口，决定是否刷新列表
+   *
+   * 响应:
+   * ```javascript
+   * {
+   *   code: 0,
+   *   data: true,  // true 表示有更新，false 表示无更新
+   *   msg: 'success'
+   * }
+   * ```
+   *
+   * 工作原理:
+   * - server.js 捕获新 API 时，设置更新标志为 true
+   * - 前端调用 /api-list 后，标志被重置为 false
+   * - 前端定时轮询此接口，检测是否需要刷新
+   */
+  router.get('/cgi-bin/mockbubu/check-api-list', wrapRouteHandler(async (ctx) => {
+    const { storageAdapter } = ctx
+    const updated = await getApiListUpdated(storageAdapter)
+
+    ctx.body = createSuccessResponse(updated)
+  }, '检查API列表更新'))
+}

package/lib/uiServer/router/files/batch-operations-router.js

@@ -0,0 +1,185 @@
+/**
+ * 文件名: batch-operations-router.js
+ * 功能: 批量操作路由
+ * 依赖: utils.js, util.js, validator.js
+ *
+ * 职责:
+ * - 批量更新 Mock 状态（智能保存：缓存数据会先保存）
+ * - 批量删除文件（智能删除：区分已保存和暂存区）
+ *
+ * 路由:
+ * - POST /cgi-bin/mockbubu/batch-update-mock - 批量更新 Mock 状态
+ * - POST /cgi-bin/mockbubu/batch-delete-by-names - 批量删除文件
+ */
+
+const {
+  createErrorResponse,
+  createSuccessResponse,
+} = require('../../utils/util')
+const {
+  validateArray,
+  validateBoolean,
+  validate,
+} = require('../../utils/validator')
+
+module.exports = (router) => {
+  /**
+   * 批量更新 Mock 状态
+   *
+   * 智能处理：
+   * - 已保存文件：直接更新配置
+   * - 暂存区数据：前端需先调用 save-from-cache 保存后再调用此接口
+   *
+   * 请求体:
+   * ```javascript
+   * {
+   *   urls: ['url1', 'url2', ...],  // 文件 URL 数组（只包含已保存的）
+   *   mock: true                     // 新的 mock 状态
+   * }
+   * ```
+   *
+   * 响应:
+   * ```javascript
+   * {
+   *   code: 0,
+   *   data: {
+   *     success: ['url1', 'url2'],  // 成功的文件
+   *     failed: ['url3'],           // 失败的文件
+   *     skipped: ['url4']           // 跳过的文件（锁定）
+   *   },
+   *   msg: '批量更新成功'
+   * }
+   * ```
+   */
+  router.post('/cgi-bin/mockbubu/batch-update-mock', validate({
+    urls: validateArray,
+    mock: validateBoolean,
+  }), async (ctx) => {
+    try {
+      const { groupManager } = ctx
+      const { urls, mock } = ctx.request.body
+
+      const currentGroupId = await groupManager.getCurrentGroupId()
+
+      const success = []
+      const failed = []
+      const skipped = []
+
+      for (const url of urls) {
+        try {
+          // 检查文件是否存在且被锁定
+          const fileConfig = await groupManager.getGroupFileConfig(currentGroupId, url)
+
+          if (!fileConfig) {
+            // 文件不存在（可能是暂存区数据），前端应先保存
+            failed.push(url)
+            continue
+          }
+
+          if (fileConfig.locked) {
+            skipped.push(url)
+            continue
+          }
+
+          // 更新 Mock 状态
+          await groupManager.setGroupFileConfig(currentGroupId, url, {
+            mock,
+            mockTime: mock ? Date.now() : null,
+          })
+
+          success.push(url)
+        } catch (error) {
+          console.error('[batch-update-mock] 更新失败:', url, error)
+          failed.push(url)
+        }
+      }
+
+      const message = `成功: ${success.length}, 失败: ${failed.length}, 跳过: ${skipped.length}`
+      ctx.body = createSuccessResponse({ success, failed, skipped }, message)
+    } catch (error) {
+      console.error('[batch-update-mock] 批量更新异常:', error)
+      ctx.body = createErrorResponse(error.message)
+    }
+  })
+
+  /**
+   * 批量删除文件
+   *
+   * 智能删除：
+   * - 已保存文件：删除文件系统和配置
+   * - 暂存区数据：后端静默跳过，前端自行处理
+   *
+   * 请求体:
+   * ```javascript
+   * {
+   *   urls: ['url1', 'url2', ...]  // 文件 URL 数组
+   * }
+   * ```
+   *
+   * 响应:
+   * ```javascript
+   * {
+   *   code: 0,
+   *   data: {
+   *     success: ['url1', 'url2'],  // 成功删除的文件
+   *     notFound: ['url3'],         // 不存在的文件（暂存区数据）
+   *     skipped: ['url4']           // 跳过的文件（锁定）
+   *   },
+   *   msg: '批量删除完成'
+   * }
+   * ```
+   */
+  router.post('/cgi-bin/mockbubu/batch-delete-by-names', validate({
+    urls: validateArray,
+  }), async (ctx) => {
+    try {
+      const { storageAdapter } = ctx
+      const { groupManager } = ctx
+      const { urls } = ctx.request.body
+
+      const currentGroupId = await groupManager.getCurrentGroupId()
+
+      console.log('[batch-delete] 开始批量删除', new Date().toLocaleString('zh-CN', { hour12: false }))
+      console.log('[batch-delete] 待删除文件数:', urls.length)
+      console.log('[batch-delete] 目标组ID:', currentGroupId)
+
+      const success = []
+      const notFound = []
+      const skipped = []
+
+      for (const url of urls) {
+        try {
+          // 检查文件是否存在
+          const fileConfig = await groupManager.getGroupFileConfig(currentGroupId, url)
+
+          if (!fileConfig) {
+            // 文件不存在（暂存区数据），前端自行处理
+            notFound.push(url)
+            continue
+          }
+
+          if (fileConfig.locked) {
+            skipped.push(url)
+            continue
+          }
+
+          // 删除物理文件
+          await storageAdapter.removeFile(`${currentGroupId}/${url}`)
+          // 删除配置
+          await groupManager.removeGroupFileConfig(currentGroupId, url)
+
+          success.push(url)
+        } catch (error) {
+          console.error('[batch-delete] 删除失败:', url, error)
+          // 删除失败也归类到 notFound（可能文件已被其他操作删除）
+          notFound.push(url)
+        }
+      }
+
+      const message = `成功: ${success.length}, 不存在: ${notFound.length}, 跳过: ${skipped.length}`
+      ctx.body = createSuccessResponse({ success, notFound, skipped }, message)
+    } catch (error) {
+      ctx.body = createErrorResponse(error.message)
+    }
+  })
+}

package/lib/uiServer/router/files/file-config-router.js

@@ -0,0 +1,118 @@
+/**
+ * 文件名: file-config-router.js
+ * 功能: 文件配置路由（mock 开关、锁定开关）
+ * 依赖: util.js, validator.js, router-helpers.js
+ *
+ * 职责:
+ * - 切换 mock 状态（启用/禁用 mock）
+ * - 切换锁定状态（防止误删）
+ *
+ * 路由:
+ * - POST /cgi-bin/mockbubu/update-api-mock - 更新 mock 开关
+ * - POST /cgi-bin/mockbubu/update-api-lock - 更新锁定开关
+ */
+
+const { createSuccessResponse } = require('../../utils/util')
+const {
+  validateFilename,
+  validateBoolean,
+  validate,
+} = require('../../utils/validator')
+const { wrapRouteHandler } = require('../../utils/router-helpers')
+
+module.exports = (router) => {
+  /**
+   * 更新 mock 开关
+   *
+   * 功能:
+   * - 切换文件的 mock 状态
+   * - 更新 mockTime 时间戳
+   *
+   * 请求体:
+   * ```javascript
+   * {
+   *   name: 'https://api.example.com/users',  // 文件名（URL）
+   *   mock: true                              // mock 状态（true/false）
+   * }
+   * ```
+   *
+   * 响应:
+   * ```javascript
+   * {
+   *   code: 0,
+   *   data: null,
+   *   msg: '更新成功'
+   * }
+   * ```
+   *
+   * 工作原理:
+   * - mock = true: 启用 mock，请求返回缓存的响应
+   * - mock = false: 禁用 mock，请求代理到真实服务器
+   */
+  router.post('/cgi-bin/mockbubu/update-api-mock', validate({
+    name: validateFilename,
+    mock: (val) => validateBoolean(val, 'mock'),
+  }), wrapRouteHandler(async (ctx) => {
+    const { groupManager } = ctx
+    const { name, mock } = ctx.request.body
+
+    const currentGroupId = await groupManager.getCurrentGroupId()
+    const fileConfig = await groupManager.getGroupFileConfig(currentGroupId, name)
+
+    fileConfig.mock = mock
+    fileConfig.mockTime = Date.now()
+
+    await groupManager.setGroupFileConfig(currentGroupId, name, fileConfig)
+
+    // 返回更新后的配置（包含 mockTime）
+    ctx.body = createSuccessResponse({
+      mock: fileConfig.mock,
+      mockTime: fileConfig.mockTime,
+    }, '更新成功')
+  }, '更新mock开关'))
+
+  /**
+   * 更新锁定开关
+   *
+   * 功能:
+   * - 切换文件的锁定状态
+   * - 锁定后无法删除（防止误删重要 mock）
+   *
+   * 请求体:
+   * ```javascript
+   * {
+   *   name: 'https://api.example.com/users',  // 文件名（URL）
+   *   locked: true                            // 锁定状态（true/false）
+   * }
+   * ```
+   *
+   * 响应:
+   * ```javascript
+   * {
+   *   code: 0,
+   *   data: null,
+   *   msg: '更新成功'
+   * }
+   * ```
+   *
+   * 工作原理:
+   * - locked = true: 文件被锁定，无法删除
+   * - locked = false: 文件未锁定，可以删除
+   */
+  router.post('/cgi-bin/mockbubu/update-api-lock', validate({
+    name: validateFilename,
+    locked: (val) => validateBoolean(val, 'locked'),
+  }), wrapRouteHandler(async (ctx) => {
+    const { groupManager } = ctx
+    const { name, locked } = ctx.request.body
+
+    const currentGroupId = await groupManager.getCurrentGroupId()
+    const fileConfig = await groupManager.getGroupFileConfig(currentGroupId, name)
+
+    fileConfig.locked = locked
+
+    await groupManager.setGroupFileConfig(currentGroupId, name, fileConfig)
+
+    ctx.body = createSuccessResponse(null, '更新成功')
+  }, '更新锁定开关'))
+}

package/lib/uiServer/router/files/file-crud-router.js

@@ -0,0 +1,212 @@
+/**
+ * 文件名: file-crud-router.js
+ * 功能: 文件 CRUD 路由（读取、更新、删除）
+ * 依赖: utils.js, util.js, validator.js
+ *
+ * 职责:
+ * - 获取文件详情（包含 session 数据）
+ * - 更新文件内容
+ * - 删除文件（支持锁定保护）
+ *
+ * 路由:
+ * - POST /cgi-bin/mockbubu/get-api-data - 获取文件详情
+ * - POST /cgi-bin/mockbubu/update-api-data - 更新文件内容
+ * - POST /cgi-bin/mockbubu/delete-api - 删除文件
+ */
+
+const {
+  updateFile,
+  readFile,
+  readSession,
+} = require('../../../utils/utils')
+const {
+  createErrorResponse,
+  createSuccessResponse,
+} = require('../../utils/util')
+const {
+  validateFilename,
+  validateMockData,
+  validate,
+} = require('../../utils/validator')
+
+module.exports = (router) => {
+  /**
+   * 获取文件详情
+   *
+   * 功能:
+   * - 读取文件内容
+   * - 读取完整 session 数据（req + res）
+   * - 读取文件配置（mock 状态、锁定状态等）
+   *
+   * 请求体:
+   * ```javascript
+   * {
+   *   name: 'https://api.example.com/users'  // 文件名（URL）
+   * }
+   * ```
+   *
+   * 响应:
+   * ```javascript
+   * {
+   *   code: 0,
+   *   data: {
+   *     name: 'https://api.example.com/users',
+   *     data: '{"data": [...]}',              // 响应体内容
+   *     session: {                             // 完整 session 数据
+   *       req: {...},                          // 请求信息
+   *       res: {...}                           // 响应信息
+   *     },
+   *     mock: false,                           // mock 状态
+   *     locked: false,                         // 锁定状态
+   *     mockTime: 1762891525570
+   *   },
+   *   msg: 'success'
+   * }
+   * ```
+   */
+  router.post('/cgi-bin/mockbubu/get-api-data', validate({
+    name: validateFilename,
+  }), async (ctx) => {
+    try {
+      const { storageAdapter } = ctx
+      const { groupManager } = ctx
+      const { name } = ctx.request.body
+
+      const currentGroupId = await groupManager.getCurrentGroupId()
+
+      const file = await readFile(storageAdapter, name, currentGroupId)
+      const session = await readSession(storageAdapter, name, currentGroupId)
+      const config = await groupManager.getGroupFileConfig(currentGroupId, name)
+
+      ctx.body = createSuccessResponse({
+        ...config,
+        name,
+        data: file,
+        session, // 包含完整的 req 和 res 数据
+      })
+    } catch (error) {
+      ctx.body = createErrorResponse(error.message)
+    }
+  })
+
+  /**
+   * 更新文件内容
+   *
+   * 功能:
+   * - 更新 mock 文件的响应体内容
+   * - 仅更新 res.body 字段
+   * - 返回更新后的文件信息
+   *
+   * 请求体:
+   * ```javascript
+   * {
+   *   name: 'https://api.example.com/users',  // 文件名（URL）
+   *   data: { data: [...] }                   // 新的响应数据（对象）
+   * }
+   * ```
+   *
+   * 响应:
+   * ```javascript
+   * {
+   *   code: 0,
+   *   data: {
+   *     name: 'https://api.example.com/users',
+   *     data: '{"data": [...]}',              // 更新后的内容
+   *     mock: false,
+   *     locked: false,
+   *     mockTime: 1762891525570
+   *   },
+   *   msg: 'success'
+   * }
+   * ```
+   */
+  router.post('/cgi-bin/mockbubu/update-api-data', validate({
+    name: validateFilename,
+    data: validateMockData,
+  }), async (ctx) => {
+    try {
+      const { storageAdapter } = ctx
+      const { groupManager } = ctx
+      const { name, data } = ctx.request.body
+
+      const currentGroupId = await groupManager.getCurrentGroupId()
+
+      await updateFile(storageAdapter, name, data, currentGroupId)
+      const file = await readFile(storageAdapter, name, currentGroupId)
+      const config = await groupManager.getGroupFileConfig(currentGroupId, name)
+
+      ctx.body = createSuccessResponse({
+        ...config,
+        name,
+        data: file,
+      })
+    } catch (error) {
+      ctx.body = createErrorResponse(error.message)
+    }
+  })
+
+  /**
+   * 删除文件（智能删除）
+   *
+   * 功能:
+   * - 删除物理文件
+   * - 删除文件配置
+   * - 支持锁定保护（锁定的文件无法删除）
+   *
+   * 请求体:
+   * ```javascript
+   * {
+   *   name: 'https://api.example.com/users',  // 文件名（URL）
+   *   groupId: 'default'                      // 可选，目标组ID
+   * }
+   * ```
+   *
+   * 响应:
+   * ```javascript
+   * {
+   *   code: 0,
+   *   data: null,
+   *   msg: '删除成功'
+   * }
+   * ```
+   *
+   * 错误处理:
+   * - 如果文件被锁定，返回错误信息
+   */
+  router.post('/cgi-bin/mockbubu/delete-api', validate({
+    name: validateFilename,
+  }), async (ctx) => {
+    try {
+      const { storageAdapter } = ctx
+      const { groupManager } = ctx
+      const { name, groupId } = ctx.request.body
+
+      // 优先使用传入的 groupId，否则使用当前组ID
+      const targetGroupId = groupId || await groupManager.getCurrentGroupId()
+
+      // [mockbubu] 单文件删除日志 (delete-api)
+      console.log('[mockbubu] delete-api 开始', new Date().toLocaleString('zh-CN', { hour12: false }))
+      console.log('[mockbubu] 待删除文件:', name)
+      console.log('[mockbubu] 目标组ID:', targetGroupId)
+
+      // ✅ 检查文件是否被锁定
+      const fileConfig = await groupManager.getGroupFileConfig(targetGroupId, name)
+      if (fileConfig && fileConfig.locked) {
+        console.log('[mockbubu] delete-api 失败: 文件已锁定', name)
+        ctx.body = createErrorResponse('文件已锁定，无法删除')
+        return
+      }
+
+      // 完全隔离架构：直接删除物理文件 + 组配置
+      // 注意：storageAdapter.removeFile 是 async 方法，必须 await
+      await storageAdapter.removeFile(`${targetGroupId}/${name}`)
+      await groupManager.removeGroupFileConfig(targetGroupId, name)
+
+      console.log('[mockbubu] delete-api 删除成功:', name)
+
+      ctx.body = createSuccessResponse(null, '删除成功')
+    } catch (error) {
+      ctx.body = createErrorResponse(error.message)
+    }
+  })
+}