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

Timestamp:

09/17/2024 09:56:18 PM (4 weeks ago)

Author:

flixos90

Message:

REST API: Support exact search in the REST API posts endpoint.

This changeset adds support for a new search_semantics enum query parameter that can be passed alongside the search string parameter. At this point, it only supports "exact" as possible value, but an enum is used for forward compatibility with potential enhancements like "sentence" search support. If search_semantics=exact is passed, it will look for an exact match rather than do a full text search, which for some use-cases is more appropriate and more performant.

Props mehulkaklotar, timothyblynjacobs, jimmyh61, ironprogrammer, johnregan3, mukesh27, costdev.
Fixes #56350.

File:

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

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

@@ -207 +207 @@
                 'search',
                 'search_columns',
+                'search_semantics',
                 'slug',
                 'status',
@@ -764 +765 @@
             $this->assertNotEquals( $draft_id, $post['id'] );
         }
+    }
+
+    /**
+     * @ticket 56350
+     *
+     * @dataProvider data_get_items_exact_search
+     *
+     * @param string $search_term  The search term.
+     * @param bool   $exact_search Whether the search is an exact or general search.
+     * @param int    $expected     The expected number of matching posts.
+     */
+    public function test_get_items_exact_search( $search_term, $exact_search, $expected ) {
+        self::factory()->post->create(
+            array(
+                'post_title'   => 'Rye',
+                'post_content' => 'This is a post about Rye Bread',
+            )
+        );
+
+        self::factory()->post->create(
+            array(
+                'post_title'   => 'Types of Bread',
+                'post_content' => 'Types of bread are White and Rye Bread',
+            )
+        );
+
+        $request           = new WP_REST_Request( 'GET', '/wp/v2/posts' );
+        $request['search'] = $search_term;
+        if ( $exact_search ) {
+            $request['search_semantics'] = 'exact';
+        }
+        $response = rest_get_server()->dispatch( $request );
+        $this->assertCount( $expected, $response->get_data() );
+    }
+
+    /**
+     * Data provider for test_get_items_exact_search().
+     *
+     * @return array[]
+     */
+    public function data_get_items_exact_search() {
+        return array(
+            'general search, one exact match and one partial match' => array(
+                'search_term'  => 'Rye',
+                'exact_search' => false,
+                'expected'     => 2,
+            ),
+            'exact search, one exact match and one partial match' => array(
+                'search_term'  => 'Rye',
+                'exact_search' => true,
+                'expected'     => 1,
+            ),
+            'exact search, no match and one partial match' => array(
+                'search_term'  => 'Rye Bread',
+                'exact_search' => true,
+                'expected'     => 0,
+            ),
+        );
     }