Changeset 40122 for trunk/tests/phpunit/tests/rest-api/rest-posts-controller.php

Timestamp:

02/25/2017 05:02:17 AM (8 years ago)

Author:

jnylen0

Message:

REST API: Fix behavior of sticky posts filter when no posts are sticky.

Previously, when getting posts from the API with sticky=true, if there were no sticky posts set, the query would return all posts as if the sticky argument was not set. In this situation, the query should return an empty array instead.

A sticky=true query that should return an empty array (in the previous situation, or with include and no intersecting post IDs) was also broken in that it would query the post with ID 1.

Finally, this commit significantly improves test coverage for the sticky filter argument, including direct testing of the WHERE clauses generated by WP_Query.

Props ryelle.
Fixes #39947.

File:

• trunk/tests/phpunit/tests/rest-api/rest-posts-controller.php (modified) (9 diffs)

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

@@ -21 +21 @@
 
     protected $forbidden_cat;
-    protected $posts_orderby;
+    protected $posts_clauses;
 
     public static function wpSetUpBeforeClass( $factory ) {
@@ -69 +69 @@
         register_post_type( 'youseeme', array( 'supports' => array(), 'show_in_rest' => true ) );
         add_filter( 'rest_pre_dispatch', array( $this, 'wpSetUpBeforeRequest' ), 10, 3 );
-        add_filter( 'posts_orderby', array( $this, 'save_posts_orderby' ), 10, 2 );
+        add_filter( 'posts_clauses', array( $this, 'save_posts_clauses' ), 10, 2 );
     }
 
     public function wpSetUpBeforeRequest( $result, $server, $request ) {
-        $this->posts_orderby = array();
+        $this->posts_clauses = array();
         return $result;
     }
 
-    public function save_posts_orderby( $orderby, $query ) {
-        array_push( $this->posts_orderby, $orderby );
+    public function save_posts_clauses( $orderby, $query ) {
+        array_push( $this->posts_clauses, $orderby );
         return $orderby;
     }
 
+    public function assertPostsClause( $clause, $pattern ) {
+        global $wpdb;
+        $expected_clause = str_replace( '{posts}', $wpdb->posts, $pattern );
+        $this->assertCount( 1, $this->posts_clauses );
+        $this->assertEquals( $expected_clause, $this->posts_clauses[0][ $clause ] );
+    }
+
     public function assertPostsOrderedBy( $pattern ) {
-        global $wpdb;
-        $orderby = str_replace( '{posts}', $wpdb->posts, $pattern );
-        $this->assertEquals( array( $orderby ), $this->posts_orderby );
+        $this->assertPostsClause( 'orderby', $pattern );
+    }
+
+    public function assertPostsWhere( $pattern ) {
+        $this->assertPostsClause( 'where', $pattern );
     }
 
@@ -691 +700 @@
     }
 
