<!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>[53233] trunk: Feeds: Use latest comment date for the `Last-Modified` header of comments feed.</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/53233">53233</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/53233","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>audrasjb</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2022-04-20 12:46:01 +0000 (Wed, 20 Apr 2022)</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'>Feeds: Use latest comment date for the `Last-Modified` header of comments feed.
Previously, the `Last-Modified` header of comments feed was using the date/time of the last comment. This behavior was breaking caching and causing feed readers to believe there is no new content even when there might be new posts.
This commit changes this behavior to use the newest date from both `get_lastcommentmodified()` and `get_lastpostmodified()` functions instead of only using the result from `get_lastcommentmodified()`.
Props xiven, mauteri, costdev, audrasjb.
Fixes <a href="https://core.trac.wordpress.org/ticket/47968">#47968</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesclasswpphp">trunk/src/wp-includes/class-wp.php</a></li>
<li><a href="#trunktestsphpunittestsfeedrss2php">trunk/tests/phpunit/tests/feed/rss2.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesclasswpphp"></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/class-wp.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/class-wp.php 2022-04-20 11:17:05 UTC (rev 53232)
+++ trunk/src/wp-includes/class-wp.php 2022-04-20 12:46:01 UTC (rev 53233)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -413,6 +413,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $headers = array();
</span><span class="cx" style="display: block; padding: 0 10px"> $status = null;
</span><span class="cx" style="display: block; padding: 0 10px"> $exit_required = false;
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $date_format = 'D, d M Y H:i:s';
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( is_user_logged_in() ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $headers = array_merge( $headers, wp_get_nocache_headers() );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -420,7 +421,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> // Unmoderated comments are only visible for 10 minutes via the moderation hash.
</span><span class="cx" style="display: block; padding: 0 10px"> $expires = 10 * MINUTE_IN_SECONDS;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $headers['Expires'] = gmdate( 'D, d M Y H:i:s', time() + $expires );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $headers['Expires'] = gmdate( $date_format, time() + $expires );
</ins><span class="cx" style="display: block; padding: 0 10px"> $headers['Cache-Control'] = sprintf(
</span><span class="cx" style="display: block; padding: 0 10px"> 'max-age=%d, must-revalidate',
</span><span class="cx" style="display: block; padding: 0 10px"> $expires
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -459,13 +460,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"> ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $wp_last_modified = mysql2date( 'D, d M Y H:i:s', get_lastcommentmodified( 'GMT' ), false );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $wp_last_modified_post = mysql2date( $date_format, get_lastpostmodified( 'GMT' ), false );
+ $wp_last_modified_comment = mysql2date( $date_format, get_lastcommentmodified( 'GMT' ), false );
+ if ( strtotime( $wp_last_modified_post ) > strtotime( $wp_last_modified_comment ) ) {
+ $wp_last_modified = $wp_last_modified_post;
+ } else {
+ $wp_last_modified = $wp_last_modified_comment;
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> } else {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $wp_last_modified = mysql2date( 'D, d M Y H:i:s', get_lastpostmodified( 'GMT' ), false );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $wp_last_modified = mysql2date( $date_format, get_lastpostmodified( 'GMT' ), false );
</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 ( ! $wp_last_modified ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $wp_last_modified = gmdate( 'D, d M Y H:i:s' );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $wp_last_modified = gmdate( $date_format );
</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"> $wp_last_modified .= ' GMT';
</span></span></pre></div>
<a id="trunktestsphpunittestsfeedrss2php"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/tests/feed/rss2.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/feed/rss2.php 2022-04-20 11:17:05 UTC (rev 53232)
+++ trunk/tests/phpunit/tests/feed/rss2.php 2022-04-20 12:46:01 UTC (rev 53233)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -494,4 +494,125 @@
</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">+
+ /**
+ * Test that the Last-Modified is a post's date when a more recent comment exists,
+ * but the "withcomments=1" query var is not passed.
+ *
+ * @ticket 47968
+ *
+ * @covers ::send_headers
+ */
+ public function test_feed_last_modified_should_be_a_post_date_when_withcomments_is_not_passed() {
+ $last_week = gmdate( 'Y-m-d H:i:s', strtotime( '-1 week' ) );
+ $yesterday = gmdate( 'Y-m-d H:i:s', strtotime( '-1 day' ) );
+
+ // Create a post dated last week.
+ $post_id = $this->factory()->post->create( array( 'post_date' => $last_week ) );
+
+ // Create a comment dated yesterday.
+ $this->factory()->comment->create(
+ array(
+ 'comment_post_ID' => $post_id,
+ 'comment_date' => $yesterday,
+ )
+ );
+
+ // The Last-Modified header should have the post's date when "withcomments" is not passed.
+ add_filter(
+ 'wp_headers',
+ function( $headers ) use ( $last_week ) {
+ $this->assertSame(
+ strtotime( $headers['Last-Modified'] ),
+ strtotime( $last_week ),
+ 'Last-Modified was not the date of the post'
+ );
+ return $headers;
+ }
+ );
+
+ $this->go_to( '/?feed=rss2' );
+ }
+
+ /**
+ * Test that the Last-Modified is a comment's date when a more recent comment exists,
+ * and the "withcomments=1" query var is passed.
+ *
+ * @ticket 47968
+ *
+ * @covers ::send_headers
+ */
+ public function test_feed_last_modified_should_be_the_date_of_a_comment_that_is_the_latest_update_when_withcomments_is_passed() {
+ $last_week = gmdate( 'Y-m-d H:i:s', strtotime( '-1 week' ) );
+ $yesterday = gmdate( 'Y-m-d H:i:s', strtotime( '-1 day' ) );
+
+ // Create a post dated last week.
+ $post_id = $this->factory()->post->create( array( 'post_date' => $last_week ) );
+
+ // Create a comment dated yesterday.
+ $this->factory()->comment->create(
+ array(
+ 'comment_post_ID' => $post_id,
+ 'comment_date' => $yesterday,
+ )
+ );
+
+ // The Last-Modified header should have the comment's date when "withcomments=1" is passed.
+ add_filter(
+ 'wp_headers',
+ function( $headers ) use ( $yesterday ) {
+ $this->assertSame(
+ strtotime( $headers['Last-Modified'] ),
+ strtotime( $yesterday ),
+ 'Last-Modified was not the date of the comment'
+ );
+ return $headers;
+ }
+ );
+
+ $this->go_to( '/?feed=rss2&withcomments=1' );
+ }
+
+ /**
+ * Test that the Last-Modified is the latest post's date when an earlier post and comment exist,
+ * and the "withcomments=1" query var is passed.
+ *
+ * @ticket 47968
+ *
+ * @covers ::send_headers
+ */
+ public function test_feed_last_modified_should_be_the_date_of_a_post_that_is_the_latest_update_when_withcomments_is_passed() {
+ $last_week = gmdate( 'Y-m-d H:i:s', strtotime( '-1 week' ) );
+ $yesterday = gmdate( 'Y-m-d H:i:s', strtotime( '-1 day' ) );
+ $today = gmdate( 'Y-m-d H:i:s' );
+
+ // Create a post dated last week.
+ $post_id = $this->factory()->post->create( array( 'post_date' => $last_week ) );
+
+ // Create a comment dated yesterday.
+ $this->factory()->comment->create(
+ array(
+ 'comment_post_ID' => $post_id,
+ 'comment_date' => $yesterday,
+ )
+ );
+
+ // Create a post dated today.
+ $this->factory()->post->create( array( 'post_date' => $today ) );
+
+ // The Last-Modified header should have the date from today's post when it is the latest update.
+ add_filter(
+ 'wp_headers',
+ function( $headers ) use ( $today ) {
+ $this->assertSame(
+ strtotime( $headers['Last-Modified'] ),
+ strtotime( $today ),
+ 'Last-Modified was not the date of the most recent most'
+ );
+ return $headers;
+ }
+ );
+
+ $this->go_to( '/?feed=rss2&withcomments=1' );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre>
</div>
</div>
</body>
</html>