fix(watcher): reap finished issue-processing task handles [DISCORD-15363517] - #138
Conversation
The watcher pushed a JoinHandle into `spawn_handles` for every issue it dispatched and never removed it outside of tests, so the list was push-only in production. Tokio frees a task's allocation only once both the scheduler and the last JoinHandle are dropped, so each completed `process_issue` task stayed resident for the daemon's lifetime — and that allocation is large, since `process_issue` inlined the whole `IssueProcessor::run` pipeline. RSS therefore grew monotonically with issues processed until the container was OOM-killed and restarted with a fresh (empty) list, matching the reported intermittent OOM kills. - Reap finished handles once per poll cycle and on every dispatch, so the list is bounded by concurrency instead of issues-processed-ever. - Drain the spawned tasks in `stop_and_drain` so shutdown waits for their teardown too. - Box the `processor.run(...)` future so each spawned task allocation carries a pointer instead of the fully inlined pipeline state machine. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Greptile SummaryThe PR bounds watcher task-handle retention and makes issue-processing shutdown tracking race-safe.
Confidence Score: 5/5The PR appears safe to merge. No blocking failure remains; the current code synchronizes spawning with draining, tracks retry and review tasks, bounds both post-abort joining and runtime teardown, and avoids polling completed handles twice. Important Files Changed
Reviews (18): Last reviewed commit: "added comments for running" | Re-trigger Greptile |
Fix Confidence: 88/100High confidence the leak is real and fixed: the push-only Vec was verified directly in code (grep over crates/ and src/ returns only the field decl, init, the test-only drain, and the push), the new test fails on main and passes with the change, and all 1186 engine unit tests plus all 16 PR checks are green. Deducted for two things I could not verify end-to-end: (1) I did not measure actual RSS of a running daemon before/after, so the OOM kills could have a second contributing cause beyond this leak; (2) the |
|
@claudear Comment: When shutdown overlaps a dispatch that has passed its running check but has not yet recorded its spawned task, For each issue above, determine whether it is valid and should be fixed. If so, fix it directly. |
…ary' into fix/DISCORD-15363517-watcher-join-handle-leak
Re-check is_running and spawn+record the handle under the spawn_handles lock that drain_spawned_tasks takes. Since stop() sets is_running=false before draining, a dispatch either records before the drain's take (so shutdown joins it) or sees the stop and never spawns. The top-of-loop check alone left a window between check and push.
Wrapping drain_spawned_tasks in a timeout dropped the handles it had already taken from spawn_handles, detaching unfinished tasks so the runtime aborted them mid-operation. drain_spawned_tasks_until pops one handle at a time and joins via &mut handle, putting any handle that exceeds the budget back into spawn_handles instead of dropping it.
The 30s cap let stop_and_drain return while a task was still running, after which runtime teardown aborted it mid-operation. Drain the spawn_handles to completion instead (active_processing is only bumped inside handle-tracked process_issue, so the handles subsume it). Unbounded on purpose: production races this against an operator force-quit, the intended hard limit. Supersedes the cancel-safe timeout drain, which the fixed budget still undermined.
Unbounded drain could stall a non-interactive shutdown (redeploy SIGTERM) when a task was wedged in an external git/LLM op with no internal timeout. drain_or_abort waits up to GRACEFUL_DRAIN_BUDGET (30s), then aborts remaining tasks explicitly and logs it, rather than stalling or leaving them for runtime teardown. Cancel-safe: handles are joined via &mut so the timeout drops only the borrow, keeping them for the abort pass.
2ff2418 to
daa8c23
Compare
Retries and review feedback reached process_issue through trigger_issue_with_feedback, which awaited it inline on the housekeeping task. That execution was never recorded in spawn_handles, so it escaped drain_or_abort: the select! in start() could drop it mid-operation, and graceful shutdown reported a clean stop while it was still mutating tracker, notifier, or agent state. Route that path through the same spawn-and-track mechanism as the poll loop. trigger_issue_with_feedback now spawns process_issue into spawn_handles under the same lock drain takes, with the identical is_running re-check, so the work survives the housekeeping future being dropped and is joined by the graceful drain. A oneshot channel carries the started bool back and fires at the end of process_issue, preserving the synchronous contract: the call still blocks to completion and still returns "already being processed" when it did not start, so retry concurrency and the review-wait loop are unchanged. A trigger arriving after stop() is refused instead of leaking a handle past the drain. Propagate self: &Arc<Self> through trigger_issue, trigger_issue_with_feedback, process_review_action, check_reviews, process_ready_retries, and run_housekeeping_cycle. Add test_trigger_records_spawn_handle_for_drain and test_trigger_refuses_once_stopped.
trigger_issue now spawns tracked processing and refuses once the watcher is stopping, so the one-shot retry and Trigger CLI paths must mark their never-started watchers running or every trigger returns a stopping error. Also Arc-wrap the retry-path watcher for the &Arc<Self> receiver.
After the graceful budget is exhausted the drain aborted stragglers and then awaited every handle to completion, unbounded. abort() only takes effect at a task's next await, so a task parked in synchronous blocking work (block_in_place bridging an LLM call) never observes it until that call returns, and the join blocked until then, re-introducing the unbounded shutdown wait the budget exists to prevent. Cap the post-abort join with a short grace joined via &mut so the timeout drops only the borrow. Handles still unfinished are dropped and left to the imminent runtime teardown, and the straggler is logged as detached. Add test_drain_or_abort_bounds_post_abort_join_for_blocking_task.
The watcher drain aborts stragglers and detaches any parked in non-preemptible blocking work, but dropping the multi-thread runtime by default waits indefinitely for that work to return, so an orphaned block_in_place LLM call could still stall a redeploy's SIGTERM during runtime teardown. Own the runtime explicitly and shut it down with a 5s timeout after block_on returns, detaching whatever blocking work remains for process exit to reclaim. Keeps the sentry and logging flush guards intact.
trigger_issue now takes &Arc<Self> and refuses once the watcher is stopping, so the e2e harness stores an Arc<Watcher> and marks it running for its one-shot trigger calls. Fixes the integration-test compile break caught by tarpaulin.
The graceful drain pass polls handles via &mut and can complete an early handle before timing out on a later wedged one. The post-abort pass then iterated all handles again and awaited the already-completed one, and awaiting a JoinHandle after it returned Ready panics with "JoinHandle polled after completion", crashing shutdown. Skip finished handles in the post-abort join so only still-running tasks are awaited. Add test_drain_or_abort_no_double_poll_of_completed_handle, which panics without the guard.
|
Want your agent to iterate on Greptile's feedback? Start a greploop in Claude Code and it will work through the open comments and keep going until this PR reviews clean. |
Problem
appwrite/claudeargets OOM-killed intermittently. The daemon leaks memory in proportion to the number of issues it processes.Watcher.spawn_handlesis aVec<JoinHandle<()>>that is push-only in production.dispatch_lanepushes a handle for every spawnedprocess_issuetask, and the only code that removes entries isdrain_spawned_tasks(), whose call sites were all inside#[cfg(test)] mod tests. Nothing in the run loop, the housekeeping loop, or the stop path ever reaped them.Tokio frees a task's allocation only once both the scheduler and the last
JoinHandleare dropped, so every completed issue-processing task stayed resident for the process lifetime. That allocation is not a 24-byte handle:process_issueawaitedIssueProcessor::runinline with no boxing, so each retained handle pinned the entire inlined pipeline state machine.RSS therefore climbed monotonically across days of polling until the kernel OOM-killed the container, which then restarted with a fresh (empty)
Vec— matching the reported "sometimes gets OOM killed" pattern.Agent spawning itself is not out of bounds: the per-source/per-lane gating in
dispatch_laneis correct,ProcessingState::removedecrements properly, and the intent-classification path is explicitly sequential.Fix
Bound the handle list (the leak)
poll_source, before the rate-limit early return so an idle or paused watcher still frees them) and on every dispatch, so the list is bounded by concurrency rather than by issues-processed-ever.Box::pintheprocessor.run(...)await so each spawned task allocation carries a pointer instead of the fully inlined pipeline state machine, shrinking the per-task footprint while tasks are running, not just after they finish.Make shutdown drain correctly (the drain path)
stop_and_drainso shutdown waits for their teardown instead of letting runtime teardown abort them mid-operation and misreport a graceful stop.is_runningunder the same lock the drain takes, then spawns and records atomically, so a dispatch either records its handle before the drain'smem::take(and is joined) or sees the stop and never spawns.&mut, so a timeout drops only the borrow — the owned handles survive for the abort pass and are never detached.abort()only takes effect at a task's next await, so a task parked in synchronous blocking work (block_in_placebridging an LLM call, e.g. the agent repo classifier) never observes it until that call returns — awaiting it to completion re-introduced the unbounded wait the budget exists to prevent. The post-abort join now runs under a short grace; any handle still unfinished is dropped and logged.block_in_placeop could still stall process exit after the drain returned.mainnow owns the runtime and callsRuntime::shutdown_timeout(5s)afterblock_on, capping teardown and detaching whatever remains for process exit to reclaim (the sentry and logging flush guards stay intact).&mutand can poll an early handle to completion before it times out on a later wedged one; the post-abort pass then iterated all handles again and awaited the finished one, and awaiting aJoinHandleafter it returnedReadypanics ("JoinHandle polled after completion"), crashing shutdown. The post-abort join now skips already-finished handles.Track retry/review processing in
spawn_handles(this commit)Retries and review feedback reach
process_issuethroughtrigger_issue_with_feedback, which awaited it inline on the housekeeping task. That execution was never recorded inspawn_handles, so it escaped the drain entirely:tokio::select!instart()completes as soon as the poll branch returns on shutdown and drops the housekeeping future, cancelling an in-flight inlineprocess_issueat its next await.drain_or_abortonly joinsspawn_handles, so it reported a clean stop while the inline retry/review run was still mutating tracker, notifier, or agent state — exactly the failure mode the drain was built to prevent for the spawned path.Route that path through the same spawn-and-track mechanism as the poll loop:
trigger_issue_with_feedbacknow spawnsprocess_issueintospawn_handlesunder the same lock the drain takes, with the identicalis_runningre-check, so the work survives the housekeeping future being dropped and is joined by the graceful drain.oneshotchannel carries thestartedbool back and fires at the end ofprocess_issue, preserving the synchronous contract: the call still blocks until processing completes and still returns"already being processed"when it did not start, so per-source retry concurrency and the review-wait loop are unchanged.stop()is refused instead of leaking a handle past the drain'smem::take.self: &Arc<Self>throughtrigger_issue,trigger_issue_with_feedback,process_review_action,check_reviews,process_ready_retries, andrun_housekeeping_cycle. The daemon paths already holdArc<Watcher>; the one-shotretryandTriggerCLI commands build a never-started watcher, so they now mark it running for the duration of the trigger (a trigger is refused once the watcher is stopping).Test
test_watcher_reaps_finished_spawn_handlesseedsspawn_handleswith the handles of 64 completed tasks, waits for them to finish, then runs a normal poll cycle and asserts nothing is retained. Fails onmainwithretained 64 handles, passes with this change.test_stop_and_drain_joins_recorded_task/test_stop_and_drain_joins_task_to_completionassert the drain waits for a recorded task's teardown rather than reporting a clean stop while it runs.test_drain_or_abort_bounds_wedged_taskasserts a wedged task can't stall shutdown past its budget.test_drain_or_abort_bounds_post_abort_join_for_blocking_taskasserts a task parked in non-preemptible blocking work can't stall shutdown past the abort grace.test_drain_or_abort_no_double_poll_of_completed_handleasserts a completed-then-wedged handle ordering doesn't panic the drain (panics without the fix).test_trigger_records_spawn_handle_for_drainasserts a retry/review trigger records a drain-tracked handle inspawn_handles.test_trigger_refuses_once_stoppedasserts a trigger afterstop()spawns no handle.Full suite: 1201 passed, 0 failed (
cargo test -p claudear-engine --lib --features sqlite).cargo fmtandcargo clippy --features sqlite --libare clean.Reported in Discord.
🤖 Generated with Claude Code