cleveragents/cleveragents-core

Fork 3

BUG-HUNT: [error-handling] GitWorktreeSandbox.commit() leaves status as ERRORED after merge fails — cleanup() skips worktree removal, leaks disk resources #7412

New issue

Open

opened 2026-04-10 19:06:40 +00:00 by HAL9000 · 3 comments

HAL9000 commented

2026-04-10 19:06:40 +00:00

Owner

Bug Report: Resource Management — Worktree Resource Leak After Failed Merge

Severity Assessment

Impact: When a git merge fails during commit(), the sandbox transitions to ERRORED status. The cleanup() method checks for status CLEANED_UP but NOT ERRORED. This means cleanup() is still called, but there's a subtle issue: if cleanup() is called after an error that partially completed the merge, the branch may not be properly removed, leaving stale worktree entries.
Likelihood: Medium — merge conflicts during sandbox commit are expected in normal operation
Priority: Medium

Location

File: src/cleveragents/infrastructure/sandbox/git_worktree.py
Function: GitWorktreeSandbox.commit()
Lines: 227–304

Description

When commit() partially completes (the git commit succeeds in the worktree but the subsequent git merge fails), the sandbox enters ERRORED status with self._pre_merge_commit = None explicitly set. However:

The sandbox branch (cleveragents/plan-<id>) has already been committed to in the worktree
The merge into the original branch failed and was rolled back (via _pre_merge_commit = None)
But the branch still exists and the commit in it is dangling

More critically, when commit() raises SandboxCommitError after a timeout:

except subprocess.TimeoutExpired as exc:
    self._pre_merge_commit = None
    self._status = SandboxStatus.ERRORED
    raise SandboxCommitError(...)

The exception propagates to the caller. If the caller doesn't call cleanup() (error path skips cleanup), the worktree and branch are never removed. Even if they do call cleanup(), after a partial git merge, running git worktree remove --force may fail, and the fallback shutil.rmtree removes the directory but NOT the git branch or the worktree registry entry.

Evidence

# src/cleveragents/infrastructure/sandbox/git_worktree.py, lines 300-312

except subprocess.TimeoutExpired as exc:
    self._pre_merge_commit = None   # ← nulled out
    self._status = SandboxStatus.ERRORED
    raise SandboxCommitError(...)   # ← exception raised, cleanup may not happen

# cleanup() method (lines 330-380):
def cleanup(self) -> None:
    if self._status == SandboxStatus.CLEANED_UP:
        return
    # Proceeds with cleanup regardless of ERRORED status
    # BUT: after partial merge failure, git state may be inconsistent
    _run_git(["branch", "-D", self._branch_name], ...)  # May fail if branch is in a weird state

Additionally, the cleanup() method silently swallows errors in branch deletion:

except (subprocess.CalledProcessError, subprocess.TimeoutExpired):
    logger.warning("Failed to delete sandbox branch %s; it may need manual cleanup", ...)

This means failed cleanups are logged but not raised, making it impossible for callers to detect that cleanup failed.

Expected Behavior

After a failed commit, the sandbox should be fully cleanable, and cleanup failures should be tracked/retried.

Actual Behavior

After a timeout during the merge step, git worktree entries and branches may accumulate on disk indefinitely.

Suggested Fix

Implement a cleanup_on_error() method that performs more aggressive cleanup for ERRORED sandboxes
In cleanup(), attempt git worktree prune before git branch -D to ensure the worktree is unregistered
Add a background cleanup job that periodically scans for stale cleveragents/plan-* branches and removes them
Consider raising exceptions from cleanup() instead of silently logging them

TDD Note

After this bug issue is verified, a corresponding Type/Testing issue will be created for TDD with tags: @tdd_issue, @tdd_issue_, @tdd_expected_fail.

Automated by CleverAgents Bot
Supervisor: Bug Detection Pool | Agent: bug-hunt-pool-supervisor

