temporalio / temporalio/features
[Feature Request] SDKs should set `supported-features` header
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 32
- Forks
- 28
- Avg merge
- 1d 9h
- Merged PRs (30d)
- 7
Description
Is your feature request related to a problem? Please describe.
In some cases, the server can change how it behaves to different SDK versions, e.g. for backwards-compatibility workarounds like https://github.com/temporalio/temporal/pull/1949. This could be useful in the future for filtering out event types or fields that SDKs don't need to be aware of.
Describe the solution you'd like
We decided a feature list was the most maintainable solution (so the server doesn't have to keep track of which versions of which SDK support which feature). If the list gets too long we can start grouping things. I forgot to follow up on this part of the solution in September, so doing it now.
SDKs should send the supported-features header with an initial value of follows-next-run-id, since they all support that now.
Additional context
https://github.com/temporalio/temporal/pull/1949
https://github.com/temporalio/temporal/blob/c2a3a2bdfb6377a633928203ffe577281da216d1/common/headers/headers.go#L37
https://github.com/temporalio/temporal/blob/c2a3a2bdfb6377a633928203ffe577281da216d1/common/headers/versionChecker.go#L54
https://github.com/temporalio/temporal/blob/c2a3a2bdfb6377a633928203ffe577281da216d1/common/headers/versionChecker.go#L150-L156
Contributor guide
No contributing guide indexed for this repository
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 by reading common/headers/headers.go and common/headers/versionChecker.go, especially the referenced lines, then trace how SDK requests construct headers. Confirm that each SDK sends supported-features with follows-next-run-id, and verify the behavior against the compatibility work described in temporalio/temporal#1949.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- go
- Domain
- api
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 30/100