Skip to content

feat(workspace): report worktree disk cleanup pressure #149

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
Apr 30, 2026
+625 −105
Merged

feat(workspace): report worktree disk cleanup pressure #149

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
45 changes: 29 additions & 16 deletions inc/Abilities/WorkspaceAbilities.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -980,22 +980,28 @@ private function registerAbilities(): void {
'type' => 'array',
'items' => array(
'type' => 'object',
'properties' => array(
'handle' => array( 'type' => 'string' ),
'repo' => array( 'type' => 'string' ),
'is_worktree' => array( 'type' => 'boolean' ),
'is_primary' => array( 'type' => 'boolean' ),
'external' => array( 'type' => 'boolean' ),
'branch_slug' => array( 'type' => array( 'string', 'null' ) ),
'branch' => array( 'type' => array( 'string', 'null' ) ),
'head' => array( 'type' => 'string' ),
'path' => array( 'type' => 'string' ),
'dirty' => array( 'type' => 'integer' ),
'created_at' => array( 'type' => array( 'string', 'null' ) ),
'properties' => array(
'handle' => array( 'type' => 'string' ),
'repo' => array( 'type' => 'string' ),
'is_worktree' => array( 'type' => 'boolean' ),
'is_primary' => array( 'type' => 'boolean' ),
'external' => array( 'type' => 'boolean' ),
'branch_slug' => array( 'type' => array( 'string', 'null' ) ),
'branch' => array( 'type' => array( 'string', 'null' ) ),
'head' => array( 'type' => 'string' ),
'path' => array( 'type' => 'string' ),
'dirty' => array( 'type' => 'integer' ),
'created_at' => array( 'type' => array( 'string', 'null' ) ),
'lifecycle_state' => array( 'type' => array( 'string', 'null' ) ),
'pr_url' => array( 'type' => array( 'string', 'null' ) ),
'pr_number' => array( 'type' => array( 'integer', 'null' ) ),
'metadata' => array( 'type' => array( 'object', 'null' ) ),
'pr_url' => array( 'type' => array( 'string', 'null' ) ),
'pr_number' => array( 'type' => array( 'integer', 'null' ) ),
'last_touched_at' => array( 'type' => array( 'string', 'null' ) ),
'age_days' => array( 'type' => array( 'integer', 'null' ) ),
'size_bytes' => array( 'type' => array( 'integer', 'null' ) ),
'artifact_size_bytes' => array( 'type' => 'integer' ),
'artifacts' => array( 'type' => 'array' ),
'stale_reason' => array( 'type' => array( 'string', 'null' ) ),
'metadata' => array( 'type' => array( 'object', 'null' ) ),
),
),
),
Expand Down Expand Up @@ -1100,6 +1106,10 @@ private function registerAbilities(): void {
'type' => 'string',
'description' => 'Optional candidate age filter such as 7d, 24h, 30m, or 60s. Uses lifecycle created_at metadata only.',
),
'sort' => array(
'type' => 'string',
'description' => 'Optional cleanup candidate sort: size or age.',
),
),
),
'output_schema' => array(
Expand Down Expand Up @@ -1468,7 +1478,7 @@ public static function worktreePrune( array $input ): array|\WP_Error { // phpcs
/**
* Remove merged worktrees across all primary checkouts.
*
* @param array $input Input parameters (dry_run, force, skip_github, apply_plan, older_than).
* @param array $input Input parameters (dry_run, force, skip_github, apply_plan, older_than, sort).
* @return array
*/
public static function worktreeCleanup( array $input ): array|\WP_Error {
Expand All @@ -1484,6 +1494,9 @@ public static function worktreeCleanup( array $input ): array|\WP_Error {
if ( isset( $input['older_than'] ) && '' !== trim( (string) $input['older_than'] ) ) {
$opts['older_than'] = trim( (string) $input['older_than'] );
}
if ( isset( $input['sort'] ) && '' !== trim( (string) $input['sort'] ) ) {
$opts['sort'] = trim( (string) $input['sort'] );
}

return $workspace->worktree_cleanup_merged( $opts );
}
Expand Down
140 changes: 109 additions & 31 deletions inc/Cli/Commands/WorkspaceCommand.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1064,21 +1064,32 @@ private function renderGitOperationResult( string $operation, array $result, arr
* [--dry-run]
* : Preview cleanup candidates without removing anything (cleanup only).
*
* [--apply-plan=<file>]
* : Apply a previously reviewed cleanup JSON report. The destructive pass
* revalidates every planned row and removes only exact current matches.
*
* [--skip-github]
* : Skip the GitHub API lookup and rely only on the local `upstream-gone`
* signal (cleanup only). Faster, but misses merged branches where the
* remote branch wasn't auto-deleted.
*
* [--older-than=<duration>]
* : Limit cleanup candidates to worktrees with lifecycle `created_at`
* metadata older than the compact duration (cleanup only, e.g. 7d, 24h).
* Candidate worktrees without valid `created_at` metadata are skipped.
*
* [--verbose]
* [--apply-plan=<file>]
* : Apply a previously reviewed cleanup JSON report. The destructive pass
* revalidates every planned row and removes only exact current matches.
*
* [--skip-github]
* : Skip the GitHub API lookup and rely only on the local `upstream-gone`
* signal (cleanup only). Faster, but misses merged branches where the
* remote branch wasn't auto-deleted.
*
* [--older-than=<duration>]
* : Limit cleanup candidates to worktrees with lifecycle `created_at`
* metadata older than the compact duration (cleanup only, e.g. 7d, 24h).
* Candidate worktrees without valid `created_at` metadata are skipped.
*
* [--sort=<field>]
* : Sort cleanup candidates by reporting field (cleanup only).
* ---
* options:
* - size
* - age
* ---
*
* [--stale]
* : For list, show only worktrees with a stale_reason (old, dirty, or missing metadata).
*
* [--verbose]
* : Show every cleanup row instead of concise samples (cleanup only).
*
* [--only=<section>]
Expand Down Expand Up @@ -1277,6 +1288,9 @@ public function worktree( array $args, array $assoc_args ): void {
if ( isset( $assoc_args['older-than'] ) && '' !== trim( (string) $assoc_args['older-than'] ) ) {
$input['older_than'] = trim( (string) $assoc_args['older-than'] );
}
if ( isset( $assoc_args['sort'] ) && '' !== trim( (string) $assoc_args['sort'] ) ) {
$input['sort'] = trim( (string) $assoc_args['sort'] );
}
break;
}

Expand Down Expand Up @@ -1307,29 +1321,39 @@ private function renderWorktreeResult( string $operation, array $result, array $
switch ( $operation ) {
case 'list':
$worktrees = $result['worktrees'] ?? array();
if ( ! empty( $assoc_args['stale'] ) ) {
$worktrees = array_values( array_filter( $worktrees, fn( $wt ) => ! empty( $wt['stale_reason'] ) ) );
}
if ( empty( $worktrees ) ) {
WP_CLI::log( 'No worktrees found.' );
return;
}
$items = array_map(
fn( $wt ) => array(
'handle' => $wt['handle'] ?? '',
'repo' => $wt['repo'] ?? '',
'kind' => ! empty( $wt['is_primary'] ) ? 'primary' : 'worktree',
'branch' => $wt['branch'] ?? '-',
'head' => isset( $wt['head'] ) ? substr( (string) $wt['head'], 0, 7 ) : '-',
'dirty' => (int) ( $wt['dirty'] ?? 0 ),
'created_at' => $wt['created_at'] ?? null,
'state' => $wt['lifecycle_state'] ?? null,
'pr' => $wt['pr_url'] ?? null,
'metadata' => $wt['metadata'] ?? null,
'path' => $wt['path'] ?? '',
'handle' => $wt['handle'] ?? '',
'repo' => $wt['repo'] ?? '',
'kind' => ! empty( $wt['is_primary'] ) ? 'primary' : 'worktree',
'branch' => $wt['branch'] ?? '-',
'head' => isset( $wt['head'] ) ? substr( (string) $wt['head'], 0, 7 ) : '-',
'dirty' => (int) ( $wt['dirty'] ?? 0 ),
'created_at' => $wt['created_at'] ?? null,
'state' => $wt['lifecycle_state'] ?? null,
'pr' => $wt['pr_url'] ?? null,
'age_days' => $wt['age_days'] ?? null,
'size_bytes' => $wt['size_bytes'] ?? null,
'size' => $this->format_bytes( $wt['size_bytes'] ?? null ),
'artifact_size_bytes' => $wt['artifact_size_bytes'] ?? 0,
'artifacts' => $this->format_bytes( $wt['artifact_size_bytes'] ?? 0 ),
'artifact_paths' => $wt['artifacts'] ?? array(),
'stale' => $wt['stale_reason'] ?? '',
'metadata' => $wt['metadata'] ?? null,
'path' => $wt['path'] ?? '',
),
$worktrees
);
$fields = array( 'handle', 'repo', 'kind', 'branch', 'head', 'dirty', 'state', 'created_at', 'pr', 'path' );
$fields = array( 'handle', 'repo', 'kind', 'branch', 'head', 'dirty', 'state', 'created_at', 'pr', 'age_days', 'size', 'artifacts', 'stale', 'path' );
if ( in_array( (string) ( $assoc_args['format'] ?? '' ), array( 'json', 'yaml' ), true ) ) {
$fields[] = 'metadata';
$fields = array( 'handle', 'repo', 'kind', 'branch', 'head', 'dirty', 'state', 'created_at', 'pr', 'age_days', 'size_bytes', 'artifact_size_bytes', 'artifact_paths', 'stale', 'metadata', 'path' );
}
$this->format_items( $items, $fields, $assoc_args, 'handle' );
return;
Expand Down Expand Up @@ -1487,8 +1511,29 @@ private function render_worktree_cleanup_result( array $result, array $assoc_arg
'count' => (int) ( $summary['age_filter']['unknown_age'] ?? 0 ),
);
}
$summary_rows[] = array(
'metric' => 'total_size',
'count' => $this->format_bytes( $summary['total_size_bytes'] ?? null ),
);
$summary_rows[] = array(
'metric' => 'artifact_size',
'count' => $this->format_bytes( $summary['artifact_size_bytes'] ?? null ),
);
$this->format_items( $summary_rows, array( 'metric', 'count' ), array( 'format' => 'table' ), 'metric' );

if ( ! empty( $summary['size_by_repo'] ) && is_array( $summary['size_by_repo'] ) ) {
WP_CLI::log( '' );
WP_CLI::log( 'Top repos by worktree size:' );
$repo_rows = array();
foreach ( array_slice( $summary['size_by_repo'], 0, 5, true ) as $repo => $bytes ) {
$repo_rows[] = array(
'repo' => (string) $repo,
'size' => $this->format_bytes( $bytes ),
);
}
$this->format_items( $repo_rows, array( 'repo', 'size' ), array( 'format' => 'table' ), 'size' );
}

if ( '' !== $only ) {
WP_CLI::log( sprintf( 'Filter: %s', $only ) );
}
Expand All @@ -1500,13 +1545,16 @@ private function render_worktree_cleanup_result( array $result, array $assoc_arg
fn( $c ) => array(
'handle' => $c['handle'] ?? '',
'branch' => $c['branch'] ?? '',
'age_days' => $c['age_days'] ?? '',
'size' => $this->format_bytes( $c['size_bytes'] ?? null ),
'artifacts' => $this->format_bytes( $c['artifact_size_bytes'] ?? 0 ),
'signal' => $c['signal'] ?? '',
'reason_code' => $c['reason_code'] ?? ( $c['signal'] ?? '' ),
'reason' => $c['reason'] ?? '',
),
array_slice( $candidates, 0, $limit )
);
$fields = $verbose ? array( 'handle', 'branch', 'signal', 'reason' ) : array( 'handle', 'branch', 'signal', 'reason_code' );
$fields = $verbose ? array( 'handle', 'branch', 'age_days', 'size', 'artifacts', 'signal', 'reason' ) : array( 'handle', 'branch', 'age_days', 'size', 'artifacts', 'signal', 'reason_code' );
$this->format_items( $candidate_rows, $fields, array( 'format' => 'table' ), 'handle' );
$this->render_cleanup_truncation_hint( count( $candidates ), $limit, 'candidate rows' );
}
Expand All @@ -1518,13 +1566,16 @@ private function render_worktree_cleanup_result( array $result, array $assoc_arg
fn( $c ) => array(
'handle' => $c['handle'] ?? '',
'branch' => $c['branch'] ?? '',
'age_days' => $c['age_days'] ?? '',
'size' => $this->format_bytes( $c['size_bytes'] ?? null ),
'artifacts' => $this->format_bytes( $c['artifact_size_bytes'] ?? 0 ),
'signal' => $c['signal'] ?? '',
'reason_code' => $c['reason_code'] ?? ( $c['signal'] ?? '' ),
'reason' => $c['reason'] ?? '',
),
array_slice( $removed, 0, $limit )
);
$fields = $verbose ? array( 'handle', 'branch', 'signal', 'reason' ) : array( 'handle', 'branch', 'signal', 'reason_code' );
$fields = $verbose ? array( 'handle', 'branch', 'age_days', 'size', 'artifacts', 'signal', 'reason' ) : array( 'handle', 'branch', 'age_days', 'size', 'artifacts', 'signal', 'reason_code' );
$this->format_items( $removed_rows, $fields, array( 'format' => 'table' ), 'handle' );
$this->render_cleanup_truncation_hint( count( $removed ), $limit, 'removed rows' );
}
Expand All @@ -1537,6 +1588,9 @@ private function render_worktree_cleanup_result( array $result, array $assoc_arg
'handle' => $s['handle'] ?? '',
'reason_code' => $s['reason_code'] ?? '',
'reason' => $verbose ? ( $s['reason'] ?? '' ) : $this->shorten_cleanup_reason( (string) ( $s['reason'] ?? '' ) ),
'age_days' => $s['age_days'] ?? '',
'size' => $this->format_bytes( $s['size_bytes'] ?? null ),
'artifacts' => $this->format_bytes( $s['artifact_size_bytes'] ?? 0 ),
'repo' => $s['repo'] ?? '',
'branch' => $s['branch'] ?? '',
'path' => $s['path'] ?? '',
Expand All @@ -1546,7 +1600,7 @@ private function render_worktree_cleanup_result( array $result, array $assoc_arg
),
array_slice( $skipped, 0, $limit )
);
$fields = $verbose ? array( 'handle', 'reason_code', 'reason', 'repo', 'branch', 'path', 'primary_path', 'missing', 'hint' ) : array( 'handle', 'reason_code', 'reason' );
$fields = $verbose ? array( 'handle', 'reason_code', 'reason', 'age_days', 'size', 'artifacts', 'repo', 'branch', 'path', 'primary_path', 'missing', 'hint' ) : array( 'handle', 'reason_code', 'age_days', 'size', 'artifacts', 'reason' );
$this->format_items( $skipped_rows, $fields, array( 'format' => 'table' ), 'handle' );
$this->render_cleanup_truncation_hint( count( $skipped ), $limit, 'skipped rows' );
}
Expand Down Expand Up @@ -1672,6 +1726,30 @@ private function render_cleanup_truncation_hint( int $total, int $limit, string
WP_CLI::log( sprintf( 'Showing %d of %d %s. Re-run with --verbose for all rows or --only=<reason_code> to filter.', $limit, $total, $label ) );
}

/**
* Format a byte count without depending on WordPress helpers in smoke tests.
*
* @param mixed $bytes Raw byte count.
* @return string Human-readable size.
*/
private function format_bytes( mixed $bytes ): string {
if ( null === $bytes || '' === $bytes ) {
return '-';
}

$bytes = max( 0, (float) $bytes );
$units = array( 'B', 'KiB', 'MiB', 'GiB', 'TiB' );
$unit = 0;
$unit_count = count( $units );
while ( $bytes >= 1024 && $unit < $unit_count - 1 ) {
$bytes /= 1024;
++$unit;
}

$precision = 0 === $unit ? 0 : 1;
return number_format( $bytes, $precision ) . ' ' . $units[ $unit ];
}

/**
* Render the freshness block for `worktree add` results.
*
Expand Down
Loading