docs(kdoc): 重写信箱生命周期相关 KDoc,改为直白说明并去掉内部编号

原有注释大量引用 §5.1/§5.2/Q2/US-01 这类文档编号和内部简称,跳过了"这段代码在做什么、
为什么这么做",没有读过设计文档的人基本读不懂。本次统一改成先讲清这件事本身、
再说为什么要这样做,编号只在末尾留一处指路。

覆盖本次改动涉及的 24 个 Kotlin 文件(生产 16 个 + 测试 8 个):

- 领域与端口:ProcState(补齐全量字段说明与状态/错误分类逐项注释)、
  ProcStateRepository / InboxCursorRepository / CminmsgInboxRepository 及
  MailboxRow / BackfillDue / Backlog;
- 收报:InboxPoller(把"水位连续、遇缺口停下、缺口老化"用大白话讲透)、
  InboxService、JdbcCminmsgInboxRepository;
- 处理:Pump / MessageProcessor、ScheduleProcessor、DynamicProcessors、
  ProcFailure、JdbcProcStateRepository 与游标实现;
- 回填与观测:BackfillService、InboxLifecycleHealthIndicator、JobRunner;
- 配置与 stub:PipelineProps(三个新增参数说清取值理由)、MailboxProps、
  StubRepositories;
- 测试:8 个测试类改为"这些用例在守哪几条规矩",并保留 H2 不覆盖
  ON CONFLICT 的说明。

术语统一按第一次出现就地解释:水位、处理标记、回填、死信、队头、终态。
纯注释改动;除拆分枚举时按仓库风格补的两个行尾逗号外无代码变更
(已用剥离注释后比对 HEAD 的方式逐文件核对)。测试仍为 78 passed / 1 skipped。
This commit is contained in:
windyboy
2026-09-10 11:05:55 +08:00
parent 8c6bb83b62
commit d475feb790
24 changed files with 332 additions and 186 deletions
@@ -14,11 +14,14 @@ import java.time.Duration
import java.time.Instant
/**
* 信箱生命周期观测(docs/message-lifecycle.md §5.3 验收 / user-stories.md OPS-2
* 输出剩余积压、最老未处理信龄、未回填终态条数与水位滞后,供积压消化期间持续观察。
* 在 /health 里输出收报与回填的当前情况,用来观察积压消化得怎么样
* - `backlog`:还没处理完的消息条数;
* - `oldestUnprocessedSeconds`:最老一条未处理消息从收到到现在过了多久;
* - `unmarkedTerminal`:已经处理完、但还没把标记写回信箱的条数(回填跟不上时这个数会涨);
* - `watermark` / `watermarkLag`:收报读到哪个 ID 了、落后信箱最新 ID 多少。
*
* 端口缺省(未接通共享信箱或自有 PG)时报告未绑定不判 DOWN——可用性由各依赖自身的
* 健康指示器承担,本指示器只反映生命周期状态;端口查询失败判 DOWN。
* 相关工作没接上时(比如没连共享信箱)只提示"未绑定"不判 DOWN——依赖本身是否可用
* 由各自的健康指示器回答,这里只报告业务状态。只有查询出错才判 DOWN。
*/
@Singleton
class InboxLifecycleHealthIndicator(
@@ -39,6 +42,7 @@ class InboxLifecycleHealthIndicator(
)
}
/** 组装上面那几个指标;单独抽出来是为了能在测试里直接调用。 */
internal fun lifecycleHealth(
procState: ProcStateRepository?,
cursor: InboxCursorRepository?,