[10.x] Add 'makeSearchableUsing' method (to allow eager loading when making specific models searchable) (#732)

* Add 'makeSearchableUsing' method

* Update Searchable.php

* Update types in docblock

* Update Searchable.php

---------

Co-authored-by: Taylor Otwell <[email protected]>

Author: gdebrauwer

src/Jobs/MakeSearchable.php

@@ -39,6 +39,6 @@ public function handle()
             return;
         }
 
-        $this->models->first()->searchableUsing()->update($this->models);
+        $this->models->first()->makeSearchableUsing($this->models)->first()->searchableUsing()->update($this->models);
     }
 }

src/Searchable.php

@@ -60,7 +60,7 @@ public function queueMakeSearchable($models)
         }
 
         if (! config('scout.queue')) {
-            return $models->first()->searchableUsing()->update($models);
+            return $models->first()->makeSearchableUsing($models)->first()->searchableUsing()->update($models);
         }
 
         dispatch((new Scout::$makeSearchableJob($models))
@@ -151,6 +151,17 @@ public static function makeAllSearchable($chunk = null)
             ->searchable($chunk);
     }
 
+    /**
+     * Modify the collection of models being made searchable.
+     *
+     * @param  \Illuminate\Support\Collection  $models
+     * @return \Illuminate\Support\Collection
+     */
+    protected function makeSearchableUsing(BaseCollection $models)
+    {
+        return $models;
+    }
+
     /**
      * Modify the query used to retrieve models when making all of the models searchable.
      *

tests/Feature/SearchableTest.php

@@ -20,6 +20,7 @@ public function test_searchable_using_update_is_called_on_collection()
     {
         $collection = m::mock();
         $collection->shouldReceive('isEmpty')->andReturn(false);
+        $collection->shouldReceive('first->makeSearchableUsing')->with($collection)->andReturn($collection);
         $collection->shouldReceive('first->searchableUsing->update')->with($collection);
 
         $model = new SearchableModel();

tests/Unit/MakeSearchableTest.php

@@ -20,6 +20,7 @@ public function test_handle_passes_the_collection_to_engine()
             $model = m::mock(),
         ]));
 
+        $model->shouldReceive('makeSearchableUsing')->with($collection)->andReturn($collection);
         $model->shouldReceive('searchableUsing->update')->with($collection);
 
         $job->handle();