Merge pull request #653 from greg0ire/upgrade-algolia

Upgrade the Algolia SDK to v4
doctrine · Feb 6, 2025 · 2bab51b · 2bab51b
2 parents a83aded + 5e98897
commit 2bab51b
Show file tree

Hide file tree

Showing 5 changed files with 34 additions and 71 deletions.
diff --git a/composer.json b/composer.json
@@ -12,7 +12,7 @@
     ],
     "require": {
         "php": "8.3.*",
-        "algolia/algoliasearch-client-php": "^3.3",
+        "algolia/algoliasearch-client-php": "^4",
         "doctrine/collections": "^2",
         "doctrine/dbal": "^4.0",
         "doctrine/inflector": "^2.0",

diff --git a/composer.lock b/composer.lock
diff --git a/config/services.xml b/config/services.xml
@@ -56,7 +56,7 @@
             <argument>%doctrine.website.send_grid.api_key%</argument>
         </service>
 
-        <service id="Algolia\AlgoliaSearch\SearchClient" autowire="false">
+        <service id="Algolia\AlgoliaSearch\Api\SearchClient" autowire="false">
             <factory method="create"/>
             <argument>%doctrine.website.algolia.app_id%</argument>
             <argument>%doctrine.website.algolia.admin_api_key%</argument>

diff --git a/lib/Docs/SearchIndexer.php b/lib/Docs/SearchIndexer.php
@@ -4,8 +4,7 @@
 
 namespace Doctrine\Website\Docs;
 
-use Algolia\AlgoliaSearch\SearchClient;
-use Algolia\AlgoliaSearch\SearchIndex;
+use Algolia\AlgoliaSearch\Api\SearchClient;
 use Doctrine\Website\Model\Project;
 use Doctrine\Website\Model\ProjectVersion;
 use Generator;
@@ -50,9 +49,7 @@ public function __construct(
 
     public function initSearchIndex(): void
     {
-        $index = $this->getSearchIndex();
-
-        $index->setSettings([
+        $this->client->setSettings(self::INDEX_NAME, [
             'attributesToIndex' => ['projectName', 'h1', 'h2', 'h3', 'h4', 'h5', 'h6', 'content'],
             'customRanking' => ['asc(rank)'],
             'ranking' => ['words', 'typo', 'attribute', 'proximity', 'custom'],
@@ -65,7 +62,7 @@ public function initSearchIndex(): void
             'removeWordsIfNoResults' => 'allOptional',
         ]);
 
-        $index->clearObjects();
+        $this->client->clearObjects(self::INDEX_NAME);
     }
 
     /** @param DocumentNode[] $documents */
@@ -82,7 +79,7 @@ public function buildSearchIndexes(
             }
         }
 
-        $this->getSearchIndex()->saveObjects($records, ['autoGenerateObjectIDIfNotExist' => true]);
+        $this->client->saveObjects(self::INDEX_NAME, $records, ['autoGenerateObjectIDIfNotExist' => true]);
     }
 
     /** @return Generator<searchRecord> */
@@ -225,9 +222,4 @@ private function stripContent(string $content): string
     {
         return str_replace(['"', '\''], '', $content);
     }
-
-    private function getSearchIndex(): SearchIndex
-    {
-        return $this->client->initIndex(self::INDEX_NAME);
-    }
 }
diff --git a/tests/Docs/SearchIndexerTest.php b/tests/Docs/SearchIndexerTest.php
@@ -4,8 +4,7 @@
 
 namespace Doctrine\Website\Tests\Docs;
 
-use Algolia\AlgoliaSearch\SearchClient;
-use Algolia\AlgoliaSearch\SearchIndex;
+use Algolia\AlgoliaSearch\Api\SearchClient;
 use Doctrine\Website\Application;
 use Doctrine\Website\Docs\RST\GuidesParser;
 use Doctrine\Website\Docs\SearchIndexer;
@@ -33,16 +32,9 @@ protected function setUp(): void
 
     public function testInitSearchIndex(): void
     {
-        $index = $this->createMock(SearchIndex::class);
-
         $this->client->expects(self::once())
-            ->method('initIndex')
-            ->with(SearchIndexer::INDEX_NAME)
-            ->willReturn($index);
-
-        $index->expects(self::once())
             ->method('setSettings')
-            ->with([
+            ->with(SearchIndexer::INDEX_NAME, [
                 'attributesToIndex' => ['projectName', 'h1', 'h2', 'h3', 'h4', 'h5', 'h6', 'content'],
                 'customRanking' => ['asc(rank)'],
                 'ranking' => ['words', 'typo', 'attribute', 'proximity', 'custom'],
@@ -55,7 +47,7 @@ public function testInitSearchIndex(): void
                 'removeWordsIfNoResults' => 'allOptional',
             ]);
 
-        $index->expects(self::once())
+        $this->client->expects(self::once())
             ->method('clearObjects');
 
         $this->searchIndexer->initSearchIndex();
@@ -70,13 +62,6 @@ public function testBuildSearchIndexes(): void
         ]);
         $version = new ProjectVersion(['slug' => '1.0']);
 
-        $index = $this->createMock(SearchIndex::class);
-
-        $this->client->expects(self::once())
-            ->method('initIndex')
-            ->with(SearchIndexer::INDEX_NAME)
-            ->willReturn($index);
-
         $documents = $this->buildDocuments(__DIR__ . '/resources/search-indexer');
 
         $expectedRecords = [
@@ -199,9 +184,9 @@ public function testBuildSearchIndexes(): void
             ],
         ];
 
-        $index->expects(self::once())
+        $this->client->expects(self::once())
             ->method('saveObjects')
-            ->with($expectedRecords, ['autoGenerateObjectIDIfNotExist' => true]);
+            ->with(SearchIndexer::INDEX_NAME, $expectedRecords, ['autoGenerateObjectIDIfNotExist' => true]);
 
         $this->searchIndexer->buildSearchIndexes($project, $version, $documents);
     }
@@ -215,13 +200,6 @@ public function testBuildSearchIndexesContainingQuotes(): void
         ]);
         $version = new ProjectVersion(['slug' => '1.0']);
 
-        $index = $this->createMock(SearchIndex::class);
-
-        $this->client->expects(self::once())
-            ->method('initIndex')
-            ->with(SearchIndexer::INDEX_NAME)
-            ->willReturn($index);
-
         $documents = $this->buildDocuments(__DIR__ . '/resources/search-indexer-with-quotes');
 
         $expectedRecords = [
@@ -266,9 +244,9 @@ public function testBuildSearchIndexesContainingQuotes(): void
             ],
         ];
 
-        $index->expects(self::once())
+        $this->client->expects(self::once())
             ->method('saveObjects')
-            ->with($expectedRecords, ['autoGenerateObjectIDIfNotExist' => true]);
+            ->with(SearchIndexer::INDEX_NAME, $expectedRecords, ['autoGenerateObjectIDIfNotExist' => true]);
 
         $this->searchIndexer->buildSearchIndexes($project, $version, $documents);
     }