Changeset 58128 for trunk/src/wp-admin/includes/class-wp-upgrader.php

Timestamp:

05/10/2024 11:46:51 AM (5 months ago)

Author:

johnbillion

Message:

Upgrade/Install: Automatically roll back to the previous version when an automatic plugin update results in a fatal error on the front end of the site.

This builds on the temporary backup system introduced in 6.3 to allow automatic updates to benefit from fatal error protection. A loopback request is performed to the home page of the site and the plugin is rolled back to its backed up version if a fatal error is observed.

For debugging and observability during beta, this change includes several calls to error_log() during the upgrade and rollback stages. These calls can be removed or placed behind a flag once we're ready for RC1.

Props costdev, johnbillion, mukesh27, afragen, audrasjb, justlevine, kirasong, peterwilsoncc

Fixes #58281

File:

• trunk/src/wp-admin/includes/class-wp-upgrader.php (modified) (6 diffs)

trunk/src/wp-admin/includes/class-wp-upgrader.php

@@ -902 +902 @@
 
         if ( is_wp_error( $result ) ) {
+            // An automatic plugin update will have already performed its rollback.
             if ( ! empty( $options['hook_extra']['temp_backup'] ) ) {
                 $this->temp_restores[] = $options['hook_extra']['temp_backup'];
@@ -910 +911 @@
                  * so in case the failure was due to a PHP timeout,
                  * it will still be able to properly restore the previous version.
+                 *
+                 * Zero arguments are accepted as a string can sometimes be passed
+                 * internally during actions, causing an error because
+                 * `WP_Upgrader::restore_temp_backup()` expects an array.
                  */
-                add_action( 'shutdown', array( $this, 'restore_temp_backup' ) );
+                add_action( 'shutdown', array( $this, 'restore_temp_backup' ), 10, 0 );
             }
             $this->skin->error( $result );
@@ -984 +989 @@
     public function maintenance_mode( $enable = false ) {
         global $wp_filesystem;
+
+        if ( ! $wp_filesystem ) {
+            require_once ABSPATH . 'wp-admin/includes/file.php';
+            WP_Filesystem();
+        }
+
         $file = $wp_filesystem->abspath() . '.maintenance';
         if ( $enable ) {
-            $this->skin->feedback( 'maintenance_start' );
+            if ( ! wp_doing_cron() ) {
+                $this->skin->feedback( 'maintenance_start' );
+            }
             // Create maintenance file to signal that we are upgrading.
             $maintenance_string = '<?php $upgrading = ' . time() . '; ?>';
@@ -992 +1005 @@
             $wp_filesystem->put_contents( $file, $maintenance_string, FS_CHMOD_FILE );
         } elseif ( ! $enable && $wp_filesystem->exists( $file ) ) {
-            $this->skin->feedback( 'maintenance_end' );
+            if ( ! wp_doing_cron() ) {
+                $this->skin->feedback( 'maintenance_end' );
+            }
             $wp_filesystem->delete( $file );
         }
@@ -1134 +1149 @@
      *
      * @since 6.3.0
+     * @since 6.6.0 Added the `$temp_backups` parameter.
      *
      * @global WP_Filesystem_Base $wp_filesystem WordPress filesystem subclass.
      *
+     * @param array[] $temp_backups {
+     *     Optional. An array of temporary backups.
+     *
+     *     @type array ...$0 {
+     *         Information about the backup.
+     *
+     *         @type string $dir  The temporary backup location in the upgrade-temp-backup directory.
+     *         @type string $slug The item's slug.
+     *         @type string $src  The directory where the original is stored. For example, `WP_PLUGIN_DIR`.
+     *     }
+     * }
      * @return bool|WP_Error True on success, false on early exit, otherwise WP_Error.
      */
-    public function restore_temp_backup() {
+    public function restore_temp_backup( array $temp_backups = array() ) {
         global $wp_filesystem;
 
         $errors = new WP_Error();
 
-        foreach ( $this->temp_restores as $args ) {
+        if ( empty( $temp_backups ) ) {
+            $temp_backups = $this->temp_restores;
+        }
+
+        foreach ( $temp_backups as $args ) {
             if ( empty( $args['slug'] ) || empty( $args['src'] ) || empty( $args['dir'] ) ) {
                 return false;
@@ -1187 +1218 @@
      *
      * @since 6.3.0
+     * @since 6.6.0 Added the `$temp_backups` parameter.
      *
      * @global WP_Filesystem_Base $wp_filesystem WordPress filesystem subclass.
      *
+     * @param array[] $temp_backups {
+     *     Optional. An array of temporary backups.
+     *
+     *     @type array ...$0 {
+     *         Information about the backup.
+     *
+     *         @type string $dir  The temporary backup location in the upgrade-temp-backup directory.
+     *         @type string $slug The item's slug.
+     *         @type string $src  The directory where the original is stored. For example, `WP_PLUGIN_DIR`.
+     *     }
+     * }
      * @return bool|WP_Error True on success, false on early exit, otherwise WP_Error.
      */
-    public function delete_temp_backup() {
+    public function delete_temp_backup( array $temp_backups = array() ) {
         global $wp_filesystem;
 
         $errors = new WP_Error();
 
-        foreach ( $this->temp_backups as $args ) {
+        if ( empty( $temp_backups ) ) {
+            $temp_backups = $this->temp_backups;
+        }
+
+        foreach ( $temp_backups as $args ) {
             if ( empty( $args['slug'] ) || empty( $args['dir'] ) ) {
                 return false;