Supports for algolia/algoliasearch-client-php v4

.github/workflows/tests.yml

@@ -90,7 +90,8 @@ jobs:
            composer update --prefer-dist --no-interaction --no-progress
 
       - name: Execute tests
-        run: vendor/bin/phpunit --group external-network,meilisearch
+        run: vendor/bin/phpunit --no-configuration --no-coverage --color --bootstrap vendor/autoload.php --group meilisearch tests/Integration
         env:
           MEILISEARCH_HOST: "http://localhost:7700"
           MEILISEARCH_KEY: 'masterKey'
+          DB_CONNECTION: 'testing'

composer.json

@@ -25,7 +25,7 @@
         "symfony/console": "^6.0|^7.0"
     },
     "require-dev": {
-        "algolia/algoliasearch-client-php": "^3.2",
+        "algolia/algoliasearch-client-php": "^4.0",
         "typesense/typesense-php": "^4.9.3",
         "meilisearch/meilisearch-php": "^1.0",
         "mockery/mockery": "^1.0",

src/EngineManager.php

@@ -2,9 +2,10 @@
 
 namespace Laravel\Scout;
 
-use Algolia\AlgoliaSearch\Config\SearchConfig;
-use Algolia\AlgoliaSearch\SearchClient as Algolia;
-use Algolia\AlgoliaSearch\Support\UserAgent;
+use Algolia\AlgoliaSearch\Api\SearchClient as Algolia;
+use Algolia\AlgoliaSearch\Configuration\SearchConfig;
+use Algolia\AlgoliaSearch\Model\Ingestion\Event;
+use Algolia\AlgoliaSearch\Support\AlgoliaAgent;
 use Exception;
 use Illuminate\Support\Manager;
 use Laravel\Scout\Engines\AlgoliaEngine;
@@ -39,7 +40,7 @@ public function createAlgoliaDriver()
     {
         $this->ensureAlgoliaClientIsInstalled();
 
-        UserAgent::addCustomUserAgent('Laravel Scout', Scout::VERSION);
+        AlgoliaAgent::addAlgoliaAgent('Laravel Scout', 'Laravel Scout', Scout::VERSION);
 
         $config = SearchConfig::create(
             config('scout.algolia.id'),
@@ -61,7 +62,7 @@ public function createAlgoliaDriver()
         }
 
         if (is_int($batchSize = config('scout.algolia.batch_size'))) {
-            $config->setBatchSize($batchSize);
+            (new Event())->setBatchSize($batchSize);
         }
 
         return new AlgoliaEngine(Algolia::createWithConfig($config), config('scout.soft_delete'));

src/Engines/AlgoliaEngine.php

@@ -2,7 +2,7 @@
 
 namespace Laravel\Scout\Engines;
 
-use Algolia\AlgoliaSearch\SearchClient as Algolia;
+use Algolia\AlgoliaSearch\Api\SearchClient as Algolia;
 use Exception;
 use Illuminate\Database\Eloquent\SoftDeletes;
 use Illuminate\Support\LazyCollection;
@@ -14,7 +14,7 @@ class AlgoliaEngine extends Engine
     /**
      * The Algolia client.
      *
-     * @var \Algolia\AlgoliaSearch\SearchClient
+     * @var \Algolia\AlgoliaSearch\Api\SearchClient
      */
     protected $algolia;
 
@@ -28,7 +28,7 @@ class AlgoliaEngine extends Engine
     /**
      * Create a new engine instance.
      *
-     * @param  \Algolia\AlgoliaSearch\SearchClient  $algolia
+     * @param  \Algolia\AlgoliaSearch\Api\SearchClient  $algolia
      * @param  bool  $softDelete
      * @return void
      */
@@ -52,7 +52,7 @@ public function update($models)
             return;
         }
 
-        $index = $this->algolia->initIndex($models->first()->indexableAs());
+        $index = $models->first()->indexableAs();
 
         if ($this->usesSoftDelete($models->first()) && $this->softDelete) {
             $models->each->pushSoftDeleteMetadata();
@@ -71,7 +71,7 @@ public function update($models)
         })->filter()->values()->all();
 
         if (! empty($objects)) {
-            $index->saveObjects($objects);
+            $this->algolia->saveObjects($index, $objects);
         }
     }
 
@@ -87,13 +87,11 @@ public function delete($models)
             return;
         }
 
-        $index = $this->algolia->initIndex($models->first()->indexableAs());
-
         $keys = $models instanceof RemoveableScoutCollection
             ? $models->pluck($models->first()->getScoutKeyName())
             : $models->map->getScoutKey();
 