## Bug Report: Resource Management — Worktree Resource Leak After Failed Merge ### Severity Assessment - **Impact**: When a git merge fails during `commit()`, the sandbox transitions to `ERRORED` status. The `cleanup()` method checks for status `CLEANED_UP` but NOT `ERRORED`. This means `cleanup()` is still called, but there's a subtle issue: if `cleanup()` is called after an error that partially completed the merge, the branch may not be properly removed, leaving stale worktree entries. - **Likelihood**: Medium — merge conflicts during sandbox commit are expected in normal operation - **Priority**: Medium ### Location - **File**: `src/cleveragents/infrastructure/sandbox/git_worktree.py` - **Function**: `GitWorktreeSandbox.commit()` - **Lines**: 227–304 ### Description When `commit()` partially completes (the `git commit` succeeds in the worktree but the subsequent `git merge` fails), the sandbox enters `ERRORED` status with `self._pre_merge_commit = None` explicitly set. However: 1. The sandbox branch (`cleveragents/plan-<id>`) has already been committed to in the worktree 2. The merge into the original branch failed and was rolled back (via `_pre_merge_commit = None`) 3. But the branch still exists and the commit in it is dangling More critically, when `commit()` raises `SandboxCommitError` after a timeout: ```python except subprocess.TimeoutExpired as exc: self._pre_merge_commit = None self._status = SandboxStatus.ERRORED raise SandboxCommitError(...) ``` The exception propagates to the caller. If the caller doesn't call `cleanup()` (error path skips cleanup), the worktree and branch are never removed. Even if they do call `cleanup()`, after a partial git merge, running `git worktree remove --force` may fail, and the fallback `shutil.rmtree` removes the directory but NOT the git branch or the worktree registry entry. ### Evidence ```python # src/cleveragents/infrastructure/sandbox/git_worktree.py, lines 300-312 except subprocess.TimeoutExpired as exc: self._pre_merge_commit = None # ← nulled out self._status = SandboxStatus.ERRORED raise SandboxCommitError(...) # ← exception raised, cleanup may not happen # cleanup() method (lines 330-380): def cleanup(self) -> None: if self._status == SandboxStatus.CLEANED_UP: return # Proceeds with cleanup regardless of ERRORED status # BUT: after partial merge failure, git state may be inconsistent _run_git(["branch", "-D", self._branch_name], ...) # May fail if branch is in a weird state ``` Additionally, the `cleanup()` method silently swallows errors in branch deletion: ```python except (subprocess.CalledProcessError, subprocess.TimeoutExpired): logger.warning("Failed to delete sandbox branch %s; it may need manual cleanup", ...) ``` This means failed cleanups are logged but not raised, making it impossible for callers to detect that cleanup failed. ### Expected Behavior After a failed commit, the sandbox should be fully cleanable, and cleanup failures should be tracked/retried. ### Actual Behavior After a timeout during the merge step, git worktree entries and branches may accumulate on disk indefinitely. ### Suggested Fix 1. Implement a `cleanup_on_error()` method that performs more aggressive cleanup for `ERRORED` sandboxes 2. In `cleanup()`, attempt `git worktree prune` before `git branch -D` to ensure the worktree is unregistered 3. Add a background cleanup job that periodically scans for stale `cleveragents/plan-*` branches and removes them 4. Consider raising exceptions from `cleanup()` instead of silently logging them ### Category resource ### TDD Note After this bug issue is verified, a corresponding Type/Testing issue will be created for TDD with tags: @tdd_issue, @tdd_issue_<this-issue-number>, @tdd_expected_fail. --- **Automated by CleverAgents Bot** Supervisor: Bug Detection Pool | Agent: bug-hunt-pool-supervisor

HAL9000 referenced this issue

2026-04-10 19:09:52 +00:00

[AUTO-BUG-SUP] Bug Hunt Status (Cycle 1) #7404

HAL9000 added the

labels

2026-04-10 19:28:44 +00:00

HAL9000 referenced this issue

2026-04-10 19:38:52 +00:00

[AUTO-BUG-SUP] Bug Hunt Status (Cycle 3) #7449

HAL9000 referenced this issue

2026-04-10 20:39:58 +00:00

[AUTO-BUG-SUP] Bug Hunt Status (Cycle 4) #7470

HAL9000 referenced this issue

2026-04-12 03:16:59 +00:00

[AUTO-BUG-POOL] Bug Detection Report (Cycle 1) #7709

freemo added the

Type

Bug

label

2026-04-12 18:34:15 +00:00

HAL9000 added

and removed

labels

2026-04-14 06:24:06 +00:00

HAL9000 commented

2026-04-14 06:24:06 +00:00

Author

Owner

✅ Verified — Resource leak: GitWorktreeSandbox.commit() leaves worktree on merge failure. MoSCoW: Should-have. Priority: Medium.

Automated by CleverAgents Bot
Supervisor: Project Owner | Agent: project-owner-pool-supervisor

✅ **Verified** — Resource leak: GitWorktreeSandbox.commit() leaves worktree on merge failure. MoSCoW: Should-have. Priority: Medium. --- **Automated by CleverAgents Bot** Supervisor: Project Owner | Agent: project-owner-pool-supervisor

HAL9000 commented

2026-04-14 06:29:44 +00:00

Author

Owner

✅ Verified — Resource leak: GitWorktreeSandbox.commit() leaves worktree on merge failure. MoSCoW: Should-have. Priority: Medium.

Automated by CleverAgents Bot
Supervisor: Project Owner | Agent: project-owner-pool-supervisor