Files
ftb-project-management/docs/roadmap.md
72a59f125c docs(ops): 补齐生产 runbook 和 readiness 清单
- 新增迁移回滚、AppData 退场、小宝后台任务 runbook\n- 新增生产 readiness 证据清单和 runbook placeholder 扫描\n- 更新部署文档与路线图到 V2.8 运维闭环阶段\n\nCo-Authored-By: GPT-5 Codex <codex@openai.com>
2026-07-08 16:28:02 +08:00

18 KiB
Raw Blame History

开发路线图

当前阶段V2.8 — 生产硬化稳定版 + 运维闭环

V2.8 的目标是在既有生产 CI/CD 基线上补齐运维闭环:备份恢复演练、发布 smoke test、监控告警、日志检索、迁移回滚 runbook、AppData 退场 runbook、小宝后台化 runbook 和生产 readiness 证据清单。当前执行前提是 V2.4 领域 CRUD 主写迁移已由上游验收完成;本阶段不重新设计业务流程,专注把生产发布和故障处置做成可验证、可复盘、可回滚的标准流程。

当前重点

  1. 备份恢复自动化PostgreSQL dump、server_data volume 备份、fresh DB restore dry-run 和显式覆盖确认。
  2. 发布 smoke testGitHub Actions 部署后自动校验 runtime version、前端根页、产品页、产品 API、V2.2 读路径和 AI 配置。
  3. 监控告警基线Prometheus/Grafana/Loki/Promtail 可选 profile覆盖慢 API、慢 Prisma、任务失败、小宝摘要 stale、磁盘压力和 DB 可用性。
  4. 迁移和后台任务 runbook迁移回滚、AppData 退场、小宝后台化处置步骤、决策点和数据风险。
  5. 生产 readiness 清单backup/restore、smoke、monitoring、audit、RBAC、consistency、performance 和 post-release verification 都要有证据项。

V2 分阶段交付链路

阶段 主题 边界
V2.1 AppData 服务端持久化 业务数据从浏览器 localStorage 迁到服务端 app_data,先解决清站点数据丢失问题。
V2.2 关系表 + 分区 + 快读 API 建高增长领域表、分区键、快读查询和小宝摘要读取,写入仍走 AppData。
V2.3 AppData 写入后同步关系表 AppData 仍是兼容期写入事实源,保存成功后非阻塞同步关系表和风险摘要脏标记。
V2.4 领域 CRUD 主写迁移 逐领域补写 API前端保存迁到领域 API同时埋权限、作用域、审计和分页/索引基础。
V2.5 AppData 分阶段退场 + RBAC/审计/一致性收口 禁写 AppData、移除 fallback、归档/导出旧 JSON正式收紧权限、审计和一致性校验。
V2.6 大数据性能增强 + 小宝预警后台化 在关系表主源稳定后做压测、慢查询治理、缓存/摘要、后台任务、幂等重试和小宝定时预警。
V2.7 企业级协作能力 + 管理治理 补齐通知、协同、组织治理、管理视图、数据治理和企业级配置能力。
V2.8 生产硬化稳定版 + 运维闭环 在现有 CI/CD 基线上补备份恢复演练、发布 smoke test、监控告警、日志检索、迁移回滚和运维手册。

阶段顺序不能倒置:权限/审计骨架从 V2.4 开始随领域 API 落地V2.5 做全面收口;分页、索引、分区键查询从 V2.4 就必须进入 API 设计V2.6 只做增强和压测治理AppData 退场必须按“禁写 → 双读核对 → 移除 fallback → 只读归档/导出 → 后续删表”推进,不能一次性删除历史 JSON。

当前状态快照2026-07-08

  • 项目已经不是早期骨架。前端业务功能已覆盖产品、项目、版本详情、需求池、工作台、成员/角色/任务类型、加班、小宝预警和 AI 配置等主要管理端路由。
  • 版本详情已有需求、调研、产品方案、UI、开发任务、测试用例、Bug、概览等核心 Tab渲染重的路径优先接入 V2.2 关系表快读,并保留 AppData fallback。
  • 后端已落地 Product、Requirement 领域 CRUDDataModule AppData 乐观锁V2.2 快读 APIV2.3 AppData 写后同步关系表AI Provider 抽象和健康版本接口。
  • Prisma schema 已包含 Product、Project、Version、Requirement、VersionPlan、DevTask、TestCase、Bug、WorkActivity、Xiaobao、AiLog、AppData 等关系模型;高增长表的分区 migration 已落地。
  • 本 V2.8 执行线程以前提“V2.4 领域 CRUD 主写迁移已完成验收”推进;本阶段不重新逐项复核领域 API 清单。
  • V2.8 新增运维交付物集中在 scripts/.github/workflows/deploy-production.ymldeploy/monitoring/docs/runbooks/docs/deployment.mddocs/production-readiness.md
  • AppData 退场、RBAC/审计、性能和小宝后台化仍通过 production readiness 证据项追踪,避免把运维稳定版误当成业务治理已全部完成。

