Changeset 13987

Timestamp:

07/27/2024 07:31:15 PM (2 years ago)

Author:

espellcaste

Message:

Groups: Add cache_results flag to the BP_Groups_Group::get getter.

When performing a request with cache_results, it stops the group information retrieved from being added to the cache.

See #8552
Closes ​https://github.com/buddypress/buddypress/pull/342/

Location:

trunk

Files:

• src/bp-groups/classes/class-bp-groups-group.php (modified) (9 diffs)
• tests/phpunit/testcases/groups/cache.php (modified) (1 diff)

trunk/src/bp-groups/classes/class-bp-groups-group.php

@@ -1058 +1058 @@
          *                                            See {@link WP_Meta_Query::queries} for description.
          *     @type array        $date_query         Optional. Filter results by group last activity date. See first
-         *                                            paramter of {@link WP_Date_Query::__construct()} for syntax. Only
+         *                                            parameter of {@link WP_Date_Query::__construct()} for syntax. Only
          *                                            applicable if $type is either 'newest' or 'active'.
          *     @type array|string $value              Optional. Array or comma-separated list of group IDs. Results
@@ -1066 +1066 @@
          *     @type array|string $exclude            Optional. Array or comma-separated list of group IDs.
          *                                            Results will exclude the listed groups. Default: false.
-         *     @type bool         $update_meta_cache  Whether to pre-fetch groupmeta for the returned groups.
+         *     @type bool         $cache_results      Optional. Whether to cache group information. Default true.
+         *     @type bool         $update_meta_cache  Optional. Whether to pre-fetch groupmeta for the returned groups.
          *                                            Default: true.
-         *     @type bool         $update_admin_cache Whether to pre-fetch administrator IDs for the returned
+         *     @type bool         $update_admin_cache Optional. Whether to pre-fetch administrator IDs for the returned
          *                                            groups. Default: false.
          *     @type bool         $show_hidden        Whether to include hidden groups in results. Default: false.
@@ -1135 +1136 @@
                         'include'            => false,
                         'parent_id'          => null,
+                        'cache_results'      => true,
                         'update_meta_cache'  => true,
                         'update_admin_cache' => false,
@@ -1374 +1376 @@
                 $paged_groups_sql = apply_filters( 'bp_groups_get_paged_groups_sql', $paged_groups_sql, $sql, $r );
 
