Ticket #11334: 11334.3.diff

src/wp-includes/comment.php

@@ -1367 +1367 @@
         if ( $args['max_depth'] > 1 && 0 != $comment->comment_parent )
                 return get_page_of_comment( $comment->comment_parent, $args );
 
-        $allowedtypes = array(
-                'comment' => '',
-                'pingback' => 'pingback',
-                'trackback' => 'trackback',
-        );
+        $older_comment_counts = wp_cache_get( $comment_ID, 'comment_pages' );
+
+        if ( ! is_array( $older_comment_counts ) ) {
+                $older_comment_counts = array();
+        }
+
+        $comment_type = $args['type'];
+        if ( isset( $older_comment_counts[ $comment_type ] ) ) {
+                $older_comment_count = (int) $older_comment_counts[ $comment_type ];
+        } else {
+                switch ( $comment_type ) {
+                        case 'comment' :
+                                $comment_type_where = " and comment_type = 'comment'";
+                                break;
+
+                        case 'pingback' :
+                                $comment_type_where = " and comment_type = 'comment'";
+                                break;
+
+                        case 'trackback' :
+                                $comment_type_where = " and comment_type = 'comment'";
+                                break;
+
+                        case 'pings' :
+                                $comment_type_where = " and comment_type = 'comment'";
+                                break;
 
-        $comtypewhere = ( 'all' != $args['type'] && isset($allowedtypes[$args['type']]) ) ? " AND comment_type = '" . $allowedtypes[$args['type']] . "'" : '';
+                        case 'all' :
+                        default :
+                                $comment_type_where = '';
+                                break;
+                }
+
+                // Count comments older than this one.
+                $older_comment_count = $wpdb->get_var( $wpdb->prepare( "SELECT COUNT(comment_ID) FROM $wpdb->comments WHERE comment_post_ID = %d AND comment_parent = 0 AND comment_approved = '1' AND comment_date_gmt < '%s'" . $comment_type_where, $comment->comment_post_ID, $comment->comment_date_gmt ) );
 
-        // Count comments older than this one
-        $oldercoms = $wpdb->get_var( $wpdb->prepare( "SELECT COUNT(comment_ID) FROM $wpdb->comments WHERE comment_post_ID = %d AND comment_parent = 0 AND comment_approved = '1' AND comment_date_gmt < '%s'" . $comtypewhere, $comment->comment_post_ID, $comment->comment_date_gmt ) );
+                $older_comment_counts[ $comment_type ] = (int) $older_comment_count;
+                wp_cache_add( $comment_ID, $older_comment_counts, 'comment_pages' );
+        }
 
         // No older comments? Then it's page #1.
-        if ( 0 == $oldercoms )
+        if ( 0 == $older_comment_count ) {
                 return 1;
+        }
 
         // Divide comments older than this one by comments per page to get this comment's page number
-        return ceil( ( $oldercoms + 1 ) / $args['per_page'] );
+        return ceil( ( $older_comment_count + 1 ) / $args['per_page'] );
 }
 
 /**
@@ -2792 +2822 @@
                 wp_cache_add($comment->comment_ID, $comment, 'comment');
 }
 
+/**
+ * Clears the cache used by `get_page_of_comment()`.
+ *
+ * @since 4.2.0
+ *
+ * @param string $new_status New comment status.
+ * @param string $old_status Old comment status.
+ * @param object $comment    Comment object.
+ * @return bool True on successful cache invalidation, false on failure.
+ */
+function wp_clean_page_of_comment_cache( $new_status, $old_status, $comment ) {
+        return wp_cache_delete( $comment->comment_ID, 'comment_pages' );
+}
+
 //
 // Internal
 //

src/wp-includes/default-filters.php

@@ -255 +255 @@
 add_action( 'publish_post',               '_publish_post_hook',                       5, 1 );
 add_action( 'transition_post_status',     '_transition_post_status',                  5, 3 );
 add_action( 'transition_post_status',     '_update_term_count_on_transition_post_status', 10, 3 );
