User metadata not propagated from child workflow command to child workflow's execution config

[dhiaayachi]

Expected Behavior

Like start workflow, I would expect start child workflow user metadata to end up on the execution config on the child workflow.

Actual Behavior

The user metadata only ends up on the event, not the actual child workflow

See https://github.com/temporalio/temporal/pull/5857 where user metadata propagation was added.

[dhiaayachi]

Thanks for reporting this! It looks like the user metadata is only available on the event, not the actual child workflow. This is not the expected behavior, and you've found a real issue! There are a few ways to work around this issue until a permanent fix is available:

• Use a query: You can use a query to retrieve the user metadata from the child workflow. For example:

tctl workflow query --workflow_id "my_child_workflow" --query_type "getUserMetadata"

• Signal the child workflow: You can signal the child workflow with the user metadata. For example:

tctl workflow signal --workflow_id "my_child_workflow" --name "setUserMetadata" --input '{"user_metadata": "my_user_metadata"}'

We're working on a fix for this issue, and we appreciate you bringing it to our attention.

[dhiaayachi]

Thanks for reporting this issue! It seems like you are experiencing an issue with user metadata propagation when starting child workflows. The user metadata is currently only being attached to the StartChildWorkflowExecutionInitiated event and not the child workflow itself.

The documentation for the StartChildWorkflowExecutionInitiated event can be found here: https://docs.temporal.io/references/events#startchildworkflowexecutioninitiated

To work around this issue, you can use one of these methods:

• Attach user metadata to the child workflow's input: Pass the user metadata as part of the child workflow's input parameters. This way, the child workflow can access the user metadata.
• Use a Signal to pass user metadata: After the child workflow has started, send a Signal with the user metadata. The child workflow can then handle the Signal and retrieve the user metadata.

Let us know if you have any further questions or if this solution doesn't work for you.