added workflow start-update-with-start and workflow execute-update-with-start commands
#762
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -4,6 +4,7 @@ import ( | |
| "bytes" | ||
| "context" | ||
| "encoding/json" | ||
| "errors" | ||
| "fmt" | ||
| "os" | ||
| "reflect" | ||
|
|
@@ -121,7 +122,7 @@ func (c *TemporalWorkflowSignalWithStartCommand) run(cctx *CommandContext, _ []s | |
| signalPayloadInputOpts := PayloadInputOptions{ | ||
| Input: c.SignalInput, | ||
| InputFile: c.SignalInputFile, | ||
| InputMeta: c.SignalInputMeta, | ||
| InputBase64: c.SignalInputBase64, | ||
| } | ||
| signalInput, err := signalPayloadInputOpts.buildRawInputPayloads() | ||
|
|
@@ -194,16 +195,191 @@ func (c *TemporalWorkflowSignalWithStartCommand) run(cctx *CommandContext, _ []s | |
| RunId string `json:"runId"` | ||
| Type string `json:"type"` | ||
| Namespace string `json:"namespace"` | ||
| }{ | ||
| WorkflowId: c.WorkflowId, | ||
| RunId: resp.RunId, | ||
| Type: c.Type, | ||
| Namespace: c.Parent.Namespace, | ||
| }, printer.StructuredOptions{}) | ||
| } | ||
|
|
||
| func (c *TemporalWorkflowStartUpdateWithStartCommand) run(cctx *CommandContext, _ []string) error { | ||
| waitForStage := client.WorkflowUpdateStageUnspecified | ||
| switch c.UpdateWaitForStage.Value { | ||
| case "accepted": | ||
| waitForStage = client.WorkflowUpdateStageAccepted | ||
| } | ||
| if waitForStage != client.WorkflowUpdateStageAccepted { | ||
| return fmt.Errorf("invalid wait for stage: %v, valid values are: 'accepted'", c.UpdateWaitForStage) | ||
| } | ||
|
|
||
| updatePayloadInputOpts := PayloadInputOptions{ | ||
| Input: c.UpdateInput, | ||
| InputFile: c.UpdateInputFile, | ||
| InputMeta: c.UpdateInputMeta, | ||
| InputBase64: c.UpdateInputBase64, | ||
| } | ||
| updateInput, err := updatePayloadInputOpts.buildRawInput() | ||
| if err != nil { | ||
| return err | ||
| } | ||
| updateOpts := client.UpdateWorkflowOptions{ | ||
| UpdateID: c.UpdateId, | ||
| WorkflowID: c.WorkflowId, | ||
| RunID: c.RunId, | ||
| UpdateName: c.UpdateName, | ||
| Args: updateInput, | ||
| WaitForStage: waitForStage, | ||
| FirstExecutionRunID: c.UpdateFirstExecutionRunId, | ||
| } | ||
|
|
||
| handle, err := executeUpdateWithStartWorkflow( | ||
| cctx, | ||
| c.Parent.ClientOptions, | ||
| c.SharedWorkflowStartOptions, | ||
| c.WorkflowStartOptions, | ||
| c.PayloadInputOptions, | ||
| updateOpts, | ||
| ) | ||
| if err != nil { | ||
| return err | ||
| } | ||
|
|
||
| // Currently we only accept 'accepted' as a valid wait for stage value, but we intend | ||
| // to support more in the future. | ||
| if waitForStage == client.WorkflowUpdateStageAccepted { | ||
| // Use a canceled context to check whether the initial server response | ||
| // shows that the update has _already_ failed, without issuing a second request. | ||
| ctx, cancel := context.WithCancel(cctx) | ||
| cancel() | ||
| err = handle.Get(ctx, nil) | ||
| var timeoutOrCanceledErr *client.WorkflowUpdateServiceTimeoutOrCanceledError | ||
| if err != nil && !errors.As(err, &timeoutOrCanceledErr) { | ||
| return fmt.Errorf("unable to update workflow: %w", err) | ||
| } | ||
| } | ||
|
|
||
| cctx.Printer.Println(color.MagentaString("Running execution:")) | ||
| return cctx.Printer.PrintStructured(struct { | ||
| WorkflowId string `json:"workflowId"` | ||
| RunId string `json:"runId"` | ||
| Type string `json:"type"` | ||
| Namespace string `json:"namespace"` | ||
| UpdateName string `json:"updateName"` | ||
| UpdateID string `json:"updateId"` | ||
| }{ | ||
| WorkflowId: c.WorkflowId, | ||
| RunId: handle.RunID(), | ||
| Type: c.Type, | ||
| Namespace: c.Parent.Namespace, | ||
| UpdateName: c.UpdateName, | ||
| UpdateID: handle.UpdateID(), | ||
| }, printer.StructuredOptions{}) | ||
| } | ||
|
|
||
| func (c *TemporalWorkflowExecuteUpdateWithStartCommand) run(cctx *CommandContext, _ []string) error { | ||
| updatePayloadInputOpts := PayloadInputOptions{ | ||
| Input: c.UpdateInput, | ||
| InputFile: c.UpdateInputFile, | ||
| InputMeta: c.UpdateInputMeta, | ||
| InputBase64: c.UpdateInputBase64, | ||
| } | ||
| updateInput, err := updatePayloadInputOpts.buildRawInput() | ||
| if err != nil { | ||
| return err | ||
| } | ||
|
|
||
| updateOpts := client.UpdateWorkflowOptions{ | ||
| UpdateName: c.UpdateName, | ||
| UpdateID: c.UpdateId, | ||
| WorkflowID: c.WorkflowId, | ||
| RunID: c.RunId, | ||
| Args: updateInput, | ||
| WaitForStage: client.WorkflowUpdateStageCompleted, | ||
| FirstExecutionRunID: c.UpdateFirstExecutionRunId, | ||
| } | ||
|
|
||
| handle, err := executeUpdateWithStartWorkflow( | ||
| cctx, | ||
| c.Parent.ClientOptions, | ||
| c.SharedWorkflowStartOptions, | ||
| c.WorkflowStartOptions, | ||
| c.PayloadInputOptions, | ||
| updateOpts, | ||
| ) | ||
| if err != nil { | ||
| return err | ||
| } | ||
|
|
||
| var valuePtr interface{} | ||
| err = handle.Get(cctx, &valuePtr) | ||
| if err != nil { | ||
| return fmt.Errorf("unable to update workflow: %w", err) | ||
| } | ||
|
Comment on lines
+314
to
+318
There was a problem hiding this comment. There's a bit of a problem with this approach and the one taken by I think we need to add support for var raw RawValue
if err = handle.Get(cctx, raw); err != nil {
return fmt.Errorf("unable to update workflow: %w", err)
}
result, err := cctx.MarshalFriendlyJSONPayloads(raw.Payload)And have |
||
|
|
||
| cctx.Printer.Println(color.MagentaString("Running execution:")) | ||
| return cctx.Printer.PrintStructured(struct { | ||
| WorkflowId string `json:"workflowId"` | ||
| RunId string `json:"runId"` | ||
| Type string `json:"type"` | ||
| Namespace string `json:"namespace"` | ||
| UpdateName string `json:"updateName"` | ||
| UpdateID string `json:"updateId"` | ||
| UpdateResult interface{} `json:"updateResult"` | ||
| }{ | ||
| WorkflowId: c.WorkflowId, | ||
| RunId: handle.RunID(), | ||
| Type: c.Type, | ||
| Namespace: c.Parent.Namespace, | ||
| UpdateName: c.UpdateName, | ||
| UpdateID: c.UpdateId, | ||
| UpdateResult: valuePtr, | ||
| }, printer.StructuredOptions{}) | ||
| } | ||
|
|
||
| func executeUpdateWithStartWorkflow( | ||
| cctx *CommandContext, | ||
| clientOpts ClientOptions, | ||
| sharedWfOpts SharedWorkflowStartOptions, | ||
| wfStartOpts WorkflowStartOptions, | ||
| wfInputOpts PayloadInputOptions, | ||
| updateWfOpts client.UpdateWorkflowOptions, | ||
| ) (client.WorkflowUpdateHandle, error) { | ||
| if sharedWfOpts.WorkflowId == "" { | ||
| return nil, fmt.Errorf("--workflow-id flag must be provided") | ||
| } | ||
| if wfStartOpts.IdConflictPolicy.Value == "" { | ||
| return nil, fmt.Errorf("--id-conflict-policy flag must be provided") | ||
| } | ||
| cl, err := clientOpts.dialClient(cctx) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| defer cl.Close() | ||
|
|
||
| clStartWfOpts, err := buildStartOptions(&sharedWfOpts, &wfStartOpts) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| wfArgs, err := wfInputOpts.buildRawInput() | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| startOp := cl.NewWithStartWorkflowOperation( | ||
| clStartWfOpts, | ||
| sharedWfOpts.Type, | ||
| wfArgs..., | ||
| ) | ||
|
|
||
| // Execute the update with start operation | ||
| return cl.UpdateWithStartWorkflow(cctx, client.UpdateWithStartWorkflowOptions{ | ||
| StartWorkflowOperation: startOp, | ||
| UpdateOptions: updateWfOpts, | ||
| }) | ||
| } | ||
|
|
||
| type workflowJSONResult struct { | ||
| WorkflowId string `json:"workflowId"` | ||
| RunId string `json:"runId"` | ||
|
|
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hrmm, I don't think
UpdateWithStartWorkflowwill return until it is at least accepted or rejected, and if there is some error, it will be reflected in the error to that call. @dandavison - is this correct?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
An example is sending a request for an update name that does not exist.
errisnil, but the update is not accepted, andhandlecontains within it an error, hence this code (which is also present in CLI update impl) to extract that error without making a network request.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ah, I see, there is "accepted but failed". We should consider adding a
Done() booltoWorkflowUpdateHandlefor this, but in the meantime, all good here.(EDIT: Found we do have an issue at temporalio/features#428)