已完成(按时间倒序)

2026-07-08

  • V2.8 production ops closure started: added PostgreSQL backup, fresh DB restore with explicit overwrite confirmation, and server_data volume backup automation.
  • Added release smoke suite and wired GitHub Actions deployment verification to runtime version, frontend root, products, V2.2 read path, and AI config checks.
  • Added optional monitoring profile with Prometheus, Grafana, Loki, Promtail, postgres-exporter, node-exporter, cAdvisor, and blackbox-exporter.
  • Added migration rollback, AppData retirement, Xiaobao background jobs runbooks, and production readiness evidence checklist.

2026-07-06

  • Added production CI/CD flow: GitHub Actions builds web and server Docker images, pushes immutable commit-SHA tags to GHCR, deploys by SSH, pulls images on the server, runs pnpm --filter server db:deploy, restarts Compose, and verifies /api/v1/health/version.
  • Added runtime version metadata: backend GET /api/v1/health/version, Docker build args/env, and a frontend refresh banner when browser assets are older than the server runtime.
  • Added pnpm deploy:check-runtime and expanded pnpm deploy:verify so deployment artifacts include workflow, image metadata, and runtime version checks.

2026-07-03

  • V2.3 AppData write-side bridge added: successful PUT /api/v1/data/:key calls now trigger AppDataV23SyncService relation-table sync after optimistic-lock AppData writes.
  • Relation sync reuses the V2.2 mapper and replaces current-state rows by partition scope: requirements by product_id, version plans/dev tasks/test cases/bugs by version_id.
  • Append-only evidence tables continue to use duplicate-skipping inserts for work activities, worklogs, overtime, Xiaobao snapshots, and Xiaobao insights.
  • Xiaobao summaries now refresh from risk snapshots and are marked dirty=true when version risk inputs change.
  • Added lightweight observability: slow API request logging through a global Nest interceptor and slow Prisma query logging through query events.
  • V2.2 partitioned domain schema foundation added: requirements uses HASH partitioning by product_id; dev_tasks, test_cases, and bugs use HASH partitioning by version_id.
  • Partitioned table primary keys and business unique constraints now include partition keys, for example (id, version_id) and (version_id, code).
  • Xiaobao precompute storage foundation added: xiaobao_risk_summaries stores the current version risk, and xiaobao_risk_snapshots stores historical snapshots.
  • Prisma schema now includes the V2.2 relational model skeleton, and the legacy RequirementService now uses the (id, product_id) composite key.
  • AppData V2.2 migration mapper and preview service added, so legacy JSON can be rehearsed into relation-table rows with counts and skipped-record diagnostics before inserts are enabled.
  • V2.2 scoped read API added for version detail, requirement pool, workspace, and Xiaobao warning summaries.
  • Version detail, requirement pool, workspace, sidebar badges, version list Xiaobao indicators, and Xiaobao warning page now prefer V2.2 fast-read data and fall back to AppData only for compatibility.
  • Requirement pool V2.2 queries require productId, avoiding accidental full-table scans against annual hundreds-of-thousands-row data.
  • Xiaobao warning now consumes precomputed xiaobao_risk_summaries before loading heavy AppData task/test/bug/activity documents.
  • V2.2 completion boundary: read hot paths are complete; writes remain on AppData until the relation-table write APIs are enabled.

2026-07-02

  • app_data 读写增加乐观锁版本:GET 返回 version,前端保存携带最近版本,后端用 key + updatedAt 原子更新
  • stale version / create race 返回 409 APP_DATA_CONFLICT,阻止多人同时编辑时的静默覆盖
  • 新增后端 AppData 并发写入回归测试和前端 server-data 版本缓存测试

2026-07-01

  • 补齐云服务器生产部署基线:Dockerfile.webDockerfile.serverdocker-compose.prod.yml、Nginx 反代模板和 .env.production.example
  • 补齐本地服务器/局域网部署基线:docker-compose.local.yml.env.local-server.exampledeploy:local:* 脚本
  • 新增生产数据库初始化 migration并提供 pnpm db:deploy / pnpm --filter server db:deploy
  • 新增 pnpm deploy:verify 校验生产部署文件完整性
  • 新增 docs/deployment.md,覆盖本地开发、云服务器部署、升级、备份和排查流程

2026-06-24

  • 新增 NestJS DataModule + Prisma AppData,提供 GET/PUT /api/v1/data/:key
  • 产品/项目/版本树、需求池、调研/产品方案/UI、开发任务、测试用例、Bug 改为服务端持久化
  • 成员/角色/部门、任务类型、任务工时日志、加班记录改为服务端持久化
  • 登录改为读取服务端成员数据;浏览器只保留登录会话

