Changeset 13990

Timestamp:

07/27/2024 08:14:28 PM (2 years ago)

Author:

espellcaste

Message:

Core: Add cache_results flag to the BP_Invitation::get getter.

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

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

Location:

trunk

Files:

• src/bp-core/classes/class-bp-invitation.php (modified) (12 diffs)
• tests/phpunit/testcases/core/invitations.php (modified) (1 diff)

trunk/src/bp-core/classes/class-bp-invitation.php

@@ -358 +358 @@
          * Assemble the WHERE clause of a get() SQL statement.
          *
-         * Used by BP_Invitation::get() to create its WHERE
-         * clause.
-         *
          * @since 5.0.0
          *
@@ -439 +436 @@
 
                 // Type.
-                if ( ! empty( $args['type'] ) && 'all' !== $args['type'] ) {
-                        if ( 'invite' === $args['type'] || 'request' === $args['type'] ) {
-                                $type_clean               = $wpdb->prepare( '%s', $args['type'] );
-                                $where_conditions['type'] = "type = {$type_clean}";
-                        }
+                if ( ! empty( $args['type'] ) && ( 'invite' === $args['type'] || 'request' === $args['type'] ) ) {
+                        $type_clean               = $wpdb->prepare( '%s', $args['type'] );
+                        $where_conditions['type'] = "type = {$type_clean}";
                 }
 
@@ -689 +684 @@
          *
          * @since 5.0.0
+         * @since 15.0.0 Introduced the `cache_results` parameter.
          *
          * @global wpdb $wpdb WordPress database object.
@@ -730 +726 @@
          *     @type string       $order_by          Field to order results by.
          *     @type string       $sort_order        ASC or DESC.
+         *     @type bool         $cache_results     Optional. Whether to cache invitation information. Default true.
          *     @type int          $page              Number of the current page of results.
          *                                           Default: false (no pagination,
@@ -745 +742 @@
         public static function get( $args = array() ) {
                 global $wpdb;
+
                 $invites_table_name = BP_Invitation_Manager::get_table_name();
 
@@ -764 +762 @@
                                 'order_by'          => false,
                                 'sort_order'        => false,
+                                'cache_results'     => true,
                                 'page'              => false,
                                 'per_page'          => false,
@@ -772 +771 @@
 
                 $sql = array(
-                        'select'     => 'SELECT',
-                        'fields'     => '',
-                        'from'       => "FROM {$invites_table_name} i",
-                        'where'      => '',
-                        'orderby'    => '',
-                        'pagination' => '',
+                        'select' => 'SELECT',
+                        'from'   => "FROM {$invites_table_name} i",
+                        'fields' => 'DISTINCT i.id',
                 );
 
@@ -786 +782 @@
                 } elseif ( 'inviter_ids' === $r['fields'] ) {
                         $sql['fields'] = 'DISTINCT i.inviter_id';
-                } else {
-                        $sql['fields'] = 'DISTINCT i.id';
                 }
 
@@ -830 +824 @@
                  * @since 5.0.0
                  *
-                 * @param string $value Concatenated SQL statement.
-                 * @param array  $sql   Array of SQL parts before concatenation.
-                 * @param array  $r     Array of parsed arguments for the get method.
+                 * @param string $paged_invites_sql Concatenated SQL statement.
+                 * @param array  $sql               Array of SQL parts before concatenation.
+                 * @param array  $r                 Array of parsed arguments for the get method.
                  */
                 $paged_invites_sql = apply_filters( 'bp_invitations_get_paged_invitations_sql', $paged_invites_sql, $sql, $r );
 
-                $cached = bp_core_get_incremented_cache( $paged_invites_sql, 'bp_invitations' );
-                if ( false === $cached ) {
+                if ( $r['cache_results'] ) {
+                        $cached = bp_core_get_incremented_cache( $paged_invites_sql, 'bp_invitations' );
+                        if ( false === $cached ) {
+                                $paged_invite_ids = $wpdb->get_col( $paged_invites_sql );
+                                bp_core_set_incremented_cache( $paged_invites_sql, 'bp_invitations', $paged_invite_ids );
+                        } else {
+                                $paged_invite_ids = $cached;
+                        }
+                } else {
                         $paged_invite_ids = $wpdb->get_col( $paged_invites_sql );
-                        bp_core_set_incremented_cache( $paged_invites_sql, 'bp_invitations', $paged_invite_ids );
-                } else {
-                        $paged_invite_ids = $cached;
                 }
 
@@ -850 +848 @@
                 }
 
-                $uncached_ids = bp_get_non_cached_ids( $paged_invite_ids, 'bp_invitations' );
-                if ( $uncached_ids ) {
-                        $ids_sql      = implode( ',', array_map( 'intval', $uncached_ids ) );
-                        $data_objects = $wpdb->get_results( "SELECT i.* FROM {$invites_table_name} i WHERE i.id IN ({$ids_sql})" );
-                        foreach ( $data_objects as $data_object ) {
-                                wp_cache_set( $data_object->id, $data_object, 'bp_invitations' );
+                if ( $r['cache_results'] ) {
+                        $uncached_ids = bp_get_non_cached_ids( $paged_invite_ids, 'bp_invitations' );
+                        if ( $uncached_ids ) {
+                                $ids_sql      = implode( ',', array_map( 'intval', $uncached_ids ) );
+                                $data_objects = $wpdb->get_results( "SELECT i.* FROM {$invites_table_name} i WHERE i.id IN ({$ids_sql})" );
+                                foreach ( $data_objects as $data_object ) {
+                                        wp_cache_set( $data_object->id, $data_object, 'bp_invitations' );
+                                }
                         }
                 }
@@ -882 +882 @@
         public static function get_total_count( $args ) {
                 global $wpdb;
+
                 $invites_table_name = BP_Invitation_Manager::get_table_name();
 
@@ -914 +915 @@
 
                 // Return the queried results.
-                return $wpdb->get_var( $sql );
+                return (int) $wpdb->get_var( $sql );
         }
 

trunk/tests/phpunit/testcases/core/invitations.php

@@ -8 +8 @@
  */
  class BP_Tests_Invitations extends BP_UnitTestCase {
+
+         /**
+          * @ticket BP8552
+          * @group cache
+          */
+         public function test_invitation_query_with_ids_cache_results() {
+                 global $wpdb;
+
+                 $u1 = self::factory()->user->create();
+                 $u2 = self::factory()->user->create();
+                 $u3 = self::factory()->user->create();
+
+                 $invites_class = new BPTest_Invitation_Manager_Extension();
+
+                 // Create a couple of invitations.
+                 $invite_args = array(
+                         'user_id'           => $u3,
+                         'inviter_id'           => $u1,
+                         'item_id'           => 1,
+                         'send_invite'       => 'sent',
+                 );
+
+                 $invites_class->add_invitation( $invite_args );
+
+                 $invite_args['inviter_id'] = $u2;
+
+                 $invites_class->add_invitation( $invite_args );
+
+                 $wpdb->num_queries = 0;
+
+                 $first_query = BP_Invitation::get(
+                         array(
+                                 'cache_results' => true,
+                                 'fields'        => 'ids',
+                         )
+                 );
+
+                 $queries_before = get_num_queries();
+
+                 $second_query = BP_Invitation::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( 2, $queries_after, 'Assert that the uncached query was run' );
+                 $this->assertSameSets( $first_query, $second_query, 'Results of the query are expected to match.' );
+         }
+
+         /**
+          * @ticket BP8552
+          * @group cache
+          */
+         public function test_invitation_query_with_all_cache_results() {
+                 global $wpdb;
+
+                 $u1 = self::factory()->user->create();
+                 $u2 = self::factory()->user->create();
+                 $u3 = self::factory()->user->create();
+
+                 $invites_class = new BPTest_Invitation_Manager_Extension();
+
+                 // Create a couple of invitations.
+                 $invite_args = array(
+                         'user_id'     => $u3,
+                         'inviter_id'  => $u1,
+                         'item_id'     => 1,
+                         'send_invite' => 'sent',
+                 );
+
+                 $invites_class->add_invitation( $invite_args );
+
+                 $invite_args['inviter_id'] = $u2;
+
+                 $invites_class->add_invitation( $invite_args );
+
+                 $wpdb->num_queries = 0;
+
+                 $first_query = BP_Invitation::get(
+                         array( 'cache_results' => true )
+                 );
+
+                 $queries_before = get_num_queries();
+
+                 $second_query = BP_Invitation::get(
+                         array( 'cache_results' => false )
+                 );
+
+                 $queries_after = get_num_queries();
+
+                 $this->assertNotSame( $queries_before, $queries_after, 'Assert that queries are run' );
+                 $this->assertSame( 3, $queries_after, 'Assert that the uncached query was run' );
+                 $this->assertEquals( $first_query, $second_query, 'Results of the query are expected to match.' );
+         }
+
         public function test_bp_invitations_add_invitation_vanilla() {
                 $old_current_user = get_current_user_id();