Skip to content

ref(workerchild): move checking future completion into bg thread #727

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
bmckerry merged 1 commit into from
Jun 23, 2026
+50 −33
Merged

ref(workerchild): move checking future completion into bg thread #727

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
83 changes: 50 additions & 33 deletions clients/python/src/taskbroker_client/worker/workerchild.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
import time
from collections.abc import Callable, Generator, Sequence
from dataclasses import dataclass
from functools import partial
from multiprocessing.synchronize import Event
from types import FrameType
from typing import Any
Expand Down Expand Up @@ -294,43 +295,57 @@ def get_oldest_pending_activation() -> ActivationWithPendingFutures | None:
oldest = task
return oldest

def check_task_future_completion() -> None:
if len(pending_task_futures) > 0:
# Records how many activations with pending producer futures
# the worker child has. Only records when there are pending activations.
metrics.gauge(
"taskworker.worker.activations_with_pending_futures",
len(pending_task_futures),
tags={
"processing_pool": processing_pool_name,
},
)
for task in pending_task_futures.copy():
future_status = [f.done() for fut in task.pending_futures.values() for f in fut]
if all(future_status):
await_task_futures(task)
else:
# How many futures are still pending in this task
def check_task_future_completion(
shutdown_event: Event, local_shutdown: threading.Event
) -> None:
while not shutdown_event.is_set() and not local_shutdown.is_set():
if len(pending_task_futures) > 0:
# Records how many activations with pending producer futures
# the worker child has. Only records when there are pending activations.
metrics.gauge(
"taskworker.worker.activations_with_pending_futures",
len(pending_task_futures),
tags={
"processing_pool": processing_pool_name,
},
)
for task in pending_task_futures.copy():
future_status = [
f.done() for fut in task.pending_futures.values() for f in fut
]
if all(future_status):
await_task_futures(task)
else:
# How many futures are still pending in this task
metrics.distribution(
"taskworker.task.incomplete_futures",
len([f for f in future_status if not f]),
tags={
"processing_pool": processing_pool_name,
"namespace": task.inflight.activation.namespace,
"taskname": task.inflight.activation.taskname,
},
)
# How long has the oldest pending task been sitting in the queue
if oldest := get_oldest_pending_activation():
metrics.distribution(
"taskworker.task.incomplete_futures",
len([f for f in future_status if not f]),
"taskworker.worker.oldest_pending_activation_age",
time.time() - oldest.futures_start_time,
tags={
"processing_pool": processing_pool_name,
"namespace": task.inflight.activation.namespace,
"taskname": task.inflight.activation.taskname,
"namespace": oldest.inflight.activation.namespace,
"taskname": oldest.inflight.activation.taskname,
},
)
# How long has the oldest pending task been sitting in the queue
if oldest := get_oldest_pending_activation():
metrics.distribution(
"taskworker.worker.oldest_pending_activation_age",
time.time() - oldest.futures_start_time,
tags={
"processing_pool": processing_pool_name,
"namespace": oldest.inflight.activation.namespace,
"taskname": oldest.inflight.activation.taskname,
},
)
else:
time.sleep(0.1)
Comment thread
sentry[bot] marked this conversation as resolved.

_future_completion_thread = threading.Thread(
name="check-future-completion",
target=partial(check_task_future_completion, shutdown_event, local_shutdown),
daemon=True,
)
_future_completion_thread.start()
Comment thread
cursor[bot] marked this conversation as resolved.
Comment thread
sentry[bot] marked this conversation as resolved.

while not shutdown_event.is_set() and not local_shutdown.is_set():
if max_task_count and processed_task_count >= max_task_count:
Expand All @@ -341,10 +356,11 @@ def check_task_future_completion() -> None:
logger.info(
"taskworker.max_task_count_reached", extra={"count": processed_task_count}
)
# Still set the shutdown signal to trigger shutdown of the future checker thread
local_shutdown.set()
break

try:
check_task_future_completion()
inflight = child_tasks.get(timeout=1.0)
except queue.Empty:
metrics.incr(
Expand Down Expand Up @@ -530,6 +546,7 @@ def check_task_future_completion() -> None:
pending_task_futures.append(pending_task)

# Once we get the shutdown signal, drain any pending futures
_future_completion_thread.join()
Comment thread
cursor[bot] marked this conversation as resolved.
Comment thread
sentry[bot] marked this conversation as resolved.
for task in pending_task_futures.copy():
await_task_futures(task)

Expand Down
Loading