<!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][11072] trunk: Cache the results of group ID and count queries.</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 { 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/11072">11072</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/11072","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>boonebgorges</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2016-09-09 15:30:07 +0000 (Fri, 09 Sep 2016)</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'>Cache the results of group ID and count queries.
Query results are cached using an incrementor, and are invalidated in
bulk whenever a group is created, updated, or deleted, or when
groupmeta is modified.
See <a href="http://buddypress.trac.wordpress.org/ticket/5451">#5451</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcbpgroupsbpgroupscachephp">trunk/src/bp-groups/bp-groups-cache.php</a></li>
<li><a href="#trunksrcbpgroupsclassesclassbpgroupsgroupphp">trunk/src/bp-groups/classes/class-bp-groups-group.php</a></li>
<li><a href="#trunktestsphpunittestcasesgroupsclassbpgroupsgroupphp">trunk/tests/phpunit/testcases/groups/class-bp-groups-group.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcbpgroupsbpgroupscachephp"></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/bp-groups-cache.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-groups/bp-groups-cache.php 2016-09-09 15:00:13 UTC (rev 11071)
+++ trunk/src/bp-groups/bp-groups-cache.php 2016-09-09 15:30:07 UTC (rev 11072)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -253,6 +253,28 @@
</span><span class="cx" style="display: block; padding: 0 10px"> add_action( 'bp_groups_member_before_delete_invite', 'bp_groups_clear_user_group_cache_on_other_events', 10, 2 );
</span><span class="cx" style="display: block; padding: 0 10px"> add_action( 'groups_accept_invite', 'bp_groups_clear_user_group_cache_on_other_events', 10, 2 );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+/**
+ * Reset cache incrementor for the Groups component.
+ *
+ * This function invalidates all cached results of group queries,
+ * whenever one of the following events takes place:
+ * - A group is created or updated.
+ * - A group is deleted.
+ * - A group's metadata is modified.
+ *
+ * @since 2.7.0
+ *
+ * @return bool True on success, false on failure.
+ */
+function bp_groups_reset_cache_incrementor() {
+ return bp_core_reset_incrementor( 'bp_groups' );
+}
+add_action( 'groups_group_after_save', 'bp_groups_reset_cache_incrementor' );
+add_action( 'bp_groups_delete_group', 'bp_groups_reset_cache_incrementor' );
+add_action( 'updated_group_meta', 'bp_groups_reset_cache_incrementor' );
+add_action( 'deleted_group_meta', 'bp_groups_reset_cache_incrementor' );
+add_action( 'added_group_meta', 'bp_groups_reset_cache_incrementor' );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> /* List actions to clear super cached pages on, if super cache is installed */
</span><span class="cx" style="display: block; padding: 0 10px"> add_action( 'groups_join_group', 'bp_core_clear_cache' );
</span><span class="cx" style="display: block; padding: 0 10px"> add_action( 'groups_leave_group', 'bp_core_clear_cache' );
</span></span></pre></div>
<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 2016-09-09 15:00:13 UTC (rev 11071)
+++ trunk/src/bp-groups/classes/class-bp-groups-group.php 2016-09-09 15:30:07 UTC (rev 11072)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -823,7 +823,6 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'pagination' => '',
</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"> if ( ! empty( $r['user_id'] ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $sql['from'] .= " JOIN {$bp->groups->table_name_members} m ON ( g.id = m.group_id )";
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -965,8 +964,15 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @param array $r Array of parsed arguments for the get method.
</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><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $paged_group_ids = $wpdb->get_col( $paged_groups_sql );
</del><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $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;
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> $uncached_group_ids = bp_get_non_cached_ids( $paged_group_ids, 'bp_groups' );
</span><span class="cx" style="display: block; padding: 0 10px"> if ( $uncached_group_ids ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $group_ids_sql = implode( ',', array_map( 'intval', $uncached_group_ids ) );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -993,8 +999,15 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @param array $r Array of parsed arguments for the get method.
</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><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $total_groups = (int) $wpdb->get_var( $total_groups_sql );
</del><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $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;
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> $group_ids = array();
</span><span class="cx" style="display: block; padding: 0 10px"> foreach ( (array) $paged_groups as $group ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $group_ids[] = $group->id;
</span></span></pre></div>
<a id="trunktestsphpunittestcasesgroupsclassbpgroupsgroupphp"></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/class-bp-groups-group.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/testcases/groups/class-bp-groups-group.php 2016-09-09 15:00:13 UTC (rev 11071)
+++ trunk/tests/phpunit/testcases/groups/class-bp-groups-group.php 2016-09-09 15:30:07 UTC (rev 11072)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -507,6 +507,114 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( '12', count( $groups['groups'] ) );
</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">+ /**
+ * @group cache
+ * @ticket BP5451
+ * @ticket BP6643
+ */
+ public function test_get_queries_should_be_cached() {
+ global $wpdb;
+
+ $g = $this->factory->group->create();
+
+ $found1 = BP_Groups_Group::get();
+
+ $num_queries = $wpdb->num_queries;
+
+ $found2 = BP_Groups_Group::get();
+
+ $this->assertEqualSets( $found1, $found2 );
+ $this->assertSame( $num_queries, $wpdb->num_queries );
+ }
+
+ /**
+ * @group cache
+ * @ticket BP5451
+ * @ticket BP6643
+ */
+ public function test_get_query_caches_should_be_busted_by_groupmeta_update() {
+ global $wpdb;
+
+ $groups = $this->factory->group->create_many( 2 );
+ groups_update_groupmeta( $groups[0], 'foo', 'bar' );
+ groups_update_groupmeta( $groups[1], 'foo', 'bar' );
+
+ $found1 = BP_Groups_Group::get( array(
+ 'meta_query' => array(
+ array(
+ 'key' => 'foo',
+ 'value' => 'bar',
+ ),
+ ),
+ ) );
+
+ $this->assertEqualSets( array( $groups[0], $groups[1] ), wp_list_pluck( $found1['groups'], 'id' ) );
+
+ groups_update_groupmeta( $groups[1], 'foo', 'baz' );
+
+ $found2 = BP_Groups_Group::get( array(
+ 'meta_query' => array(
+ array(
+ 'key' => 'foo',
+ 'value' => 'bar',
+ ),
+ ),
+ ) );
+
+ $this->assertEqualSets( array( $groups[0] ), wp_list_pluck( $found2['groups'], 'id' ) );
+ }
+
+ /**
+ * @group cache
+ * @ticket BP5451
+ * @ticket BP6643
+ */
+ public function test_get_query_caches_should_be_busted_by_group_save() {
+ global $wpdb;
+
+ $groups = $this->factory->group->create_many( 2 );
+ groups_update_groupmeta( $groups[0], 'foo', 'bar' );
+ groups_update_groupmeta( $groups[1], 'foo', 'bar' );
+
+ $found1 = BP_Groups_Group::get( array(
+ 'search_terms' => 'Foo',
+ ) );
+
+ $this->assertEmpty( $found1['groups'] );
+
+ $group0 = groups_get_group( array( 'group_id' => $groups[0] ) );
+ $group0->name = 'Foo';
+ $group0->save();
+
+ $found2 = BP_Groups_Group::get( array(
+ 'search_terms' => 'Foo',
+ ) );
+
+ $this->assertEqualSets( array( $groups[0] ), wp_list_pluck( $found2['groups'], 'id' ) );
+ }
+
+ /**
+ * @group cache
+ * @ticket BP5451
+ * @ticket BP6643
+ */
+ public function test_get_query_caches_should_be_busted_by_group_delete() {
+ global $wpdb;
+
+ $groups = $this->factory->group->create_many( 2 );
+
+ $found1 = BP_Groups_Group::get();
+
+ $this->assertEqualSets( $groups, wp_list_pluck( $found1['groups'], 'id' ) );
+
+ $group0 = groups_get_group( array( 'group_id' => $groups[0] ) );
+ $group0->delete();
+
+ $found2 = BP_Groups_Group::get();
+
+ $this->assertEqualSets( array( $groups[1] ), wp_list_pluck( $found2['groups'], 'id' ) );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> /** convert_type_to_order_orderby() **********************************/
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span></span></pre>
</div>
</div>
</body>
</html>