<!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][11054] trunk: Cache the results of activity 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/11054">11054</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/11054","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-01 03:27:12 +0000 (Thu, 01 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 activity ID and count queries.
Query results are cached using an incrementor, and are invalidated in
bulk whenever an activity item is created, updated, or deleted.
Fixes <a href="http://buddypress.trac.wordpress.org/ticket/7237">#7237</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcbpactivitybpactivitycachephp">trunk/src/bp-activity/bp-activity-cache.php</a></li>
<li><a href="#trunksrcbpactivityclassesclassbpactivityactivityphp">trunk/src/bp-activity/classes/class-bp-activity-activity.php</a></li>
<li><a href="#trunktestsphpunittestcasesactivitycachephp">trunk/tests/phpunit/testcases/activity/cache.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcbpactivitybpactivitycachephp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/bp-activity/bp-activity-cache.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-activity/bp-activity-cache.php 2016-09-01 03:27:05 UTC (rev 11053)
+++ trunk/src/bp-activity/bp-activity-cache.php 2016-09-01 03:27:12 UTC (rev 11054)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -63,3 +63,19 @@
</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"> add_action( 'bp_activity_deleted_activities', 'bp_activity_clear_cache_for_deleted_activity' );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+/**
+ * Reset cache incrementor for the Activity component.
+ *
+ * Called whenever an activity item is created, updated, or deleted, this
+ * function effectively invalidates all cached results of activity queries.
+ *
+ * @since 2.7.0
+ *
+ * @return bool True on success, false on failure.
+ */
+function bp_activity_reset_cache_incrementor() {
+ return bp_core_reset_incrementor( 'bp_activity' );
+}
+add_action( 'bp_activity_delete', 'bp_activity_reset_cache_incrementor' );
+add_action( 'bp_activity_add', 'bp_activity_reset_cache_incrementor' );
</ins></span></pre></div>
<a id="trunksrcbpactivityclassesclassbpactivityactivityphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/bp-activity/classes/class-bp-activity-activity.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-activity/classes/class-bp-activity-activity.php 2016-09-01 03:27:05 UTC (rev 11053)
+++ trunk/src/bp-activity/classes/class-bp-activity-activity.php 2016-09-01 03:27:12 UTC (rev 11054)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -645,7 +645,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> $activity_ids_sql = apply_filters( 'bp_activity_paged_activities_sql', $activity_ids_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">- $activity_ids = $wpdb->get_col( $activity_ids_sql );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $cached = bp_core_get_incremented_cache( $activity_ids_sql, 'bp_activity' );
+ if ( false === $cached ) {
+ $activity_ids = $wpdb->get_col( $activity_ids_sql );
+ bp_core_set_incremented_cache( $activity_ids_sql, 'bp_activity', $activity_ids );
+ } else {
+ $activity_ids = $cached;
+ }
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $retval['has_more_items'] = ! empty( $per_page ) && count( $activity_ids ) > $per_page;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -702,7 +708,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $sort Sort direction for query.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> $total_activities_sql = apply_filters( 'bp_activity_total_activities_sql', "SELECT count(DISTINCT a.id) FROM {$bp->activity->table_name} a {$join_sql} {$where_sql}", $where_sql, $sort );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $total_activities = $wpdb->get_var( $total_activities_sql );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $cached = bp_core_get_incremented_cache( $total_activities_sql, 'bp_activity' );
+ if ( false === $cached ) {
+ $total_activities = $wpdb->get_var( $total_activities_sql );
+ bp_core_set_incremented_cache( $total_activities_sql, 'bp_activity', $total_activities );
+ } else {
+ $total_activities = $cached;
+ }
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( !empty( $r['max'] ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( (int) $total_activities > (int) $r['max'] ) {
</span></span></pre></div>
<a id="trunktestsphpunittestcasesactivitycachephp"></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/activity/cache.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/testcases/activity/cache.php 2016-09-01 03:27:05 UTC (rev 11053)
+++ trunk/tests/phpunit/testcases/activity/cache.php 2016-09-01 03:27:12 UTC (rev 11054)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -83,4 +83,193 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertSame( 'bar foo', $a_fp['activities'][0]->content );
</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 BP7237
+ * @ticket BP6643
+ */
+ public function test_query_should_be_cached() {
+ global $wpdb;
+
+ $u = $this->factory->user->create();
+ $a = $this->factory->activity->create( array(
+ 'component' => buddypress()->activity->id,
+ 'type' => 'activity_update',
+ 'user_id' => $u,
+ 'content' => 'foo bar',
+ ) );
+
+ $activity_args = array(
+ 'per_page' => 10,
+ 'fields' => 'ids',
+ 'count_total' => true,
+ );
+
+ $a1 = bp_activity_get( $activity_args );
+
+ $num_queries = $wpdb->num_queries;
+
+ $a2 = bp_activity_get( $activity_args );
+
+ $this->assertEqualSets( $a1, $a2 );
+ $this->assertSame( $num_queries, $wpdb->num_queries );
+ }
+
+ /**
+ * @ticket BP7237
+ * @ticket BP6643
+ */
+ public function test_query_cache_should_be_skipped_for_different_query_params() {
+ global $wpdb;
+
+ $u = $this->factory->user->create();
+ $a = $this->factory->activity->create( array(
+ 'component' => buddypress()->activity->id,
+ 'type' => 'activity_update',
+ 'user_id' => $u,
+ 'content' => 'foo bar',
+ ) );
+
+ $activity_args = array(
+ 'per_page' => 10,
+ 'fields' => 'ids',
+ 'count_total' => true,
+ 'filter' => array(
+ 'component' => buddypress()->activity->id,
+ ),
+ );
+
+ $a1 = bp_activity_get( $activity_args );
+
+ $num_queries = $wpdb->num_queries;
+
+ // This is enough to make the ID and COUNT clause miss the cache.
+ $activity_args['filter']['action'] = 'activity_update';
+ $a2 = bp_activity_get( $activity_args );
+
+ $this->assertEqualSets( $a1, $a2 );
+
+ // Two extra queries: one for the IDs, one for the count.
+ $n = $num_queries + 2;
+ $this->assertSame( $num_queries + 2, $wpdb->num_queries );
+ }
+
+ /**
+ * @ticket BP7237
+ * @ticket BP6643
+ */
+ public function test_query_cache_should_be_invalidated_by_activity_add() {
+ global $wpdb;
+
+ $u = $this->factory->user->create();
+ $a1 = $this->factory->activity->create( array(
+ 'component' => buddypress()->activity->id,
+ 'type' => 'activity_update',
+ 'user_id' => $u,
+ 'content' => 'foo bar',
+ ) );
+
+ $activity_args = array(
+ 'per_page' => 10,
+ 'fields' => 'ids',
+ 'count_total' => true,
+ );
+
+ $q1 = bp_activity_get( $activity_args );
+
+ // Bust the cache.
+ $a2 = $this->factory->activity->create( array(
+ 'component' => buddypress()->activity->id,
+ 'type' => 'activity_update',
+ 'user_id' => $u,
+ 'content' => 'foo bar',
+ ) );
+
+ $num_queries = $wpdb->num_queries;
+
+ $q2 = bp_activity_get( $activity_args );
+
+ $expected = array( $a1, $a2 );
+
+ $this->assertEqualSets( $expected, $q2['activities'] );
+ $this->assertEquals( 2, $q2['total'] );
+ $this->assertSame( $num_queries + 2, $wpdb->num_queries );
+ }
+
+ /**
+ * @ticket BP7237
+ * @ticket BP6643
+ */
+ public function test_query_cache_should_be_invalidated_by_activity_edit() {
+ global $wpdb;
+
+ $u = $this->factory->user->create();
+ $a = $this->factory->activity->create( array(
+ 'component' => buddypress()->activity->id,
+ 'type' => 'activity_update',
+ 'user_id' => $u,
+ 'content' => 'foo bar',
+ ) );
+
+ $activity_args = array(
+ 'per_page' => 10,
+ 'fields' => 'ids',
+ 'count_total' => true,
+ );
+
+ $q1 = bp_activity_get( $activity_args );
+
+ // Bust the cache.
+ $this->factory->activity->create( array(
+ 'id' => $a,
+ 'component' => buddypress()->activity->id,
+ 'type' => 'activity_update',
+ 'user_id' => $u,
+ 'content' => 'foo bar baz',
+ ) );
+
+ $num_queries = $wpdb->num_queries;
+
+ $q2 = bp_activity_get( $activity_args );
+
+ $this->assertEqualSets( $q1, $q2 );
+ $this->assertSame( $num_queries + 2, $wpdb->num_queries );
+ }
+
+ /**
+ * @ticket BP7237
+ * @ticket BP6643
+ */
+ public function test_query_cache_should_be_invalidated_by_activity_delete() {
+ global $wpdb;
+
+ $u = $this->factory->user->create();
+ $a = $this->factory->activity->create( array(
+ 'component' => buddypress()->activity->id,
+ 'type' => 'activity_update',
+ 'user_id' => $u,
+ 'content' => 'foo bar',
+ ) );
+
+ $activity_args = array(
+ 'per_page' => 10,
+ 'fields' => 'ids',
+ 'count_total' => true,
+ );
+
+ $q1 = bp_activity_get( $activity_args );
+
+ // Bust the cache.
+ bp_activity_delete( array(
+ 'id' => $a,
+ ) );
+
+ $num_queries = $wpdb->num_queries;
+
+ $q2 = bp_activity_get( $activity_args );
+
+ $this->assertEqualSets( array(), $q2['activities'] );
+ $this->assertEquals( 0, $q2['total'] );
+ $this->assertSame( $num_queries + 2, $wpdb->num_queries );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre>
</div>
</div>
</body>
</html>