<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[BuddyPress][13987] trunk: Groups: Add `cache_results` flag to the `BP_Groups_Group::get` getter.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { white-space: pre-line; overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="http://buddypress.trac.wordpress.org/changeset/13987">13987</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"http://buddypress.trac.wordpress.org/changeset/13987","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>espellcaste</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2024-07-27 19:31:15 +0000 (Sat, 27 Jul 2024)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>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 <a href="http://buddypress.trac.wordpress.org/ticket/8552">#8552</a>
Closes https://github.com/buddypress/buddypress/pull/342/</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcbpgroupsclassesclassbpgroupsgroupphp">trunk/src/bp-groups/classes/class-bp-groups-group.php</a></li>
<li><a href="#trunktestsphpunittestcasesgroupscachephp">trunk/tests/phpunit/testcases/groups/cache.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcbpgroupsclassesclassbpgroupsgroupphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/bp-groups/classes/class-bp-groups-group.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-groups/classes/class-bp-groups-group.php 2024-07-27 19:16:17 UTC (rev 13986)
+++ trunk/src/bp-groups/classes/class-bp-groups-group.php 2024-07-27 19:31:15 UTC (rev 13987)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1057,7 +1057,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @type array $meta_query Optional. An array of meta_query conditions.
</span><span class="cx" style="display: block; padding: 0 10px"> * See {@link WP_Meta_Query::queries} for description.
</span><span class="cx" style="display: block; padding: 0 10px"> * @type array $date_query Optional. Filter results by group last activity date. See first
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * paramter of {@link WP_Date_Query::__construct()} for syntax. Only
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * parameter of {@link WP_Date_Query::__construct()} for syntax. Only
</ins><span class="cx" style="display: block; padding: 0 10px"> * applicable if $type is either 'newest' or 'active'.
</span><span class="cx" style="display: block; padding: 0 10px"> * @type array|string $value Optional. Array or comma-separated list of group IDs. Results
</span><span class="cx" style="display: block; padding: 0 10px"> * will be limited to groups within the list. Default: false.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1065,9 +1065,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * will be limited to children of the specified groups. Default: null.
</span><span class="cx" style="display: block; padding: 0 10px"> * @type array|string $exclude Optional. Array or comma-separated list of group IDs.
</span><span class="cx" style="display: block; padding: 0 10px"> * Results will exclude the listed groups. Default: false.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @type bool $update_meta_cache Whether to pre-fetch groupmeta for the returned groups.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @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.
</ins><span class="cx" style="display: block; padding: 0 10px"> * Default: true.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @type bool $update_admin_cache Whether to pre-fetch administrator IDs for the returned
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @type bool $update_admin_cache Optional. Whether to pre-fetch administrator IDs for the returned
</ins><span class="cx" style="display: block; padding: 0 10px"> * groups. Default: false.
</span><span class="cx" style="display: block; padding: 0 10px"> * @type bool $show_hidden Whether to include hidden groups in results. Default: false.
</span><span class="cx" style="display: block; padding: 0 10px"> * @type array|string $status Optional. Array or comma-separated list of group statuses to limit
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1134,6 +1135,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'date_query' => false,
</span><span class="cx" style="display: block; padding: 0 10px"> 'include' => false,
</span><span class="cx" style="display: block; padding: 0 10px"> 'parent_id' => null,
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'cache_results' => true,
</ins><span class="cx" style="display: block; padding: 0 10px"> 'update_meta_cache' => true,
</span><span class="cx" style="display: block; padding: 0 10px"> 'update_admin_cache' => false,
</span><span class="cx" style="display: block; padding: 0 10px"> 'exclude' => false,
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1373,12 +1375,23 @@
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> $paged_groups_sql = apply_filters( 'bp_groups_get_paged_groups_sql', $paged_groups_sql, $sql, $r );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $cached = bp_core_get_incremented_cache( $paged_groups_sql, 'bp_groups' );
- if ( false === $cached ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /*
+ * 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 {
</ins><span class="cx" style="display: block; padding: 0 10px"> $paged_group_ids = $wpdb->get_col( $paged_groups_sql );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- bp_core_set_incremented_cache( $paged_groups_sql, 'bp_groups', $paged_group_ids );
- } else {
- $paged_group_ids = $cached;
</del><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( 'ids' === $r['fields'] ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1385,12 +1398,14 @@
</span><span class="cx" style="display: block; padding: 0 10px"> // We only want the IDs.
</span><span class="cx" style="display: block; padding: 0 10px"> $paged_groups = array_map( 'intval', $paged_group_ids );
</span><span class="cx" style="display: block; padding: 0 10px"> } else {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $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' );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 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' );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1400,12 +1415,12 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $group_ids = array();
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- foreach ( (array) $paged_groups as $group ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ foreach ( $paged_groups as $group ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> $group_ids[] = $group->id;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Grab all groupmeta.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( ! empty( $r['update_meta_cache'] ) ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( $r['update_meta_cache'] ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> bp_groups_update_meta_cache( $group_ids );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1415,9 +1430,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Set up integer properties needing casting.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $int_props = array(
- 'id', 'creator_id', 'enable_forum'
- );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $int_props = array( 'id', 'creator_id', 'enable_forum' );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Integer casting.
</span><span class="cx" style="display: block; padding: 0 10px"> foreach ( $paged_groups as $key => $g ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1425,7 +1438,6 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $paged_groups[ $key ]->{$int_prop} = (int) $paged_groups[ $key ]->{$int_prop};
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-
</del><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Find the total number of groups in the results set.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1442,15 +1454,22 @@
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> $total_groups_sql = apply_filters( 'bp_groups_get_total_groups_sql', $total_groups_sql, $sql, $r );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $cached = bp_core_get_incremented_cache( $total_groups_sql, 'bp_groups' );
- if ( false === $cached ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 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 {
</ins><span class="cx" style="display: block; padding: 0 10px"> $total_groups = (int) $wpdb->get_var( $total_groups_sql );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- bp_core_set_incremented_cache( $total_groups_sql, 'bp_groups', $total_groups );
- } else {
- $total_groups = (int) $cached;
</del><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- return array( 'groups' => $paged_groups, 'total' => $total_groups );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ return array(
+ 'groups' => $paged_groups,
+ 'total' => $total_groups,
+ );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span></span></pre></div>
<a id="trunktestsphpunittestcasesgroupscachephp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/testcases/groups/cache.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/testcases/groups/cache.php 2024-07-27 19:16:17 UTC (rev 13986)
+++ trunk/tests/phpunit/testcases/groups/cache.php 2024-07-27 19:31:15 UTC (rev 13987)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -7,6 +7,62 @@
</span><span class="cx" style="display: block; padding: 0 10px"> class BP_Tests_Group_Cache extends BP_UnitTestCase {
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @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.' );
+ }
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * @group bp_groups_update_meta_cache
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function test_bp_groups_update_meta_cache() {
</span></span></pre>
</div>
</div>
</body>
</html>