Skip to content

Surface stale lock cleanup guidance #730

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 15, 2026
Merged

Surface stale lock cleanup guidance #730

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
2d58d0d
Fix stale lock cleanup guidance
homeboy-ci[bot] Jun 15, 2026
79668a8
Fix stale lock guidance lint
homeboy-ci[bot] Jun 15, 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
50 changes: 42 additions & 8 deletions inc/Cli/Commands/WorkspaceCommand.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1318,17 +1318,51 @@ private function render_cleanup_control_result( array $result, array $assoc_args
* @return array<string,mixed>
*/
private function attach_current_workspace_lock_status( array $result ): array {
if ( isset($result['locks']) || ! class_exists(Workspace::class) || ! class_exists(WorkspaceMutationLock::class) ) {
if ( ! isset($result['locks']) && class_exists(Workspace::class) && class_exists(WorkspaceMutationLock::class) ) {
try {
$workspace = new Workspace();
$result['locks'] = WorkspaceMutationLock::status($workspace->get_path());
} catch ( \Throwable $e ) {
$result['locks'] = array(
'error' => $e->getMessage(),
);
}
}

return $this->attach_stale_lock_recommendation($result);
}

/**
* Promote safe stale-lock remediation above the detailed lock evidence.
*
* @param array<string,mixed> $result Cleanup result.
* @return array<string,mixed>
*/
private function attach_stale_lock_recommendation( array $result ): array {
$report = $result['locks']['stale_locks'] ?? null;
if ( ! is_array($report) || (int) ( $report['count'] ?? 0 ) <= 0 ) {
return $result;
}

try {
$workspace = new Workspace();
$result['locks'] = WorkspaceMutationLock::status($workspace->get_path());
} catch ( \Throwable $e ) {
$result['locks'] = array(
'error' => $e->getMessage(),
);
$protected = 0;
foreach ( array( 'database', 'filesystem' ) as $source ) {
foreach ( (array) ( $report[ $source ] ?? array() ) as $row ) {
if ( is_array($row) && empty($row['safe_to_prune']) ) {
++$protected;
}
}
}

$result['stale_lock_summary'] = array(
'stale_database_locks' => (int) ( $report['database_count'] ?? 0 ),
'stale_filesystem_locks' => (int) ( $report['filesystem_count'] ?? 0 ),
'active_protected_locks' => $protected,
'preview_command' => (string) ( $report['preview_command'] ?? 'wp datamachine-code workspace worktree locks --prune-stale --dry-run --format=json' ),
'prune_command' => (string) ( $report['apply_command'] ?? 'wp datamachine-code workspace worktree locks --prune-stale --format=json' ),
);

if ( 0 === $protected ) {
$result['recommended_next_step'] = $result['stale_lock_summary']['prune_command'];
}

return $result;
Expand Down
17 changes: 12 additions & 5 deletions tests/smoke-worktree-cleanup-cli.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1342,11 +1342,17 @@ public function execute( array $input ): array
WP_CLI::$logs = array();
WP_CLI::$successes = array();
$command->cleanup(array( 'until-empty' ), array( 'mode' => 'artifacts', 'limit' => 11, 'max-passes' => 3, 'budget-seconds' => 60, 'force' => true, 'format' => 'json' ));
$until_empty_json = json_decode(WP_CLI::$logs[0] ?? '', true);
datamachine_code_cleanup_assert('artifacts' === ( $cleanup_until_empty_ability->last_input['mode'] ?? '' ), 'cleanup until-empty forwards artifact mode');
datamachine_code_cleanup_assert(11 === (int) ( $cleanup_until_empty_ability->last_input['limit'] ?? 0 ), 'cleanup until-empty forwards apply limit');
datamachine_code_cleanup_assert(3 === (int) ( $cleanup_until_empty_ability->last_input['max_passes'] ?? 0 ), 'cleanup until-empty forwards pass cap');
datamachine_code_cleanup_assert(60 === (int) ( $cleanup_until_empty_ability->last_input['budget_seconds'] ?? 0 ), 'cleanup until-empty forwards time budget');
datamachine_code_cleanup_assert(true === (bool) ( $cleanup_until_empty_ability->last_input['force'] ?? false ), 'cleanup until-empty forwards force flag');
datamachine_code_cleanup_assert('wp datamachine-code workspace worktree locks --prune-stale --format=json' === (string) ( $until_empty_json['recommended_next_step'] ?? '' ), 'cleanup until-empty JSON promotes safe stale lock prune command');
datamachine_code_cleanup_assert(1 === (int) ( $until_empty_json['stale_lock_summary']['stale_database_locks'] ?? 0 ), 'cleanup until-empty JSON summarizes stale DB locks at top level');
datamachine_code_cleanup_assert(0 === (int) ( $until_empty_json['stale_lock_summary']['stale_filesystem_locks'] ?? -1 ), 'cleanup until-empty JSON summarizes stale filesystem locks at top level');
datamachine_code_cleanup_assert(0 === (int) ( $until_empty_json['stale_lock_summary']['active_protected_locks'] ?? -1 ), 'cleanup until-empty JSON summarizes protected lock count at top level');
datamachine_code_cleanup_assert(1 === (int) ( $until_empty_json['locks']['stale_locks']['database_count'] ?? 0 ), 'cleanup until-empty JSON keeps detailed stale lock evidence');

WP_CLI::$logs = array();
WP_CLI::$successes = array();
Expand All @@ -1356,11 +1362,12 @@ public function execute( array $input ): array
datamachine_code_cleanup_assert('inventory' === ( $cleanup_run_ability->last_input['mode'] ?? '' ), 'cleanup run can schedule inventory mode');

WP_CLI::$logs = array();
WP_CLI::$successes = array();
$command->cleanup(array( 'status', 'cleanup-run-20260504193024-abc123' ), array( 'format' => 'json' ));
$db_status_json = json_decode(WP_CLI::$logs[0] ?? '', true);
datamachine_code_cleanup_assert('cleanup-run-20260504193024-abc123' === ( $cleanup_status_ability->last_input['run_id'] ?? '' ), 'DB cleanup run IDs are routed to cleanup status ability');
datamachine_code_cleanup_assert('planned' === ( $db_status_json['state'] ?? '' ), 'DB cleanup run status does not route to job-backed status parser');
WP_CLI::$successes = array();
$command->cleanup(array( 'status', 'cleanup-run-20260504193024-abc123' ), array( 'format' => 'json' ));
$db_status_json = json_decode(WP_CLI::$logs[0] ?? '', true);
datamachine_code_cleanup_assert('cleanup-run-20260504193024-abc123' === ( $cleanup_status_ability->last_input['run_id'] ?? '' ), 'DB cleanup run IDs are routed to cleanup status ability');
datamachine_code_cleanup_assert('planned' === ( $db_status_json['state'] ?? '' ), 'DB cleanup run status does not route to job-backed status parser');
datamachine_code_cleanup_assert('wp datamachine-code workspace worktree locks --prune-stale --format=json' === (string) ( $db_status_json['recommended_next_step'] ?? '' ), 'cleanup status JSON promotes safe stale lock prune command');
datamachine_code_cleanup_assert(1 === (int) ( $db_status_json['locks']['stale_locks']['database_count'] ?? 0 ), 'cleanup status JSON surfaces stale DB locks');
datamachine_code_cleanup_assert('wp datamachine-code workspace worktree locks --prune-stale --dry-run --format=json' === (string) ( $db_status_json['locks']['stale_locks']['preview_command'] ?? '' ), 'cleanup status JSON includes exact stale lock preview command');
datamachine_code_cleanup_assert('wp datamachine-code workspace worktree locks --prune-stale --format=json' === (string) ( $db_status_json['locks']['stale_locks']['apply_command'] ?? '' ), 'cleanup status JSON includes exact stale lock apply command');
Expand Down
Loading