Changeset 7808

Timestamp:

02/06/2014 02:23:51 AM (11 years ago)

Author:

boonebgorges

Message:

Refactor BP_XProfile_ProfileData::get_all_for_user() for performance

Method has been refactored to avoid joins, especially against global tables.
Direct SQL queries have been removed in favor of using existing query methods,
which has the added benefit of allowing existing caching strategies to be
inherited automatically from those methods.

Adds 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

@@ -1279 +1279 @@
 
     /**
-     * BP_XProfile_ProfileData::get_all_for_user()
-     *
      * Get all of the profile information for a specific user.
+     *
+     * @param int $user_id ID of the user.
+     * @return array
      */
     public static function get_all_for_user( $user_id ) {
         global $wpdb, $bp;
 
-        $results      = $wpdb->get_results( $wpdb->prepare( "SELECT g.id as field_group_id, g.name as field_group_name, f.id as field_id, f.name as field_name, f.type as field_type, d.value as field_data, u.user_login, u.user_nicename, u.user_email FROM {$bp->profile->table_name_groups} g LEFT JOIN {$bp->profile->table_name_fields} f ON g.id = f.group_id INNER JOIN {$bp->profile->table_name_data} d ON f.id = d.field_id LEFT JOIN {$wpdb->users} u ON d.user_id = u.ID WHERE d.user_id = %d AND d.value != ''", $user_id ) );
+        $groups = BP_XProfile_Group::get( array(
+            'user_id'                => $user_id,
+            'hide_empty_groups'      => true,
+            'hide_empty_fields'      => true,
+            'fetch_fields'           => true,
+            'fetch_field_data'       => true,
+        ) );
+
         $profile_data = array();
 
-        if ( !empty( $results ) ) {
-            $profile_data['user_login']    = $results[0]->user_login;
-            $profile_data['user_nicename'] = $results[0]->user_nicename;
-            $profile_data['user_email']    = $results[0]->user_email;
-
-            foreach( (array) $results as $field ) {
-                $profile_data[$field->field_name] = array(
-                    'field_group_id'   => $field->field_group_id,
-                    'field_group_name' => $field->field_group_name,
-                    'field_id'         => $field->field_id,
-                    'field_type'       => $field->field_type,
-                    'field_data'       => $field->field_data
-                );
+        if ( ! empty( $groups ) ) {
+            $user = new WP_User( $user_id );
+
+            $profile_data['user_login']    = $user->user_login;
+            $profile_data['user_nicename'] = $user->user_nicename;
+            $profile_data['user_email']    = $user->user_email;
+
+            foreach ( (array) $groups as $group ) {
+                if ( empty( $group->fields ) ) {
+                    continue;
+                }
+
+                foreach ( (array) $group->fields as $field ) {
+                    $profile_data[ $field->name ] = array(
+                        'field_group_id'   => $group->id,
+                        'field_group_name' => $group->name,
+                        'field_id'         => $field->id,
+                        'field_type'       => $field->type,
+                        'field_data'       => $field->data->value,
+                    );
+                }
             }
         }

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

@@ -264 +264 @@
     }
 
+    /**
+     * @group get_all_for_user
+     */
+    public function test_get_all_for_user_uncached() {
+        $u = $this->create_user();
+        $g1 = $this->factory->xprofile_group->create();
+        $g2 = $this->factory->xprofile_group->create();
+        $f1 = $this->factory->xprofile_field->create( array(
+            'type' => 'textbox',
+            'field_group_id' => $g1->id,
+        ) );
+        $f2 = $this->factory->xprofile_field->create( array(
+            'type' => 'radio',
+            'field_group_id' => $g2->id,
+        ) );
+
+        $time = bp_core_current_time();
+
+        // Get the fullname field - hackish
+        $f0_id = xprofile_get_field_id_from_name( bp_xprofile_fullname_field_name() );
+        $f0 = new BP_XProfile_Field( $f0_id );
+        $g0 = new BP_XProfile_Group( $f0->group_id );
+        $d0 = new BP_XProfile_ProfileData( $f0->id, $u );
+
+        $d1 = new BP_XProfile_ProfileData();
+        $d1->user_id = $u;
+        $d1->field_id = $f1->id;
+        $d1->value = 'foo';
+        $d1->last_updated = $time;
+        $d1->save();
+
+        $d2 = new BP_XProfile_ProfileData();
+        $d2->user_id = $u;
+        $d2->field_id = $f2->id;
+        $d2->value = 'bar';
+        $d2->last_updated = $time;
+        $d2->save();
+
+        // Ensure it's deleted from cache
+        wp_cache_delete( $f1->id, 'bp_xprofile_data_' . $u );
+        wp_cache_delete( $f2->id, 'bp_xprofile_data_' . $u );
+
+        $u_obj = new WP_User( $u );
+
+        $expected = array(
+            'user_login' => $u_obj->user_login,
+            'user_nicename' => $u_obj->user_nicename,
+            'user_email' => $u_obj->user_email,
+            $f0->name => array(
+                'field_group_id' => $g0->id,
+                'field_group_name' => $g0->name,
+                'field_id' => $f0->id,
+                'field_type' => $f0->type,
+                'field_data' => $d0->value,
+            ),
+            $f1->name => array(
+                'field_group_id' => $g1->id,
+                'field_group_name' => $g1->name,
+                'field_id' => $f1->id,
+                'field_type' => $f1->type,
+                'field_data' => $d1->value,
+            ),
+            $f2->name => array(
+                'field_group_id' => $g2->id,
+                'field_group_name' => $g2->name,
+                'field_id' => $f2->id,
+                'field_type' => $f2->type,
+                'field_data' => $d2->value,
+            ),
+        );
+
+        $this->assertEquals( $expected, BP_XProfile_ProfileData::get_all_for_user( $u ) );
+    }
+
+    /**
+     * @group get_all_for_user
+     */
+    public function test_get_all_for_user_cached() {
+        $u = $this->create_user();
+        $g1 = $this->factory->xprofile_group->create();
+        $g2 = $this->factory->xprofile_group->create();
+        $f1 = $this->factory->xprofile_field->create( array(
+            'type' => 'textbox',
+            'field_group_id' => $g1->id,
+        ) );
+        $f2 = $this->factory->xprofile_field->create( array(
+            'type' => 'radio',
+            'field_group_id' => $g2->id,
+        ) );
+
+        $time = bp_core_current_time();
+
+        $g0 = new BP_XProfile_Group( 1 );
+        $f0 = new BP_XProfile_Field( 1 );
+        $d0 = new BP_XProfile_ProfileData( 1, $u );
+
+        $d1 = new stdClass;
+        $d1->user_id = $u;
+        $d1->field_id = $f1->id;
+        $d1->value = 'foo';
+        $d1->last_updated = $time;
+
+        $d2 = new stdClass;
+        $d2->user_id = $u;
+        $d2->field_id = $f2->id;
+        $d2->value = 'bar';
+        $d2->last_updated = $time;
+
+        wp_cache_set( $f1->id, $d1, 'bp_xprofile_data_' . $u );
+        wp_cache_set( $f2->id, $d2, 'bp_xprofile_data_' . $u );
+
+        $u_obj = new WP_User( $u );
+
+        $expected = array(
+            'user_login' => $u_obj->user_login,
+            'user_nicename' => $u_obj->user_nicename,
+            'user_email' => $u_obj->user_email,
+            $f0->name => array(
+                'field_group_id' => $g0->id,
+                'field_group_name' => $g0->name,
+                'field_id' => $f0->id,
+                'field_type' => $f0->type,
+                'field_data' => $d0->value,
+            ),
+            $f1->name => array(
+                'field_group_id' => $g1->id,
+                'field_group_name' => $g1->name,
+                'field_id' => $f1->id,
+                'field_type' => $f1->type,
+                'field_data' => $d1->value,
+            ),
+            $f2->name => array(
+                'field_group_id' => $g2->id,
+                'field_group_name' => $g2->name,
+                'field_id' => $f2->id,
+                'field_type' => $f2->type,
+                'field_data' => $d2->value,
+            ),
+        );
+
+        $this->assertEquals( $expected, BP_XProfile_ProfileData::get_all_for_user( $u ) );
+    }
+
 }