temporalio / temporalio/temporal
Support full, structured failures for queries
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 23.2k
- Forks
- 1.9k
- Avg merge
- 2d 8h
- Merged PRs (30d)
- 228
Description
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)
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with temporal/api/query/v1/message.proto at line 56 and compare the failure structure described in temporal/api/failure/v1/message.proto at lines 107-122. Trace how query results use the current string failure, then define completion as supporting a mutually exclusive temporal.api.failure.v1.Failure while preserving the existing string form and allowing encoded failure details.
Written by the indexing model from the issue text.
Assessment
- Domain
- api, backend-api-design, distributed-systems
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100