Changeset 57029

Timestamp:

10/30/2023 10:56:25 PM (9 months ago)

Author:

peterwilsoncc

Message:

Options, Meta APIs: Fast follow fixes for option cache priming functions.

A collection of fixes for wp_prime_option_caches():

• cache arrays and objects in their serialized form for consistency with get_option() and wp_load_alloptions()
• prevent repeat database queries for falsey and known non-existent options (notoptions)

Additional tests for wp_prime_option_caches() to ensure:

• additional database queries are not made repriming options (known, known-unknown and alloptions)
• cache is primed consistently
• get_option() returns a consistent value regardless of how it is primed
• database queries do not contain earlier primed options
• get_option does not prime the cache when testing the cache has been successfully primed

Fixes a test for wp_prime_option_caches_by_group() to ensure get_option does not prime the cache when testing the cache has been successfully primed.

Follow up to [56445],[56990],[57013].

Props peterwilsoncc, costdev, flixos90, hellofromTonya, mikeschroder, joemcgill.
Fixes #59738. See #58962.

Location:

trunk

Files:

• src/wp-includes/option.php (modified) (3 diffs)
• tests/phpunit/tests/option/wpPrimeOptionCaches.php (modified) (7 diffs)
• tests/phpunit/tests/option/wpPrimeOptionCachesByGroup.php (modified) (1 diff)

trunk/src/wp-includes/option.php

@@ -262 +262 @@
     $alloptions     = wp_load_alloptions();
     $cached_options = wp_cache_get_multiple( $options, 'options' );
+
+
+
+
 
     // Filter options that are not in the cache.
     $options_to_prime = array();
     foreach ( $options as $option ) {
-        if ( ( ! isset( $cached_options[ $option ] ) || ! $cached_options[ $option ] ) && ! isset( $alloptions[ $option ] ) ) {
+        if (
+            ( ! isset( $cached_options[ $option ] ) || false === $cached_options[ $option ] )
+            && ! isset( $alloptions[ $option ] )
+            && ! isset( $notoptions[ $option ] )
+        ) {
             $options_to_prime[] = $option;
         }
@@ -289 +297 @@
     $options_found = array();
     foreach ( $results as $result ) {
-        $options_found[ $result->option_name ] = maybe_unserialize( $result->option_value );
+        /*
+         * The cache is primed with the raw value (i.e. not maybe_unserialized).
+         *
+         * `get_option()` will handle unserializing the value as needed.
+         */
+        $options_found[ $result->option_name ] = $result->option_value;
     }
     wp_cache_set_multiple( $options_found, 'options' );
@@ -299 +312 @@
 
     $options_not_found = array_diff( $options_to_prime, array_keys( $options_found ) );
-
-    $notoptions = wp_cache_get( 'notoptions', 'options' );
-
-    if ( ! is_array( $notoptions ) ) {
-        $notoptions = array();
-    }
 
     // Add the options that were not found to the cache.

trunk/tests/phpunit/tests/option/wpPrimeOptionCaches.php

@@ -42 +42 @@
         foreach ( $options_to_prime as $option ) {
             $this->assertSame(
+
                 wp_cache_get( $option, 'options' ),
-                get_option( $option ),
                 "$option was not primed in the 'options' cache group."
             );
 
-            $this->assertFalse(
-                wp_cache_get( $option, 'notoptions' ),
-                get_option( $option ),
-                "$option was primed in the 'notoptions' cache group."
+            $new_notoptions = wp_cache_get( $option, 'notoptions' );
+            if ( ! is_array( $new_notoptions ) ) {
+                $new_notoptions = array();
+            }
+            $this->assertArrayNotHasKey(
+                $option,
+                $new_notoptions,
+                "$option was primed in the 'notoptions' cache."
             );
         }
@@ -63 +67 @@
 
     /**
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
      * Tests wp_prime_option_caches() with options that do not exist in the database.
      *
      * @ticket 58962
+
      */
     public function test_wp_prime_option_caches_with_nonexistent_options() {
@@ -97 +161 @@
             $this->assertArrayHasKey( $option, $new_notoptions, "$option was not added to the notoptions cache." );
         }
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
     }
 
@@ -103 +185 @@
      *
      * @ticket 58962
+
      */
     public function test_wp_prime_option_caches_with_empty_array() {
@@ -108 +191 @@
         $notoptions = wp_cache_get( 'notoptions', 'options' );
 
+
         wp_prime_option_caches( array() );
 
         $this->assertSame( $alloptions, wp_cache_get( 'alloptions', 'options' ), 'The alloptions cache was modified.' );
         $this->assertSame( $notoptions, wp_cache_get( 'notoptions', 'options' ), 'The notoptions cache was modified.' );
+
+
+
+
+
+
+
     }
 
@@ -118 +209 @@
      *
      * @ticket 58962
+
      */
     public function test_wp_prime_option_caches_handles_empty_notoptions_cache() {
@@ -127 +219 @@
         $this->assertIsArray( $notoptions, 'The notoptions cache should be an array.' );
         $this->assertArrayHasKey( 'nonexistent_option', $notoptions, 'nonexistent_option was not added to notoptions.' );
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
     }
 }

trunk/tests/phpunit/tests/option/wpPrimeOptionCachesByGroup.php

@@ -48 +48 @@
         wp_prime_option_caches_by_group( 'group1' );
 
-        // Check that options are now in the cache.
-        $this->assertSame( get_option( 'option1' ), wp_cache_get( 'option1', 'options' ), 'option1\'s cache was not primed.' );
-        $this->assertSame( get_option( 'option2' ), wp_cache_get( 'option2', 'options' ), 'option2\'s cache was not primed.' );
+        /*
+         * Check that options are now in the cache.
+         *
+         * Repeat the string here rather than using get_option as get_option
+         * will prime the cache before the call to wp_cache_get if the option
+         * is not in the cache. Thus causing the tests to pass when they should
+         * fail.
+         */
+        $this->assertSame( 'value_option1', wp_cache_get( 'option1', 'options' ), 'option1\'s cache was not primed.' );
+        $this->assertSame( 'value_option2', wp_cache_get( 'option2', 'options' ), 'option2\'s cache was not primed.' );
 
         // Make sure option3 is still not in cache.