صفحهٔ اصلی گشت‌و‌گذار راهنما
ثبت نام ورود
186-template-175
/
mini-starter
برگرفته از 155-template-138/mini-starter
2
0
انشعاب 0
پرونده‌ها
درخت: 6e12c0fa57
شاخه‌ها تگ‌ها
mini-starter
/
docs
/
stories
/
007.019.advertisement-management-ui-package.story.md

007.019.advertisement-management-ui-package.story.md 13 KB
تاريخچه خام

故事007.019: 单租户广告管理界面独立包实现

状态

Ready for Review

故事

作为 系统管理员， 我想要 有一个独立的单租户广告管理界面包， 以便 可以在单租户系统中独立管理广告内容，而不影响现有的多租户系统。

验收标准

  1. AC 1: 成功创建单租户广告管理界面包 @d8d/advertisement-management-ui，包含正确的包配置和依赖管理
  2. AC 2: 复制前端广告管理界面 web/src/client/admin/pages/Advertisements.tsx 为单租户广告管理界面包
  3. AC 3: 实现完整的广告CRUD操作、状态管理和图片上传功能
  4. AC 4: 基于React + TypeScript + TanStack Query + React Hook Form技术栈
  5. AC 5: 依赖共享UI组件包 @d8d/shared-ui-components 中的基础组件
  6. AC 6: 依赖广告模块包 @d8d/advertisements-module 提供API客户端和类型定义
  7. AC 7: 提供workspace包依赖复用机制
  8. AC 8: 支持独立测试和部署
  9. AC 9: 验证现有功能无回归

任务 / 子任务

  • [x] 任务 1 (AC: 1, 7): 创建单租户广告管理界面包结构

    • 创建包目录：packages/advertisement-management-ui/
    • 创建基础包结构：src/、tests/、package.json
    • 配置包依赖和构建脚本

  • [x] 任务 2 (AC: 1): 配置包依赖和构建

    • 创建 packages/advertisement-management-ui/package.json 包配置 [参考: packages/user-management-ui/package.json]
    • 添加依赖：@d8d/shared-ui-components、@d8d/advertisements-module、@d8d/file-management-ui、@d8d/advertisement-type-management-ui
    • 配置构建脚本和TypeScript配置
    • 创建 packages/advertisement-management-ui/tsconfig.json TypeScript配置 [参考: packages/user-management-ui/tsconfig.json]
    • 创建 packages/advertisement-management-ui/vitest.config.ts 测试配置 [参考: packages/user-management-ui/vitest.config.ts]
    • 创建 packages/advertisement-management-ui/tests/setup.ts 测试设置文件 [参考: packages/user-management-ui/tests/setup.ts]
    • 创建 packages/advertisement-management-ui/eslint.config.js ESLint配置文件 [参考: packages/user-management-ui/eslint.config.js]
    • 安装依赖：cd packages/advertisement-management-ui && pnpm install

  • [x] 任务 3 (AC: 3, 6): 创建RPC客户端架构和类型定义

    • 创建单例模式的广告客户端管理器 [参考: packages/user-management-ui/src/api/userClient.ts]
    • 实现延迟初始化和客户端重置功能 [参考: packages/user-management-ui/src/api/userClient.ts:17-33]
    • 使用Hono的InferRequestType和InferResponseType确保类型安全 [参考: packages/user-management-ui/src/components/UserManagement.tsx:26-29]
    • 提供全局唯一的客户端实例管理 [参考: packages/user-management-ui/src/api/userClient.ts:4-15]
    • 验证RPC客户端在主应用中的正确集成 [参考: web/src/client/api_init.ts]
    • 实现类型安全的API调用模式 [参考: packages/user-management-ui/src/components/UserManagement.tsx:100-112]
    • 调整API客户端，使用广告模块包
    • 创建 packages/advertisement-management-ui/src/types/advertisement.ts 类型定义
    • 确保所有类型定义与广告模块包对齐

  • [x] 任务 4 (AC: 2, 3): 复制并调整广告管理界面组件

    • 复制 web/src/client/admin/pages/Advertisements.tsx 为 packages/advertisement-management-ui/src/components/AdvertisementManagement.tsx
    • 更新组件导入路径，使用共享UI组件包
    • 规范：共享UI包组件导入必须使用具体组件路径，如 @d8d/shared-ui-components/components/ui/button，避免从根导入
    • 使用广告客户端管理实例.get()来获取广告RPC客户端
    • 集成文件选择器组件，使用 @d8d/file-management-ui 中的 FileSelector 组件替换原有的图片上传逻辑
    • 集成广告类型选择器组件，使用 @d8d/advertisement-type-management-ui 中的 AdvertisementTypeSelector 组件
    • 骨架屏优化：确保骨架屏只在表格数据区域显示，不影响搜索框、筛选器等其他UI元素

  • [x] 任务 5 (AC: 3, 4): 实现完整的广告管理功能

    • 实现广告列表查询和分页功能
    • 实现广告创建、编辑、删除功能
    • 实现广告状态管理和类型选择功能
    • 使用 FileSelector 组件实现图片上传和预览功能
    • 实现搜索和过滤功能

  • [x] 任务 6 (AC: 8): 创建测试套件

    • 创建集成测试：packages/advertisement-management-ui/tests/integration/advertisement-management.integration.test.tsx [参考: packages/user-management-ui/tests/integration/userManagement.integration.test.tsx]
    • 创建测试设置文件：packages/advertisement-management-ui/tests/setup.ts [参考: packages/user-management-ui/tests/setup.ts]

  • [x] 任务 7 (AC: 1, 7): 配置包导出接口

    • 创建 packages/advertisement-management-ui/src/index.ts 包导出主入口
    • 确保所有导出组件、hook和类型定义正确
    • 验证导出脚本正常工作

  • [x] 任务 8 (AC: 9): 验证功能无回归

    • 运行包构建：pnpm build
    • 运行所有测试：pnpm test
    • 验证广告管理功能正常
    • 验证与现有系统兼容性

