temporal icon indicating copy to clipboard operation
temporal copied to clipboard

Attach user metadata from commands to corresponding history events

Open gow opened this issue 1 year ago • 2 comments

What changed?

In this PR we are attaching the user metadata if found in the command to the corresponding history events that are being created.

Why?

Users need a way to set arbitrary information on workflows and events. This would be later used in the clients to build custom tooling (ex: UI showing additional information about a timer event etc)

How did you test it?

Added unit tests

Potential risks

N/A. It is backward compatible.

Documentation

N/A

Is hotfix candidate?

No

gow avatar May 06 '24 19:05 gow

Will let others more familiar with this repo review. But I want to confirm that some features will be present:

  • Is the user metadata on StartWorkflowExecution and SignalWithStartWorkflowExecutionRequest copied to the start event?
  • Is the user metadata on the child workflow command copied to the workflow start event?
  • Is the user metadata on NewWorkflowExecutionInfo copied to the start event on schedules?
  • Is the user metadata on WorkflowExecutionConfig returned from describe populated with the metadata the workflow was started with?

cretz avatar May 07 '24 20:05 cretz

Will let others more familiar with this repo review. But I want to confirm that some features will be present:

  • Is the user metadata on StartWorkflowExecution and SignalWithStartWorkflowExecutionRequest copied to the start event?
  • Is the user metadata on the child workflow command copied to the workflow start event?
  • Is the user metadata on NewWorkflowExecutionInfo copied to the start event on schedules?
  • Is the user metadata on WorkflowExecutionConfig returned from describe populated with the metadata the workflow was started with?

This is PR is just for commands only (to keep PRs short). I'm working on another PR to include user metadata in all the other areas you mentioned.

gow avatar May 08 '24 18:05 gow