Skip to content

fix: compact bounded cleanup JSON output #741

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 2 commits into from
Jun 16, 2026
Merged

fix: compact bounded cleanup JSON output #741

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
86a26a9
fix: compact bounded cleanup JSON output
homeboy-ci[bot] Jun 15, 2026
4a93211
fix: satisfy cleanup output lint
homeboy-ci[bot] Jun 16, 2026
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
234 changes: 233 additions & 1 deletion inc/Cli/Commands/WorkspaceCommand.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6385,7 +6385,8 @@ private function flatten_artifact_cleanup_rows( array $rows ): array {
private function render_worktree_bounded_cleanup_eligible_apply_result( array $result, array $assoc_args ): void {
$format = isset($assoc_args['format']) ? (string) $assoc_args['format'] : 'table';
if ( 'json' === $format ) {
$json = wp_json_encode($result, JSON_PRETTY_PRINT | JSON_UNESCAPED_SLASHES);
$report = ! empty($assoc_args['verbose']) ? $result : $this->compact_worktree_bounded_cleanup_eligible_apply_json($result);
$json = wp_json_encode($report, JSON_PRETTY_PRINT | JSON_UNESCAPED_SLASHES);
WP_CLI::log(false === $json ? '{}' : $json);
return;
}
Expand Down Expand Up @@ -6512,6 +6513,237 @@ private function render_worktree_bounded_cleanup_eligible_apply_result( array $r
}
}

/**
* Compact bounded cleanup JSON for chat/operator output.
*
* @param array<string,mixed> $result Full bounded apply result.
* @return array<string,mixed>
*/
private function compact_worktree_bounded_cleanup_eligible_apply_json( array $result ): array {
$summary = (array) ( $result['summary'] ?? array() );
$candidates = (array) ( $result['candidates'] ?? array() );
$removed = (array) ( $result['removed'] ?? array() );
$skipped = (array) ( $result['skipped'] ?? array() );
$buckets = $this->build_cleanup_blocker_buckets($skipped);
$actions = $this->build_cleanup_next_actions($buckets, (array) ( $summary['skipped_next_commands'] ?? array() ));

$compact_summary = array_merge(
$summary,
array(
'processed' => (int) ( $summary['processed'] ?? $summary['inspected'] ?? count($candidates) ),
'would_remove' => (int) ( $summary['would_remove'] ?? ( ! empty($result['dry_run']) ? count($candidates) : 0 ) ),
'removed' => (int) ( $summary['removed'] ?? count($removed) ),
'skipped' => max( (int) ( $summary['skipped'] ?? 0 ), count($skipped) ),
'bytes_reclaimed' => (int) ( $summary['bytes_reclaimed'] ?? 0 ),
'skipped_by_reason' => array_map(fn( $bucket ) => (int) ( $bucket['count'] ?? 0 ), $buckets),
'blocker_bucket_count' => count($buckets),
)
);

$report = array(
'success' => (bool) ( $result['success'] ?? true ),
'mode' => (string) ( $result['mode'] ?? 'bounded_cleanup_eligible_apply' ),
'dry_run' => ! empty($result['dry_run']),
'destructive' => ! empty($result['destructive']),
'workspace_path' => $result['workspace_path'] ?? null,
'generated_at' => $result['generated_at'] ?? null,
'summary' => $compact_summary,
'blocker_buckets' => $buckets,
'next_actions' => $actions,
'candidates' => $this->compact_cleanup_rows($candidates, 25),
'removed' => $this->compact_cleanup_rows($removed, 25),
'continuation' => $this->compact_cleanup_continuation( (array) ( $result['continuation'] ?? $result['pagination'] ?? array() ) ),
'evidence' => $this->compact_cleanup_evidence( (array) ( $result['evidence'] ?? array() ), $skipped ),
);

if ( ! empty($result['job_backed']) ) {
$report['job_backed'] = true;
}

return array_filter($report, fn( $value ) => null !== $value);
}

/**
* Build skipped blocker buckets with bounded examples.
*
* @param array<int,array<string,mixed>> $rows Skipped rows.
* @return array<string,array<string,mixed>>
*/
private function build_cleanup_blocker_buckets( array $rows ): array {
$buckets = array();
foreach ( $rows as $row ) {
$reason_code = (string) ( $row['reason_code'] ?? 'unknown' );
if ( ! isset($buckets[ $reason_code ]) ) {
$buckets[ $reason_code ] = array(
'count' => 0,
'examples' => array(),
'reason' => (string) ( $row['reason'] ?? '' ),
);
}
++$buckets[ $reason_code ]['count'];
if ( count($buckets[ $reason_code ]['examples']) < 3 ) {
$buckets[ $reason_code ]['examples'][] = $this->compact_cleanup_row($row);
}
}

ksort($buckets);
return $buckets;
}

/**
* Build compact next actions for unresolved blocker classes.
*
* @param array<string,array<string,mixed>> $buckets Blocker buckets.
* @param array<int,array<string,mixed>> $commands Existing cleanup command hints.
* @return array<int,array<string,mixed>>
*/
private function build_cleanup_next_actions( array $buckets, array $commands ): array {
$by_reason = array();
foreach ( $commands as $command ) {
$reason_code = (string) ( $command['reason_code'] ?? '' );
if ( '' !== $reason_code ) {
$by_reason[ $reason_code ] = $command;
}
}

$defaults = array(
'active_no_signal' => array(
'command' => 'studio wp datamachine-code workspace worktree active-no-signal-report --limit=25 --offset=0 --format=json',
'destructive' => false,
),
'needs_metadata_reconcile' => array(
'command' => 'studio wp datamachine-code workspace worktree reconcile-metadata --dry-run --limit=25 --offset=0 --until-budget=30s --format=json',
'destructive' => false,
),
'lifecycle_reconciliation_candidate' => array(
'command' => 'studio wp datamachine-code workspace worktree cleanup --dry-run --format=json',
'destructive' => false,
),
'dirty_worktree' => array(
'command' => 'git -C <worktree-path> status --short --branch --untracked-files=normal',
'destructive' => false,
),
'unpushed_commits' => array(
'command' => 'git -C <worktree-path> log --oneline --decorate @{u}..HEAD',
'destructive' => false,
),
'stale_worktree_marker' => array(
'command' => 'git -C <primary-path> worktree prune --dry-run --verbose',
'destructive' => false,
),
'primary_missing' => array(
'command' => 'studio wp datamachine-code workspace show <repo>',
'destructive' => false,
),
'submodule_worktree' => array(
'command' => 'git -C <worktree-path> submodule status --recursive',
'destructive' => false,
),
'remove_timeout' => array(
'command' => 'studio wp datamachine-code workspace worktree bounded-cleanup-eligible-apply --limit=25 --remove-timeout=<seconds>',
'destructive' => true,
),
);

$actions = array();
foreach ( $buckets as $reason_code => $bucket ) {
$hint = $by_reason[ $reason_code ] ?? $defaults[ $reason_code ] ?? array(
'command' => 'Re-run with --verbose --format=json and inspect this reason_code before retrying cleanup.',
'destructive' => false,
);
$actions[] = array(
'reason_code' => $reason_code,
'count' => (int) ( $bucket['count'] ?? 0 ),
'command' => (string) ( $hint['command'] ?? '' ),
'alternative' => (string) ( $hint['alternative'] ?? '' ),
'destructive' => ! empty($hint['destructive']),
);
}

return $actions;
}

/**
* Compact a bounded cleanup continuation without full handle lists.
*
* @param array<string,mixed> $continuation Continuation payload.
* @return array<string,mixed>
*/
private function compact_cleanup_continuation( array $continuation ): array {
if ( empty($continuation) ) {
return array();
}

$handles = array_values(array_filter(array_map('strval', (array) ( $continuation['remaining_handles'] ?? array() ))));
unset($continuation['remaining_handles']);
if ( ! isset($continuation['remaining_total']) && isset($continuation['total']) ) {
$continuation['remaining_total'] = (int) $continuation['total'];
}
$continuation['remaining_handles_count'] = count($handles);
$continuation['remaining_handles_examples'] = array_slice($handles, 0, 10);
if ( count($handles) > 10 ) {
$continuation['remaining_handles_truncated'] = true;
}

return $continuation;
}

/**
* Compact evidence while removing full skipped handle lists.
*
* @param array<string,mixed> $evidence Evidence payload.
* @param array<int,array<string,mixed>> $skipped Skipped rows.
* @return array<string,mixed>
*/
private function compact_cleanup_evidence( array $evidence, array $skipped ): array {
$skipped_handles = array_values(array_filter(array_map(fn( $row ) => (string) ( $row['handle'] ?? '' ), $skipped)));
unset($evidence['skipped_handles']);
$evidence['skipped_handles_count'] = count($skipped_handles);
$evidence['skipped_handles_examples'] = array_slice($skipped_handles, 0, 10);
if ( count($skipped_handles) > 10 ) {
$evidence['skipped_handles_truncated'] = true;
}
$evidence['full_detail_hint'] = 'Re-run with --verbose --format=json for full skipped rows and handle lists.';

return $evidence;
}

/**
* Compact cleanup rows to the fields operators need first.
*
* @param array<int,array<string,mixed>> $rows Rows to compact.
* @param int $limit Maximum rows.
* @return array<int,array<string,mixed>>
*/
private function compact_cleanup_rows( array $rows, int $limit ): array {
return array_map(fn( $row ) => $this->compact_cleanup_row( (array) $row ), array_slice($rows, 0, $limit));
}

/**
* Compact one cleanup row.
*
* @param array<string,mixed> $row Cleanup row.
* @return array<string,mixed>
*/
private function compact_cleanup_row( array $row ): array {
$compact = array(
'handle' => $row['handle'] ?? null,
'repo' => $row['repo'] ?? null,
'branch' => $row['branch'] ?? null,
'reason_code' => $row['reason_code'] ?? $row['signal'] ?? null,
'reason' => isset($row['reason']) ? $this->shorten_cleanup_reason( (string) $row['reason'] ) : null,
'path' => $row['path'] ?? null,
);

foreach ( array( 'size_bytes', 'artifact_size_bytes', 'dirty', 'unpushed', 'created_at', 'liveness', 'pr_url' ) as $field ) {
if ( array_key_exists($field, $row) ) {
$compact[ $field ] = $row[ $field ];
}
}

return array_filter($compact, fn( $value ) => null !== $value && '' !== $value && array() !== $value);
}

private function render_worktree_emergency_cleanup_result( array $result, array $assoc_args ): void {
$format = isset($assoc_args['format']) ? (string) $assoc_args['format'] : 'table';
if ( 'json' === $format ) {
Expand Down
17 changes: 17 additions & 0 deletions tests/smoke-worktree-cleanup-cli.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1896,11 +1896,28 @@ public function execute( array $input ): array
WP_CLI::$successes = array();
$command->worktree(array( 'bounded-cleanup-eligible-apply' ), array( 'limit' => 25, 'remove-timeout' => 120, 'format' => 'json' ));
datamachine_code_cleanup_assert(120 === (int) ( $bounded_apply_ability->last_input['remove_timeout'] ?? 0 ), 'bounded cleanup apply forwards remove-timeout');
$bounded_json = json_decode(WP_CLI::$logs[0] ?? '', true);
datamachine_code_cleanup_assert(JSON_ERROR_NONE === json_last_error(), 'bounded cleanup compact JSON parses cleanly');
datamachine_code_cleanup_assert(32 === (int) ( $bounded_json['summary']['skipped'] ?? 0 ), 'bounded cleanup compact JSON reports full skipped count');
datamachine_code_cleanup_assert(! isset($bounded_json['skipped']), 'bounded cleanup compact JSON omits full skipped rows by default');
datamachine_code_cleanup_assert(15 === (int) ( $bounded_json['blocker_buckets']['active_no_signal']['count'] ?? 0 ), 'bounded cleanup compact JSON buckets active/no-signal blockers');
datamachine_code_cleanup_assert('repo@blocked-0' === (string) ( $bounded_json['blocker_buckets']['active_no_signal']['examples'][0]['handle'] ?? '' ), 'bounded cleanup compact JSON includes bounded blocker examples');
datamachine_code_cleanup_assert(str_contains((string) wp_json_encode($bounded_json['next_actions'] ?? array()), 'active-no-signal-report'), 'bounded cleanup compact JSON includes actionable next actions');
datamachine_code_cleanup_assert(! isset($bounded_json['continuation']['remaining_handles']), 'bounded cleanup compact JSON omits full remaining handle lists');
datamachine_code_cleanup_assert(32 === (int) ( $bounded_json['continuation']['remaining_handles_count'] ?? 0 ), 'bounded cleanup compact JSON keeps remaining handle count');
datamachine_code_cleanup_assert(10 === count($bounded_json['evidence']['skipped_handles_examples'] ?? array()), 'bounded cleanup compact JSON keeps bounded skipped handle examples');

WP_CLI::$logs = array();
WP_CLI::$successes = array();
$command->worktree(array( 'bounded-cleanup-eligible-apply' ), array( 'limit' => 25, 'verbose' => true ));
datamachine_code_cleanup_assert(in_array('table:32:handle,reason_code,reason', WP_CLI::$logs, true), 'bounded cleanup apply verbose output lists skipped rows');

WP_CLI::$logs = array();
WP_CLI::$successes = array();
$command->worktree(array( 'bounded-cleanup-eligible-apply' ), array( 'limit' => 25, 'verbose' => true, 'format' => 'json' ));
$bounded_verbose_json = json_decode(WP_CLI::$logs[0] ?? '', true);
datamachine_code_cleanup_assert(32 === count($bounded_verbose_json['skipped'] ?? array()), 'bounded cleanup verbose JSON preserves full skipped rows');
datamachine_code_cleanup_assert(32 === count($bounded_verbose_json['pagination']['remaining_handles'] ?? array()), 'bounded cleanup verbose JSON preserves full remaining handles');
$bounded_apply_ability->extra_skipped = 0;

echo "\n[8a] active/no-signal apply forwards bounded continuation flags\n";
Expand Down
Loading