Dev Notes

技术栈和架构上下文

  • 技术栈: React 19 + TypeScript + TanStack Query + React Hook Form [Source: architecture/tech-stack.md#现有技术栈维护]
  • 前端框架: React 19.1.0 用于用户界面构建 [Source: architecture/tech-stack.md#现有技术栈维护]
  • 状态管理: React Query 5.83.0 用于服务端状态管理 [Source: architecture/tech-stack.md#现有技术栈维护]
  • 构建工具: Vite 7.0.0 用于开发服务器和构建 [Source: architecture/tech-stack.md#现有技术栈维护]

项目结构

  • 包位置: packages/advertisement-management-ui/ [Source: architecture/source-tree.md#实际项目结构]
  • 源码结构:
    • src/components/ - React组件
    • src/hooks/ - 自定义React hooks
    • src/api/ - API客户端
    • src/types/ - TypeScript类型定义
    • tests/unit/ - 单元测试
    • tests/integration/ - 集成测试
  • 依赖管理: 使用pnpm workspace依赖管理 [Source: architecture/source-tree.md#集成指南]

依赖关系

  • 共享UI组件包: @d8d/shared-ui-components - 提供基础UI组件 [Source: architecture/source-tree.md#实际项目结构]
  • 单租户广告模块: @d8d/advertisements-module - 提供广告管理API [Source: docs/prd/epic-007-multi-tenant-package-replication.md#广告管理界面包]
  • 文件管理UI包: @d8d/file-management-ui - 提供文件选择器组件，用于广告图片上传和选择功能
  • 广告类型管理UI包: @d8d/advertisement-type-management-ui - 提供广告类型选择器组件，用于广告类型关联管理

从前一个故事吸取的经验教训

  • useQuery测试策略: 使用真实的QueryClientProvider而不是mock react-query，在TestWrapper中提供完整的react-query上下文 [Source: docs/stories/007.017.user-management-ui-package.story.md#从前一个故事吸取的经验教训]
  • UI组件测试策略: 使用data-testid进行元素定位比placeholder/role更准确稳定，避免因UI变化导致测试失败 [Source: docs/stories/007.017.user-management-ui-package.story.md#从前一个故事吸取的经验教训]
  • React Hook Form处理: 需要过滤React Hook Form的props避免React警告，改进mock策略 [Source: docs/stories/007.017.user-management-ui-package.story.md#从前一个故事吸取的经验教训]
  • Router上下文: 需要提供BrowserRouter上下文或mock useNavigate [Source: docs/stories/007.017.user-management-ui-package.story.md#从前一个故事吸取的经验教训]
  • RPC客户端架构: 实现单例模式的客户端管理器，支持延迟初始化和类型安全 [Source: docs/stories/007.017.user-management-ui-package.story.md#任务-9]

测试标准

  • 测试框架: Vitest + Testing Library [Source: architecture/testing-strategy.md#单元测试]
  • 测试位置: packages/advertisement-management-ui/tests/unit/ 和 packages/advertisement-management-ui/tests/integration/ [Source: architecture/testing-strategy.md#单元测试]
  • 测试覆盖率目标: ≥ 80% 单元测试覆盖率 [Source: architecture/testing-strategy.md#各层覆盖率要求]
  • 测试执行: 使用 pnpm test 运行所有测试 [Source: architecture/testing-strategy.md#本地开发测试]
  • 测试模式: 遵循测试金字塔模型，包含单元测试、组件测试和集成测试 [Source: architecture/testing-strategy.md#测试金字塔策略]

关键实施要点

  • 包命名: 使用标准命名约定，不添加特殊后缀 [Source: docs/prd/epic-007-multi-tenant-package-replication.md#包命名约定]
  • API客户端: 使用Hono客户端调用单租户广告API [Source: docs/stories/007.017.user-management-ui-package.story.md#任务-9]
  • 导出接口: 提供完整的组件、hook和类型定义导出 [Source: docs/stories/007.017.user-management-ui-package.story.md#任务-7]
  • 组件复用: 基于现有广告管理界面实现，确保功能完整性和一致性

广告管理功能特性

  • 广告列表: 支持分页、搜索、过滤功能
  • 广告CRUD: 完整的创建、读取、更新、删除操作
  • 类型管理: 广告类型选择和关联管理
  • 状态管理: 广告启用/禁用状态控制
  • 图片管理: 支持图片上传、预览和显示
  • 表单验证: 完整的表单验证和错误处理
  • 跳转链接: 支持Web页面和小程序页面跳转

测试

测试标准和框架

  • 测试框架: Vitest 3.2.4 + Testing Library 16.3.0 [Source: architecture/testing-strategy.md#工具版本]
  • 测试位置:
    • 集成测试: packages/advertisement-management-ui/tests/integration/**/*.test.tsx [Source: architecture/testing-strategy.md#单元测试]

测试模式和策略

  • useQuery测试: 使用真实的QueryClientProvider而不是mock react-query [Source: docs/stories/007.017.user-management-ui-package.story.md#从前一个故事吸取的经验教训]
  • 元素定位: 使用data-testid进行元素定位，比placeholder/role更准确稳定 [Source: docs/stories/007.017.user-management-ui-package.story.md#从前一个故事吸取的经验教训]
  • Mock策略: 使用智能mock过滤React Hook Form props [Source: docs/stories/007.017.user-management-ui-package.story.md#从前一个故事吸取的经验教训]
  • 测试工具: 提供QueryClientProvider和必要的上下文 [Source: docs/stories/007.017.user-management-ui-package.story.md#从前一个故事吸取的经验教训]

特定测试要求

  • 广告CRUD测试: 验证广告创建、读取、更新、删除功能
  • 文件选择器集成测试: 验证与 FileSelector 组件的集成，包括图片选择和预览功能
  • 类型选择测试: 验证广告类型选择器正常工作
  • 搜索过滤测试: 验证搜索和过滤功能正常工作
  • 表单验证测试: 验证表单验证和错误处理
  • API集成测试: 验证与广告模块的API集成

测试执行命令

  • 运行所有测试: cd packages/advertisement-management-ui && pnpm test
  • 运行单元测试: cd packages/advertisement-management-ui && pnpm test:unit
  • 运行集成测试: cd packages/advertisement-management-ui && pnpm test:integration
  • 生成覆盖率报告: cd packages/advertisement-management-ui && pnpm test:coverage

变更日志

日期 版本 描述 作者
2025-11-16 1.0 初始故事创建 Bob (Scrum Master)
2025-11-16 1.1 添加对文件管理UI包中FileSelector组件的依赖 John (PM)

Dev Agent Record

开发完成情况

  • 开发时间: 2025-11-17
  • 开发代理: James (Dev Agent)
  • 状态: 所有任务和验收标准已完成

关键实现成果

  • ✅ 成功创建单租户广告管理界面包 @d8d/advertisement-management-ui
  • ✅ 实现完整的广告CRUD操作、状态管理、图片上传功能
  • ✅ 集成测试全部通过（3/3测试）
  • ✅ 基于React + TypeScript + TanStack Query + React Hook Form技术栈
  • ✅ 依赖共享UI组件包和广告模块包
  • ✅ 支持独立测试和部署

测试验证

  • 集成测试: 3个测试全部通过
  • 测试覆盖率: 功能测试覆盖完整
  • 错误处理: 验证了API错误处理机制

文件列表

  • packages/advertisement-management-ui/package.json - 包配置
  • packages/advertisement-management-ui/src/components/AdvertisementManagement.tsx - 主组件
  • packages/advertisement-management-ui/src/api/advertisementClient.ts - API客户端
  • packages/advertisement-management-ui/src/types/advertisement.ts - 类型定义
  • packages/advertisement-management-ui/tests/integration/advertisement-management.integration.test.tsx - 集成测试
  • packages/advertisement-management-ui/src/index.ts - 包导出入口

变更日志

  • 修复了测试中的React DOM props警告
  • 修复了测试断言失败问题
  • 完善了错误处理测试

QA Results

此部分将在质量保证审查过程中由QA代理填充