Changeset 58782

Timestamp:

07/23/2024 12:25:19 AM (6 months ago)

Author:

peterwilsoncc

Message:

Options, Meta APIs: Prime notoptions cache when deleting options.

Prime the notoptions cache within delete_option and delete_network_option to avoid the need for a database query if get_option or get_network_option is subsequently called.

Adds some associated tests to ensure that an option is cleared from the notoptions cache when an option is added either via add_option, update_option or their network option equivalent.

Props pbearne, mukesh27.
Fixes #61484.

Location:

trunk

Files:

• src/wp-includes/option.php (modified) (2 diffs)
• tests/phpunit/tests/option/networkOption.php (modified) (2 diffs)
• tests/phpunit/tests/option/option.php (modified) (1 diff)

trunk/src/wp-includes/option.php

@@ -1218 +1218 @@
             wp_cache_delete( $option, 'options' );
         }
+
+        $notoptions = wp_cache_get( 'notoptions', 'options' );
+
+        if ( ! is_array( $notoptions ) ) {
+            $notoptions = array();
+        }
+        $notoptions[ $option ] = true;
+
+        wp_cache_set( 'notoptions', $notoptions, 'options' );
     }
 
@@ -2285 +2294 @@
         do_action( 'delete_site_option', $option, $network_id );
 
+        $notoptions_key = "$network_id:notoptions";
+        $notoptions     = wp_cache_get( $notoptions_key, 'site-options' );
+
+        if ( ! is_array( $notoptions ) ) {
+            $notoptions = array();
+        }
+        $notoptions[ $option ] = true;
+        wp_cache_set( $notoptions_key, $notoptions, 'site-options' );
+
         return true;
     }

trunk/tests/phpunit/tests/option/networkOption.php

@@ -58 +58 @@
 
     /**
+     * Tests that calling delete_network_option() updates nooptions when option deleted.
+     *
+     * @ticket 61484
+     *
+     * @covers ::delete_network_option
+     */
+    public function test_check_delete_network_option_updates_notoptions() {
+        add_network_option( 1, 'foo', 'value1' );
+
+        delete_network_option( 1, 'foo' );
+        $cache_key   = is_multisite() ? '1:notoptions' : 'notoptions';
+        $cache_group = is_multisite() ? 'site-options' : 'options';
+        $notoptions  = wp_cache_get( $cache_key, $cache_group );
+        $this->assertIsArray( $notoptions, 'The notoptions cache is expected to be an array.' );
+        $this->assertTrue( $notoptions['foo'], 'The deleted options is expected to be in notoptions.' );
+
+        $before = get_num_queries();
+        get_network_option( 1, 'foo' );
+        $queries = get_num_queries() - $before;
+
+        $this->assertSame( 0, $queries, 'get_network_option should not make any database queries.' );
+    }
+
+    /**
      * @ticket 22846
      * @group ms-excluded
@@ -229 +253 @@
         $this->assertSame( $num_queries_pre_update, get_num_queries() );
     }
+
+    /**
+     * Tests that calling update_network_option() clears the notoptions cache.
+     *
+     * @ticket 61484
+     *
+     * @covers ::update_network_option
+     */
+    public function test_update_network_option_clears_the_notoptions_cache() {
+        $option_name = 'ticket_61484_option_to_be_created';
+        $cache_key   = is_multisite() ? '1:notoptions' : 'notoptions';
+        $cache_group = is_multisite() ? 'site-options' : 'options';
+        $notoptions  = wp_cache_get( $cache_key, $cache_group );
+        if ( ! is_array( $notoptions ) ) {
+            $notoptions = array();
+        }
+        $notoptions[ $option_name ] = true;
+        wp_cache_set( $cache_key, $notoptions, $cache_group );
+        $this->assertArrayHasKey( $option_name, wp_cache_get( $cache_key, $cache_group ), 'The "foobar" option should be in the notoptions cache.' );
+
+        update_network_option( 1, $option_name, 'baz' );
+
+        $updated_notoptions = wp_cache_get( $cache_key, $cache_group );
+        $this->assertArrayNotHasKey( $option_name, $updated_notoptions, 'The "foobar" option should not be in the notoptions cache after updating it.' );
+    }
+
+    /**
+     * Tests that calling add_network_option() clears the notoptions cache.
+     *
+     * @ticket 61484
+     *
+     * @covers ::add_network_option
+     */
+    public function test_add_network_option_clears_the_notoptions_cache() {
+        $option_name = 'ticket_61484_option_to_be_created';
+        $cache_key   = is_multisite() ? '1:notoptions' : 'notoptions';
+        $cache_group = is_multisite() ? 'site-options' : 'options';
+        $notoptions  = wp_cache_get( $cache_key, $cache_group );
+        if ( ! is_array( $notoptions ) ) {
+            $notoptions = array();
+        }
+        $notoptions[ $option_name ] = true;
+        wp_cache_set( $cache_key, $notoptions, $cache_group );
+        $this->assertArrayHasKey( $option_name, wp_cache_get( $cache_key, $cache_group ), 'The "foobar" option should be in the notoptions cache.' );
+
+        add_network_option( 1, $option_name, 'baz' );
+
+        $updated_notoptions = wp_cache_get( $cache_key, $cache_group );
+        $this->assertArrayNotHasKey( $option_name, $updated_notoptions, 'The "foobar" option should not be in the notoptions cache after updating it.' );
+    }
 }

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

