Changeset 53097

Timestamp:

04/07/2022 05:44:34 PM (3 years ago)

Author:

spacedmonkey

Message:

Networks and Sites: Improve cache key generation in WP_Site_Query class.

Improve cache key generation in the WP_Site_Query class by removing update_site_cache and update_site_meta_cache elements in the array used to generate
the cache key. These elements do not affect that cache and by removing them, improve the likelihood of reusing an existing cache.

Props Spacedmonkey, furi3r, johnbillion, johnjamesjacoby, flixos90.
Fixes #55462.

Location:

trunk

Files:

• src/wp-includes/class-wp-site-query.php (modified) (1 diff)
• tests/phpunit/tests/multisite/wpSiteQuery.php (modified) (2 diffs)

trunk/src/wp-includes/class-wp-site-query.php

@@ -346 +346 @@
         $_args = wp_array_slice_assoc( $this->query_vars, array_keys( $this->query_var_defaults ) );
 
-        // Ignore the $fields argument as the queried result will be the same regardless.
-        unset( $_args['fields'] );
+        // Ignore the $fields, $update_site_cache, $update_site_meta_cache argument as the queried result will be the same regardless.
+        unset( $_args['fields'], $_args['update_site_cache'], $_args['update_site_meta_cache'] );
 
         $key          = md5( serialize( $_args ) );

trunk/tests/phpunit/tests/multisite/wpSiteQuery.php

@@ -850 +850 @@
             );
 
-            $number_of_queries = $wpdb->num_queries;
+            $number_of_queries = get_num_queries();
 
             $query_2 = $q->query(
@@ -862 +862 @@
             );
             $this->assertSame( $number_of_queries + 1, $wpdb->num_queries );
+        }
+
+        /**
+         * @ticket 55462
+         */
+        public function test_wp_site_query_cache_with_same_fields_same_cache_fields() {
+            $q = new WP_Site_Query();
+
+            $query_1 = $q->query(
+                array(
+                    'fields'                 => 'ids',
+                    'network_id'             => self::$network_ids['wordpress.org/'],
+                    'number'                 => 3,
+                    'order'                  => 'ASC',
+                    'update_site_cache'      => true,
+                    'update_site_meta_cache' => true,
+                )
+            );
+
+            $number_of_queries = get_num_queries();
+
+            $query_2 = $q->query(
+                array(
+                    'fields'                 => 'ids',
+                    'network_id'             => self::$network_ids['wordpress.org/'],
+                    'number'                 => 3,
+                    'order'                  => 'ASC',
+                    'update_site_cache'      => true,
+                    'update_site_meta_cache' => true,
+                )
+            );
+            $this->assertSame( $number_of_queries, get_num_queries() );
+        }
+
+        /**
+         * @ticket 55462
+         */
+        public function test_wp_site_query_cache_with_same_fields_different_cache_fields() {
+            $q = new WP_Site_Query();
+
+            $query_1 = $q->query(
+                array(
+                    'fields'                 => 'ids',
+                    'network_id'             => self::$network_ids['wordpress.org/'],
+                    'number'                 => 3,
+                    'order'                  => 'ASC',
+                    'update_site_cache'      => true,
+                    'update_site_meta_cache' => true,
+                )
+            );
+
+            $number_of_queries = get_num_queries();
+
+            $query_2 = $q->query(
+                array(
+                    'fields'                 => 'ids',
+                    'network_id'             => self::$network_ids['wordpress.org/'],
+                    'number'                 => 3,
+                    'order'                  => 'ASC',
+                    'update_site_cache'      => false,
+                    'update_site_meta_cache' => false,
+                )
+            );
+            $this->assertSame( $number_of_queries, get_num_queries() );
         }