User metadata and workflow metadata support #378
Conversation
This reverts commit 64faaf9.
Sushisource
left a comment
Sushisource
left a comment
There was a problem hiding this comment.
Makes sense to me! Not much to think about really. Left a few comment suggestions
| /// </summary> | ||
| /// <param name="Delay">Delay duration.</param> | ||
| /// <param name="CancellationToken">Optional cancellation token.</param> | ||
| /// <param name="Summary">Summary for the delay.</param> |
There was a problem hiding this comment.
Maybe worth saying "which will appear in the workflow history" or something
For new users it might be really nonobvious why a "delay" would have a summary.
There was a problem hiding this comment.
This is the interceptor field (mostly because .NET linting makes me document it). For the one the user calls, in DelayOptions, it states:
Gets or sets a simple string identifying this timer that may be visible in UI/CLI. While it can be normal text, it is best to treat as a timer ID.
| /// This can be in single-line Temporal markdown format. | ||
| /// </summary> | ||
| /// <remarks>WARNING: This setting is experimental.</remarks> | ||
| public string? Summary { get; set; } |
There was a problem hiding this comment.
No, and neither is the timer one. And technically in history, neither is the workflow one. We only call the workflow one StaticSummary because we want to use the term StaticDetails and to clarify they are immutable/static and differentiate those from the concept of CurrentDetails which is mutable. So workflows have "static" summary/details even though they are really just details, but we don't want confused with "current" details. We could not find better terminology for these when we designed them.
| public string? Name { get; } | ||
|
|
||
| /// <summary> | ||
| /// Gets or sets a short description for this query that may appear in UI/CLI. |
There was a problem hiding this comment.
Maybe worth mentioning that this is returned when asking what queries a workflow supports, and that that is what may appear in UI/CLI
| public string? Name { get; } | ||
|
|
||
| /// <summary> | ||
| /// Gets or sets a short description for this update that may appear in UI/CLI. |
There was a problem hiding this comment.
Same about when this is returned
2 participants
What was changed
WorkflowOptions.StaticSummaryandWorkflowOptions.StaticDetailsfor setting static summary/details on workflow start, workflow signal with start, and schedule workflow actionActivityOptions.Summaryfor setting a summary for activity executionsChildWorkflowOptions.StaticSummaryandChildWorkflowOptions.StaticDetailsfor setting summary/details on child workflow startWorkflow.DelayWithOptionsAsyncandDelayOptionsfor an options-based overload that supports timerSummaryWorkflow.WaitConditionWithOptionsAsyncandWaitConditionOptionsfor an options-based overload that supports timeout timerSummaryWorkflowExecutionDescription.StaticSummaryandWorkflowExecutionDescription.StaticDetailsfor viewing summary/details on workflow describeWorkflow.CurrentDetailsproperty with get/set, so it can be set with a string visible on workflow metadataDefinitionsupport for signal, query, and update attributes/definitions__temporal_workflow_metadataquery in workflow instanceCan ignore commits prior to the one for this PR, they are in main already.
Checklist