@@ -479 +479 @@
         $this->assertFalse( get_option( 'foo' ) );
     }
+
+    /**
+     * Tests that calling delete_option() updates notoptions when option deleted.
+     *
+     * @ticket 61484
+     *
+     * @covers ::delete_option
+     */
+    public function test_check_delete_option_updates_notoptions() {
+        add_option( 'foo', 'value1' );
+
+        delete_option( 'foo' );
+        $notoptions = wp_cache_get( 'notoptions', 'options' );
+        $this->assertIsArray( $notoptions, 'The notoptions cache is expected to be an array.' );
+        $this->assertTrue( $notoptions['foo'], 'The deleted options is expected to be in notoptions.' );
+
+        $before = get_num_queries();
+        get_option( 'foo' );
+        $queries = get_num_queries() - $before;
+
+        $this->assertSame( 0, $queries, 'get_option should not make any database queries.' );
+    }
+
+    /**
+     * Tests that calling update_option() clears the notoptions cache.
+     *
+     * @ticket 61484
+     *
+     * @covers ::update_option
+     */
+    public function test_update_option_clears_the_notoptions_cache() {
+        $option_name = 'ticket_61484_option_to_be_created';
+        $notoptions  = wp_cache_get( 'notoptions', 'options' );
+        if ( ! is_array( $notoptions ) ) {
+            $notoptions = array();
+        }
+        $notoptions[ $option_name ] = true;
+        wp_cache_set( 'notoptions', $notoptions, 'options' );
+        $this->assertArrayHasKey( $option_name, wp_cache_get( 'notoptions', 'options' ), 'The "foobar" option should be in the notoptions cache.' );
+
+        update_option( $option_name, 'baz' );
+
+        $updated_notoptions = wp_cache_get( 'notoptions', 'options' );
+        $this->assertArrayNotHasKey( $option_name, $updated_notoptions, 'The "foobar" option should not be in the notoptions cache after updating it.' );
+    }
+
+    /**
+     * Tests that calling add_option() clears the notoptions cache.
+     *
+     * @ticket 61484
+     *
+     * @covers ::add_option
+     */
+    public function test_add_option_clears_the_notoptions_cache() {
+        $option_name = 'ticket_61484_option_to_be_created';
+        $notoptions  = wp_cache_get( 'notoptions', 'options' );
+        if ( ! is_array( $notoptions ) ) {
+            $notoptions = array();
+        }
+        $notoptions[ $option_name ] = true;
+        wp_cache_set( 'notoptions', $notoptions, 'options' );
+        $this->assertArrayHasKey( $option_name, wp_cache_get( 'notoptions', 'options' ), 'The "foobar" option should be in the notoptions cache.' );
+
+        add_option( $option_name, 'baz' );
+
+        $updated_notoptions = wp_cache_get( 'notoptions', 'options' );
+        $this->assertArrayNotHasKey( $option_name, $updated_notoptions, 'The "foobar" option should not be in the notoptions cache after adding it.' );
+    }
 }