+add_action( 'transition_comment_status',  'wp_clean_page_of_comment_cache',          10, 3 );
 add_action( 'comment_form',               'wp_comment_form_unfiltered_html_nonce'          );
 add_action( 'wp_scheduled_delete',        'wp_scheduled_delete'                            );
 add_action( 'wp_scheduled_auto_draft_delete', 'wp_delete_auto_drafts'                      );

tests/phpunit/tests/comment/getPageOfComment.php

@@ -38 +38 @@
                 $this->assertEquals( 1, get_page_of_comment( $comment_first[0], array( 'per_page' =>  3 ) ) );
                 $this->assertEquals( 1, get_page_of_comment( $comment_first[0], array( 'per_page' => 10 ) ) );
         }
+
+        /**
+         * @ticket 11334
+         */
+        public function test_subsequent_calls_should_hit_cache() {
+                global $wpdb;
+
+                $p = $this->factory->post->create();
+                $c = $this->factory->comment->create( array( 'comment_post_ID' => $p ) );
+
+                // Prime cache.
+                $page_1 = get_page_of_comment( $c, array( 'per_page' => 3 ) );
+
+                $num_queries = $wpdb->num_queries;
+                $page_2 = get_page_of_comment( $c, array( 'per_page' => 3 ) );
+
+                $this->assertSame( $page_1, $page_2 );
+                $this->assertSame( $num_queries, $wpdb->num_queries );
+        }
+
+        /**
+         * @ticket 11334
+         */
+        public function test_cache_hits_should_be_sensitive_to_comment_type() {
+                global $wpdb;
+
+                $p = $this->factory->post->create();
+                $c = $this->factory->comment->create( array( 'comment_post_ID' => $p ) );
+
+                // Prime cache for trackbacks.
+                $page_1 = get_page_of_comment( $c, array( 'per_page' => 3, 'type' => 'trackback' ) );
+
+                $num_queries = $wpdb->num_queries;
+                $page_2 = get_page_of_comment( $c, array( 'per_page' => 3, 'type' => 'comment' ) );
+
+                $this->assertNotEquals( $num_queries, $wpdb->num_queries );
+        }
+
+        /**
+         * @ticket 11334
+         */
+        public function test_cache_should_be_invalidated_when_comment_is_approved() {
+                $p = $this->factory->post->create();
+                $c = $this->factory->comment->create( array( 'comment_post_ID' => $p, 'comment_approved' => 0 ) );
+
+                // Prime cache.
+                $page_1 = get_page_of_comment( $c, array( 'per_page' => 3 ) );
+
+                // Approve comment.
+                wp_set_comment_status( $c, 'approve' );
+
+                $this->assertFalse( wp_cache_get( $c, 'comment_pages' ) );
+        }
+
+        /**
+         * @ticket 11334
+         */
+        public function test_cache_should_be_invalidated_when_comment_is_deleted() {
+                $p = $this->factory->post->create();
+                $c = $this->factory->comment->create( array( 'comment_post_ID' => $p ) );
+
+                // Prime cache.
+                $page_1 = get_page_of_comment( $c, array( 'per_page' => 3 ) );
+
+                // Trash comment.
+                wp_trash_comment( $c );
+
+                $this->assertFalse( wp_cache_get( $c, 'comment_pages' ) );
+        }
+
+        /**
+         * @ticket 11334
+         */
+        public function test_cache_should_be_invalidated_when_comment_is_spammed() {
+                $p = $this->factory->post->create();
+                $c = $this->factory->comment->create( array( 'comment_post_ID' => $p ) );
+
+                // Prime cache.
+                $page_1 = get_page_of_comment( $c, array( 'per_page' => 3 ) );
+
+                // Spam comment.
+                wp_spam_comment( $c );
+
+                $this->assertFalse( wp_cache_get( $c, 'comment_pages' ) );
+        }
 }