-        $index->deleteObjects($keys->all());
+        $this->algolia->deleteObjects($models->first()->indexableAs(), $keys->all());
     }
 
     /**
@@ -136,22 +134,24 @@ public function paginate(Builder $builder, $perPage, $page)
      */
     protected function performSearch(Builder $builder, array $options = [])
     {
-        $algolia = $this->algolia->initIndex(
-            $builder->index ?: $builder->model->searchableAs()
-        );
-
         $options = array_merge($builder->options, $options);
 
         if ($builder->callback) {
             return call_user_func(
                 $builder->callback,
-                $algolia,
+                $this->algolia,
                 $builder->query,
                 $options
             );
         }
 
-        return $algolia->search($builder->query, $options);
+        $queryParams = ['query' => $builder->query];
+
+        return $this->algolia->searchSingleIndex(
+            $builder->index ?: $builder->model->searchableAs(),
+            $queryParams,
+            $options
+        );
     }
 
     /**
@@ -280,9 +280,7 @@ public function getTotalCount($results)
      */
     public function flush($model)
     {
-        $index = $this->algolia->initIndex($model->indexableAs());
-
-        $index->clearObjects();
+        $this->algolia->clearObjects($model->indexableAs());
     }
 
     /**
@@ -307,7 +305,7 @@ public function createIndex($name, array $options = [])
      */
     public function deleteIndex($name)
     {
-        return $this->algolia->initIndex($name)->delete();
+        return $this->algolia->deleteIndex($name);
     }
 
     /**

tests/Integration/AlgoliaSearchableTest.php

@@ -2,13 +2,14 @@
 
 namespace Laravel\Scout\Tests\Integration;
 
-use Illuminate\Support\Env;
 use Laravel\Scout\Tests\Fixtures\User;
+use Orchestra\Testbench\Attributes\RequiresEnv;
 
 /**
  * @group algolia
  * @group external-network
  */
