Add metadata to lazyMap() for both engines as well

laravel · Nov 16, 2023 · 1fa2842 · 1fa2842
1 parent 1a70aca
commit 1fa2842
Show file tree

Hide file tree

Showing 4 changed files with 30 additions and 4 deletions.
diff --git a/src/Engines/AlgoliaEngine.php b/src/Engines/AlgoliaEngine.php
@@ -246,6 +246,16 @@ public function lazyMap(Builder $builder, $results, $model)
             $builder, $objectIds
         )->cursor()->filter(function ($model) use ($objectIds) {
             return in_array($model->getScoutKey(), $objectIds);
+        })->map(function ($model) use ($results, $objectIdPositions) {
+            $result = $results['hits'][$objectIdPositions[$model->getScoutKey()]] ?? [];
+
+            foreach ($result as $key => $value) {
+                if (substr($key, 0, 1) === '_') {
+                    $model->withScoutMetadata($key, $value);
+                }
+            }
+
+            return $model;
         })->sortBy(function ($model) use ($objectIdPositions) {
             return $objectIdPositions[$model->getScoutKey()];
         })->values();

diff --git a/src/Engines/MeilisearchEngine.php b/src/Engines/MeilisearchEngine.php
@@ -329,6 +329,16 @@ public function lazyMap(Builder $builder, $results, $model)
             $builder, $objectIds
         )->cursor()->filter(function ($model) use ($objectIds) {
             return in_array($model->getScoutKey(), $objectIds);
+        })->map(function ($model) use ($results, $objectIdPositions) {
+            $result = $results['hits'][$objectIdPositions[$model->getScoutKey()]] ?? [];
+
+            foreach ($result as $key => $value) {
+                if (substr($key, 0, 1) === '_') {
+                    $model->withScoutMetadata($key, $value);
+                }
+            }
+
+            return $model;
         })->sortBy(function ($model) use ($objectIdPositions) {
             return $objectIdPositions[$model->getScoutKey()];
         })->values();

diff --git a/tests/Unit/AlgoliaEngineTest.php b/tests/Unit/AlgoliaEngineTest.php
@@ -216,16 +216,18 @@ public function test_lazy_map_correctly_maps_results_to_models()
 
         $model = m::mock(stdClass::class);
         $model->shouldReceive('queryScoutModelsByIds->cursor')->andReturn($models = LazyCollection::make([
-            new SearchableModel(['id' => 1]),
+            new SearchableModel(['id' => 1, 'name' => 'test']),
         ]));
 
         $builder = m::mock(Builder::class);
 
         $results = $engine->lazyMap($builder, ['nbHits' => 1, 'hits' => [
-            ['objectID' => 1, 'id' => 1],
+            ['objectID' => 1, 'id' => 1, '_rankingInfo' => ['nbTypos' => 0]],
         ]], $model);
 
         $this->assertCount(1, $results);
+        $this->assertEquals(['id' => 1, 'name' => 'test'], $results->first()->toArray());
+        $this->assertEquals(['_rankingInfo' => ['nbTypos' => 0]], $results->first()->scoutMetaData());
     }
 
     public function test_lazy_map_method_respects_order()

diff --git a/tests/Unit/MeilisearchEngineTest.php b/tests/Unit/MeilisearchEngineTest.php
@@ -346,17 +346,21 @@ public function test_lazy_map_correctly_maps_results_to_models()
 
         $model = m::mock(stdClass::class);
         $model->shouldReceive(['getScoutKeyName' => 'id']);
-        $model->shouldReceive('queryScoutModelsByIds->cursor')->andReturn($models = LazyCollection::make([new SearchableModel(['id' => 1])]));
+        $model->shouldReceive('queryScoutModelsByIds->cursor')->andReturn($models = LazyCollection::make([
+            new SearchableModel(['id' => 1, 'name' => 'test']),
+        ]));
         $builder = m::mock(Builder::class);
 
         $results = $engine->lazyMap($builder, [
             'totalHits' => 1,
             'hits' => [
-                ['id' => 1],
+                ['id' => 1, '_rankingScore' => 0.86],
             ],
         ], $model);
 
         $this->assertEquals(1, count($results));
+        $this->assertEquals(['id' => 1, 'name' => 'test'], $results->first()->toArray());
+        $this->assertEquals(['_rankingScore' => 0.86], $results->first()->scoutMetadata());
     }
 
     public function test_lazy_map_method_respects_order()