orbit/docs/sdk

Go SDK 接入说明

已实现健康查询、任务单项与批量提交/查询/分页/待执行取消、队列创建/查询、自动 Worker、Worker 底层协议 SDK 和 执行历史查询。人工核查与重试 已提供 ReviewTask、RetryTask 与任务操作审计查询。安全重试 已提供有限策略、WorkerFailure.Retryable、历史查询及完整例子。计划调度 已支持创建、查询、版本发布、暂停/恢复、触发历史与完整示例。订阅管理 已支持创建、查询、暂停恢复、交付历史与人工重试；事件消费 SDK 已支持连接、自动心跳、重连与确认。流程定义发布、实例/控制/信号/操作审计及六类人工恢复已提供独立SDK；完整历史与更多场景按开发计划继续实现。

module：git.yuntuo.hk/k2safe/orbit/sdk/go。SDK 使用独立 go.mod，依赖 Go 标准库与 github.com/coder/websocket v1.8.15，不引用服务端模型或数据库实现。

任务相对延迟使用SubmitTaskRequest.DelayMS，由数据库首次受理时间计算，原键重报不重新计时；完整延迟示例包含Worker执行和历史核对。非零DelayMS不能与AvailableAt同用，旧服务须先升级。

流程历史查询已提供激活/轮次/信号有界分页、历史等待与预算详情及显式权限的信号操作审计；当前视图与指定历史激活分开。

1. 从初始化到运行示例

需要 Go 1.27.1、MySQL 8.4+。在仓库根目录，通过环境设置专用 ORBIT_MYSQL_DSN：

go run ./cmd/orbit-migrate up
mkdir -p .local
chmod 700 .local
go run ./cmd/orbit-admin bootstrap \
  --application sample-app --namespace default --environment development \
  --queue files --output .local/development.credentials.json
go run ./cmd/orbit

另开终端，从仓库根目录执行：

cd sdk/go
ORBIT_URL=http://127.0.0.1:8080 go run ./examples/health
ORBIT_URL=http://127.0.0.1:8080 \
  ORBIT_CREDENTIALS_FILE=../../.local/development.credentials.json \
  go run ./examples/tasks

预期输出，task 为每次运行生成的实际 ID：

liveness=alive readiness=ready scope=database_and_schema
source_kind=DIRECT
task=<32位任务ID> duplicate=true listed=1 final_state=CANCELLED revision=2

重复运行示例会新建一个独立任务并取消它，listed 数量可能增加，最多显示当前页 10 条。数据和审计保留，不执行硬删除。示例只演示受理闭环，尚不执行文件转换。

• 健康示例源码：只读，无业务资源写入。
• 任务示例源码：提交两次同一身份、获取当前状态、列表、带版本取消，再核对直接来源。
• 任务示例也接受 ORBIT_TOKEN 和 ORBIT_QUEUE_ID，环境值优先于凭据文件。
• 示例发生错误会打印错误并非零退出；打印内容不包含原始 token。
• 初始凭据 30 天有效。初始化行为和错误核对方式见 凭据文档。
• make integration 会在一次性数据库中自动完成上面的真实服务与 SDK 示例验证。

2. 创建客户端与提交任务

下方是接入函数内的调用片段；完整 imports/main 见示例源码。

client, err := orbit.NewClient(baseURL, orbit.Options{Token: token})
if err != nil {
    return err
}
ctx, cancel := context.WithTimeout(context.Background(), 10*time.Second)
defer cancel()

// 应先把 key 与请求内容保存在业务数据库；网络重报必须复用。
key := "file-conversion-operation-001"
request := orbit.SubmitTaskRequest{
    QueueID: queueID,
    Handler: "file.convert",
    HandlerVersion: "v1",
    PayloadVersion: "v1",
    Payload: json.RawMessage(`{"source_ref":"objects/input.txt","format":"pdf"}`),
    RecoverySafety: orbit.RecoveryReconcileOnly,
}
accepted, err := client.SubmitTask(ctx, key, request)
if err != nil {
    return err
}
current, err := client.GetTask(ctx, accepted.Task.ID)
if err != nil {
    return err
}
fmt.Println(current.ID, current.State, current.Revision)

受理回执不是业务执行结果。同键重报返回原始快照；当前状态应使用 GetTask。业务侧创建操作与平台提交之间存在双写边界，接入方应在自身事务中保存操作记录/Outbox，再使用稳定身份提交，不能依靠随机新键补发来“修复”未知结果。

