<!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][13990] trunk: Core: Add `cache_results` flag to the `BP_Invitation::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/13990">13990</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/13990","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 20:14:28 +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'>Core: Add `cache_results` flag to the `BP_Invitation::get` getter.
When performing a request with `cache_results`, it stops the invite 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/346/</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcbpcoreclassesclassbpinvitationphp">trunk/src/bp-core/classes/class-bp-invitation.php</a></li>
<li><a href="#trunktestsphpunittestcasescoreinvitationsphp">trunk/tests/phpunit/testcases/core/invitations.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcbpcoreclassesclassbpinvitationphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/bp-core/classes/class-bp-invitation.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-core/classes/class-bp-invitation.php 2024-07-27 20:12:32 UTC (rev 13989)
+++ trunk/src/bp-core/classes/class-bp-invitation.php 2024-07-27 20:14:28 UTC (rev 13990)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -357,9 +357,6 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Assemble the WHERE clause of a get() SQL statement.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Used by BP_Invitation::get() to create its WHERE
- * clause.
- *
</del><span class="cx" style="display: block; padding: 0 10px"> * @since 5.0.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @global wpdb $wpdb WordPress database object.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -438,11 +435,9 @@
</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"> // Type.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( ! empty( $args['type'] ) && 'all' !== $args['type'] ) {
- if ( 'invite' === $args['type'] || 'request' === $args['type'] ) {
- $type_clean = $wpdb->prepare( '%s', $args['type'] );
- $where_conditions['type'] = "type = {$type_clean}";
- }
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( ! empty( $args['type'] ) && ( 'invite' === $args['type'] || 'request' === $args['type'] ) ) {
+ $type_clean = $wpdb->prepare( '%s', $args['type'] );
+ $where_conditions['type'] = "type = {$type_clean}";
</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">@@ -688,6 +683,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Get invitations, based on provided filter parameters.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 5.0.0
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 15.0.0 Introduced the `cache_results` parameter.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @global wpdb $wpdb WordPress database object.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -729,6 +725,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @type string $sort_order Either 'ASC' or 'DESC'.
</span><span class="cx" style="display: block; padding: 0 10px"> * @type string $order_by Field to order results by.
</span><span class="cx" style="display: block; padding: 0 10px"> * @type string $sort_order ASC or DESC.
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @type bool $cache_results Optional. Whether to cache invitation information. Default true.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @type int $page Number of the current page of results.
</span><span class="cx" style="display: block; padding: 0 10px"> * Default: false (no pagination,
</span><span class="cx" style="display: block; padding: 0 10px"> * all items).
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -744,6 +741,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public static function get( $args = array() ) {
</span><span class="cx" style="display: block; padding: 0 10px"> global $wpdb;
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> $invites_table_name = BP_Invitation_Manager::get_table_name();
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Parse the arguments.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -763,6 +761,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'search_terms' => '',
</span><span class="cx" style="display: block; padding: 0 10px"> 'order_by' => false,
</span><span class="cx" style="display: block; padding: 0 10px"> 'sort_order' => false,
</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"> 'page' => false,
</span><span class="cx" style="display: block; padding: 0 10px"> 'per_page' => false,
</span><span class="cx" style="display: block; padding: 0 10px"> 'fields' => 'all',
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -771,12 +770,9 @@
</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"> $sql = array(
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'select' => 'SELECT',
- 'fields' => '',
- 'from' => "FROM {$invites_table_name} i",
- 'where' => '',
- 'orderby' => '',
- 'pagination' => '',
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'select' => 'SELECT',
+ 'from' => "FROM {$invites_table_name} i",
+ 'fields' => 'DISTINCT i.id',
</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"> if ( 'item_ids' === $r['fields'] ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -785,8 +781,6 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $sql['fields'] = 'DISTINCT i.user_id';
</span><span class="cx" style="display: block; padding: 0 10px"> } elseif ( 'inviter_ids' === $r['fields'] ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $sql['fields'] = 'DISTINCT i.inviter_id';
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- } else {
- $sql['fields'] = 'DISTINCT i.id';
</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"> // WHERE.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -829,18 +823,22 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 5.0.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string $value Concatenated SQL statement.
- * @param array $sql Array of SQL parts before concatenation.
- * @param array $r Array of parsed arguments for the get method.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $paged_invites_sql Concatenated SQL statement.
+ * @param array $sql Array of SQL parts before concatenation.
+ * @param array $r Array of parsed arguments for the get method.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> $paged_invites_sql = apply_filters( 'bp_invitations_get_paged_invitations_sql', $paged_invites_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_invites_sql, 'bp_invitations' );
- if ( false === $cached ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( $r['cache_results'] ) {
+ $cached = bp_core_get_incremented_cache( $paged_invites_sql, 'bp_invitations' );
+ if ( false === $cached ) {
+ $paged_invite_ids = $wpdb->get_col( $paged_invites_sql );
+ bp_core_set_incremented_cache( $paged_invites_sql, 'bp_invitations', $paged_invite_ids );
+ } else {
+ $paged_invite_ids = $cached;
+ }
+ } else {
</ins><span class="cx" style="display: block; padding: 0 10px"> $paged_invite_ids = $wpdb->get_col( $paged_invites_sql );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- bp_core_set_incremented_cache( $paged_invites_sql, 'bp_invitations', $paged_invite_ids );
- } else {
- $paged_invite_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"> // Special return format cases.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -849,12 +847,14 @@
</span><span class="cx" style="display: block; padding: 0 10px"> return array_map( 'intval', $paged_invite_ids );
</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">- $uncached_ids = bp_get_non_cached_ids( $paged_invite_ids, 'bp_invitations' );
- if ( $uncached_ids ) {
- $ids_sql = implode( ',', array_map( 'intval', $uncached_ids ) );
- $data_objects = $wpdb->get_results( "SELECT i.* FROM {$invites_table_name} i WHERE i.id IN ({$ids_sql})" );
- foreach ( $data_objects as $data_object ) {
- wp_cache_set( $data_object->id, $data_object, 'bp_invitations' );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( $r['cache_results'] ) {
+ $uncached_ids = bp_get_non_cached_ids( $paged_invite_ids, 'bp_invitations' );
+ if ( $uncached_ids ) {
+ $ids_sql = implode( ',', array_map( 'intval', $uncached_ids ) );
+ $data_objects = $wpdb->get_results( "SELECT i.* FROM {$invites_table_name} i WHERE i.id IN ({$ids_sql})" );
+ foreach ( $data_objects as $data_object ) {
+ wp_cache_set( $data_object->id, $data_object, 'bp_invitations' );
+ }
</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">@@ -881,6 +881,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public static function get_total_count( $args ) {
</span><span class="cx" style="display: block; padding: 0 10px"> global $wpdb;
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> $invites_table_name = BP_Invitation_Manager::get_table_name();
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $r = bp_parse_args(
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -913,7 +914,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $sql = "{$select_sql} {$from_sql} {$where_sql}";
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Return the queried results.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- return $wpdb->get_var( $sql );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ return (int) $wpdb->get_var( $sql );
</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="trunktestsphpunittestcasescoreinvitationsphp"></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/core/invitations.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/testcases/core/invitations.php 2024-07-27 20:12:32 UTC (rev 13989)
+++ trunk/tests/phpunit/testcases/core/invitations.php 2024-07-27 20:14:28 UTC (rev 13990)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -7,6 +7,105 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @group invitations
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> class BP_Tests_Invitations extends BP_UnitTestCase {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * @ticket BP8552
+ * @group cache
+ */
+ public function test_invitation_query_with_ids_cache_results() {
+ global $wpdb;
+
+ $u1 = self::factory()->user->create();
+ $u2 = self::factory()->user->create();
+ $u3 = self::factory()->user->create();
+
+ $invites_class = new BPTest_Invitation_Manager_Extension();
+
+ // Create a couple of invitations.
+ $invite_args = array(
+ 'user_id' => $u3,
+ 'inviter_id' => $u1,
+ 'item_id' => 1,
+ 'send_invite' => 'sent',
+ );
+
+ $invites_class->add_invitation( $invite_args );
+
+ $invite_args['inviter_id'] = $u2;
+
+ $invites_class->add_invitation( $invite_args );
+
+ $wpdb->num_queries = 0;
+
+ $first_query = BP_Invitation::get(
+ array(
+ 'cache_results' => true,
+ 'fields' => 'ids',
+ )
+ );
+
+ $queries_before = get_num_queries();
+
+ $second_query = BP_Invitation::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( 2, $queries_after, 'Assert that the uncached query was run' );
+ $this->assertSameSets( $first_query, $second_query, 'Results of the query are expected to match.' );
+ }
+
+ /**
+ * @ticket BP8552
+ * @group cache
+ */
+ public function test_invitation_query_with_all_cache_results() {
+ global $wpdb;
+
+ $u1 = self::factory()->user->create();
+ $u2 = self::factory()->user->create();
+ $u3 = self::factory()->user->create();
+
+ $invites_class = new BPTest_Invitation_Manager_Extension();
+
+ // Create a couple of invitations.
+ $invite_args = array(
+ 'user_id' => $u3,
+ 'inviter_id' => $u1,
+ 'item_id' => 1,
+ 'send_invite' => 'sent',
+ );
+
+ $invites_class->add_invitation( $invite_args );
+
+ $invite_args['inviter_id'] = $u2;
+
+ $invites_class->add_invitation( $invite_args );
+
+ $wpdb->num_queries = 0;
+
+ $first_query = BP_Invitation::get(
+ array( 'cache_results' => true )
+ );
+
+ $queries_before = get_num_queries();
+
+ $second_query = BP_Invitation::get(
+ array( 'cache_results' => false )
+ );
+
+ $queries_after = get_num_queries();
+
+ $this->assertNotSame( $queries_before, $queries_after, 'Assert that queries are run' );
+ $this->assertSame( 3, $queries_after, 'Assert that the uncached query was run' );
+ $this->assertEquals( $first_query, $second_query, 'Results of the query are expected to match.' );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> public function test_bp_invitations_add_invitation_vanilla() {
</span><span class="cx" style="display: block; padding: 0 10px"> $old_current_user = get_current_user_id();
</span><span class="cx" style="display: block; padding: 0 10px">
</span></span></pre>
</div>
</div>
</body>
</html>