Changeset 58332

Timestamp:

06/04/2024 02:07:13 PM (4 months ago)

Author:

joemcgill

Message:

Site Health: Add test for large autoloaded options.

This adds a new Site Health check that will alert site owners if they are autoloading a large amount of data from the options table, as it could result in poor performance. The issue will be shown if the size of autoloaded options is greater than 800 KB, which can be adjusted using the new site_status_autoloaded_options_size_limit filter.

Props mukesh27, joemcgill, rajinsharwar, costdev, audrasjb, krupajnanda, pooja1210, Ankit K Gupta, johnbillion, oglekler.
Fixes #61276.

Location:

trunk

Files:

• src/wp-admin/includes/class-wp-site-health.php (modified) (2 diffs)
• tests/phpunit/tests/admin/wpSiteHealth.php (modified) (1 diff)

trunk/src/wp-admin/includes/class-wp-site-health.php

@@ -2584 +2584 @@
         );
 
+        return $result;
+    }
+
+    /**
+     * Calculates total amount of autoloaded data.
+     *
+     * @since 6.6.0
+     *
+     * @return int Autoloaded data in bytes.
+     */
+    public function get_autoloaded_options_size() {
+        $alloptions = wp_load_alloptions();
+
+        $total_length = 0;
+
+        foreach ( $alloptions as $option_name => $option_value ) {
+            $total_length += strlen( $option_value );
+        }
+
+        return $total_length;
+    }
+
+    /**
+     * Tests the number of autoloaded options.
+     *
+     * @since 6.6.0
+     *
+     * @return array The test results.
+     */
+    public function get_test_autoloaded_options() {
+        $autoloaded_options_size  = $this->get_autoloaded_options_size();
+        $autoloaded_options_count = count( wp_load_alloptions() );
+
+        $base_description = __( 'Autoloaded options are configuration settings for plugins and themes that are automatically loaded with every page load in WordPress. Having too many autoloaded options can slow down your site.' );
+
+        $result = array(
+            'label'       => __( 'Autoloaded options are acceptable' ),
+            'status'      => 'good',
+            'badge'       => array(
+                'label' => __( 'Performance' ),
+                'color' => 'blue',
+            ),
+            'description' => sprintf(
+                /* translators: 1: Number of autoloaded options, 2: Autoloaded options size. */
+                '<p>' . esc_html( $base_description ) . ' ' . __( 'Your site has %1$s autoloaded options (size: %2$s) in the options table, which is acceptable.' ) . '</p>',
+                $autoloaded_options_count,
+                size_format( $autoloaded_options_size )
+            ),
+            'actions'     => '',
+            'test'        => 'autoloaded_options',
+        );
+
+        /**
+         * Filters max bytes threshold to trigger warning in Site Health.
+         *
+         * @since 6.6.0
+         *
+         * @param int $limit Autoloaded options threshold size. Default 800000.
+         */
+        $limit = apply_filters( 'site_status_autoloaded_options_size_limit', 800000 );
+
+        if ( $autoloaded_options_size < $limit ) {
+            return $result;
+        }
+
+        $result['status']      = 'critical';
+        $result['label']       = __( 'Autoloaded options could affect performance' );
+        $result['description'] = sprintf(
+            /* translators: 1: Number of autoloaded options, 2: Autoloaded options size. */
+            '<p>' . esc_html( $base_description ) . ' ' . __( 'Your site has %1$s autoloaded options (size: %2$s) in the options table, which could cause your site to be slow. You can review the options being autoloaded in your database and remove any options that are no longer needed by your site.' ) . '</p>',
+            $autoloaded_options_count,
+            size_format( $autoloaded_options_size )
+        );
+
+        /**
+         * Filters description to be shown on Site Health warning when threshold is met.
+         *
+         * @since 6.6.0
+         *
+         * @param string $description Description message when autoloaded options bigger than threshold.
+         */
+        $result['description'] = apply_filters( 'site_status_autoloaded_options_limit_description', $result['description'] );
+
+        $result['actions'] = sprintf(
+            /* translators: 1: HelpHub URL, 2: Link description. */
+            '<p><a target="_blank" rel="noopener" href="%1$s">%2$s</a></p>',
+            esc_url( __( 'https://developer.wordpress.org/advanced-administration/performance/optimization/#autoloaded-options' ) ),
+            __( 'More info about optimizing autoloaded options' )
+        );
+
+        /**
+         * Filters actionable information to tackle the problem. It can be a link to an external guide.
+         *
+         * @since 6.6.0
+         *
+         * @param string $actions Call to Action to be used to point to the right direction to solve the issue.
+         */
+        $result['actions'] = apply_filters( 'site_status_autoloaded_options_action_to_perform', $result['actions'] );
         return $result;
     }
@@ -2671 +2769 @@
                     'test'  => 'available_updates_disk_space',
                 ),
+                'autoloaded_options' => array(
+                    'label' => __( 'Autoloaded options' ),
+                    'test'  => 'autoloaded_options',
+                ),
             ),
             'async'  => array(

trunk/tests/phpunit/tests/admin/wpSiteHealth.php

@@ -500 +500 @@
         );
     }
+
+    /**
+     * Tests get_test_autoloaded_options() when autoloaded options less than warning size.
+     *
+     * @ticket 61276
+     *
+     * @covers ::get_test_autoloaded_options()
+     */
+    public function test_wp_autoloaded_options_test_no_warning() {
+        $expected_label  = esc_html__( 'Autoloaded options are acceptable' );
+        $expected_status = 'good';
+
+        $result = $this->instance->get_test_autoloaded_options();
+        $this->assertSame( $expected_label, $result['label'], 'The label should indicate that autoloaded options are acceptable.' );
+        $this->assertSame( $expected_status, $result['status'], 'The status should be "good" when autoloaded options are acceptable.' );
+    }
+
+    /**
+     * Tests get_test_autoloaded_options() when autoloaded options more than warning size.
+     *
+     * @ticket 61276
+     *
+     * @covers ::get_test_autoloaded_options()
+     */
+    public function test_wp_autoloaded_options_test_warning() {
+        self::set_autoloaded_option( 800000 );
+
+        $expected_label  = esc_html__( 'Autoloaded options could affect performance' );
+        $expected_status = 'critical';
+
+        $result = $this->instance->get_test_autoloaded_options();
+        $this->assertSame( $expected_label, $result['label'], 'The label should indicate that autoloaded options could affect performance.' );
+        $this->assertSame( $expected_status, $result['status'], 'The status should be "critical" when autoloaded options could affect performance.' );
+    }
+
+    /**
+     * Tests get_autoloaded_options_size().
+     *
+     * @ticket 61276
+     *
+     * @covers ::get_autoloaded_options_size()
+     */
+    public function test_get_autoloaded_options_size() {
+        global $wpdb;
+
+        $autoload_values = wp_autoload_values_to_autoload();
+
+        $autoloaded_options_size = (int) $wpdb->get_var(
+            $wpdb->prepare(
+                sprintf(
+                    "SELECT SUM(LENGTH(option_value)) FROM $wpdb->options WHERE autoload IN (%s)",
+                    implode( ',', array_fill( 0, count( $autoload_values ), '%s' ) )
+                ),
+                $autoload_values
+            )
+        );
+        $this->assertSame( $autoloaded_options_size, $this->instance->get_autoloaded_options_size(), 'The size of autoloaded options should match the calculated size from the database.' );
+
+        // Add autoload option.
+        $test_option_string       = 'test';
+        $test_option_string_bytes = mb_strlen( $test_option_string, '8bit' );
+        self::set_autoloaded_option( $test_option_string_bytes );
+        $this->assertSame( $autoloaded_options_size + $test_option_string_bytes, $this->instance->get_autoloaded_options_size(), 'The size of autoloaded options should increase by the size of the newly added option.' );
+    }
+
+    /**
+     * Sets a test autoloaded option.
+     *
+     * @param int $bytes bytes to load in options.
+     */
+    public static function set_autoloaded_option( $bytes = 800000 ) {
+        $heavy_option_string = wp_generate_password( $bytes );
+
+        // Force autoloading so that WordPress core does not override it. See https://core.trac.wordpress.org/changeset/57920.
+        add_option( 'test_set_autoloaded_option', $heavy_option_string, '', true );
+    }
 }