2026-06-16

  • 项目模块顶部卡片(总版本数/已开发/需求数/Bug 总数)
  • 项目模块版本记录与版本详情数据联动(耗时 + 状态胶囊)
  • 4 份核心文档architecture / decisions / workflow / roadmap

2026-06-15

  • 与我相关:产品/项目/版本树筛选 + 红色待办徽标
  • 与我相关:点击卡片打开 DrawerPlanDetailDrawer 新建DevTask/TestCase/Bug 复用)
  • 全局 Drawer 阴影统一 shadow-2xl + 顶部上下文条
  • 测试用例提 Bug 流程drawer 内点击 → BugCreateModal
  • DevTask + TestCase 转交功能(人员离职场景)
  • 需求池:录入人员自动取当前用户 + 状态列改名(业务状态 / 实际进度)
  • 产品页面:去掉规划中、项目名/版本胶囊可点击跳转

2026-06-14

  • 需求变更模块:变更人员/原因/概述/详细 + 概览统计(变更人员排名 + 原因占比饼图)
  • 计划任务转交(未开始/进行中可转交,从参与人员选)
  • 关联需求增强:描述列 hover 完整内容、需求类型/变更原因/添加日期列
  • 计划时间精确到分钟datetime-local+ 到期自动开始
  • 阶段耗时 + 个人耗时排名(涵盖调研/产品/UI/开发/测试 5 类工作)

2026-06-13

  • DevTask 状态简化:去掉 donesubmitted 是终态
  • 实际工时改为精确时间戳计算(精确到 0.5h
  • TestCase 主归属版本requirement 改为可选标签
  • Bug 直接挂版本versionId 字段)
  • linkage-engine需求 ↔ DevTask 派生)
  • workspace-engine统一 WorkItem 聚合)

