Changeset 7806

Timestamp:

02/06/2014 01:39:48 AM (11 years ago)

Author:

boonebgorges

Message:

Implement persistent caching in BP_XProfile_ProfileData::get_value_byid()

This change should mean significant performance improvements, as the method
is used a number of places throughout BuddyPress:

• bp_get_the_profile_field_options() (to check/select the saved values)
• xprofile_get_field_data()
• when swapping out blog commenter names with BP display names

Introduces unit tests for the method.

See #1332

Location:

trunk

Files:

• bp-xprofile/bp-xprofile-classes.php (modified) (1 diff)
• tests/testcases/xprofile/class-bp-xprofile-profiledata.php (modified) (1 diff)

trunk/bp-xprofile/bp-xprofile-classes.php

@@ -1334 +1334 @@
     }
 
+    /**
+     * Get profile field values by field ID and user IDs.
+     *
+     * Supports multiple user IDs.
+     *
+     * @param int $field_id ID of the field.
+     * @param int|array $user_ids ID or IDs of user(s).
+     * @return string|array Single value if a single user is queried,
+     *         otherwise an array of results.
+     */
     public static function get_value_byid( $field_id, $user_ids = null ) {
         global $wpdb, $bp;
 
-        if ( empty( $user_ids ) )
+        if ( empty( $user_ids ) ) {
             $user_ids = bp_displayed_user_id();
-
-        if ( is_array( $user_ids ) ) {
-            $user_ids = implode( ',', wp_parse_id_list( $user_ids ) );
-            $data = $wpdb->get_results( $wpdb->prepare( "SELECT user_id, value FROM {$bp->profile->table_name_data} WHERE field_id = %d AND user_id IN ({$user_ids})", $field_id ) );
-        } else {
-            $data = $wpdb->get_var( $wpdb->prepare( "SELECT value FROM {$bp->profile->table_name_data} WHERE field_id = %d AND user_id = %d", $field_id, $user_ids ) );
-        }
-
-        return $data;
+        }
+
+        $is_single = false;
+        if ( ! is_array( $user_ids ) ) {
+            $user_ids  = array( $user_ids );
+            $is_single = true;
+        }
+
+        // Assemble uncached IDs
+        $uncached_ids = array();
+        foreach ( $user_ids as $user_id ) {
+            if ( false === wp_cache_get( $field_id, 'bp_xprofile_data_' . $user_id ) ) {
+                $uncached_ids[] = $user_id;
+            }
+        }
+
+        // Prime caches
+        if ( ! empty( $uncached_ids ) ) {
+            $uncached_ids_sql = implode( ',', $uncached_ids );
+            $queried_data = $wpdb->get_results( $wpdb->prepare( "SELECT id, user_id, field_id, value, last_updated FROM {$bp->profile->table_name_data} WHERE field_id = %d AND user_id IN ({$uncached_ids_sql})", $field_id ) );
+
+            foreach ( $queried_data as $d ) {
+                wp_cache_set( $field_id, $d, 'bp_xprofile_data_' . $d->user_id );
+            }
+        }
+
+        // Now that the cache is primed with all data, fetch it
+        $data = array();
+        foreach ( $user_ids as $user_id ) {
+            $data[] = wp_cache_get( $field_id, 'bp_xprofile_data_' . $user_id );
+        }
+
+        // If a single ID was passed, just return the value
+        if ( $is_single ) {
+            return $data[0]->value;
+
+        // Otherwise return the whole array
+        } else {
+            return $data;
+        }
     }
 

trunk/tests/testcases/xprofile/class-bp-xprofile-profiledata.php

@@ -118 +118 @@
         $this->assertSame( 5, BP_XProfile_ProfileData::get_fielddataid_byid( $f->id, $u ) );
     }