业务事务Outbox完整场景已提供独立业务数据库、原子业务写入、持久化发送器、原身份恢复及CLI；核心SDK保持无MySQL/ORM依赖。业务适配包的Enqueue/SendOnce/Status与实际运行命令均在该手册说明。

3. 取消与错误处理

cancelled, err := client.CancelTask(ctx, current.ID, key+"-cancel", orbit.CancelTaskRequest{
    ExpectedRevision: current.Revision,
    Reason: "source object was replaced",
})
if err != nil {
    var apiErr *orbit.APIError
    if errors.As(err, &apiErr) {
        // apiErr.Code、StatusCode、RequestID 可用于分支与排查。
        // STATE_CONFLICT：先查询；UNAVAILABLE：保留原键和原请求核对。
    }
    return err
}
fmt.Println(cancelled.Task.State)

取消重报必须保留第一次取消时的 expected_revision，不能将响应中的新版本塞回同一幂等请求。已支持独立任务和计划任务的等待、预占、运行和核查状态；运行中受理返回 202，任务状态仍为 RUNNING，需另行查询最终状态。完整语义和运行示例见 取消契约。若此前存在未知效果，本次确认取消不能清除它。

业务错误返回 *orbit.APIError，支持 errors.As 转为 *orbit.HTTPError 查看状态。健康错误或无法识别的网关错误使用 *orbit.HTTPError，不带未知响应正文。网络/上下文错误按标准库错误返回；超时并不能证明服务端没有提交。

4. 方法与限制

方法	请求 / 返回	文档
ReviewTask / RetryTask	原任务ID、稳定key、显式声明、证据与版本；返回任务及audit_id	人工恢复 / 完整场景
ListTaskOperations / GetTaskOperation	操作摘要分页、原因、证据与前后状态	任务审计
SubmitTasks	SubmitTasksRequest / SubmitTasksResult，32项独立幂等与结果	批量受理 / 运行场景
CreateSubscription / GetSubscription / ListSubscriptions	订阅受理、当前配置与队列分页	订阅
ConfigureSubscription	显式暂停/继续与版本、原因	订阅
ListEventDeliveries / GetEventDelivery / RetryEventDelivery	交付历史、冻结结果和耗尽后追加预算	订阅
DialEvents / Next / Ack / Ping	单连接交付、确认与心跳，可用原证明跨连接重报	消费 SDK
NewEventConsumer / Run / Events / Stats	自动心跳、重连、受控处理器并发及有界收尾	消费 SDK
CreateSchedule / GetSchedule / ListSchedules	计划受理、详情与队列分页	计划
PublishSchedule / GetScheduleVersion	不可变发布与历史版本	计划
PauseSchedule / ResumeSchedule / ListScheduleOccurrences	控制与触发记录	计划
Liveness / Readiness	Health	健康
SubmitTask	SubmitTaskRequest / SubmitTaskResult	任务
GetTask	taskID / Task	任务
GetTaskSource	taskID / TaskSource，普通/恢复/计划及流程固定版本、历史激活与轮次	来源查询
ListTasks	ListTasksRequest / TaskPage，业务键及创建时间范围	查询
CancelTask	taskID、key、CancelTaskRequest / CancelTaskResult	任务
CreateQueue	key、CreateQueueRequest / CreateQueueResult	队列
GetQueue	queueID / Queue	队列
ListTaskAttempts	taskID、HistoryPageRequest / AttemptPage	执行历史
GetTaskAttempt	taskID、attemptID / Attempt	执行历史
ListAttemptEvidence	taskID、attemptID、HistoryPageRequest / AttemptEvidencePage	执行历史
GetAttemptEvidence	taskID、attemptID、evidenceID / AttemptEvidence	执行历史

所有方法第一个参数为context.Context，返回值之外都返回error。计划方法的具体参数见对应手册。命令方法要求调用方提供稳定key，不自动生成或重试。ListTasksRequest接受QueueID、State、BusinessKey、CreatedFrom、CreatedBefore、Limit、Cursor；筛选与游标语义和运行示例已提供。

Options.HTTPClient 可注入专用 HTTP 客户端。SDK 复制配置，不修改调用方实例；默认超时 10 秒，可用 context 缩短。禁止自动跟随重定向，避免凭据被转交其他地址。生产配置 HTTPS；SDK 不承担部署 TLS 终止。

健康响应最多 16 KiB，业务响应最多 1 MiB，请求最多 512 KiB。大业务内容应传对象引用。参数/result 使用 json.RawMessage，不转成 float64；revision 在 Go 中为 uint64，JSON 编码为字符串。服务端字段及上限见各接口手册。

