Changeset 8027 for trunk/tests/testcases/members/functions.php

Timestamp:

03/03/2014 09:35:48 PM (11 years ago)

Author:

boonebgorges

Message:

Introduce bp_core_user_displaynames(), for quick, bulk displayname lookup

The technique BP uses for determining a user's displayname takes into
consideration whether the xprofile component is active, whether the user has a
WP display_name, and a number of other factors. Because the values are used so
often throughout BP, they are then cached in WP's object cache. However, there
are a number of places throughout BuddyPress where displaynames are fetched
in a way that is inconsistent with the "canonical" workflow (ie, by querying
the xprofile tables correctly). This causes inconsistent results, and also can
result in performance degradation when the persistent cache is skipped.
Moreover, the singular nature of bp_core_get_user_displayname() meant that
doing it the "right" way meant introducing large numbers of queries to a given
page load.

This changeset introduces bp_core_get_user_displaynames(), which contains all
the critical logic of bp_core_get_user_displayname() - including fallbacks for
various setups and support for the object cache - but allows for fetching large
numbers of displaynames without multiple queries. bp_core_get_user_displayname()
is now a wrapper for the more general function.

The function has been swapped in throughout BuddyPress as appropriate.

See #5445

File:

• trunk/tests/testcases/members/functions.php (modified) (1 diff)

trunk/tests/testcases/members/functions.php

@@ -210 +210 @@
         }
     }
+
+    /**
+     * @group bp_core_get_user_displaynames
+     */
+    public function test_bp_core_get_user_displayname_arrays_all_bad_entries() {
+        $this->assertSame( array(), bp_core_get_user_displaynames( array( 0, 'foo', ) ) );
+    }
+
+    /**
+     * @group bp_core_get_user_displaynames
+     */
+    public function test_bp_core_get_user_displaynames_all_uncached() {
+        $u1 = $this->create_user();
+        $u2 = $this->create_user();
+
+        xprofile_set_field_data( 1, $u1, 'Foo' );
+        xprofile_set_field_data( 1, $u2, 'Bar' );
+
+        $expected = array(
+            $u1 => 'Foo',
+            $u2 => 'Bar',
+        );
+
+        $this->assertSame( $expected, bp_core_get_user_displaynames( array( $u1, $u2, ) ) );
+    }
+
+    /**
+     * @group bp_core_get_user_displaynames
+     */
+    public function test_bp_core_get_user_displaynames_one_not_in_xprofile() {
+        $u1 = $this->create_user();
+        $u2 = $this->create_user( array(
+            'display_name' => 'Bar',
+        ) );
+
+        xprofile_set_field_data( 1, $u1, 'Foo' );
+
+        // Delete directly because BP won't let you delete a required
+        // field through the API
+        global $wpdb, $bp;
+        $wpdb->query( $wpdb->prepare( "DELETE FROM {$bp->profile->table_name_data} WHERE user_id = %d AND field_id = 1", $u2 ) );
+        wp_cache_delete( 'bp_user_fullname_' . $u2, 'bp' );
+        wp_cache_delete( 1, 'bp_xprofile_data_' . $u2, 'bp' );
+
+        $expected = array(
+            $u1 => 'Foo',
+            $u2 => 'Bar',
+        );
+
+        $this->assertSame( $expected, bp_core_get_user_displaynames( array( $u1, $u2, ) ) );
+    }
+
+    /**
+     * @group bp_core_get_user_displaynames
+     */
+    public function test_bp_core_get_user_displaynames_one_in_cache() {
+        $u1 = $this->create_user();
+        xprofile_set_field_data( 1, $u1, 'Foo' );
+
+        // Fake the cache for $u2
+        $u2 = 123;
+        wp_cache_set( 'bp_user_fullname_' . $u2, 'Bar', 'bp' );
+
+        $expected = array(
+            $u1 => 'Foo',
+            $u2 => 'Bar',
+        );
+
+        $this->assertSame( $expected, bp_core_get_user_displaynames( array( $u1, $u2, ) ) );
+    }
 }