support testing for result order

Author: notbakaneko

app/Libraries/Search/BeatmapsetSearch.php

@@ -63,20 +63,30 @@ public function getQuery()
         $query = new BoolQuery();
 
         if (!empty($this->tokens['include'])) {
+            $implodedInclude = implode(' ', $this->tokens['include']);
             // the subscoping is not necessary but prevents unintentional accidents when combining other matchers
             $boolQuery = new BoolQuery()
-                // results must contain at least one of the terms and boosted by containing all of them,
-                // or match the id of the beatmapset.
+                // results boosted by containing all terms, or match the id of the beatmapset.
                 ->shouldMatch(1)
-                ->should(['term' => ['_id' => ['value' => implode(' ', $this->tokens['include']), 'boost' => 100]]]);
+                ->should(['term' => ['_id' => ['value' => $implodedInclude, 'boost' => 100]]])
+                ->should([
+                    'multi_match' => [
+                        'fields' => $fullMatchFields,
+                        'type' => 'phrase',
+                        'query' => $implodedInclude,
+                    ],
+                ]);
 
+            // Look for maybe relevant results.
+            // "Something like this but I'm not exactly sure" kind of search.
             foreach ($this->tokens['include'] as $include) {
                 $isQuoted = static::isQuoted($include);
                 $boolQuery
                     ->should([
                         'multi_match' => [
+                            'boost' => $isQuoted ? 1 : 1 / count($this->tokens['include']),
                             'fields' => $isQuoted ? $fullMatchFields : $partialMatchFields,
-                            'type' => $isQuoted ? 'phrase' : 'most_fields',
+                            'type' => $isQuoted ? 'phrase' : 'cross_fields',
                             'query' => $include,
                         ],
                     ])

database/factories/BeatmapsetFactory.php

@@ -47,6 +47,12 @@ public function definition(): array
         ];
     }
 
+    // Set values that can affect search scoring to a consistent value.
+    public function consistent()
+    {
+        return $this->state(['favourite_count' => 0]);
+    }
+
     public function deleted()
     {
         return $this->state(['deleted_at' => now()]);

tests/Libraries/Search/BeatmapsetSearch/QueryStringTest.php

@@ -13,17 +13,16 @@ class QueryStringTest extends TestCase
 {
     public static function dataProvider(): array
     {
-        // TODO: support scoring order in tests.
         return [
             [['q' => ''], [0, 1, 2, 3]],
             [['q' => '2'], [1]], // id only search.
             [['q' => '2 3'], []], // putting more than one id becomes a normal string search.
-            [['q' => 'triangles'], [0, 1, 3]],
+            [['q' => 'triangles'], [0, 1, 3], true],
             [['q' => '-triangles'], [2]],
-            [['q' => 'triangles -revival'], [0, 3]],
+            [['q' => 'triangles -revival'], [0, 3], true],
             [['q' => 'cross circle'], [2, 3]],
             [['q' => 'cross -circle'], []], // exclusion shouldn't add new matches.
-            [['q' => 'tri'], [0, 1, 3]],
+            [['q' => 'tri'], [0, 1, 3], true],
             [['q' => 'tri -circ'], [0, 1, 3]],
             [['q' => 'tri -circle'], [0, 1, 3]],
             [['q' => '-tri'], [0, 1, 2, 3]],
@@ -34,7 +33,7 @@ public static function setUpBeforeClass(): void
     {
         static::withDbAccess(function () {
             // use something besides empty string so it doesn't match empty string.
-            $factory = Beatmapset::factory()->state(['artist' => 'a', 'creator' => 'a'])->ranked()->withBeatmaps();
+            $factory = Beatmapset::factory()->consistent()->state(['artist' => 'a', 'creator' => 'a'])->ranked()->withBeatmaps();
             static::$beatmapsets = [
                 $factory->create(['title' => 'Triangles']),
                 $factory->create(['title' => 'Triangles Revival']),

tests/Libraries/Search/BeatmapsetSearch/TestCase.php

@@ -74,12 +74,11 @@ public static function tearDownAfterClass(): void
     }
 
     #[DataProvider('dataProvider')]
-    public function testSearch(array $params, array $expected): void
+    public function testSearch(array $params, array $expected, ?bool $order = null): void
     {
-        $this->assertEqualsCanonicalizing(
-            array_map(fn (int $index) => static::$beatmapsets[$index]->getKey(), $expected),
-            new BeatmapsetSearch(new BeatmapsetSearchRequestParams($params))->response()->ids()
-        );
+        $ids = new BeatmapsetSearch(new BeatmapsetSearchRequestParams($params))->response()->ids();
+        $method = $order ?? false ? 'assertEquals' : 'assertEqualsCanonicalizing';
+        $this->$method(array_map(fn (int $index) => static::$beatmapsets[$index]->getKey(), $expected), $ids);
     }
 
     protected function setUp(): void

tests/Libraries/Search/BeatmapsetSearch/TitleFilterTest.php

@@ -14,29 +14,30 @@ class TitleFilterTest extends TestCase
     public static function dataProvider(): array
     {
         return [
-            [['q' => 'best'], [0, 1, 2, 3]],
-            [['q' => 'best beatmap'], [0, 1, 2, 3]],
-            [['q' => '"best beatmap"'], [1, 2]],
+            [['q' => 'best'], [0, 1, 2, 3, 4]],
+            [['q' => 'best beatmap'], [3, 1, 2, 0, 4], true],
+            [['q' => '"best beatmap"'], [3, 1, 2], true],
             [['q' => '-best'], []],
             [['q' => '-best -beatmap'], []],
-            [['q' => '-"best beatmap"'], [0, 3]],
+            [['q' => '-"best beatmap"'], [0, 4]],
 
-            [['q' => 'title=best'], [0, 1, 2]],
-            [['q' => 'title="best beatmap"'], [1, 2]],
-            [['q' => 'title="the beatmap"'], [1, 2]],
-            [['q' => 'title=""best beatmap""'], [1, 2]],
+            [['q' => 'title=best'], [0, 1, 2, 3]],
+            [['q' => 'title="best beatmap"'], [1, 2, 3]],
+            [['q' => 'title="the beatmap"'], [2, 1], true],
+            [['q' => 'title=""best beatmap""'], [3, 2, 1], true],
             [['q' => 'title=""the beatmap""'], []],
         ];
     }
 
     public static function setUpBeforeClass(): void
     {
         static::withDbAccess(function () {
-            $factory = Beatmapset::factory()->ranked()->withBeatmaps();
+            $factory = Beatmapset::factory()->consistent()->ranked()->withBeatmaps();
             static::$beatmapsets = [
                 $factory->create(['title' => 'best']),
                 $factory->create(['title' => 'the best beatmap']),
-                $factory->create(['title_unicode' => 'the best beatmapよ']),
+                $factory->create(['title_unicode' => 'the best beatmapよ']), // this sets title as well, giving it higher field relevancy scoring.
+                $factory->create(['title' => 'best beatmap']),
                 $factory->create(['artist' => 'the best artist']),
             ];
         });