服务注册与分布式协调 / 系统课时

使用历史 Replay 做回归检查

使用历史 Replay 做回归检查

Workflow 代码上线后会被用来重放已有事件历史;如果新代码对同一段历史生成了不同的命令序列,Worker 就可能触发 Non-Determinism。本课把真实历史保存为回归样本,并在部署前自动 Replay。

学习目标

  • 能导出指定 Workflow Execution 的事件历史并保存为测试样本
  • 能用当前 Java Workflow 实现对历史执行 Replay
  • 能把 Replay 失败转化为发布前的兼容性检查

Replay 实际在检查什么

Temporal 的事件历史记录了 Workflow 已经做出的持久化决定,例如调度 Activity、启动 Timer、启动 Child Workflow 等。Replay 时,SDK 重新执行 Workflow 代码,并让这些决定与历史中的事件逐步对齐;如果新代码在某个位置产生了不同类型、顺序或关键属性的命令,就会出现非确定性错误。

Replay 因此特别适合拦截“代码单测都通过,但旧执行无法继续”的回归。它不重新执行历史中的 Activity,也不证明业务结果一定正确;它检查的是当前 Workflow 代码能否解释既有历史。

历史 Replay 从样本采集到发布闸门的回归链路

保存可重复使用的历史样本

优先保存能覆盖长期运行、Signal/Update、Timer、失败重试和条件分支的历史,而不是只挑最短的成功案例。下面用 Temporal CLI 导出一个明确的 Run,避免同一 Workflow ID 的“最新 Run”随时间变化。

bash
mkdir -p src/test/resources/history
temporal workflow show \
  --workflow-id <ID> \
  --run-id <ID> \
  --output json > src/test/resources/history/order-v1.json
test -s src/test/resources/history/order-v1.json && echo history-ready

预期输出:

text
history-ready

<ID> 分别替换为实际 Workflow ID 与 Run ID;实际历史内容、事件数量和时间戳会不同。用于 CI 的样本应去除不该进入仓库的敏感 Payload,若生产环境启用了自定义 Data Converter 或 Codec,Replay 环境也必须具备与历史匹配的解码配置。

用当前代码执行 Replay

以下是片段示例,依赖项目中真实的 OrderWorkflowImpl,并要求测试依赖包含 Temporal Java SDK 的 testing 模块。历史必须来自与该实现对应的 Workflow Type。

java
import io.temporal.testing.WorkflowReplayer;
import java.io.File;
import org.junit.jupiter.api.Test;

class OrderWorkflowReplayTest {

    @Test
    void replaysSavedHistory() throws Exception {
        File history =
                new File("src/test/resources/history/order-v1.json");

        // Replay 成功意味着当前 Workflow 代码仍能解释这段既有历史。
        WorkflowReplayer.replayWorkflowExecution(
                history,
                OrderWorkflowImpl.class);
    }
}

预期结果:

text
测试通过;Replay 过程中未抛出 NonDeterministicException。

如果测试失败,先看异常中“历史事件”和“当前命令”的不匹配位置,再回到对应代码变更。常见原因是插入或删除 Activity、改变 Timer/Child Workflow 的执行顺序、修改分支条件后让旧输入走到另一条命令路径,或者把非确定性的系统时间、随机数、外部 I/O 引入 Workflow 代码。

把 Replay 变成部署前闸门

单个历史通过并不代表所有执行都兼容。更稳妥的做法是按 Workflow Type 建立一个小型历史语料库,至少覆盖旧版本、关键业务分支和长生命周期执行;每次修改 Workflow 代码时,在 CI 中对这些样本全部 Replay。

Replay 失败时不要用“更新测试快照”直接抹掉证据。先判断新代码是否真的需要改变命令序列:如果只是误改,应恢复兼容代码;如果是有意演进,则使用版本分支或 Worker Versioning 等安全发布策略,让旧历史仍能由兼容代码重放。只有历史样本和新执行测试都通过后,Replay 才能作为可信的发布信号。

按自己的节奏,确认真正理解。

目录与阅读设置

阅读设置

17

记录一个想法

使用历史 Replay 做回归检查

0 / 10000 · 笔记保存到账号。未提交的修改会在关闭、离开或刷新后丢失。

登录哪都通