Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Support full, structured failures for queries #6845

Open
cretz opened this issue Nov 20, 2024 · 1 comment
Open

Support full, structured failures for queries #6845

cretz opened this issue Nov 20, 2024 · 1 comment
Labels
enhancement New feature or request

Comments

@cretz
Copy link
Member

cretz commented Nov 20, 2024

Describe the solution you'd like

Today we only support a single string for query failure: https://github.com/temporalio/api/blob/c5bab058fa7ffb52c7137cdbaabd37ac0c41537f/temporal/api/query/v1/message.proto#L56. This means users can't get stack traces or set any of the details they expect to be able to set when using errors in other parts of the platform (workflows, activities, updates, etc). Also, users expect to be able to "encode" failures (i.e. move the message to a payload so it is encryptable, see here), but queries not supporting our proper failure structures does not allow them to do this for queries.

Support a full temporal.api.failure.v1.Failure on query result (can be mutually exclusive with the string today)

@cretz cretz added the enhancement New feature or request label Nov 20, 2024
@cretz
Copy link
Member Author

cretz commented Nov 21, 2024

Proposed API:

  • Add temporal.api.failure.v1.Failure failure to temporal.api.query.v1.WorkflowQueryResult. This will be set by SDKs in addition to the existing error_message.
  • Add temporal.api.failure.v1.Failure failure to temporal.api.errordetails.v1.QueryFailedFailure. This will be populated by server with the failure from above

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant