Changeset 58332 for trunk/tests/phpunit/tests/admin/wpSiteHealth.php

Timestamp:

06/04/2024 02:07:13 PM (11 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.

File:

• trunk/tests/phpunit/tests/admin/wpSiteHealth.php (modified) (1 diff)

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 );
+    }
 }