Skip to content

Update graceful worker shutdown #627

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.

Sign up for GitHub

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

Merged
yuandrew merged 7 commits into from
Jul 14, 2025
Merged

Update graceful worker shutdown #627

Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
23ccf73
Edit README for shutdown
yuandrew May 28, 2025
b47ad88
PR feedback
yuandrew May 28, 2025
16db718
heartbeating blurb
yuandrew May 28, 2025
8b0f40a
Merge branch 'main' into graceful-worker-shutdown
yuandrew Jul 8, 2025
690e2bd
Be more specific about core vs. lang timeout behavior
yuandrew Jul 8, 2025
9a26089
Add links, add TS TODO
yuandrew Jul 9, 2025
2134fe6
Merge branch 'main' into graceful-worker-shutdown
yuandrew Jul 14, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 17 additions & 7 deletions features/activity/shutdown/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,22 @@ complete with failure, and ignore the cancel. The one which ignores the cancel s
encounter a hard timeout.

# Detailed spec
* If a worker is told to begin shutdown, activities are immediately notified via
a cancel. It must be possible for the user to determine if this cancel was issued
by server, or is the result of worker shutdown
* When a worker shutdown is initiated, the activity context isn't canceled until the
graceful shutdown timeout has elapsed
* Graceful shutdown language behavior
* Core based SDKs - when graceful shutdown timeout isn't specified, this is treated as a 0 second timeout
* Note: Core itself treats no graceful shutdown timeout meaning no-timeout, but every lang has logic to
set a 0 second timeout when lang-side timeout not specified
* Go - when graceful shutdown timeout isn't specified, this is treated as a 0 second timeout
* Java - there is no timeout parameter set like Go or Core, but instead after calling `shutdown()`
a user can call `workerFactory.awaitTermination(timeout, unit)` and `isTerminated()` to see if the timeout
has passed, then it is up to the user to forcibly shutdown or do something else
* It must be possible for an activity to determine that a worker is being shut down even before graceful timeout elapses
* [TODO TS](https://github.com/temporalio/sdk-typescript/issues/1739)
* It must be possible for the user to determine whether the activity context cancel was the result of worker shutdown,
or issued by server
* [TODO Java](https://github.com/temporalio/sdk-java/issues/1005) - need to add a way for Activities to know when the worker is being shutdown.
* Activities may handle the cancel however they like (including continuing running)
* Heartbeating is possible while the shutdown process is ongoing
* Heartbeating is possible while the shutdown process is ongoing, both during and after the graceful shutdown period
* If all activities complete, shutdown can complete (assuming WFT work is complete too)
* SDKs should provide a timeout parameter which, if elapsed, shutdown completes even if
there are still running activities. If such activities complete later their response
is ignored
* If an activity runs indefinitely and ignores the cancelation, then worker shutdown will hang indefinitely.
Loading