whistle.mockbubu 2.0.0 → 2.1.0

package/lib/storage/group-manager.js

@@ -0,0 +1,627 @@
+/**
+ * 文件名: group-manager.js
+ * 功能: Mock 数据分组管理器
+ * 依赖: storage-adapter.js, logger.js, const.js
+ * 更新: 2025-12-04
+ *
+ * 职责:
+ * - 管理多个 Mock 数据组，每个组有独立的 mock 配置
+ * - 提供组的 CRUD 操作（创建、读取、更新、删除）
+ * - 管理组内文件配置和版本数据
+ * - 支持组间配置复制
+ *
+ * 架构特点:
+ * - 使用 V3 文件系统存储
+ * - 支持版本管理（通过 V3 Storage）
+ *
+ * 使用示例:
+ * ```javascript
+ * const manager = new GroupManager(storage)
+ * const newGroup = await manager.createGroup({ name: '测试组' })
+ * await manager.setCurrentGroup(newGroup.id)
+ * ```
+ */
+
+const { createLogger } = require('../utils/logger')
+const { SystemConstants, BusinessRules } = require('../config/const')
+const { buildConfigKey } = require('../utils/path-utils')
+
+class GroupManager {
+  /**
+   * 构造函数
+   *
+   * @param {StorageAdapter} storage - 存储适配器实例
+   */
+  constructor(storage) {
+    this.storage = storage
+    this.logger = createLogger('group-manager')
+
+    // 使用 SystemConstants 中的常量
+    this.GROUPS_KEY = SystemConstants.GROUPS_META_KEY
+    this.DEFAULT_GROUP_ID = SystemConstants.DEFAULT_GROUP_ID
+    this.DEFAULT_GROUP_NAME = SystemConstants.DEFAULT_GROUP_NAME
+
+    // 初始化：确保默认组存在
+    this.ensureDefaultGroup()
+  }
+
+  /**
+   * 确保默认组存在
+   */
+  async ensureDefaultGroup() {
+    const groupsData = await this.getGroupsData()
+    if (!groupsData || !groupsData.groups || groupsData.groups.length === 0) {
+      // 首次使用，创建默认组
+      const defaultGroup = {
+        id: this.DEFAULT_GROUP_ID,
+        name: this.DEFAULT_GROUP_NAME,
+        description: '系统默认分组',
+        createTime: Date.now(),
+        updateTime: Date.now(),
+        isDefault: true,
+      }
+
+      await this.setGroupsData({
+        groups: [defaultGroup],
+        currentGroupId: this.DEFAULT_GROUP_ID,
+      })
+    }
+  }
+
+  /**
+   * 获取组列表数据（内部方法）
+   * 从 _meta.json 读取
+   *
+   * @private
+   * @returns {Promise<Object>} 组列表数据
+   * @property {Array} groups - 组列表
+   * @property {string} currentGroupId - 当前激活的组ID
+   */
+  async getGroupsData() {
+    const v3Storage = this.storage.getV3Storage()
+    return await v3Storage.getGroupsMeta()
+  }
+
+  /**
+   * 保存组列表数据（内部方法）
+   * 写入 _meta.json
+   *
+   * @private
+   * @param {Object} data - 组列表数据
+   * @returns {Promise<void>}
+   */
+  async setGroupsData(data) {
+    const v3Storage = this.storage.getV3Storage()
+    await v3Storage.setGroupsMeta(data)
+  }
+
+  /**
+   * 获取所有组
+   */
+  async getGroups() {
+    const data = await this.getGroupsData()
+    return data.groups || []
+  }
+
+  /**
+   * 获取当前组ID
+   */
+  async getCurrentGroupId() {
+    const data = await this.getGroupsData()
+    return data.currentGroupId || this.DEFAULT_GROUP_ID
+  }
+
+  /**
+   * 获取当前组信息
+   */
+  async getCurrentGroup() {
+    const currentId = await this.getCurrentGroupId()
+    const groups = await this.getGroups()
+    return groups.find(g => g.id === currentId) || groups[0]
+  }
+
+  /**
+   * 设置当前组
+   */
+  async setCurrentGroup(groupId) {
+    const groups = await this.getGroups()
+    const group = groups.find(g => g.id === groupId)
+
+    if (!group) {
+      throw new Error(`组不存在: ${groupId}`)
+    }
+
+    const data = await this.getGroupsData()
+    data.currentGroupId = groupId
+    await this.setGroupsData(data)
+
+    return group
+  }
+
+  /**
+   * 生成唯一组ID
+   */
+  generateGroupId() {
+    return 'group_' + Date.now() + '_' + Math.random().toString(36).substr(2, 9)
+  }
+
+  /**
+   * 创建新组
+   * @param {Object} params
+   * @param {string} params.name - 组名
+   * @param {string} params.description - 组描述
+   * @param {string} params.copyFromGroupId - 从哪个组复制（可选）
+   */
+  async createGroup({ name, description = '', copyFromGroupId = null }) {
+    if (!name || !name.trim()) {
+      throw new Error('组名不能为空')
+    }
+
+    const groups = await this.getGroups()
+
+    // 检查组名是否重复
+    if (groups.some(g => g.name === name)) {
+      throw new Error('组名已存在')
+    }
+
+    // 检查组数量限制（使用业务规则常量）
+    if (groups.length >= BusinessRules.MAX_GROUPS) {
+      throw new Error(`组数量已达上限（${BusinessRules.MAX_GROUPS}个）`)
+    }
+
+    const newGroupId = this.generateGroupId()
+
+    // V3 架构：直接调用 V3 Storage 的 createGroup
+    const v3Storage = this.storage.getV3Storage()
+    const newGroup = await v3Storage.createGroup({
+      id: newGroupId,
+      name: name.trim(),
+      description: description.trim(),
+      isDefault: false,
+    })
+
+    // 如果指定了复制源，复制配置
+    if (copyFromGroupId) {
+      await this.copyGroupConfigs(copyFromGroupId, newGroup.id)
+    }
+
+    return newGroup
+  }
+
+  /**
+   * 更新组信息
+   */
+  async updateGroup(groupId, { name, description }) {
+    const groups = await this.getGroups()
+    const groupIndex = groups.findIndex(g => g.id === groupId)
+
+    if (groupIndex === -1) {
+      throw new Error(`组不存在: ${groupId}`)
+    }
+
+    // 检查新名称是否与其他组重复
+    if (name && groups.some((g, idx) => idx !== groupIndex && g.name === name)) {
+      throw new Error('组名已存在')
+    }
+
+    // V3 架构：直接调用 V3 Storage 的 updateGroup
+    const v3Storage = this.storage.getV3Storage()
+    const updates = {}
+    if (name) updates.name = name.trim()
+    if (description !== undefined) updates.description = description.trim()
+
+    const updatedGroup = await v3Storage.updateGroup(groupId, updates)
+    return updatedGroup
+  }
+
+  /**
+   * 删除组
+   *
+   * @param {Object} options - 删除选项
+   * @param {Function} options.memoryBuffer - 内存缓冲区实例（可选）
+   */
+  async deleteGroup(groupId, options = {}) {
+    if (groupId === this.DEFAULT_GROUP_ID) {
+      throw new Error('不能删除默认组')
+    }
+
+    const groups = await this.getGroups()
+    const groupIndex = groups.findIndex(g => g.id === groupId)
+
+    if (groupIndex === -1) {
+      throw new Error(`组不存在: ${groupId}`)
+    }
+
+    // 如果删除的是当前组，先切换到默认组
+    const currentGroupId = await this.getCurrentGroupId()
+    if (currentGroupId === groupId) {
+      // 使用 setCurrentGroup 同时更新 storage adapter 和 _meta.json
+      await this.setCurrentGroup(this.DEFAULT_GROUP_ID)
+    }
+
+    // 清理内存缓冲区中对应组的数据（如果提供了 memoryBuffer）
+    if (options.memoryBuffer && typeof options.memoryBuffer.clearGroup === 'function') {
+      options.memoryBuffer.clearGroup(groupId)
+      this.logger.log(`删除组时清理内存缓冲区: ${groupId}`)
+    }
+
+    // V3 架构：直接调用 V3 Storage 的 deleteGroup
+    const v3Storage = this.storage.getV3Storage()
+    await v3Storage.deleteGroup(groupId)
+  }
+
+  /**
+   * 获取组的配置键名
+   * 使用统一的 buildConfigKey 工具函数
+   *
+   * @param {string} groupId - 组ID
+   * @param {string} filename - 文件名
+   * @returns {string} 配置键，格式：group.{groupId}.file.{filename}
+   */
+  getGroupConfigKey(groupId, filename) {
+    return buildConfigKey(groupId, filename)
+  }
+
+  /**
+   * 获取组的文件配置
+   */
+  async getGroupFileConfig(groupId, filename) {
+    // V3 架构：从索引查找 fileId，再读取 file.json
+    const v3Storage = this.storage.getV3Storage()
+
+    try {
+      // ⚠️ 强制刷新索引缓存
+      v3Storage.invalidateIndex(groupId)
+
+      // 从索引查找对应的 fileId（因为 fileId 是随机生成的）
+      const index = await v3Storage.getIndex(groupId)
+      const indexEntry = index.files.find(f => f.url === filename)
+
+      if (!indexEntry) {
+        // 文件不存在，返回默认配置（首次捕获）
+        return {
+          url: filename,
+          method: 'GET',
+          status: 0,
+          date: Date.now(),
+          mock: false,
+          locked: false,
+          mockVersion: 'source',
+          mockTime: null,
+        }
+      }
+
+      // 读取完整的文件数据
+      const file = await v3Storage.getFile(groupId, indexEntry.id)
+
+      // 返回完整的文件信息（包含 config + 元数据 + 版本数据）
+      // 提取所有版本相关字段（version.* 和 versionMeta.*）
+      const versionFields = {}
+      Object.keys(file).forEach(key => {
+        if (key.startsWith('version.') || key.startsWith('versionMeta.')) {
+          versionFields[key] = file[key]
+        }
+      })
+
+      // 从 session.url 提取 query 参数(包含完整 URL 和 query)
+      // 注意: file.url 可能被 ruleValue 截断(如 pathname 模式会去掉 query)
+      const query = this._extractQueryFromUrl(file.session?.url || file.url)
+
+      // 从 session 提取 payload
+      const payload = this._extractPayloadFromSession(file.session)
+
+      return {
+        url: file.url,
+        method: file.method,
+        status: file.status,
+        date: file.date || file.createTime, // 优先使用 file.date,兼容旧数据使用 createTime
+        rule: file.rule || '',
+        ruleValue: file.ruleValue || '',
+        pattern: file.pattern || '',
+        ...file.config,
+        ...versionFields, // 包含所有版本数据
+        query, // ✨ 从 URL 提取的 query 参数
+        payload, // ✨ 从 session 提取的 payload
+      }
+    } catch (err) {
+      // 读取失败，返回默认配置
+      return {
+        url: filename,
+        method: 'GET',
+        status: 0,
+        date: Date.now(),
+        mock: false,
+        locked: false,
+        mockVersion: 'source',
+        mockTime: null,
+      }
+    }
+  }
+
+  /**
+   * 设置组的文件配置
+   * V3 架构：从索引查找 fileId，再更新 file.json
+   */
+  async setGroupFileConfig(groupId, filename, config) {
+    const v3Storage = this.storage.getV3Storage()
+
+    try {
+      // ⚠️ 强制刷新索引缓存
+      v3Storage.invalidateIndex(groupId)
+
+      // 从索引查找对应的 fileId
+      const index = await v3Storage.getIndex(groupId)
+      const indexEntry = index.files.find(f => f.url === filename)
+
+      let fileId
+      let file = null
+
+      if (indexEntry) {
+        // 文件已存在，使用现有的 fileId
+        fileId = indexEntry.id
+        try {
+          file = await v3Storage.getFile(groupId, fileId)
+        } catch (err) {
+          // 文件读取失败（可能物理文件丢失），忽略
+        }
+      } else {
+        // 文件不存在，生成新的 fileId
+        fileId = v3Storage.generateFileId()
+      }
+
+      // 合并配置到 config 字段
+      const mergedConfig = {
+        mock: config.mock !== undefined ? config.mock : (file?.config?.mock || false),
+        locked: config.locked !== undefined ? config.locked : (file?.config?.locked || false),
+        mockVersion: config.mockVersion !== undefined ? config.mockVersion : (file?.config?.mockVersion || 'source'),
+        mockTime: config.mockTime !== undefined ? config.mockTime : (file?.config?.mockTime || null),
+      }
+
+      // 构建更新数据：仅包含非 config 字段 + config 对象
+      const updates = {
+        config: mergedConfig,
+        updateTime: Date.now(),
+      }
+
+      // 如果 config 包含非配置字段（如 url, method, status等），单独添加
+      const configFields = ['mock', 'locked', 'mockVersion', 'mockTime']
+      Object.keys(config).forEach(key => {
+        if (!configFields.includes(key)) {
+          updates[key] = config[key]
+        }
+      })
+
+      // 更新文件（如果文件不存在，updateFile会自动创建）
+      await v3Storage.updateFile(groupId, fileId, updates)
+
+      this.logger.log(`setGroupFileConfig: ${file ? '更新' : '创建'} ${groupId}/${fileId}`)
+    } catch (err) {
+      this.logger.error(`setGroupFileConfig 失败: ${err.message}`)
+      throw err
+    }
+  }
+
+  /**
+   * 复制组配置（从源组到目标组）
+   * 包括：配置元数据 + 物理文件数据
+   * 深拷贝会自动包含所有嵌套的版本配置（version.xxx、versionMeta.xxx）
+   */
+  async copyGroupConfigs(sourceGroupId, targetGroupId) {
+    // V3 架构：直接调用 V3 Storage 的 copyGroup
+    const v3Storage = this.storage.getV3Storage()
+    const copiedCount = await v3Storage.copyGroup(sourceGroupId, targetGroupId)
+    this.logger.log(`V3架构组复制完成: ${sourceGroupId} -> ${targetGroupId}, 共 ${copiedCount} 个文件`)
+  }
+
+  /**
+   * 删除组的文件配置
+   * V3 架构：配置存储在 file.json 中,随文件一起删除,无需单独删除
+   * @param {string} groupId - 组ID
+   * @param {string} filename - 文件名
+   */
+  async removeGroupFileConfig(groupId, filename) {
+    // V3 架构：配置已随文件删除,无需额外操作
+    this.logger.log('removeGroupFileConfig (V3): 配置已在 file.json 中,随文件一起删除')
+  }
+
+
+  /**
+   * 获取组的版本列表
+   * V3 架构：从文件系统读取版本列表
+   */
+  async getGroupVersions(groupId, filename) {
+    const v3Storage = this.storage.getV3Storage()
+
+    try {
+      // 从索引查找文件ID
+      const index = await v3Storage.getIndex(groupId)
+      const fileEntry = index.files.find(f => f.url === filename)
+
+      if (!fileEntry) {
+        return []
+      }
+
+      // 使用 V3 Storage 的 listVersions 方法
+      const versions = await v3Storage.listVersions(groupId, fileEntry.id)
+
+      // 映射字段保持兼容（前端可能使用 filename 字段）
+      return versions.map(v => ({
+        id: v.id, // ✅ 添加 id 字段
+        name: v.name,
+        filename: v.name, // 保留 filename 用于兼容
+        content: v.content,
+        description: v.description || '',
+        createTime: v.createTime || 0,
+        updateTime: v.updateTime || 0,
+      }))
+    } catch (err) {
+      this.logger.error('获取版本列表失败:', err.message)
+      return []
+    }
+  }
+
+  /**
+   * 获取组的版本内容
+   * V3 架构：从文件系统读取版本内容
+   */
+  async getGroupVersionContent(groupId, filename, versionName) {
+    const v3Storage = this.storage.getV3Storage()
+
+    try {
+      // 从索引查找文件ID
+      const index = await v3Storage.getIndex(groupId)
+      const fileEntry = index.files.find(f => f.url === filename)
+
+      if (!fileEntry) {
+        return null
+      }
+
+      // 通过版本名称获取版本
+      const version = await v3Storage.getVersionByName(groupId, fileEntry.id, versionName)
+
+      return version ? version.content : null
+    } catch (err) {
+      this.logger.error('获取版本内容失败:', err.message)
+      return null
+    }
+  }
+
+  /**
+   * 从 URL 提取 query 参数
+   * @param {string} url - 完整的 URL
+   * @returns {Object} query 参数对象
+   */
+  _extractQueryFromUrl(url) {
+    try {
+      const urlObj = new URL(url)
+      const query = {}
+      urlObj.searchParams.forEach((value, key) => {
+        query[key] = value
+      })
+      return query
+    } catch (err) {
+      // URL 解析失败，返回空对象
+      return {}
+    }
+  }
+
+  /**
+   * 从 session 提取 payload (请求 body)
+   * @param {Object} session - Whistle session 对象
+   * @returns {Object} 返回 { raw: string, parsed: Object|null, type: string }
+   */
+  _extractPayloadFromSession(session) {
+    if (!session || !session.req) {
+      return { raw: '', parsed: null, type: 'empty' }
+    }
+
+    // 从 session.req.body 提取 payload
+    let body = session.req.body || ''
+
+    // 如果 body 是对象，转换为 JSON 字符串
+    if (typeof body === 'object') {
+      try {
+        return {
+          raw: JSON.stringify(body, null, 2),
+          parsed: body,
+          type: 'json',
+        }
+      } catch (err) {
+        return { raw: '', parsed: null, type: 'empty' }
+      }
+    }
+
+    // 字符串类型的 body
+    if (typeof body !== 'string') {
+      body = String(body)
+    }
+
+    // 尝试解析不同格式的 payload
+    const parsed = this._parsePayload(body, session)
+
+    return {
+      raw: body,
+      parsed,
+      type: parsed ? (parsed.type || 'unknown') : 'raw',
+    }
+  }
+
+  /**
+   * 解析 payload 为键值对
+   * @param {string} body - 请求体字符串
+   * @param {Object} session - session 对象(用于获取 Content-Type)
+   * @returns {Object|null} 解析后的键值对,或 null
+   */
+  _parsePayload(body, session) {
+    if (!body) return null
+
+    const contentType = session.req?.headers?.[' content-type'] || session.req?.headers?.['content-type'] || ''
+
+    // 1. multipart/form-data
+    if (contentType.includes('multipart/form-data') || body.includes('Content-Disposition: form-data')) {
+      return this._parseMultipartFormData(body)
+    }
+
+    // 2. application/x-www-form-urlencoded
+    if (contentType.includes('application/x-www-form-urlencoded') || (body.includes('=') && !body.includes('\n'))) {
+      return this._parseUrlEncoded(body)
+    }
+
+    // 3. application/json
+    if (contentType.includes('application/json')) {
+      try {
+        return {
+          type: 'json',
+          data: JSON.parse(body),
+        }
+      } catch (err) {
+        // JSON 解析失败,返回 null
+      }
+    }
+
+    return null
+  }
+
+  /**
+   * 解析 multipart/form-data 格式
+   */
+  _parseMultipartFormData(body) {
+    const result = {}
+    const boundaryMatch = body.match(/------[^\r\n]+/)
+    if (!boundaryMatch) return null
+
+    const boundary = boundaryMatch[0]
+    const parts = body.split(boundary).filter(part => part.trim() && part !== '--')
+
+    parts.forEach(part => {
+      const nameMatch = part.match(/name="([^"]+)"/)
+      if (nameMatch) {
+        const name = nameMatch[1]
+        const valueMatch = part.match(/\r\n\r\n([\s\S]*?)\r\n/)
+        if (valueMatch) {
+          result[name] = valueMatch[1].trim()
+        }
+      }
+    })
+
+    return Object.keys(result).length > 0 ? { type: 'form-data', data: result } : null
+  }
+
+  /**
+   * 解析 application/x-www-form-urlencoded 格式
+   */
+  _parseUrlEncoded(body) {
+    try {
+      const params = new URLSearchParams(body)
+      const result = {}
+      params.forEach((value, key) => {
+        result[key] = value
+      })
+      return Object.keys(result).length > 0 ? { type: 'urlencoded', data: result } : null
+    } catch (err) {
+      return null
+    }
+  }
+}
+
+module.exports = GroupManager