-                $cached = bp_core_get_incremented_cache( $paged_groups_sql, 'bp_groups' );
-                if ( false === $cached ) {
+                /*
+                 * Ensure the database query is able to be cached.
+                 *
+                 * Random queries are expected to have unpredictable results.
+                 */
+                $query_is_cacheable = 'rand()' !== $orderby;
+
+                if ( $r['cache_results'] && $query_is_cacheable ) {
+                        $cached = bp_core_get_incremented_cache( $paged_groups_sql, 'bp_groups' );
+                        if ( false === $cached ) {
+                                $paged_group_ids = $wpdb->get_col( $paged_groups_sql );
+                                bp_core_set_incremented_cache( $paged_groups_sql, 'bp_groups', $paged_group_ids );
+                        } else {
+                                $paged_group_ids = $cached;
+                        }
+                } else {
                         $paged_group_ids = $wpdb->get_col( $paged_groups_sql );
-                        bp_core_set_incremented_cache( $paged_groups_sql, 'bp_groups', $paged_group_ids );
-                } else {
-                        $paged_group_ids = $cached;
                 }
 
@@ -1386 +1399 @@
                         $paged_groups = array_map( 'intval', $paged_group_ids );
                 } else {
-                        $uncached_group_ids = bp_get_non_cached_ids( $paged_group_ids, 'bp_groups' );
-                        if ( $uncached_group_ids ) {
-                                $group_ids_sql = implode( ',', array_map( 'intval', $uncached_group_ids ) );
-                                $group_data_objects = $wpdb->get_results( "SELECT g.* FROM {$bp->groups->table_name} g WHERE g.id IN ({$group_ids_sql})" );
-                                foreach ( $group_data_objects as $group_data_object ) {
-                                        wp_cache_set( $group_data_object->id, $group_data_object, 'bp_groups' );
+                        if ( $r['cache_results'] && $query_is_cacheable ) {
+                                $uncached_group_ids = bp_get_non_cached_ids( $paged_group_ids, 'bp_groups' );
+                                if ( $uncached_group_ids ) {
+                                        $group_ids_sql      = implode( ',', array_map( 'intval', $uncached_group_ids ) );
+                                        $group_data_objects = $wpdb->get_results( "SELECT g.* FROM {$bp->groups->table_name} g WHERE g.id IN ({$group_ids_sql})" );
+                                        foreach ( $group_data_objects as $group_data_object ) {
+                                                wp_cache_set( $group_data_object->id, $group_data_object, 'bp_groups' );
+                                        }
                                 }
                         }
@@ -1401 +1416 @@
 
                         $group_ids = array();
-                        foreach ( (array) $paged_groups as $group ) {
+                        foreach ( $paged_groups as $group ) {
                                 $group_ids[] = $group->id;
                         }
 
                         // Grab all groupmeta.
-                        if ( ! empty( $r['update_meta_cache'] ) ) {
+                        if ( $r['update_meta_cache'] ) {
                                 bp_groups_update_meta_cache( $group_ids );
                         }
@@ -1416 +1431 @@
 
                         // Set up integer properties needing casting.
-                        $int_props = array(
-                                'id', 'creator_id', 'enable_forum'
-                        );
+                        $int_props = array( 'id', 'creator_id', 'enable_forum' );
 
                         // Integer casting.
@@ -1426 +1439 @@
                                 }
                         }
-
                 }
 
@@ -1443 +1455 @@
                 $total_groups_sql = apply_filters( 'bp_groups_get_total_groups_sql', $total_groups_sql, $sql, $r );
 
-                $cached = bp_core_get_incremented_cache( $total_groups_sql, 'bp_groups' );
-                if ( false === $cached ) {
+                if ( $r['cache_results'] && $query_is_cacheable ) {
+                        $cached = bp_core_get_incremented_cache( $total_groups_sql, 'bp_groups' );
+                        if ( false === $cached ) {
+                                $total_groups = (int) $wpdb->get_var( $total_groups_sql );
+                                bp_core_set_incremented_cache( $total_groups_sql, 'bp_groups', $total_groups );
+                        } else {
+                                $total_groups = (int) $cached;
+                        }
+                } else {
                         $total_groups = (int) $wpdb->get_var( $total_groups_sql );
-                        bp_core_set_incremented_cache( $total_groups_sql, 'bp_groups', $total_groups );
-                } else {
-                        $total_groups = (int) $cached;
-                }
-
-                return array( 'groups' => $paged_groups, 'total' => $total_groups );
+                }
+
+                return array(
+                        'groups' => $paged_groups,
+                        'total'  => $total_groups,
+                );
         }
 

trunk/tests/phpunit/testcases/groups/cache.php

@@ -6 +6 @@
  */
 class BP_Tests_Group_Cache extends BP_UnitTestCase {
+
+        /**
+         * @ticket BP8552
+         */
+        public function test_query_cache_results() {
+                global $wpdb;
+
+                self::factory()->group->create_many( 2 );
+
+                // Reset.
+                $wpdb->num_queries = 0;
+
+                $first_query = BP_Groups_Group::get(
+                        array(
+                                'cache_results' => true,
+                                'fields'        => 'ids',
+                        )
+                );
+
+                $queries_before = get_num_queries();
+
+                $second_query = BP_Groups_Group::get(
+                        array(
+                                'cache_results' => false,
+                                'fields'        => 'ids',
+                        )
+                );
+
+                $queries_after = get_num_queries();
+
+                $this->assertNotSame( $queries_before, $queries_after, 'Assert that queries are run' );
+                $this->assertSame( 4, $queries_after, 'Assert that the uncached query was run' );
+                $this->assertSameSets( $first_query['groups'], $second_query['groups'], 'Results of the query are expected to match.' );
+        }
+
+        /**
+         * @ticket BP8552
+         */
+        public function test_random_query_cache_results() {
+                global $wpdb;
+
+                self::factory()->group->create_many( 2 );
+
+                // Reset.
+                $wpdb->num_queries = 0;
+
+                $args = array(
+                        'orderby' => 'random',
+                        'fields'  => 'ids',
+                );
+
+                BP_Groups_Group::get( $args );
+                BP_Groups_Group::get( $args );
+
+                $this->assertSame( 4, get_num_queries(), 'Assert random group queries are not cached.' );
+        }
 
         /**