2026-06-12 及更早

  • 完整模块:需求池/版本管理/计划任务(调研/产品/UI/开发任务/测试用例/Bug
  • 加班记录 + 排名 + 原因占比饼图
  • 健康度计算 + 风险标签
  • 版本执行态自动推导

进行中

  • V2.8 生产硬化稳定版:补齐备份恢复、发布 smoke、监控告警、日志检索、迁移回滚和运维证据闭环。
  • 项目详情页 VersionCard 状态胶囊数据联动(部分已完成)

V2 — 后端接入

NestJS + Prisma + PostgreSQL 已完成 V2.1 至 V2.4 的后端迁移主线。第一阶段用 app_data JSONB 文档表承接现有 store 数据形状避免浏览器清站点数据导致业务数据丢失第二阶段建立分区关系表、V2.2 快读 API 和 V2.3 AppData 写后同步V2.4 完成领域 CRUD 主写迁移验收。V2.8 不再新增业务主写迁移范围,而是把生产运维、备份恢复、监控告警和回滚手册补齐。

关键任务

  1. 服务端文档层app_data + /api/v1/data/:key(第一阶段已实现)
  2. localStorage → API 切换:业务主数据不再写浏览器(第一阶段已实现)
  3. 运行 Prisma 同步/迁移:本地和服务器数据库都需要创建 app_data 与 V2.2/V2.3 关系表
  4. 关系化拆表:把稳定模块从 JSONB 拆成 Product/Project/Version/Task 等领域表(关系模型和同步桥已落地,领域写 API 仍待迁移)
  5. 领域 CRUD 主写入:前端保存不再写整份 JSON 文档,而是调用具体领域 API 写关系表
  6. 基础权限/审计骨架:领域 API 从迁移期开始接入用户身份、资源作用域、操作人和审计事件入口
  7. AppData 主路径移除:完成迁移核对后逐模块删除 JSON fallback 和 /data/:key 主写入依赖
  8. 认证NextAuth.js + JWT
  9. 权限RBACOwner/Admin/Member/Viewer按项目/版本级别
  10. 版本规则引擎收敛VersionPlan 完成条件、关联需求候选、TaskCategory 语义码、TestCase.categoryId 统一收束到规则层

数据迁移策略

当前不做本地导入导出。清站点数据后浏览器旧数据无法恢复,后续新增数据直接写入 PostgreSQL。若以后需要迁移旧浏览器数据再单独做管理员导入工具。

V2.4 — 领域 CRUD 迁移(已完成前提)

目标是让关系表从“快读 + AppData 同步副本”逐步升级为主写入路径。迁移顺序应优先选择写入频率高、实体边界清晰、已经在 V2.2 mapper 中稳定的领域:

  1. Project / Version替代 products-overview 中的项目和版本主写入,保留产品树兼容读取。
  2. VersionPlan / DevTask / TestCase / BugversionId 分区键提供领域写 API写入后继续复用现有小宝 dirty 策略和工作活动记录。
  3. Member / TaskCategory替代 memberstask-categories AppData 文档,统一权限、人员和任务类型字典来源。
  4. TaskWorklog / Overtime / WorkActivity保留追加型写入语义避免从当前 AppData 快照反向删除历史证据。
  5. 前端 store 分批切换:每切一个领域,都要保留兼容读取和回滚路径,直到 AppData 对应 key 不再是事实源。

V2.4 推进前必须先统一 packages/shared 的状态枚举与当前前端业务口径,避免领域 API 切换时把旧的 draft/reviewing/approvedtodo/in_review/done/closed 状态重新带回系统。

V3 — AI Agent 集成

详细 Agent 规范见 agent-spec.md。本节只列规划,不重复 Agent 实现细节。

V3.1 — Prototype Decompose Agent首个 Agent

目标:从产品方案的原型 + 关联需求,拆解出开发任务草案 + 测试用例草案原型中明确可拆但没有匹配到关联需求的内容按无需求ID分组进入任务/用例,不补需求池。

已完成的数据底座2026-06

  • DevTask / TestCase 加 references[] + aiDraft + aiDraftAt
  • 创建表单加「原型批注」字段
  • 列表中 AI 草案视觉区分(紫色边 + 徽章)
  • 编辑后自动清除 aiDraft 标记
  • agent-spec.md / glossary.md 文档落地
  • 约定:原型链接 = 产品方案 (VersionPlan type=product) 已完成计划的 resultUrl不在 Version 上独立存储

待实现

  1. 后端 AiGateway + PrototypeDecomposeServiceNestJS module
  2. 前端「AI 拆解任务和用例」按钮(产品方案 Tab
  3. 对账报告组件(弹窗呈现:完美对应 / 需求未见原型 / 无需求ID分组 / 含糊)
  4. 用户确认后批量创建 DevTask + TestCase 草案
  5. DevTask 增加 versionIdrequirementId 改为可选,兼容旧数据通过需求反查版本
  6. AiLog 表调用记录、token 计量、用时)

MVP 范围限制

  • 不自动分配 assignee留给用户在草案上手填
  • 不做"上一版基准 diff"(按 decisions.md #17 决议)
  • 单 Agent 单 Round不做多 Agent 编排

V3.2 — 小宝预警 / Risk Watch Agent

小宝预警以版本发版风险为核心,先通过规则引擎计算风险分、趋势、静默风险、预计可发日期和置信度,再由 Risk Watch Agent 自动解释高风险版本。第一版已落地页面触发模式:打开 /xiaobao-warning 时保存当天快照,并在满足触发条件时自动生成 AI 解读。

当前不做后台定时 Agent。后续如果需要主动通知再在已有 xiaobao-risk-snapshotsxiaobao-risk-insights 基础上增加定时巡检与消息推送。

Schedule Suggest Agent:基于成员负载和历史耗时,建议下一阶段任务分配,仍作为后续候选。

多 Agent 协作设计:等 Risk Watch 与 Schedule Suggest 都稳定后再设计编排策略。

V3.3 — 其他场景候选

  1. 需求智能分类(自动归档到产品 / 项目)
  2. 健康度智能解读(数据指标 → 自然语言报告)
  3. 需求转任务(需求采纳后一键生成 DevTask 草稿)

落地约束

  • 不直接动数据:所有 Agent 写入必须带 aiDraft: true,用户编辑后才转正
  • 必须有引用:所有 AI 产物带 references用户能追溯到源头
  • 必须有对账报告:拆解类 Agent 输出前端展示结构化报告,让用户决策
  • 不补需求池无需求ID分组只进入 DevTask/TestCase不创建 Requirement不加入关联需求列表
  • 可降级:原型不可达 / 输入数据不全 / 模型超时,明确告知用户失败原因,不写入任何数据

不在路线图(明确不做)

  • Jira/TAPD 替代品:定位是产品/项目经理视角,不是开发任务管理
  • 测试套件/测试计划:测试用例是版本验收手段,不做完整测试管理
  • Gantt 甘特图:现有的胶囊状态条 + 阶段耗时已经够用
  • 看板视图DevTask 列表 + 筛选 + 状态流转已够用
  • 回归测试:测试用例不做版本间复用
  • 客户/合同管理:超出研发管理边界

关键里程碑

节点 状态
V1 业务流程打磨 进行中
V1 朋友试用反馈 持续中
V2 后端接入 V2.1-V2.4 已完成V2.8 运维闭环进行中
V3 AI 集成 等 V2 数据沉淀
公开发布 TBD
2026-06-26
  • Workspace daily report upgraded from manual worklog summary to mixed activity aggregation.
  • Added work-activities AppData key and a typed activity factory for VersionPlan, DevTask, TestCase, and Bug actions.
  • /workspace daily report now groups delivery/progress/creation/risk/progress-note records and flags in-progress work that needs today's progress update.