[💡 FEATURE REQUEST]: Temporal Replay API

[rustatian]

Plugin

Temporal

I have an idea!

Temporal Replay API RFC: GO-SDK replay docs: link, SDK-GO workflow replayer: link

SDK-PHP ref: temporalio/sdk-php#227

PROTO API:

// ReplayRequest message contains all needed fields (which might be extended) to replay the workflow.

message ReplayRequest {
	temporal.api.common.v1.WorkflowExecution workflow_execution = 1;
	temporal.api.common.v1.WorkflowType workflow_type = 2;
	string save_path = 3;
	int64 last_event_id = 4;
}

// ReplayResponse contains Status response with the error details or nil if there are no errors.

// https://cloud.google.com/apis/design/errors
message ReplayResponse {
       Status status = 1;
}

message History {
  temporal.api.history.v1.History history = 1;
  temporal.api.common.v1.WorkflowType workflow_type = 2;
}

On error, RR will return the Status response with the appropriate error code. All status codes are described here: link

RR Response statuses for all requests :

1. Missing fields in the request or data corruption: RR responds with the status code InvalidArgument (code 3) and an error message in the Message field.
2. Internal errors (proto parsing, marshaling): Internal (code 13) error with error description in the Message status response field.
3. Replays failure - FailedPrecondition (code 9). with the description of error in the Message status response field.

RoadRunner API:

1. Replay method:

ReplayWorkflow(in *protoApi.ReplayRequest, out *protoApi.ReplayResponse) error

Required fields in the ReplayRequest:

• run_id
• workflow_id
• workflow_name

2. Download WF history:

DownloadWorkflowHistory(in *protoApi.ReplayRequest, out *protoApi.ReplayResponse) error

Required fields in the ReplayRequest:

• run_id
• workflow_id
• save_path

3. Replay from the JSON file saved on the disk:

ReplayFromJSON(in *protoApi.ReplayRequest, out *protoApi.ReplayResponse) error

Required fields in the ReplayRequest:

• workflow_name
• save_path // path with the file

Optional:

• last_event_id (int64). If this field is not 0 RR executes a single workflow task for the json history file upto provided last_event_id.

4. Replay from proto workflow history:

ReplayWofkflowHistory(in *protoApi.History, out *protoApi.ReplayResponse) error

Required fields in the ReplayRequest:

• workflow_name

CC: @wolfy-j , @roxblnfk

[rustatian]

@roxblnfk updated