5. 外部项目本地接入

SDK 尚未发布版本。开发期可以用本地 replace：

go mod edit -require=git.yuntuo.hk/k2safe/orbit/sdk/go@v0.0.0
go mod edit -replace=git.yuntuo.hk/k2safe/orbit/sdk/go=/absolute/path/to/orbit/sdk/go
go mod tidy

将示例路径换成真实路径，不要把本机绝对路径作为发布依赖提交。后续会验证独立 module 标签和真实远端取包，再提供 go get 发布命令。当前源码同时验证 GOWORK=off 的独立构建。

6. 查询执行历史与证据

只读凭据需要 tasks:read 和任务所属队列范围。下方为接入函数片段，遍历尝试摘要并查询每条尝试详情；每次页面请求均需检查错误：

pageRequest := orbit.HistoryPageRequest{Limit: 20}
for {
    page, err := client.ListTaskAttempts(ctx, taskID, pageRequest)
    if err != nil { return err }
    for _, summary := range page.Items {
        detail, err := client.GetTaskAttempt(ctx, taskID, summary.ID)
        if err != nil { return err }
        fmt.Println(detail.ID, detail.Epoch, detail.State)
        // Result 是 json.RawMessage；读取业务字段时保留精确类型。
    }
    if page.NextCursor == "" { break }
    pageRequest.Cursor = page.NextCursor
}

查询证据对应 ListAttemptEvidence(ctx, taskID, attemptID, pageRequest) 与 GetAttemptEvidence(ctx, taskID, attemptID, evidenceID)，列表相同方式使用 NextCursor。结果正文只在详情返回，列表适合按需展示。查询快照不授予执行权；证据的 outcome 是 Worker 原始声明，EVIDENCE_ONLY 不能当作任务成功。当前权威任务结果用 GetTask 核对。

完整 执行历史示例 会创建一条模拟任务，提交固定成功结果，再模拟矛盾报告，并通过上述四个查询核对历史。先按 Worker 初始化步骤 准备具有提交、读取及 Worker 权限的专用凭据，再从仓库根目录执行：

cd sdk/go
ORBIT_URL=http://127.0.0.1:8080 \
  ORBIT_CREDENTIALS_FILE=../../.local/worker.credentials.json \
  go run ./examples/history

预期输出：

task=<任务ID> state=SUCCEEDED attempts=1 evidence=1 reason=RESULT_CONFLICT disposition=EVIDENCE_ONLY

示例是受控故障演示，不调用外部业务系统。原结果为 {"version":"v1","sequence":9007199254740993}，矛盾内容 {"version":"v2"} 只进入证据；任务仍保留原成功结果。每次运行创建独立任务/处理器身份，正常结束会排空并关闭连接，历史保留。示例不自动处理全部网络故障，失败时非零退出；应按输出的稳定错误分类核查，持续消费请使用自动 Worker。

7. 后续交付

P2 已提供底层协议、自动 Worker 运行器及示例 与历史查询，并通过 Schema 及进程故障阶段验收；P3 已实现 安全重试、计划调度、运行中取消 、队列资源控制及示例 和 应用共享配额及示例，资源键互斥和单调序号示例 已实现，优先级场景和节点公平派发 已实现，结果订阅及消费SDK、独立Inbox场景已实现，人工核查与重试也已提供完整示例；P4–P5 提供流程构建发布、信号、等待、轮询与人工恢复。每项随实现同步交付可运行示例及异常回归。

订阅管理示例

完整运行方法 使用显式 --event-access 凭据，执行创建/同键核对/暂停/恢复/查询，再暂停本次订阅并保留审计。源码见 examples/subscriptions。WSS 连接 SDK 与自动消费器见 消费手册，可运行 协议示例 验证跨连接 ACK；持久化 Inbox 示例 已独立交付，核心SDK不新增数据库驱动。

流程定义发布

已提供独立WorkflowSpecification类型及CreateWorkflowDefinition、GetWorkflowDefinition、PublishWorkflowVersion、GetWorkflowVersion四个HTTP方法。业务侧研发显式发布，服务端冻结版本；实例执行使用StartWorkflow等方法，完整运行见示例。见接口与字段、结构版本1、完整可运行场景。

流程任务同样调用GetTaskSource，kind为WORKFLOW时读取workflow中的固定版本、步骤、历史激活代次、查询轮次和直接恢复父任务。该代次不表示当前等待目标；发送信号须另读GetWorkflowStep。完整字段及兼容边界见来源接口，workflow示例实际核对三个任务来源。