<!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>[53498] trunk: REST API: Avoid duplicated query in post collections.</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/53498">53498</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/53498","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>spacedmonkey</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2022-06-14 12:40:29 +0000 (Tue, 14 Jun 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'>REST API: Avoid duplicated query in post collections.
Avoid duplicated query when retrieving empty posts collections by adding a check if the page is more than 1.
Props furi3r, gdetassigny, TimothyBlynJacobs, spacedmonkey.
Fixes <a href="https://core.trac.wordpress.org/ticket/55677">#55677</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesrestapiendpointsclasswprestpostscontrollerphp">trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php</a></li>
<li><a href="#trunktestsphpunittestsrestapirestattachmentscontrollerphp">trunk/tests/phpunit/tests/rest-api/rest-attachments-controller.php</a></li>
<li><a href="#trunktestsphpunittestsrestapirestpostscontrollerphp">trunk/tests/phpunit/tests/rest-api/rest-posts-controller.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesrestapiendpointsclasswprestpostscontrollerphp"></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/rest-api/endpoints/class-wp-rest-posts-controller.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php 2022-06-14 11:44:58 UTC (rev 53497)
+++ trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php 2022-06-14 12:40:29 UTC (rev 53498)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -388,7 +388,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $page = (int) $query_args['paged'];
</span><span class="cx" style="display: block; padding: 0 10px"> $total_posts = $posts_query->found_posts;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( $total_posts < 1 ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( $total_posts < 1 && $page > 1 ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> // Out-of-bounds, run the query again without LIMIT for total count.
</span><span class="cx" style="display: block; padding: 0 10px"> unset( $query_args['paged'] );
</span><span class="cx" style="display: block; padding: 0 10px">
</span></span></pre></div>
<a id="trunktestsphpunittestsrestapirestattachmentscontrollerphp"></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/rest-api/rest-attachments-controller.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/rest-api/rest-attachments-controller.php 2022-06-14 11:44:58 UTC (rev 53497)
+++ trunk/tests/phpunit/tests/rest-api/rest-attachments-controller.php 2022-06-14 12:40:29 UTC (rev 53498)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -29,6 +29,11 @@
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> private $test_file2;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * @var array The recorded posts query clauses.
+ */
+ protected $posts_clauses;
+
</ins><span class="cx" style="display: block; padding: 0 10px"> public static function wpSetUpBeforeClass( WP_UnitTest_Factory $factory ) {
</span><span class="cx" style="display: block; padding: 0 10px"> self::$superadmin_id = $factory->user->create(
</span><span class="cx" style="display: block; padding: 0 10px"> array(
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -85,8 +90,21 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $orig_file2 = DIR_TESTDATA . '/images/codeispoetry.png';
</span><span class="cx" style="display: block; padding: 0 10px"> $this->test_file2 = get_temp_dir() . 'codeispoetry.png';
</span><span class="cx" style="display: block; padding: 0 10px"> copy( $orig_file2, $this->test_file2 );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ add_filter( 'rest_pre_dispatch', array( $this, 'wpSetUpBeforeRequest' ), 10, 3 );
+ add_filter( 'posts_clauses', array( $this, 'save_posts_clauses' ), 10, 2 );
</ins><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">+ public function wpSetUpBeforeRequest( $result ) {
+ $this->posts_clauses = array();
+ return $result;
+ }
+
+ public function save_posts_clauses( $clauses ) {
+ $this->posts_clauses[] = $clauses;
+ return $clauses;
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> public function tear_down() {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( file_exists( $this->test_file ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> unlink( $this->test_file );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -619,6 +637,48 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertSame( $id2, $data[0]['id'] );
</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">+ /**
+ * @ticket 55677
+ */
+ public function test_get_items_avoid_duplicated_count_query_if_no_items() {
+ $request = new WP_REST_Request( 'GET', '/wp/v2/media' );
+ $request->set_param( 'media_type', 'video' );
+
+ $response = rest_get_server()->dispatch( $request );
+
+ $this->assertCount( 1, $this->posts_clauses );
+
+ $headers = $response->get_headers();
+
+ $this->assertSame( 0, $headers['X-WP-Total'] );
+ $this->assertSame( 0, $headers['X-WP-TotalPages'] );
+ }
+
+ /**
+ * @ticket 55677
+ */
+ public function test_get_items_with_empty_page_runs_count_query_after() {
+ $this->factory->attachment->create_object(
+ $this->test_file,
+ 0,
+ array(
+ 'post_date' => '2022-06-12T00:00:00Z',
+ 'post_mime_type' => 'image/jpeg',
+ 'post_excerpt' => 'A sample caption',
+ )
+ );
+
+ $request = new WP_REST_Request( 'GET', '/wp/v2/media' );
+ $request->set_param( 'media_type', 'image' );
+ $request->set_param( 'page', 2 );
+
+ $response = rest_get_server()->dispatch( $request );
+
+ $this->assertCount( 2, $this->posts_clauses );
+
+ $this->assertErrorResponse( 'rest_post_invalid_page_number', $response, 400 );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> public function test_get_item() {
</span><span class="cx" style="display: block; padding: 0 10px"> $attachment_id = $this->factory->attachment->create_object(
</span><span class="cx" style="display: block; padding: 0 10px"> $this->test_file,
</span></span></pre></div>
<a id="trunktestsphpunittestsrestapirestpostscontrollerphp"></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/rest-api/rest-posts-controller.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/rest-api/rest-posts-controller.php 2022-06-14 11:44:58 UTC (rev 53497)
+++ trunk/tests/phpunit/tests/rest-api/rest-posts-controller.php 2022-06-14 12:40:29 UTC (rev 53498)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1385,8 +1385,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $response = rest_get_server()->dispatch( $request );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertCount( 0, $response->get_data() );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // FIXME Since this request returns zero posts, the query is executed twice.
- $this->assertCount( 2, $this->posts_clauses );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->assertCount( 1, $this->posts_clauses );
</ins><span class="cx" style="display: block; padding: 0 10px"> $this->posts_clauses = array_slice( $this->posts_clauses, 0, 1 );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertPostsWhere( " AND {posts}.ID IN (0) AND {posts}.post_type = 'post' AND (({posts}.post_status = 'publish'))" );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1417,8 +1416,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $response = rest_get_server()->dispatch( $request );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertCount( 0, $response->get_data() );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // FIXME Since this request returns zero posts, the query is executed twice.
- $this->assertCount( 2, $this->posts_clauses );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->assertCount( 1, $this->posts_clauses );
</ins><span class="cx" style="display: block; padding: 0 10px"> $this->posts_clauses = array_slice( $this->posts_clauses, 0, 1 );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertPostsWhere( " AND {posts}.ID IN (0) AND {posts}.post_type = 'post' AND (({posts}.post_status = 'publish'))" );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1436,8 +1434,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $response = rest_get_server()->dispatch( $request );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertCount( 0, $response->get_data() );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // FIXME Since this request returns zero posts, the query is executed twice.
- $this->assertCount( 2, $this->posts_clauses );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->assertCount( 1, $this->posts_clauses );
</ins><span class="cx" style="display: block; padding: 0 10px"> $this->posts_clauses = array_slice( $this->posts_clauses, 0, 1 );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertPostsWhere( " AND {posts}.ID IN (0) AND {posts}.post_type = 'post' AND (({posts}.post_status = 'publish'))" );
</span></span></pre>
</div>
</div>
</body>
</html>