Changeset 53498

Timestamp:

06/14/2022 12:40:29 PM (4 years ago)

Author:

spacedmonkey

Message:

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 #55677.

Location:

trunk

Files:

• src/wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php (modified) (1 diff)
• tests/phpunit/tests/rest-api/rest-attachments-controller.php (modified) (3 diffs)
• tests/phpunit/tests/rest-api/rest-posts-controller.php (modified) (3 diffs)

trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php

@@ -389 +389 @@
                 $total_posts = $posts_query->found_posts;
 
-                if ( $total_posts < 1 ) {
+                if ( $total_posts < 1 && $page > 1 ) {
                         // Out-of-bounds, run the query again without LIMIT for total count.
                         unset( $query_args['paged'] );

trunk/tests/phpunit/tests/rest-api/rest-attachments-controller.php

@@ -30 +30 @@
         private $test_file2;
 
+        /**
+         * @var array The recorded posts query clauses.
+         */
+        protected $posts_clauses;
+
         public static function wpSetUpBeforeClass( WP_UnitTest_Factory $factory ) {
                 self::$superadmin_id  = $factory->user->create(
@@ -86 +91 @@
                 $this->test_file2 = get_temp_dir() . 'codeispoetry.png';
                 copy( $orig_file2, $this->test_file2 );
+
+                add_filter( 'rest_pre_dispatch', array( $this, 'wpSetUpBeforeRequest' ), 10, 3 );
+                add_filter( 'posts_clauses', array( $this, 'save_posts_clauses' ), 10, 2 );
+        }
+
+        public function wpSetUpBeforeRequest( $result ) {
+                $this->posts_clauses = array();
+                return $result;
+        }
+
+        public function save_posts_clauses( $clauses ) {
+                $this->posts_clauses[] = $clauses;
+                return $clauses;
         }
 
@@ -618 +636 @@
                 $this->assertCount( 1, $data );
                 $this->assertSame( $id2, $data[0]['id'] );
+        }
+
+        /**
+         * @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 );
         }
 

trunk/tests/phpunit/tests/rest-api/rest-posts-controller.php

@@ -1386 +1386 @@
                 $this->assertCount( 0, $response->get_data() );
 
-                // FIXME Since this request returns zero posts, the query is executed twice.
-                $this->assertCount( 2, $this->posts_clauses );
+                $this->assertCount( 1, $this->posts_clauses );
                 $this->posts_clauses = array_slice( $this->posts_clauses, 0, 1 );
 
@@ -1418 +1417 @@
                 $this->assertCount( 0, $response->get_data() );
 
-                // FIXME Since this request returns zero posts, the query is executed twice.
-                $this->assertCount( 2, $this->posts_clauses );
+                $this->assertCount( 1, $this->posts_clauses );
                 $this->posts_clauses = array_slice( $this->posts_clauses, 0, 1 );
 
@@ -1437 +1435 @@
                 $this->assertCount( 0, $response->get_data() );
 
-                // FIXME Since this request returns zero posts, the query is executed twice.
-                $this->assertCount( 2, $this->posts_clauses );
+                $this->assertCount( 1, $this->posts_clauses );
                 $this->posts_clauses = array_slice( $this->posts_clauses, 0, 1 );