Add workflow `update result`, `update describe` and `result` commands #658

Sushisource · 2024-09-09T23:37:59Z

This is functionally complete but certainly open to discussion on the details or output.

What was changed

Added these new commands

Why?

More consistent experience for related concepts

Checklist

Closes [Feature Request] Add workflow result, workflow update result, and workflow update describe #647
How was this tested:
Added tests
Any docs updates needed?

Here are some examples of what output looks like from the tests:

For workflow result:

    commands_test.go:153: Calling: workflow result --address 127.0.0.1:43621 -w d8144f29-a91f-471b-99d7-61a1fc6aa307
    commands_test.go:156: Stdout:
    -----
        Results:
          Status          COMPLETED
          Result          "hi!"
          ResultEncoding  json/plain
        
        -----
        -----
        {
          "workflowId": "d8144f29-a91f-471b-99d7-61a1fc6aa307",
          "runId": "8a17387c-5259-4c31-a104-fe7b9a9017af",
          "namespace": "default",
          "status": "COMPLETED",
          "closeEvent": {
            "eventId": "7",
            "eventTime": "2024-09-09T23:35:01.915449305Z",
            "eventType": "EVENT_TYPE_WORKFLOW_EXECUTION_COMPLETED",
            "taskId": "1048607",
            "workflowExecutionCompletedEventAttributes": {
              "result": [
                "hi!"
              ],
              "workflowTaskCompletedEventId": "6"
            }
          },
          "result": "hi!"
        }
        
        -----
    commands_test.go:153: Calling: workflow result --address 127.0.0.1:43621 -w 5cfabe6e-addf-42fc-a458-0061b63c163a
    commands_test.go:156: Stdout:
        -----
        Results:
          Status   FAILED
          Failure  
            Message: failed on purpose
        
        -----
    commands_test.go:153: Calling: workflow result --address 127.0.0.1:43621 -w 5cfabe6e-addf-42fc-a458-0061b63c163a -o json
    commands_test.go:156: Stdout:
        -----
        {
          "workflowId": "5cfabe6e-addf-42fc-a458-0061b63c163a",
          "runId": "368cc0b6-a47f-47c3-9a2f-43c5aa161cd1",
          "namespace": "default",
          "status": "FAILED",
          "closeEvent": {
            "eventId": "6",
            "eventTime": "2024-09-09T23:35:01.921375049Z",
            "eventType": "EVENT_TYPE_WORKFLOW_EXECUTION_FAILED",
            "taskId": "1048625",
            "workflowExecutionFailedEventAttributes": {
              "failure": {
                "message": "failed on purpose",
                "source": "GoSDK",
                "applicationFailureInfo": {}
              },
              "retryState": "RETRY_STATE_RETRY_POLICY_NOT_SET",
              "workflowTaskCompletedEventId": "5"
            }
          }
        }
        
        -----

