Skip to content

fix: keep artifact cleanup branch identity stable #428

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
chubes4 merged 1 commit into from
May 18, 2026
Merged

fix: keep artifact cleanup branch identity stable #428

Show file tree
Hide file tree
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
16 changes: 6 additions & 10 deletions inc/Workspace/WorkspaceArtifactCleanup.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -245,23 +245,19 @@ private function build_worktree_artifact_cleanup_plan( bool $force, array $opts
$skipped = array();

foreach ( $slice as $wt ) {
$handle = (string) ( $wt['handle'] ?? '?' );
$repo = (string) ( $wt['repo'] ?? '' );
$wt_path = (string) ( $wt['path'] ?? '' );
$handle = (string) ( $wt['handle'] ?? '?' );
$repo = (string) ( $wt['repo'] ?? '' );
$wt_path = (string) ( $wt['path'] ?? '' );
$resolved_branch = '' !== $wt_path ? $this->resolve_worktree_branch_from_head_file( $wt_path ) : null;
if ( $safety_probes ) {
$branch = (string) ( $wt['branch'] ?? '' );
if ( '' === $branch ) {
$resolved = '' !== $wt_path ? $this->resolve_worktree_branch_from_head_file( $wt_path ) : null;
$branch = (string) ( $resolved ?? $wt['branch_slug'] ?? '' );
}
$branch = (string) ( $resolved_branch ?? $wt['branch'] ?? $wt['branch_slug'] ?? '' );
} else {
// Inventory rows only carry `branch_slug` (the directory slug,
// e.g. `fix-foo`). The plan apply path revalidates against the
// real git branch from `worktree_list()` (e.g. `fix/foo`), so
// resolve it cheaply here from the per-worktree `.git/HEAD`
// pointer file. This is two file reads vs a `git` invocation.
$resolved = '' !== $wt_path ? $this->resolve_worktree_branch_from_head_file( $wt_path ) : null;
$branch = (string) ( $resolved ?? $wt['branch'] ?? $wt['branch_slug'] ?? '' );
$branch = (string) ( $resolved_branch ?? $wt['branch'] ?? $wt['branch_slug'] ?? '' );
}

// Inventory rows don't include detected artifacts; detect them on
Expand Down
12 changes: 8 additions & 4 deletions tests/smoke-worktree-cleanup-artifacts-bounded.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -192,13 +192,15 @@ public function worktree_list( ?string $repo = null, ?string $state = null, arra
$run( 'git branch -M main', $primary );
$run( 'git push -u origin main', $primary );

// One real worktree with an artifact directory.
$run( 'git checkout -b feature-real', $primary );
// One real worktree with an artifact directory. Use a slashed branch so
// bounded inventory's directory slug (`feature-real`) differs from HEAD's
// branch identity (`feature/real`).
$run( 'git checkout -b feature/real', $primary );
file_put_contents( $primary . '/feature-real.txt', 'real' );
$run( 'git add . && git commit -m feature', $primary );
$run( 'git push -u origin feature-real', $primary );
$run( 'git push -u origin feature/real', $primary );
$run( 'git checkout main', $primary );
$run( sprintf( 'git worktree add %s feature-real', escapeshellarg( $tmp . '/demo@feature-real' ) ), $primary );
$run( sprintf( 'git worktree add %s feature/real', escapeshellarg( $tmp . '/demo@feature-real' ) ), $primary );
mkdir( $tmp . '/demo@feature-real/target', 0755, true );
file_put_contents( $tmp . '/demo@feature-real/target/artifact.bin', str_repeat( 'x', 1024 ) );

Expand Down Expand Up @@ -249,6 +251,7 @@ public function worktree_list( ?string $repo = null, ?string $state = null, arra
fn( $row ) => 'demo@feature-real' === ( $row['handle'] ?? '' )
) ) );
$assert( 1, count( $apply_plan['candidates'] ), 'extracted exactly one planned candidate' );
$assert( 'feature/real', $apply_plan['candidates'][0]['branch'] ?? '', 'bounded dry-run records HEAD branch instead of directory slug' );

$workspace->full_listing_calls = 0;
$start = microtime( true );
Expand All @@ -257,6 +260,7 @@ public function worktree_list( ?string $repo = null, ?string $state = null, arra
$assert( false, is_wp_error( $apply ), 'apply_plan revalidation succeeds on huge workspace' );
$assert( 0, $workspace->full_listing_calls, 'apply_plan revalidation does not call full worktree_list' );
$assert( true, (bool) ( $apply['pagination']['safety_probes'] ?? false ), 'apply_plan revalidation still runs safety probes' );
$assert( array(), (array) ( $apply['summary']['skipped_by_reason'] ?? array() ), 'apply_plan does not reject slashed branches as branch mismatches' );
$assert( 1, (int) ( $apply['summary']['removed_artifacts'] ?? 0 ), 'apply_plan removes the planned artifact' );
$assert( false, is_dir( $tmp . '/demo@feature-real/target' ), 'apply_plan revalidation removes the target directory' );
$assert_lt( 5.0, $elapsed, 'apply_plan revalidation stays fast because only_handles narrows the scan (' . number_format( $elapsed, 3 ) . 's)' );
Expand Down
Loading