+
+    /**
+     * @group get_value_byid
+     */
+    public function test_get_value_byid_singleuser_uncached() {
+        $u = $this->create_user();
+        $g = $this->factory->xprofile_group->create();
+        $f = $this->factory->xprofile_field->create( array(
+            'type' => 'textbox',
+            'field_group_id' => $g->id,
+        ) );
+
+        $d = new BP_XProfile_ProfileData();
+        $d->user_id = $u;
+        $d->field_id = $f->id;
+        $d->value = 'foo';
+        $d->save();
+
+        // Ensure it's deleted from cache
+        wp_cache_delete( $f->id, 'bp_xprofile_data_' . $u );
+
+        $this->assertSame( 'foo', BP_XProfile_ProfileData::get_value_byid( $f->id, $u ) );
+    }
+
+    /**
+     * @group get_value_byid
+     */
+    public function test_get_value_byid_multipleusers_uncached() {
+        $u1 = $this->create_user();
+        $u2 = $this->create_user();
+        $g = $this->factory->xprofile_group->create();
+        $f = $this->factory->xprofile_field->create( array(
+            'type' => 'textbox',
+            'field_group_id' => $g->id,
+        ) );
+
+        $time = bp_core_current_time();
+
+        $d1 = new BP_XProfile_ProfileData();
+        $d1->user_id = $u1;
+        $d1->field_id = $f->id;
+        $d1->value = 'foo';
+        $d1->last_updated = $time;
+        $d1->save();
+
+        $d2 = new BP_XProfile_ProfileData();
+        $d2->user_id = $u2;
+        $d2->field_id = $f->id;
+        $d2->value = 'bar';
+        $d2->last_updated = $time;
+        $d2->save();
+
+        // Ensure it's deleted from cache
+        wp_cache_delete( $f->id, 'bp_xprofile_data_' . $u1 );
+        wp_cache_delete( $f->id, 'bp_xprofile_data_' . $u2 );
+
+        $eu1 = new stdClass;
+        $eu1->user_id = $u1;
+        $eu1->value = 'foo';
+        $eu1->id = $d1->id;
+        $eu1->field_id = $f->id;
+        $eu1->last_updated = $time;
+
+        $eu2 = new stdClass;
+        $eu2->user_id = $u2;
+        $eu2->value = 'bar';
+        $eu2->id = $d2->id;
+        $eu2->field_id = $f->id;
+        $eu2->last_updated = $time;
+
+        $expected = array( $eu1, $eu2 );
+
+        $this->assertEquals( $expected, BP_XProfile_ProfileData::get_value_byid( $f->id, array( $u1, $u2 ) ) );
+    }
+
+    /**
+     * @group get_value_byid
+     */
+    public function test_get_value_byid_singleuser_cached() {
+        $u = $this->create_user();
+        $g = $this->factory->xprofile_group->create();
+        $f = $this->factory->xprofile_field->create( array(
+            'type' => 'textbox',
+            'field_group_id' => $g->id,
+        ) );
+
+        $time = bp_core_current_time();
+
+        // Fake the cache
+        $d = new stdClass;
+        $d->value = 'foo';
+        $d->field_id = $f->id;
+        wp_cache_set( $f->id, $d, 'bp_xprofile_data_' . $u );
+
+        $this->assertSame( 'foo', BP_XProfile_ProfileData::get_value_byid( $f->id, $u ) );
+    }
+
+    /**
+     * @group get_value_byid
+     */
+    public function test_get_value_byid_multipleusers_cached() {
+        $u1 = $this->create_user();
+        $u2 = $this->create_user();
+        $g = $this->factory->xprofile_group->create();
+        $f = $this->factory->xprofile_field->create( array(
+            'type' => 'textbox',
+            'field_group_id' => $g->id,
+        ) );
+
+        // Fake the cache
+        $d1 = new stdClass;
+        $d1->id = 10;
+        $d1->user_id = $u1;
+        $d1->field_id = $f->id;
+        $d1->value = 'foo';
+        $d1->last_updated = $time;
+
+        $d2 = new stdClass;
+        $d1->id = 21;
+        $d2->user_id = $u2;
+        $d2->field_id = $f->id;
+        $d2->value = 'bar';
+        $d2->last_updated = $time;
+
+        wp_cache_set( $f->id, $d1, 'bp_xprofile_data_' . $u1 );
+        wp_cache_set( $f->id, $d2, 'bp_xprofile_data_' . $u2 );
+
+        $eu1 = new stdClass;
+        $eu1->id = 10;
+        $eu1->user_id = $u1;
+        $eu1->field_id = $f->id;
+        $eu1->value = 'foo';
+        $eu1->last_updated = $time;
+
+        $eu2 = new stdClass;
+        $eu1->id = 21;
+        $eu2->user_id = $u2;
+        $eu2->field_id = $f->id;
+        $eu2->value = 'bar';
+        $eu2->last_updated = $time;
+
+        $expected = array( $eu1, $eu2 );
+
+        $this->assertEquals( $expected, BP_XProfile_ProfileData::get_value_byid( $f->id, array( $u1, $u2 ) ) );
+    }
+
 }