For update describe:

  commands_test.go:153: Calling: workflow update start --wait-for-stage accepted --address 127.0.0.1:45097 -w 7bd9e978-65d9-4991-8c87-3f6e47844938 --name test-update -i "pass" --update-id passing
    commands_test.go:156: Stdout:
        -----
          Name      test-update
          UpdateID  passing
        
        -----
    commands_test.go:153: Calling: workflow update describe --address 127.0.0.1:45097 -w 7bd9e978-65d9-4991-8c87-3f6e47844938 --update-id passing
    commands_test.go:156: Stdout:
        -----
          UpdateID  passing
          Stage     Accepted
        
        -----
    commands_test.go:153: Calling: workflow update describe --address 127.0.0.1:45097 -w 7bd9e978-65d9-4991-8c87-3f6e47844938 --update-id passing
    commands_test.go:156: Stdout:
        -----
          UpdateID  passing
          Stage     Accepted
        
        -----
    commands_test.go:153: Calling: workflow update describe --address 127.0.0.1:45097 -w 7bd9e978-65d9-4991-8c87-3f6e47844938 --update-id passing
    commands_test.go:156: Stdout:
        -----
          UpdateID  passing
          Result    hi pass
          Stage     Completed
        
        -----
    commands_test.go:153: Calling: workflow update describe --address 127.0.0.1:45097 -w 7bd9e978-65d9-4991-8c87-3f6e47844938 --update-id passing -o json
    commands_test.go:156: Stdout:
        -----
        {
          "updateId": "passing",
          "result": "hi pass",
          "stage": "Completed"
        }
        
        -----
    commands_test.go:153: Calling: workflow update execute --address 127.0.0.1:45097 -w 7bd9e978-65d9-4991-8c87-3f6e47844938 --name test-update -i "reject" --update-id rejected
    commands_test.go:153: Calling: workflow update describe --address 127.0.0.1:45097 -w 7bd9e978-65d9-4991-8c87-3f6e47844938 --update-id rejected
    commands_test.go:153: Calling: workflow update execute --address 127.0.0.1:45097 -w 7bd9e978-65d9-4991-8c87-3f6e47844938 --name test-update -i "fail" --update-id fail
    commands_test.go:153: Calling: workflow update describe --address 127.0.0.1:45097 -w 7bd9e978-65d9-4991-8c87-3f6e47844938 --update-id fail
    commands_test.go:156: Stdout:
        -----
          UpdateID  fail
          Failure   failing
          Stage     Completed
        
        -----
    commands_test.go:153: Calling: workflow update describe --address 127.0.0.1:45097 -w 7bd9e978-65d9-4991-8c87-3f6e47844938 --update-id fail -o json
    commands_test.go:156: Stdout:
        -----
        {
          "updateId": "fail",
          "failure": {
            "message": "failing",
            "source": "GoSDK",
            "FailureInfo": {
              "ApplicationFailureInfo": {}
            }
          },
          "stage": "Completed"
        }
        
        -----

For update result:

  commands_test.go:153: Calling: workflow update execute --address 127.0.0.1:33535 -w 76ab9ebe-acc1-4615-a4aa-a4ebda4ee568 --name test-update -i "pass" --update-id passing
    commands_test.go:156: Stdout:
        -----
          Name      test-update
          UpdateID  passing
          Result    hi pass
        
        -----
    commands_test.go:153: Calling: workflow update result --address 127.0.0.1:33535 -w 76ab9ebe-acc1-4615-a4aa-a4ebda4ee568 --update-id passing
    commands_test.go:156: Stdout:
        -----
          UpdateID  passing
          Result    hi pass
        
        -----
    commands_test.go:153: Calling: workflow update result --address 127.0.0.1:33535 -w 76ab9ebe-acc1-4615-a4aa-a4ebda4ee568 --update-id passing -o json
    commands_test.go:156: Stdout:
        -----
        {
          "updateId": "passing",
          "result": "hi pass"
        }
        
        -----
    commands_test.go:153: Calling: workflow update execute --address 127.0.0.1:33535 -w 76ab9ebe-acc1-4615-a4aa-a4ebda4ee568 --name test-update -i "reject" --update-id rejected
    commands_test.go:153: Calling: workflow update result --address 127.0.0.1:33535 -w 76ab9ebe-acc1-4615-a4aa-a4ebda4ee568 --update-id rejected
    commands_test.go:153: Calling: workflow update execute --address 127.0.0.1:33535 -w 76ab9ebe-acc1-4615-a4aa-a4ebda4ee568 --name test-update -i "fail" --update-id fail
    commands_test.go:153: Calling: workflow update result --address 127.0.0.1:33535 -w 76ab9ebe-acc1-4615-a4aa-a4ebda4ee568 --update-id fail
    commands_test.go:156: Stdout:
        -----
          UpdateID  fail
          Failure   failing
        
        -----
    commands_test.go:153: Calling: workflow update result --address 127.0.0.1:33535 -w 76ab9ebe-acc1-4615-a4aa-a4ebda4ee568 --update-id fail -o json
    commands_test.go:156: Stdout:
        -----
        {
          "updateId": "fail",
          "failure": {
            "message": "failing",
            "details": {}
          }
        }
        
        -----

cretz · 2024-09-10T12:18:32Z

