Add high level workflow describe #1924
Conversation
client/client.go
Outdated
| // - serviceerror.Internal | ||
| // - serviceerror.Unavailable | ||
| // - serviceerror.NotFound | ||
| DescribeWorkflow(ctx context.Context, workflowID, runID string) (*DescribeWorkflowExecution, error) |
There was a problem hiding this comment.
Returned a pointer here for consistency with some other APIs
| @@ -901,6 +917,27 @@ type QueryWorkflowWithOptionsResponse struct { | |||
| QueryRejected *querypb.QueryRejected | |||
| } | |||
|
|
|||
| type WorkflowExecutionMetadata struct { | |||
There was a problem hiding this comment.
I picked fields to expsoe here based of what dotnet exposed https://github.com/temporalio/sdk-dotnet/blob/main/src/Temporalio/Client/WorkflowExecutionDescription.cs#L10
There was a problem hiding this comment.
Works for me, though not the biggest fan of the term "metadata", but I know it's what Java uses, so up to you. I figure one day we'll deprecate all the bad forms of "list" and have a new "list" call that returns iter.Seq[WorkflowExecutionMetadata], but not sure if that affects your name choice.
There was a problem hiding this comment.
If you have a different name I am open to suggestions, when we add list I was going to add another type that would also embedded WorkflowExecutionMetadata
There was a problem hiding this comment.
Yeah, since WorkflowExecution is already in use elsewhere, this is fine. Not sure at list time we need another type since list contents should be a subset of describe, but can discuss at that time.
client/client.go
Outdated
| // - serviceerror.Internal | ||
| // - serviceerror.Unavailable | ||
| // - serviceerror.NotFound | ||
| DescribeWorkflow(ctx context.Context, workflowID, runID string) (*DescribeWorkflowExecution, error) |
There was a problem hiding this comment.
Do we want to accept DescribeWorkflowOptions for future proofing?
There was a problem hiding this comment.
I was thinking we would add DescribeWorkflowWithOptions if we ever add more options here
| @@ -901,6 +917,27 @@ type QueryWorkflowWithOptionsResponse struct { | |||
| QueryRejected *querypb.QueryRejected | |||
| } | |||
|
|
|||
| type WorkflowExecutionMetadata struct { | |||
There was a problem hiding this comment.
Works for me, though not the biggest fan of the term "metadata", but I know it's what Java uses, so up to you. I figure one day we'll deprecate all the bad forms of "list" and have a new "list" call that returns iter.Seq[WorkflowExecutionMetadata], but not sure if that affects your name choice.
| // GetStaticSummary returns the summary set on workflow start. | ||
| // | ||
| // NOTE: Experimental | ||
| func (w *WorkflowExecutionDescription) GetStaticSummary() (string, error) { |
There was a problem hiding this comment.
Arguably could be worth memoizing e.g. behind a sync.Once, but no strong opinion
Quinn-With-Two-Ns
force-pushed
the
issue-1667
branch
2 times, most recently
from
9021a9b to
aa30f1b
Compare
Quinn-With-Two-Ns
force-pushed
the
issue-1667
branch
from
aa30f1b to
095000f
Compare
Add high level workflow describe
close #1667