Changeset 55747

Timestamp:

05/11/2023 11:13:10 AM (19 months ago)

Author:

spacedmonkey

Message:

Networks and Sites: Lazy load site meta.

In [36566] a framework to lazily load metadata was introduced. This supported term and comment meta by default. In this commit, extends support for site ( blog ) meta. Site meta is not heavily used by core and is used by developers to extend multisite. In this change, _prime_site_caches and WP_Site_Query now call the new function wp_lazyload_site_meta. The function wp_lazyload_site_meta accepts an array of ids and adds them to the queue of metadata to be lazily loaded. The function get_blogs_of_user was updated to now lazily load site meta.

Follow on from [55671].

Props spacedmonkey, johnjamesjacoby, peterwilsoncc, mukesh27.
Fixes #58185.

Location:

trunk

Files:

• src/wp-includes/class-wp-metadata-lazyloader.php (modified) (1 diff)
• src/wp-includes/class-wp-site-query.php (modified) (2 diffs)
• src/wp-includes/ms-site.php (modified) (2 diffs)
• src/wp-includes/user.php (modified) (1 diff)
• tests/phpunit/includes/abstract-testcase.php (modified) (1 diff)
• tests/phpunit/tests/multisite/siteMeta.php (modified) (2 diffs)

trunk/src/wp-includes/class-wp-metadata-lazyloader.php

@@ -62 +62 @@
                 'callback' => array( $this, 'lazyload_meta_callback' ),
             ),
+            'blog'    => array(
+                'filter'   => 'get_blog_metadata',
+                'callback' => array( $this, 'lazyload_meta_callback' ),
+            ),
         );
     }

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

@@ -389 +389 @@
         $site_ids = array_map( 'intval', $site_ids );
 
+        if ( $this->query_vars['update_site_meta_cache'] ) {
+            wp_lazyload_site_meta( $site_ids );
+        }
+
         if ( 'ids' === $this->query_vars['fields'] ) {
             $this->sites = $site_ids;
@@ -397 +401 @@
         // Prime site network caches.
         if ( $this->query_vars['update_site_cache'] ) {
-            _prime_site_caches( $site_ids, $this->query_vars['update_site_meta_cache'] );
+            _prime_site_caches( $site_ids, false );
         }
 

trunk/src/wp-includes/ms-site.php

@@ -341 +341 @@
  * @since 5.1.0 Introduced the `$update_meta_cache` parameter.
  * @since 6.1.0 This function is no longer marked as "private".
+ * @since 6.3.0 Use wp_lazyload_site_meta() for lazy-loading of site meta.
  *
  * @see update_site_cache()
@@ -355 +356 @@
         $fresh_sites = $wpdb->get_results( sprintf( "SELECT * FROM $wpdb->blogs WHERE blog_id IN (%s)", implode( ',', array_map( 'intval', $non_cached_ids ) ) ) ); // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared
 
-        update_site_cache( $fresh_sites, $update_meta_cache );
-    }
+        update_site_cache( $fresh_sites, false );
+    }
+
+    if ( $update_meta_cache ) {
+        wp_lazyload_site_meta( $ids );
+    }
+}
+
+/**
+ * Queue site meta for lazy-loading.
+ *
+ * @since 6.3.0
+ *
+ * @param array $site_ids List of site IDs.
+ */
+function wp_lazyload_site_meta( array $site_ids ) {
+    if ( empty( $site_ids ) ) {
+        return;
+    }
+    $lazyloader = wp_metadata_lazyloader();
+    $lazyloader->queue_objects( 'blog', $site_ids );
 }
 

trunk/src/wp-includes/user.php

@@ -1005 +1005 @@
     if ( ! empty( $site_ids ) ) {
         $args = array(
-            'number'                 => '',
-            'site__in'               => $site_ids,
-            'update_site_meta_cache' => false,
+            'number'   => '',
+            'site__in' => $site_ids,
         );
         if ( ! $all ) {

trunk/tests/phpunit/includes/abstract-testcase.php

@@ -282 +282 @@
         $lazyloader->reset_queue( 'term' );
         $lazyloader->reset_queue( 'comment' );
+        $lazyloader->reset_queue( 'blog' );
     }
 

trunk/tests/phpunit/tests/multisite/siteMeta.php

@@ -249 +249 @@
             $num_queries = get_num_queries();
             get_site_meta( self::$site_id, 'foo', true );
-            $this->assertSame( $num_queries, get_num_queries() );
+            $this->assertSame( 1, get_num_queries() - $num_queries );
+        }
+
+        /**
+         * @ticket 58185
+         */
+        public function test_lazy_load_site_meta() {
+            if ( ! is_site_meta_supported() ) {
+                $this->markTestSkipped( 'Test only runs with the blogmeta database table installed.' );
+            }
+
+            $filter = new MockAction();
+            add_filter( 'update_blog_metadata_cache', array( $filter, 'filter' ), 10, 2 );
+
+            $q = new WP_Site_Query(
+                array(
+                    'ID' => self::$site_id,
+                )
+            );
+
+            $this->assertSameSets( array( (string) self::$site_id ), wp_list_pluck( $q->sites, 'blog_id' ), 'Site query should return the first test site' );
+
+            $q = new WP_Site_Query(
+                array(
+                    'ID' => self::$site_id2,
+                )
+            );
+
+            $this->assertSameSets( array( (string) self::$site_id2 ), wp_list_pluck( $q->sites, 'blog_id' ), 'Site query should return the second test site' );
+
+            get_site_meta( self::$site_id2 );
+
+            $args     = $filter->get_args();
+            $first    = reset( $args );
+            $site_ids = end( $first );
+            $this->assertSameSets( $site_ids, array( self::$site_id, self::$site_id2 ), 'This should have two site\'s meta' );
+        }
+
+        /**
+         * @ticket 58185
+         */
+        public function test_lazy_load_site_meta_fields_id() {
+            if ( ! is_site_meta_supported() ) {
+                $this->markTestSkipped( 'Test only runs with the blogmeta database table installed.' );
+            }
+
+            $filter = new MockAction();
+            add_filter( 'update_blog_metadata_cache', array( $filter, 'filter' ), 10, 2 );
+
+            $q = new WP_Site_Query(
+                array(
+                    'ID'     => self::$site_id,
+                    'fields' => 'ids',
+                )
+            );
+
+            $this->assertSameSets( array( self::$site_id ), $q->sites, 'Site query should return the first test site' );
+
+            $q = new WP_Site_Query(
+                array(
+                    'ID'     => self::$site_id2,
+                    'fields' => 'ids',
+                )
+            );
+
+            $this->assertSameSets( array( self::$site_id2 ), $q->sites, 'Site query should return the second test site' );
+
+            get_site_meta( self::$site_id2 );
+
+            $args     = $filter->get_args();
+            $first    = reset( $args );
+            $site_ids = end( $first );
+            $this->assertSameSets( $site_ids, array( self::$site_id, self::$site_id2 ), 'This should have two sites meta' );
         }
 
@@ -268 +340 @@
             $num_queries = get_num_queries();
             get_site_meta( self::$site_id, 'foo', true );
-            $this->assertSame( $num_queries + 1, get_num_queries() );
+            $this->assertSame( 1, get_num_queries() - $num_queries );
         }