temporalcli/commandsmd/commands.md

 An Update is a synchronous call to a Workflow Execution that can change its
 state, control its flow, and return a result.

 Experimental.

+#### Options set for update targeting


The named options set should be under the first command that uses it instead of this command. This now shows that this command accepts these args. Can move and replace the #### Options section for temporal workflow update describe with this section.

cretz · 2024-09-10T12:19:58Z

temporalcli/commandsmd/commands.md

+* `--workflow-id`, `-w` (string) -
+  Workflow ID.
+  Required.
+* `--update-id` (string) -


This should be required for describe (and therefore reused for result and make start be the unnamed set that has a UUID default)

cretz · 2024-09-10T12:20:34Z

temporalcli/structured_errors.go

Meh, just toss this at the bottom of commands.go IMO

cretz · 2024-09-10T19:09:06Z

temporalcli/commands.go

+	return &structuredError{
+		Message: err.Error(),
+		Type:    err.Type(),
+		Details: err.Details(),


.Details expects a pointer to deserialize into and returns an error if it can't. You could have var details any and then err.Details(&details) (checking error) and then set details to in this field

Ah thanks good catch

cretz · 2024-09-10T19:10:13Z

temporalcli/commands.go

@@ -5,6 +5,7 @@ import (
 	"context"
 	"encoding/json"
 	"fmt"
+	"go.temporal.io/sdk/temporal"


Usually go fmt will get these non-stdlib imports separated from the stdlib ones (here and elsewhere in PR)

It doesn't for me, for whatever reason.

Hrmm, maybe it was goimports or similar that I just assumed was in go fmt by now

cretz

LGTM, but would like someone that has an eye for CLI output to take a peek (@dandavison?)

josh-berry · 2024-09-13T21:33:47Z

Filed #667 for an unrelated failed test on Windows that happened to show up in this PR.

josh-berry · 2024-09-13T21:53:19Z

LGTM, but would like someone that has an eye for CLI output to take a peek (@dandavison?)

Took a quick look and it seems reasonable to me. Merging so this can be included in the CLI release on Monday.

cretz reviewed Sep 10, 2024

View reviewed changes

Sushisource force-pushed the add-result-describe branch from 57bf705 to 38bb8ef Compare September 10, 2024 17:54

cretz reviewed Sep 10, 2024

View reviewed changes

cretz approved these changes Sep 10, 2024

View reviewed changes

Sushisource added 8 commits September 13, 2024 12:56

Add stubs for new commands

a6dab39

Add workflow result command

4f4c9d4

Implement update result

b8f6e87

Fix typo in md causing alias to not get written

bce0e78

Add update describe command

a2d761c

Add failing to workflow result test

a00cec0

Review fixes

3ffee9b

Fix failure detail extraction

d781eb9

Sushisource force-pushed the add-result-describe branch from 1a605b7 to d781eb9 Compare September 13, 2024 19:57

josh-berry merged commit a754102 into main Sep 13, 2024
7 checks passed

josh-berry deleted the add-result-describe branch September 13, 2024 21:54

BrewTestBot mentioned this pull request Sep 17, 2024

temporal 1.1.0 Homebrew/homebrew-core#190910

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add workflow `update result`, `update describe` and `result` commands #658

Add workflow `update result`, `update describe` and `result` commands #658

Sushisource commented Sep 9, 2024

cretz Sep 10, 2024

cretz Sep 10, 2024

cretz Sep 10, 2024

cretz Sep 10, 2024

Sushisource Sep 10, 2024

cretz Sep 10, 2024

Sushisource Sep 10, 2024

cretz Sep 10, 2024

cretz left a comment

josh-berry commented Sep 13, 2024

josh-berry commented Sep 13, 2024

Add workflow update result, update describe and result commands #658

Add workflow update result, update describe and result commands #658

Conversation

Sushisource commented Sep 9, 2024

What was changed

Why?

Checklist

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

cretz left a comment

Choose a reason for hiding this comment

josh-berry commented Sep 13, 2024

josh-berry commented Sep 13, 2024

Add workflow `update result`, `update describe` and `result` commands #658

Add workflow `update result`, `update describe` and `result` commands #658