Add completed_by_worker_shutdown field to poll responses#730
Open
Add completed_by_worker_shutdown field to poll responses#730
Conversation
Add a bool field to PollWorkflowTaskQueueResponse, PollActivityTaskQueueResponse, and PollNexusTaskQueueResponse to indicate when an empty poll response was caused by the server rejecting the poll because the worker has been shut down via the ShutdownWorker API. Made-with: Cursor
dnr
reviewed
Mar 17, 2026
Contributor
dnr
left a comment
There was a problem hiding this comment.
Does it make more sense to do this with a specific grpc error code instead? Maybe NotFound or FailedPrecondition? Something that would make old SDKs abort or at least back off?
This was referenced Mar 17, 2026
f7ea4d9 to
4993846
Compare
Contributor
Author
We agreed to not introduce a new error as this interferes with older sdks. |
Aligns the field name with the ShutdownWorker capability name and removes ambiguity from the old name. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
4993846 to
d3b45e9
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What changed?
Add
completed_by_worker_shutdownbool field toPollWorkflowTaskQueueResponse,PollActivityTaskQueueResponse, andPollNexusTaskQueueResponse.Why?
When the server completes a poll because the worker was shut down via
ShutdownWorker, SDKs currently receive an empty response indistinguishable from a normal poll timeout. This gives SDKs an explicit signal to stop re-polling, and is useful for debugging.How did you test it?
Potential risks
None — additive proto field, fully backward compatible.