如何对Cadence工作流程进行版本控制？

显然，这可能是新的Cadence开发人员提出的最常见问题之一。Cadence工作流必须是确定性算法。如果工作流算法不确定，则Cadence工作人员在尝试重播历史记录时（例如，在工作人员故障恢复期间）将面临遇到不确定性工作流程错误的风险。

有两种方法可以解决此问题：

• 创建全新的工作流程：这是版本控制工作流程中最幼稚的方法。这种方法听起来很简单：只要您需要更改工作流程的算法，就可以复制原始工作流程并按所需方式对其进行编辑，并为其命名一个新名称，例如MyWorkflow_V2，并开始将其用于所有实例向前。如果您的工作流程不是很长寿，那么您现有的工作流程将在某个时候“耗尽”，您将能够完全删除旧版本。另一方面，由于明显的原因，这种方法会很快变成维护的噩梦。
• 使用GetVersion（）API派生工作流逻辑：Cadence客户端具有一个名为GetVersion的函数，该函数可以告诉您当前正在运行的工作流版本。您可以使用此函数返回的信息来确定需要使用哪个版本的工作流程算法。换句话说，您的工作流程具有新旧算法并排运行，并且您可以为您的工作流程实例选择正确的版本，以确保它们确定地运行。

下面是基于GetVersion（）的方法的示例。假设您要在工作流程中更改以下行：

err = workflow.ExecuteActivity(ctx, foo).Get(ctx, nil)

至

err = workflow.ExecuteActivity(ctx, bar).Get(ctx, nil)

这是一个重大更改，因为它运行bar活动而不是foo。如果您只是进行更改而不必担心确定性，那么您的工作流将无法重播（如果需要），并且会陷入不确定性工作流错误中。正确进行此更改的正确方法是更新工作流，如下所示：

v :=  GetVersion(ctx, "fooChange", DefaultVersion, 1)
if v  == DefaultVersion {
   err = workflow.ExecuteActivity(ctx, foo).Get(ctx, nil)
} else {
   err = workflow.ExecuteActivity(ctx, bar).Get(ctx, nil)
}

GetVersion函数接受4个参数：

• ctx是标准上下文对象
• “ fooChange”是人类可读的ChangeID或您在工作流程算法中进行的语义更改，破坏了确定性
• DefaultVersion是一个常数，仅表示版本0，即第一个版本。它作为minSupportedVersion参数传递给GetVersion函数
• 当前工作流程代码可以处理的maxSupportedVersion 1是。在这种情况下，我们的算法可以支持从DefaultVersion到Version 1（包括1）的工作流版本。

当此工作流程的新实例首次到达上面的GetVersion（）调用时，该函数将返回maxSupportedVersion参数，以便您可以运行最新版本的工作流程算法。同时，它还将在工作流程历史记录中记录该版本号（内部称为Marker Event），以便将来记住该版本号。稍后重播此工作流时，即使您传递了不同的maxSupportedVersion参数（例如，如果您的工作流具有更多版本），Cadence客户端也将继续返回相同的版本号。

如果在历史记录重播期间遇到GetVersion调用，并且该历史记录没有先前记录的标记事件，则该函数将返回DefaultVersion，并假设在此工作流程实例的上下文中不存在“ fooChange”。

如果您需要在工作流的同一步骤中进行更重大的更改，只需更改上面的代码，如下所示：

v :=  GetVersion(ctx, "fooChange", DefaultVersion, 2) // Note the new max version
if v  == DefaultVersion {
   err = workflow.ExecuteActivity(ctx, foo).Get(ctx, nil)
} else if v == 1 {
   err = workflow.ExecuteActivity(ctx, bar).Get(ctx, nil)
} else { // This is the Version 2 logic
   err = workflow.ExecuteActivity(ctx, baz).Get(ctx, nil)
}

如果您愿意放弃对Version 0的支持，则可以像下面这样更改上面的代码：

v :=  GetVersion(ctx, "fooChange", 1, 2) // DefaultVersion is no longer supported
if v == 1 {
   err = workflow.ExecuteActivity(ctx, bar).Get(ctx, nil)
} else { 
   err = workflow.ExecuteActivity(ctx, baz).Get(ctx, nil)
}

进行此更改之后，如果您的工作流代码针对具有DefaultVersion版本的旧工作流实例运行，则Cadence客户端将引发错误并停止执行。

最终，您可能希望摆脱所有以前的版本，而仅支持最新版本。一种选择是简单地完全摆脱GetVersion调用和if语句，而只用一行代码来完成正确的事情。但是，将GetVersion（）调用保留在其中实际上是一个更好的主意，这有两个原因：

1. GetVersion（）使您可以更好地了解如果您的工作人员尝试重播旧工作流程实例的历史记录时出了什么问题。您无需了解神秘的不确定性工作流错误的根本原因，而是会知道失败是由此位置的工作流版本控制引起的。
2. 如果您需要对工作流程算法的同一步骤进行更重大的更改，则可以重复使用相同的更改ID，并继续遵循与上述相同的模式。

考虑到上面提到的两个原因，当您应该放弃对所有旧版本的支持时，您应该像下面那样更新工作流代码：

GetVersion(ctx, "fooChange", 2, 2) // This acts like an assertion to give you a proper error
err = workflow.ExecuteActivity(ctx, baz).Get(ctx, nil)