Changeset 41848

Timestamp:

10/12/2017 02:58:58 PM (6 years ago)

Author:

boonebgorges

Message:

Invalidate comment query cache when modifying comment meta.

Comment queries are sensitive to comment meta due to the meta_query
parameter, so the cache must be invalidated when comment meta is changed,
added, or deleted.

Props spacedmonkey.
See #40669.

Location:

trunk

Files:

• src/wp-includes/comment.php (modified) (3 diffs)
• tests/phpunit/tests/comment/query.php (modified) (1 diff)

trunk/src/wp-includes/comment.php

@@ -424 +424 @@
  */
 function add_comment_meta($comment_id, $meta_key, $meta_value, $unique = false) {
-    return add_metadata('comment', $comment_id, $meta_key, $meta_value, $unique);
+    $added = add_metadata( 'comment', $comment_id, $meta_key, $meta_value, $unique );
+    if ( $added ) {
+        wp_cache_set( 'last_changed', microtime(), 'comment' );
+    }
+    return $added;
 }
 
@@ -443 +447 @@
  */
 function delete_comment_meta($comment_id, $meta_key, $meta_value = '') {
-    return delete_metadata('comment', $comment_id, $meta_key, $meta_value);
+    $deleted = delete_metadata( 'comment', $comment_id, $meta_key, $meta_value );
+    if ( $deleted ) {
+        wp_cache_set( 'last_changed', microtime(), 'comment' );
+    }
+    return $deleted;
 }
 
@@ -480 +488 @@
  */
 function update_comment_meta($comment_id, $meta_key, $meta_value, $prev_value = '') {
-    return update_metadata('comment', $comment_id, $meta_key, $meta_value, $prev_value);
+    $updated = update_metadata( 'comment', $comment_id, $meta_key, $meta_value, $prev_value );
+    if ( $updated ) {
+        wp_cache_set( 'last_changed', microtime(), 'comment' );
+    }
+    return $updated;
 }
 

trunk/tests/phpunit/tests/comment/query.php

@@ -3026 +3026 @@
         $this->assertEquals( $number_of_queries, $wpdb->num_queries );
     }
+
+    /**
+     * @ticket 40669
+     */
+    public function test_add_comment_meta_should_invalidate_query_cache() {
+        global $wpdb;
+
+        $p = self::factory()->post->create( array( 'post_status' => 'publish' ) );
+        $c1 = self::factory()->comment->create_post_comments( $p, 1 );
+        $c2 = self::factory()->comment->create_post_comments( $p, 1 );
+
+        foreach ( $c1 as $cid ) {
+            add_comment_meta( $cid, 'sauce', 'fire' );
+        }
+
+        $cached = get_comments( array(
+            'post_id' => $p,
+            'fields' => 'ids',
+            'meta_query' => array(
+                array(
+                    'key' => 'sauce',
+                    'value' => 'fire',
+                ),
+            )
+        ) );
+
+        $this->assertEqualSets( $c1, $cached );
+
+        foreach ( $c2 as $cid ) {
+            add_comment_meta( $cid, 'sauce', 'fire' );
+        }
+
+        $found = get_comments( array(
+            'post_id' => $p,
+            'fields' => 'ids',
+            'meta_query' => array(
+                array(
+                    'key' => 'sauce',
+                    'value' => 'fire',
+                ),
+            )
+        ) );
+
+        $this->assertEqualSets( array_merge( $c1, $c2 ), $found );
+    }
+
+    /**
+     * @ticket 40669
+     */
+    public function test_update_comment_meta_should_invalidate_query_cache() {
+        global $wpdb;
+
+        $p = self::factory()->post->create( array( 'post_status' => 'publish' ) );
+        $c1 = self::factory()->comment->create_post_comments( $p, 1 );
+        $c2 = self::factory()->comment->create_post_comments( $p, 1 );
+
+        foreach ( array_merge( $c1, $c2 ) as $cid ) {
+            add_comment_meta( $cid, 'sauce', 'fire' );
+        }
+
+        $cached = get_comments( array(
+            'post_id' => $p,
+            'fields' => 'ids',
+            'meta_query' => array(
+                array(
+                    'key' => 'sauce',
+                    'value' => 'fire',
+                ),
+            )
+        ) );
+
+        $this->assertEqualSets( array_merge( $c1, $c2 ), $cached );
+
+        foreach ( $c2 as $cid ) {
+            update_comment_meta( $cid, 'sauce', 'foo' );
+        }
+
+        $found = get_comments( array(
+            'post_id' => $p,
+            'fields' => 'ids',
+            'meta_query' => array(
+                array(
+                    'key' => 'sauce',
+                    'value' => 'fire',
+                ),
+            )
+        ) );
+
+        $this->assertEqualSets( $c1, $found );
+    }
+
+    /**
+     * @ticket 40669
+     */
+    public function test_delete_comment_meta_should_invalidate_query_cache() {
+        global $wpdb;
+
+        $p = self::factory()->post->create( array( 'post_status' => 'publish' ) );
+        $c1 = self::factory()->comment->create_post_comments( $p, 1 );
+        $c2 = self::factory()->comment->create_post_comments( $p, 1 );
+
+        foreach ( array_merge( $c1, $c2 ) as $cid ) {
+            add_comment_meta( $cid, 'sauce', 'fire' );
+        }
+
+        $cached = get_comments( array(
+            'post_id' => $p,
+            'fields' => 'ids',
+            'meta_query' => array(
+                array(
+                    'key' => 'sauce',
+                    'value' => 'fire',
+                ),
+            )
+        ) );
+
+        $this->assertEqualSets( array_merge( $c1, $c2 ), $cached );
+
+        foreach ( $c2 as $cid ) {
+            delete_comment_meta( $cid, 'sauce' );
+        }
+
+        $found = get_comments( array(
+            'post_id' => $p,
+            'fields' => 'ids',
+            'meta_query' => array(
+                array(
+                    'key' => 'sauce',
+                    'value' => 'fire',
+                ),
+            )
+        ) );
+
+        $this->assertEqualSets( $c1, $found );
+    }
 }