docs(harness): annotate entry orchestration, enums, and exception recovery paths

This commit is contained in:
zhuyongxin
2026-07-30 19:08:03 +08:00
parent b39a625e5b
commit 5b2fb985d9
26 changed files with 639 additions and 6 deletions
@@ -1,8 +1,28 @@
package com.superbiz.agent.harness.contract;
/**
* 诊断发布裁决结果(Release 层):这一次诊断「对外给什么结局」。
*
* <p>层级:Release / Application 结果。注意与 {@link com.superbiz.agent.harness.core.RunState} 不同:
* <ul>
* <li>{@code RunState} 回答 Run 是否还在跑、因何技术终态停下(含 TIMED_OUT、BUDGET_EXHAUSTED)</li>
* <li>{@code ReleaseOutcome} 回答用户侧内容形态:正常报告 / 安全降级 / 失败 / 取消</li>
* </ul>
*
* <p>常见组合:RunState=BUDGET_EXHAUSTED 且有安全进展 → ReleaseOutcome=FALLBACK;
* 无进展 → 往往落到 FAILED。
*/
public enum ReleaseOutcome {
/** 通过门控,可发布 DIAGNOSIS_REPORT。 */
SUCCESS,
/** 不发布根因报告,发布 SafeFallback(见 {@link FallbackType})。 */
FALLBACK,
/** 无法形成可发布的安全内容(含无 observed facts 的预算停等)。 */
FAILED,
/** 运行被取消,通常不再保证客户端能收到完整 done。 */
CANCELLED
}