+#[RequiresEnv('ALGOLIA_APP_ID')]
 class AlgoliaSearchableTest extends TestCase
 {
     use SearchableTests;
@@ -21,10 +22,6 @@ class AlgoliaSearchableTest extends TestCase
      */
     protected function defineEnvironment($app)
     {
-        if (is_null(Env::get('ALGOLIA_APP_ID'))) {
-            $this->markTestSkipped();
-        }
-
         $this->defineScoutEnvironment($app);
     }
 

tests/Integration/MeilisearchSearchableTest.php

@@ -3,19 +3,20 @@
 namespace Laravel\Scout\Tests\Integration;
 
 use Illuminate\Database\Eloquent\Collection;
-use Illuminate\Support\Env;
 use Laravel\Scout\Builder;
 use Laravel\Scout\Engines\MeilisearchEngine;
 use Laravel\Scout\Tests\Fixtures\User;
 use Laravel\Scout\Tests\Fixtures\VersionableModel;
 use Meilisearch\Client;
 use Meilisearch\Endpoints\Indexes;
 use Mockery as m;
+use Orchestra\Testbench\Attributes\RequiresEnv;
 
 /**
  * @group meilisearch
  * @group external-network
  */
+#[RequiresEnv('MEILISEARCH_HOST')]
 class MeilisearchSearchableTest extends TestCase
 {
     use SearchableTests {
@@ -30,12 +31,6 @@ class MeilisearchSearchableTest extends TestCase
      */
     protected function defineEnvironment($app)
     {
-        if (is_null(Env::get('MEILISEARCH_HOST'))) {
-            $this->markTestSkipped();
-
-            return;
-        }
-
         $this->defineScoutEnvironment($app);
     }
 

tests/Integration/TypesenseSearchableTest.php

@@ -2,13 +2,14 @@
 
 namespace Laravel\Scout\Tests\Integration;
 
-use Illuminate\Support\Env;
 use Laravel\Scout\Tests\Fixtures\User;
+use Orchestra\Testbench\Attributes\RequiresEnv;
 
 /**
  * @group typesense
  * @group external-network
  */
+#[RequiresEnv('TYPESENSE_API_KEY')]
 class TypesenseSearchableTest extends TestCase
 {
     use SearchableTests;
@@ -21,10 +22,6 @@ class TypesenseSearchableTest extends TestCase
      */
     protected function defineEnvironment($app)
     {
-        if (is_null(Env::get('TYPESENSE_API_KEY'))) {
-            $this->markTestSkipped();
-        }
-
         $this->defineScoutEnvironment($app);
     }
 

tests/Unit/AlgoliaEngineTest.php

@@ -2,7 +2,7 @@
 
 namespace Laravel\Scout\Tests\Unit;
 
-use Algolia\AlgoliaSearch\SearchClient;
+use Algolia\AlgoliaSearch\Api\SearchClient;
 use Illuminate\Container\Container;
 use Illuminate\Database\Eloquent\Collection;
 use Illuminate\Support\Facades\Config;
@@ -48,8 +48,7 @@ public function test_update_adds_objects_to_index()
     public function test_delete_removes_objects_to_index()
     {
         $client = m::mock(SearchClient::class);
-        $client->shouldReceive('initIndex')->with('table')->andReturn($index = m::mock(stdClass::class));
-        $index->shouldReceive('deleteObjects')->with([1]);
+        $client->shouldReceive('deleteObjects')->with('table', [1]);
 
         $engine = new AlgoliaEngine($client);
         $engine->delete(Collection::make([new SearchableModel(['id' => 1])]));
@@ -58,8 +57,7 @@ public function test_delete_removes_objects_to_index()
     public function test_delete_removes_objects_to_index_with_a_custom_search_key()
     {
         $client = m::mock(SearchClient::class);
-        $client->shouldReceive('initIndex')->with('table')->andReturn($index = m::mock(Indexes::class));
-        $index->shouldReceive('deleteObjects')->once()->with(['my-algolia-key.5']);
+        $client->shouldReceive('deleteObjects')->once()->with('table', ['my-algolia-key.5']);
 
         $engine = new AlgoliaEngine($client);
         $engine->delete(Collection::make([new AlgoliaCustomKeySearchableModel(['id' => 5])]));
@@ -74,8 +72,7 @@ public function test_delete_with_removeable_scout_collection_using_custom_search
         $job = unserialize(serialize($job));
 
         $client = m::mock(SearchClient::class);
-        $client->shouldReceive('initIndex')->with('table')->andReturn($index = m::mock(stdClass::class));
-        $index->shouldReceive('deleteObjects')->once()->with(['my-algolia-key.5']);
+        $client->shouldReceive('deleteObjects')->once()->with('table', ['my-algolia-key.5']);
 
         $engine = new AlgoliaEngine($client);
         $engine->delete($job->models);
@@ -111,10 +108,11 @@ public function test_remove_from_search_job_uses_custom_search_key()
     public function test_search_sends_correct_parameters_to_algolia()
     {
         $client = m::mock(SearchClient::class);
-        $client->shouldReceive('initIndex')->with('table')->andReturn($index = m::mock(stdClass::class));
-        $index->shouldReceive('search')->with('zonda', [
-            'numericFilters' => ['foo=1'],
-        ]);
+        $client->shouldReceive('searchSingleIndex')->with(
+            'table',
+            ['query' => 'zonda'],
+            ['numericFilters' => ['foo=1']]
+        );
 
         $engine = new AlgoliaEngine($client);
         $builder = new Builder(new SearchableModel, 'zonda');
@@ -125,10 +123,11 @@ public function test_search_sends_correct_parameters_to_algolia()
     public function test_search_sends_correct_parameters_to_algolia_for_where_in_search()
     {
         $client = m::mock(SearchClient::class);
-        $client->shouldReceive('initIndex')->with('table')->andReturn($index = m::mock(stdClass::class));
-        $index->shouldReceive('search')->with('zonda', [
-            'numericFilters' => ['foo=1', ['bar=1', 'bar=2']],
-        ]);
+        $client->shouldReceive('searchSingleIndex')->with(
+            'table',
+            ['query' => 'zonda'],
+            ['numericFilters' => ['foo=1', ['bar=1', 'bar=2']]]
+        );
 
         $engine = new AlgoliaEngine($client);
         $builder = new Builder(new SearchableModel, 'zonda');
@@ -139,10 +138,11 @@ public function test_search_sends_correct_parameters_to_algolia_for_where_in_sea
     public function test_search_sends_correct_parameters_to_algolia_for_empty_where_in_search()
     {
         $client = m::mock(SearchClient::class);
-        $client->shouldReceive('initIndex')->with('table')->andReturn($index = m::mock(stdClass::class));
-        $index->shouldReceive('search')->with('zonda', [
-            'numericFilters' => ['foo=1', '0=1'],
-        ]);
+        $client->shouldReceive('searchSingleIndex')->with(
+            'table',
+            ['query' => 'zonda'],
+            ['numericFilters' => ['foo=1', '0=1']]
+        );
 
         $engine = new AlgoliaEngine($client);
         $builder = new Builder(new SearchableModel, 'zonda');
@@ -280,8 +280,7 @@ public function test_a_model_is_indexed_with_a_custom_algolia_key()
     public function test_a_model_is_removed_with_a_custom_algolia_key()
     {
         $client = m::mock(SearchClient::class);
-        $client->shouldReceive('initIndex')->with('table')->andReturn($index = m::mock(stdClass::class));
-        $index->shouldReceive('deleteObjects')->with(['my-algolia-key.1']);
+        $client->shouldReceive('deleteObjects')->with('table', ['my-algolia-key.1']);
 
         $engine = new AlgoliaEngine($client);
         $engine->delete(Collection::make([new AlgoliaCustomKeySearchableModel(['id' => 1])]));
@@ -290,8 +289,7 @@ public function test_a_model_is_removed_with_a_custom_algolia_key()
     public function test_flush_a_model_with_a_custom_algolia_key()
     {
         $client = m::mock(SearchClient::class);
-        $client->shouldReceive('initIndex')->with('table')->andReturn($index = m::mock(stdClass::class));
-        $index->shouldReceive('clearObjects');
+        $client->shouldReceive('clearObjects')->with('table');
 
         $engine = new AlgoliaEngine($client);
         $engine->flush(new AlgoliaCustomKeySearchableModel);