-    public function test_get_items_sticky_query() {
+    public function test_get_items_sticky() {
         $id1 = self::$post_id;
         $id2 = $this->factory->post->create( array( 'post_status' => 'publish' ) );
@@ -712 +721 @@
     }
 
-    public function test_get_items_sticky_with_post__in_query() {
+    public function test_get_items_sticky_with_include() {
         $id1 = self::$post_id;
         $id2 = $this->factory->post->create( array( 'post_status' => 'publish' ) );
@@ -726 +735 @@
         $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->posts_clauses = array_slice( $this->posts_clauses, 0, 1 );
+
+        $this->assertPostsWhere( " AND {posts}.ID IN (0) AND {posts}.post_type = 'post' AND (({posts}.post_status = 'publish'))" );
+
         update_option( 'sticky_posts', array( $id1, $id2 ) );
 
@@ -739 +754 @@
         $post = $posts[0];
         $this->assertEquals( $id1, $post['id'] );
-    }
-
-    public function test_get_items_not_sticky_query() {
+
+        $this->assertPostsWhere( " AND {posts}.ID IN ($id1) AND {posts}.post_type = 'post' AND (({posts}.post_status = 'publish'))" );
+    }
+
+    public function test_get_items_sticky_no_sticky_posts() {
+        $id1 = self::$post_id;
+
+        update_option( 'sticky_posts', array() );
+
+        $request = new WP_REST_Request( 'GET', '/wp/v2/posts' );
+        $request->set_param( 'sticky', true );
+
+        $response = $this->server->dispatch( $request );
+        $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->posts_clauses = array_slice( $this->posts_clauses, 0, 1 );
+
+        $this->assertPostsWhere( " AND {posts}.ID IN (0) AND {posts}.post_type = 'post' AND (({posts}.post_status = 'publish'))" );
+    }
+
+    public function test_get_items_sticky_with_include_no_sticky_posts() {
+        $id1 = self::$post_id;
+
+        update_option( 'sticky_posts', array() );
+
+        $request = new WP_REST_Request( 'GET', '/wp/v2/posts' );
+        $request->set_param( 'sticky', true );
+        $request->set_param( 'include', array( $id1 ) );
+
+        $response = $this->server->dispatch( $request );
+        $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->posts_clauses = array_slice( $this->posts_clauses, 0, 1 );
+
+        $this->assertPostsWhere( " AND {posts}.ID IN (0) AND {posts}.post_type = 'post' AND (({posts}.post_status = 'publish'))" );
+    }
+
+    public function test_get_items_not_sticky() {
         $id1 = self::$post_id;
         $id2 = $this->factory->post->create( array( 'post_status' => 'publish' ) );
@@ -756 +810 @@
         $post = $posts[0];
         $this->assertEquals( $id1, $post['id'] );
-    }
-
-    public function test_get_items_sticky_with_post__not_in_query() {
+
+        $this->assertPostsWhere( " AND {posts}.ID NOT IN ($id2) AND {posts}.post_type = 'post' AND (({posts}.post_status = 'publish'))" );
+    }
+
+    public function test_get_items_not_sticky_with_exclude() {
         $id1 = self::$post_id;
         $id2 = $this->factory->post->create( array( 'post_status' => 'publish' ) );
@@ -775 +831 @@
         $post = $posts[0];
         $this->assertEquals( $id1, $post['id'] );
+
+        $this->assertPostsWhere( " AND {posts}.ID NOT IN ($id3,$id2) AND {posts}.post_type = 'post' AND (({posts}.post_status = 'publish'))" );
+    }
+
+    public function test_get_items_not_sticky_with_exclude_no_sticky_posts() {
+        $id1 = self::$post_id;
+        $id2 = $this->factory->post->create( array( 'post_status' => 'publish' ) );
+        $id3 = $this->factory->post->create( array( 'post_status' => 'publish' ) );
+
+        update_option( 'sticky_posts', array() );
+
+        $request = new WP_REST_Request( 'GET', '/wp/v2/posts' );
+        $request->set_param( 'sticky', false );
+        $request->set_param( 'exclude', array( $id3 ) );
+
+        $response = $this->server->dispatch( $request );
+        $this->assertCount( 2, $response->get_data() );
+
+        $posts = $response->get_data();
+        $ids = wp_list_pluck( $posts, 'id' );
+        sort( $ids );
+        $this->assertEquals( array( $id1, $id2 ), $ids );
+
+        $this->assertPostsWhere( " AND {posts}.ID NOT IN ($id3) AND {posts}.post_type = 'post' AND (({posts}.post_status = 'publish'))" );
     }
 
@@ -2971 +3051 @@
         }
         remove_filter( 'rest_pre_dispatch', array( $this, 'wpSetUpBeforeRequest' ), 10, 3 );
-        remove_filter( 'posts_orderby', array( $this, 'save_posts_orderby' ), 10, 2 );
+        remove_filter( 'posts_clauses', array( $this, 'save_posts_clauses' ), 10, 2 );
         parent::tearDown();
     }