Override attributesToRetrieve config to ensure search result is complete (#751)

Author: mmachatschek

src/Builder.php

@@ -79,7 +79,7 @@ class Builder
     /**
      * Extra options that should be applied to the search.
      *
-     * @var int
+     * @var array
      */
     public $options = [];
 

src/Engines/MeilisearchEngine.php

@@ -143,6 +143,13 @@ protected function performSearch(Builder $builder, array $searchParams = [])
 
         $searchParams = array_merge($builder->options, $searchParams);
 
+        if (array_key_exists('attributesToRetrieve', $searchParams)) {
+            $searchParams['attributesToRetrieve'] = array_merge(
+                [$builder->model->getScoutKeyName()],
+                $searchParams['attributesToRetrieve'],
+            );
+        }
+
         if ($builder->callback) {
             $result = call_user_func(
                 $builder->callback,

tests/Unit/MeilisearchEngineTest.php

@@ -130,6 +130,25 @@ public function test_search_sends_correct_parameters_to_meilisearch()
         $engine->search($builder);
     }
 
+    public function test_search_includes_at_least_scoutKeyName_in_attributesToRetrieve_on_builder_options()
+    {
+        $client = m::mock(Client::class);
+        $client->shouldReceive('index')->with('table')->andReturn($index = m::mock(Indexes::class));
+        $index->shouldReceive('search')->with('mustang', [
+            'filter' => 'foo=1 AND bar=2',
+            'attributesToRetrieve' => ['id', 'foo'],
+        ]);
+
+        $engine = new MeilisearchEngine($client);
+        $builder = new Builder(new SearchableModel(), 'mustang', function ($meilisearch, $query, $options) {
+            $options['filter'] = 'foo=1 AND bar=2';
+
+            return $meilisearch->search($query, $options);
+        });
+        $builder->options = ['attributesToRetrieve' => ['foo']];
+        $engine->search($builder);
+    }
+
     public function test_submitting_a_callable_search_with_search_method_returns_array()
     {
         $builder = new Builder(