datai/datai-scenes/datai-scene-salesforce/docs/requirements/REQ-010-9.md
Kris 2e6f087732 docs: 完成REQ-010-17和REQ-010-2的文档创建
- 完成REQ-010-17(性能优化和限流处理)的所有6个阶段
  - 创建ADR文档:0026-performance-optimization.md
  - 创建Prompt文档:027-performance-optimization.md
  - 创建会话记录:20260119-performance-optimization.md
  - 创建变更记录:20260119-performance-optimization.md
  - 创建复盘报告:20260119-performance-optimization-retro.md
  - 更新index.md和CHANGELOG.md

- 完成REQ-010-2(基础实体类和Mapper创建)的前3个阶段
  - 更新ADR文档:0011-entity-mapper-create.md
  - 创建Prompt文档:002-entity-mapper-create.md
  - 更新index.md

所有文档均按照SSOT方法论创建,包括需求定义、架构决策、提示词资产化、执行会话、变更记录和闭环复盘。
2026-01-19 10:06:09 +08:00

150 lines
5.5 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# Requirements - Quick Deploy功能实现
## 需求信息
- **需求名称**: Quick Deploy功能实现
- **需求类型**: 功能需求
- **需求编号**: REQ-010-9
- **父需求**: REQ-010
- **创建日期**: 2026-01-17
- **需求版本**: v1.0.0
- **需求提出人**: 系统管理员
- **需求状态**: 待审核
## 输入引用
引用相关的 docs 文档链接:
- [REQ-010.md](REQ-010.md) - Salesforce元数据拉取和部署主需求文档
- [REQ-010-1.md](REQ-010-1.md) - 数据库表结构设计和创建
- [REQ-010-2.md](REQ-010-2.md) - 基础实体类和Mapper创建
- [REQ-010-8.md](REQ-010-8.md) - 元数据部署核心功能
- [004-元数据部署网页资料链接地址](../reference-code/metadata/004-元数据部署网页资料链接地址) - 官方文档和开源项目参考
- [010-metadata-retrieve-deploy-sub-requirements.md](010-metadata-retrieve-deploy-sub-requirements.md) - REQ-010子需求拆分文档
- [metadata-module.md](../reference-code/com/docs/metadata-module.md) - Salesforce Metadata API 模块说明(唯一真源)
- [index.md](../reference-code/com/docs/index.md) - Salesforce SOAP API Java 客户端参考文档(唯一真源)
## Context Maps
强制列出本次需求依赖的 Canvas 文件:
- [Authentication.canvas](../Authentication.canvas) - 项目架构视觉化展示
- **相关节点**: [集成核心](node_integration_core) - 提供与Salesforce的各种连接方式
## 需求目标
实现Quick Deploy功能支持基于最近一次成功的部署记录快速重新部署无需重新运行测试。
## 需求描述
### 概述
本需求旨在实现Quick Deploy功能包括Quick Deploy触发、Quick Deploy历史记录、Quick Deploy状态监控、Quick Deploy结果解析等。
### 详细需求
#### 1. Quick Deploy触发
- **需求描述**: 实现Quick Deploy触发功能基于最近一次成功的部署记录
- **优先级**: 高
- **验收标准**:
- Quick Deploy触发成功
- 支持选择最近一次成功的部署记录
- 支持Quick Deploy验证
- 触发成功返回Job ID
- API接口符合RESTful规范
- **依赖关系**: 依赖于REQ-010-1, REQ-010-2, REQ-010-8
- **实现建议**: 使用MetadataApiClient调用quickDeploy()方法使用部署历史记录验证Quick Deploy可用性
#### 2. Quick Deploy历史记录
- **需求描述**: 实现Quick Deploy历史记录功能
- **优先级**: 高
- **验收标准**:
- Quick Deploy历史记录成功
- 支持分页查询
- 支持条件查询
- 历史记录完整
- **依赖关系**: 依赖于Quick Deploy触发
- **实现建议**: 使用MyBatis Plus的BaseMapper实现历史记录查询
#### 3. Quick Deploy状态监控
- **需求描述**: 实现Quick Deploy状态监控Pending/Processing/Success/Failed
- **优先级**: 高
- **验收标准**:
- 状态监控正常工作
- 使用状态机管理Quick Deploy状态
- 支持状态查询
- 状态更新及时
- **依赖关系**: 依赖于Quick Deploy触发
- **实现建议**: 使用状态机管理Quick Deploy状态使用轮询机制检查Quick Deploy状态
#### 4. Quick Deploy结果解析
- **需求描述**: 实现Quick Deploy结果解析提取错误信息
- **优先级**: 高
- **验收标准**:
- Quick Deploy结果解析成功
- 错误信息提取正确
- 支持多种部署状态
- 错误信息详细
- **依赖关系**: 依赖于Quick Deploy状态监控
- **实现建议**: 使用JSON解析库处理API响应使用正则表达式提取错误信息
## 约束
- **技术栈限制**: 必须基于现有的Spring Boot 3 + Vue 3技术栈
- **架构约束**: 必须遵循Authentication.canvas中定义的架构和调用关系
- **模块约束**: 必须在datai-salesforce-metadata模块下实现
- **数据库约束**: 必须使用MyBatis Plus作为持久层框架
- **API约束**: 必须使用现有的集成核心功能进行Salesforce API调用
- **文档约束**: 必须遵循REQ-010中定义的验收标准
- **依赖约束**: 必须依赖于REQ-010-1, REQ-010-2, REQ-010-8
## Rule Set
"请严格参考 @Authentication.canvas 中的状态机转移逻辑,不要自行发挥。"
**具体规则**
- 必须使用Canvas中定义的类名和方法名
- 必须遵循Canvas中定义的调用关系
- 必须参考Canvas中的流程图逻辑
## 验收标准
- **功能完整性**: 所有Quick Deploy功能能够正常工作
- **性能指标**: Quick Deploy操作快速完成不影响系统响应
- **代码规范性**: 代码符合项目编码规范,有清晰的注释
- **可维护性**: 代码结构清晰,易于扩展和维护
- **可测试性**: 代码易于单元测试和集成测试
## 风险
- **Quick Deploy验证风险**: Quick Deploy验证逻辑复杂可能导致验证不准确
- **状态监控风险**: 状态监控不准确可能导致Quick Deploy状态不一致
- **结果解析风险**: 结果解析不完善可能导致错误信息不准确
- **历史记录风险**: Quick Deploy历史记录过多可能影响查询性能
## 需求变更记录
| 日期 | 变更内容 | 变更原因 | 变更人 | 审核人 | 状态 |
|------|---------|---------|--------|--------|------|
| 2026-01-17 | 创建需求文档 | 初始需求 | 系统管理员 | - | 待审核 |
## 相关人员
- **需求提出人**: 系统管理员 - 联系方式
- **需求负责人**: 系统管理员 - 联系方式
- **技术负责人**: 开发工程师 - 联系方式
- **测试负责人**: 测试工程师 - 联系方式
- **其他相关人员**: - 联系方式
## 评审信息
- **评审日期**: -
- **评审人员**: -
- **评审结果**: -
- **评审意见**: -
- **修改建议**: -