From dde6b740c0a721ac3b5a640307a1f630fe5b2de1 Mon Sep 17 00:00:00 2001 From: Riddhesh Sanghvi Date: Tue, 3 Nov 2026 17:52:46 +0530 Subject: [PATCH] chore(backup): rename EasyDash to EasyEngine Dashboard in messages and docs Use the product name in the backup rollback warning, the captured-error debug line, the --dash-auth help text and the related comments and docblocks. The --dash-auth flag, the ed-api-url config key, the dash_* identifiers and the easydash.* API endpoint paths are unchanged. --- src/helper/Site_Backup_Restore.php | 26 +++++++++++++------------- src/helper/class-ee-site.php | 2 +- 2 files changed, 14 insertions(+), 14 deletions(-) diff --git a/src/helper/Site_Backup_Restore.php b/src/helper/Site_Backup_Restore.php index d2620cc4..f551d7a9 100644 --- a/src/helper/Site_Backup_Restore.php +++ b/src/helper/Site_Backup_Restore.php @@ -36,7 +36,7 @@ class Site_Backup_Restore { public $site_data; private $rclone_config_path; - // Properties for EasyDash callback handling + // Properties for EasyEngine Dashboard callback handling private $dash_auth_enabled = false; private $dash_backup_id; private $dash_verify_token; @@ -45,7 +45,7 @@ class Site_Backup_Restore { private $dash_backup_completed = false; private $dash_new_backup_path; // Track new backup path for potential rollback - // Error tracking for EasyDash failure callbacks + // Error tracking for EasyEngine Dashboard failure callbacks private $dash_error_message = ''; private $dash_error_type = 'unknown'; private $dash_error_code = 0; @@ -80,7 +80,7 @@ public function backup( $args, $assoc_args = [] ) { return; // Exit after listing backups } - // Handle --dash-auth flag for EasyDash integration + // Handle --dash-auth flag for EasyEngine Dashboard integration if ( $dash_auth ) { // Parse backup-id:backup-verification-token format $auth_parts = explode( ':', $dash_auth, 2 ); @@ -184,7 +184,7 @@ public function backup( $args, $assoc_args = [] ) { } /** - * Shutdown handler to send failure callback to EasyDash if backup didn't complete. + * Shutdown handler to send failure callback to EasyEngine Dashboard if backup didn't complete. * This is called when script terminates (including via EE::error which calls exit). * * Automatically captures fatal errors and interrupted processes if no error was @@ -235,7 +235,7 @@ public function dash_shutdown_handler() { } /** - * Capture error details for EasyDash failure callback. + * Capture error details for EasyEngine Dashboard failure callback. * Stores error information to be sent when backup fails. * * @param string $message Error message describing what went wrong. @@ -250,7 +250,7 @@ private function capture_error( $message, $type = self::ERROR_TYPE_UNKNOWN, $cod $this->dash_error_code = $code; EE::debug( sprintf( - 'Captured error for EasyDash: [%s] %s (code: %d)', + 'Captured error for EasyEngine Dashboard: [%s] %s (code: %d)', $type, $message, $code @@ -1627,8 +1627,8 @@ private function cleanup_old_backups() { } /** - * Rollback (delete) the newly uploaded backup when EasyDash API callback fails. - * This prevents orphaned backups in remote storage that aren't tracked by EasyDash. + * Rollback (delete) the newly uploaded backup when EasyEngine Dashboard API callback fails. + * This prevents orphaned backups in remote storage that aren't tracked by the EasyEngine Dashboard. */ private function rollback_failed_backup() { if ( empty( $this->dash_new_backup_path ) ) { @@ -1637,7 +1637,7 @@ private function rollback_failed_backup() { return; } - EE::warning( 'EasyDash API callback failed. Rolling back newly uploaded backup...' ); + EE::warning( 'EasyEngine Dashboard API callback failed. Rolling back newly uploaded backup...' ); EE::log( 'Deleting unregistered backup: ' . $this->dash_new_backup_path ); $result = EE::launch( sprintf( 'rclone purge %s', escapeshellarg( $this->dash_new_backup_path ) ) ); @@ -1696,9 +1696,9 @@ private function restore_php_conf( $backup_dir ) { } /** - * Send success callback to EasyDash API after successful backup. + * Send success callback to EasyEngine Dashboard API after successful backup. * - * @param string $ed_api_url The EasyDash API URL. + * @param string $ed_api_url The EasyEngine Dashboard API URL. * @param string $backup_id The backup ID. * @param string $verify_token The verification token. * @param array $backup_metadata The backup metadata. @@ -1738,10 +1738,10 @@ private function send_dash_success_callback( $ed_api_url, $backup_id, $verify_to } /** - * Send failure callback to EasyDash API after failed backup. + * Send failure callback to EasyEngine Dashboard API after failed backup. * Includes error details (message, type, code) for debugging and user feedback. * - * @param string $ed_api_url The EasyDash API URL. + * @param string $ed_api_url The EasyEngine Dashboard API URL. * @param string $backup_id The backup ID. * @param string $verify_token The verification token. */ diff --git a/src/helper/class-ee-site.php b/src/helper/class-ee-site.php index f9dd4ff2..9ecf8703 100644 --- a/src/helper/class-ee-site.php +++ b/src/helper/class-ee-site.php @@ -2936,7 +2936,7 @@ public function sync( $args, $assoc_args ) { * : List all available backups on remote. * * [--dash-auth] - * : Pass dash auth token and backup id. For EasyEngine dash use only. + * : Pass dash auth token and backup id. For EasyEngine Dashboard use only. * * ## EXAMPLES *