<!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>[48748] trunk: Comments: Update comment cache in the upgrade routine for changing the `comment_type` DB field value in comments table.</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="https://core.trac.wordpress.org/changeset/48748">48748</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/48748","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>SergeyBiryukov</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2020-08-07 14:27:40 +0000 (Fri, 07 Aug 2020)</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'>Comments: Update comment cache in the upgrade routine for changing the `comment_type` DB field value in comments table.
This ensures that comment object cache is cleared after changing the comment type to `comment` instead of an empty string.
Add a unit test for `_wp_batch_update_comment_type()`.
Follow-up to <a href="https://core.trac.wordpress.org/changeset/47597">[47597]</a>, <a href="https://core.trac.wordpress.org/changeset/47626">[47626]</a>, <a href="https://core.trac.wordpress.org/changeset/48225">[48225]</a>, <a href="https://core.trac.wordpress.org/changeset/48227">[48227]</a>.
Props imath, westonruter.
Fixes <a href="https://core.trac.wordpress.org/ticket/49236">#49236</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludescommentphp">trunk/src/wp-includes/comment.php</a></li>
</ul>
<h3>Added Paths</h3>
<ul>
<li><a href="#trunktestsphpunittestscommentwpBatchUpdateCommentTypephp">trunk/tests/phpunit/tests/comment/wpBatchUpdateCommentType.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludescommentphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/comment.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/comment.php 2020-08-07 13:49:47 UTC (rev 48747)
+++ trunk/src/wp-includes/comment.php 2020-08-07 14:27:40 UTC (rev 48748)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3839,11 +3839,11 @@
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> $comment_batch_size = (int) apply_filters( 'wp_update_comment_type_batch_size', 100 );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Update the `comment_type` field value to be `comment` for the next batch of comments.
- $wpdb->query(
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Get the IDs of the comments to update.
+ $comment_ids = $wpdb->get_col(
</ins><span class="cx" style="display: block; padding: 0 10px"> $wpdb->prepare(
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- "UPDATE {$wpdb->comments}
- SET comment_type = 'comment'
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ "SELECT comment_ID
+ FROM {$wpdb->comments}
</ins><span class="cx" style="display: block; padding: 0 10px"> WHERE comment_type = ''
</span><span class="cx" style="display: block; padding: 0 10px"> ORDER BY comment_ID DESC
</span><span class="cx" style="display: block; padding: 0 10px"> LIMIT %d",
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3851,6 +3851,21 @@
</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">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( $comment_ids ) {
+ $comment_id_list = implode( ',', $comment_ids );
+
+ // Update the `comment_type` field value to be `comment` for the next batch of comments.
+ $wpdb->query(
+ "UPDATE {$wpdb->comments}
+ SET comment_type = 'comment'
+ WHERE comment_type = ''
+ AND comment_ID IN ({$comment_id_list})" // phpcs:ignore WordPress.DB.PreparedSQL.InterpolatedNotPrepared
+ );
+
+ // Make sure to clean the comment cache.
+ clean_comment_cache( $comment_ids );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> delete_option( $lock_name );
</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="trunktestsphpunittestscommentwpBatchUpdateCommentTypephp"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: trunk/tests/phpunit/tests/comment/wpBatchUpdateCommentType.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/comment/wpBatchUpdateCommentType.php (rev 0)
+++ trunk/tests/phpunit/tests/comment/wpBatchUpdateCommentType.php 2020-08-07 14:27:40 UTC (rev 48748)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -0,0 +1,49 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+<?php
+
+/**
+ * @group comment
+ * @covers ::_wp_batch_update_comment_type
+ */
+class Tests_Batch_Update_Comment_Type extends WP_UnitTestCase {
+
+ /**
+ * @ticket 49236
+ */
+ public function test__wp_batch_update_comment_type() {
+ global $wpdb;
+
+ $comment_ids = self::factory()->comment->create_many( 3 );
+ $comment_id_list = implode( ',', $comment_ids );
+
+ $wpdb->query(
+ "UPDATE {$wpdb->comments}
+ SET comment_type = ''
+ WHERE comment_type = 'comment'
+ AND comment_ID in ({$comment_id_list})" // phpcs:ignore WordPress.DB.PreparedSQL.InterpolatedNotPrepared
+ );
+
+ clean_comment_cache( $comment_ids );
+
+ foreach ( $comment_ids as $comment_id ) {
+ $comment = get_comment( $comment_id );
+ $this->assertEmpty( $comment->comment_type );
+ }
+
+ add_filter( 'wp_update_comment_type_batch_size', array( $this, 'filter_comment_type_batch_size' ) );
+ add_filter( 'schedule_event', '__return_null' );
+
+ _wp_batch_update_comment_type();
+
+ remove_filter( 'wp_update_comment_type_batch_size', array( $this, 'filter_comment_type_batch_size' ) );
+ remove_filter( 'schedule_event', '__return_null' );
+
+ foreach ( $comment_ids as $comment_id ) {
+ $updated_comment = get_comment( $comment_id );
+ $this->assertEquals( 'comment', $updated_comment->comment_type );
+ }
+ }
+
+ public function filter_comment_type_batch_size() {
+ return 3;
+ }
+}
</ins><span class="cx" style="display: block; padding: 0 10px">Property changes on: trunk/tests/phpunit/tests/comment/wpBatchUpdateCommentType.php
</span><span class="cx" style="display: block; padding: 0 10px">___________________________________________________________________
</span></span></pre></div>
<a id="svneolstyle"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: svn:eol-style</h4></div>
<ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+native
</ins><span class="cx" style="display: block; padding: 0 10px">\ No newline at end of property
</span></div>
</body>
</html>