Skip to content

Harden sync failure handling #7

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
jonbp merged 5 commits into from
Sep 23, 2026
+30 −12
Merged

Harden sync failure handling #7

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
edf639f
Detect database sync failures
paintface Sep 19, 2026
913f147
Fail the remote WP-CLI check on unexpected output
paintface Sep 19, 2026
dd8e110
Check the rsync exit status in the sync tasks
paintface Sep 19, 2026
a53f2b7
Shell-escape the rsync paths and excludes
paintface Sep 19, 2026
fc3d622
Replace backtick operators with shell_exec()
paintface Sep 19, 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
3 changes: 2 additions & 1 deletion tasks/connection_check.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,8 @@
$command = 'ssh -q '.$ssh_username.'@'.$ssh_hostname.' "bash -c \"test -f '.$remote_wp_cli.' && echo true || echo false\""';
$live_server_check = exec($command);

if ($live_server_check == 'false') {
// Anything but an explicit 'true' (e.g. no output from a dropped connection) is a failure
if ($live_server_check !== 'true') {

// Exit Messages
task_message('Connected but cannot find remote WP-CLI', 'Error', 31, false);
Expand Down
14 changes: 10 additions & 4 deletions tasks/database_sync.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
task_message($task_name);

// pv check
if (`which pv`) {
if (shell_exec('which pv')) {
$pipe = '| pv |';
} else {
task_message('Install the \'pv\' command to monitor import progress', 'Notice', 33, false);
Expand All @@ -16,12 +16,18 @@

$command = 'ssh '.$ssh_username.'@'.$ssh_hostname.' "bash -c \"cd '.$rem_proj_loc.' && '.$remote_wp_cli.' db export --single-transaction -\"" '.$pipe.' '.$local_wp_cli.' db import -';
debug_message($command);
system($command);
// pipefail catches a failed export, not just a failed import
system('bash -c '.escapeshellarg('set -o pipefail; '.$command), $db_status);

if ($db_status !== 0) {
task_message('Database sync failed (exit code '.$db_status.')', 'Error', 31);
$fail_count++;
}

/**
* TASK: Post sync queries
* TASK: Post sync queries (skipped if the import failed)
*/
if ($queries = $_ENV['DEV_POST_SYNC_QUERIES']) {
if ($db_status === 0 && ($queries = $_ENV['DEV_POST_SYNC_QUERIES'])) {
$command = $local_wp_cli . ' db query "' . preg_replace('/(`|")/i', '\\\\${1}', $queries) . '"';
debug_message($command);
system($command);
Expand Down
11 changes: 8 additions & 3 deletions tasks/plugins_sync.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,16 @@
return;
}

if (`which rsync`) {
if (shell_exec('which rsync')) {
task_message($task_name);
$command = 'rsync -avhP ' . $ssh_username . '@' . $ssh_hostname . ':' . $rem_proj_loc . '/' . $plugin_dir . '/ ./' . $plugin_dir . '/';
$command = 'rsync -avhP ' . escapeshellarg($ssh_username . '@' . $ssh_hostname . ':' . $rem_proj_loc . '/' . $plugin_dir . '/') . ' ' . escapeshellarg('./' . $plugin_dir . '/');
debug_message($command);
system($command);
system($command, $rsync_status);

if ($rsync_status !== 0 && $rsync_status !== 24) {
task_message($task_name.' failed (rsync exit code '.$rsync_status.')', 'Error', 31);
$fail_count++;
}
} else {
task_message($task_name.' task not ran, please install \'rsync\'', 'Error', 31);
$fail_count++;
Expand Down
14 changes: 10 additions & 4 deletions tasks/uploads_sync.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,21 @@
if ($exclude_dirs = $_ENV['DEV_SYNC_DIR_EXCLUDES']) {
$exclude_dirs = explode(',', $exclude_dirs);
foreach ($exclude_dirs as $dir) {
$excludes .= ' --exclude=' . $dir;
$excludes .= ' --exclude=' . escapeshellarg($dir);
}
}

if (`which rsync`) {
if (shell_exec('which rsync')) {
task_message($task_name);
$command = 'rsync -avhP ' . $ssh_username . '@' . $ssh_hostname . ':' . $rem_proj_loc . '/' . $upload_dir . '/ ./' . $upload_dir . '/' . $excludes;
$command = 'rsync -avhP ' . escapeshellarg($ssh_username . '@' . $ssh_hostname . ':' . $rem_proj_loc . '/' . $upload_dir . '/') . ' ' . escapeshellarg('./' . $upload_dir . '/') . $excludes;
debug_message($command);
system($command);
system($command, $rsync_status);

// 24 = files vanished mid-transfer, routine on a live uploads folder
if ($rsync_status !== 0 && $rsync_status !== 24) {
task_message($task_name.' failed (rsync exit code '.$rsync_status.')', 'Error', 31);
$fail_count++;
}
} else {
task_message($task_name.' task not ran, please install \'rsync\'', 'Error', 31);
$fail_count++;
Expand Down