[!!!][TASK] Remove deprecated Node class

Removes deprecated class ApacheSolrForTypo3\Solr\System\Solr\Node and it's usages. - Replace deprecated Node class with Endpoint - Replace getUsername/getPassword with getAuthentication() Resolves: #3630
TYPO3-Solr · Sep 25, 2023 · 72adf9b · 72adf9b
1 parent afb986e
commit 72adf9b
Show file tree

Hide file tree

Showing 5 changed files with 27 additions and 172 deletions.
diff --git a/Classes/ConnectionManager.php b/Classes/ConnectionManager.php
@@ -22,10 +22,10 @@
 use ApacheSolrForTypo3\Solr\Domain\Site\SiteRepository;
 use ApacheSolrForTypo3\Solr\Exception\InvalidArgumentException;
 use ApacheSolrForTypo3\Solr\System\Records\Pages\PagesRepository as PagesRepositoryAtExtSolr;
-use ApacheSolrForTypo3\Solr\System\Solr\Node;
 use ApacheSolrForTypo3\Solr\System\Solr\SolrConnection;
 use ApacheSolrForTypo3\Solr\System\Util\SiteUtility;
 use Doctrine\DBAL\Exception as DBALException;
+use Solarium\Core\Client\Endpoint;
 use TYPO3\CMS\Core\SingletonInterface;
 use TYPO3\CMS\Core\Site\Entity\Site as Typo3Site;
 use TYPO3\CMS\Core\Utility\GeneralUtility;
@@ -63,8 +63,8 @@ public function getSolrConnectionForNodes(array $readNodeConfiguration, array $w
     {
         $connectionHash = md5(json_encode($readNodeConfiguration) . json_encode($writeNodeConfiguration));
         if (!isset(self::$connections[$connectionHash])) {
-            $readNode = Node::fromArray($readNodeConfiguration);
-            $writeNode = Node::fromArray($writeNodeConfiguration);
+            $readNode = new Endpoint($readNodeConfiguration);
+            $writeNode = new Endpoint($writeNodeConfiguration);
             self::$connections[$connectionHash] = GeneralUtility::makeInstance(SolrConnection::class, $readNode, $writeNode);
         }
         return self::$connections[$connectionHash];

diff --git a/Classes/System/Solr/Node.php b/Classes/System/Solr/Node.php
diff --git a/Classes/System/Solr/SolrConnection.php b/Classes/System/Solr/SolrConnection.php
@@ -34,6 +34,7 @@
 use Psr\Http\Message\StreamFactoryInterface;
 use Solarium\Client;
 use Solarium\Core\Client\Adapter\Psr18Adapter;
+use Solarium\Core\Client\Endpoint;
 use TYPO3\CMS\Core\Utility\GeneralUtility;
 
 /**
@@ -58,7 +59,7 @@ class SolrConnection
     protected ?SchemaParser $schemaParser = null;
 
     /**
-     * @var Node[]
+     * @var Endpoint[]
      */
     protected array $nodes = [];
 
@@ -83,8 +84,8 @@ class SolrConnection
      * @throws NotFoundExceptionInterface
      */
     public function __construct(
-        Node $readNode,
-        Node $writeNode,
+        Endpoint $readNode,
+        Endpoint $writeNode,
         TypoScriptConfiguration $configuration = null,
         SynonymParser $synonymParser = null,
         StopWordParser $stopWordParser = null,
@@ -112,7 +113,7 @@ public function __construct(
     /**
      * Returns Endpoint by key
      */
-    public function getNode(string $key): Node
+    public function getNode(string $key): Endpoint
     {
         return $this->nodes[$key];
     }
@@ -200,13 +201,12 @@ protected function buildWriteService(): SolrWriteService
      */
     protected function initializeClient(Client $client, string $endpointKey): Client
     {
-        if (trim($this->getNode($endpointKey)->getUsername()) === '') {
+        $authentication = $this->getNode($endpointKey)->getAuthentication();
+        if (trim($authentication['username']) === '') {
             return $client;
         }
 
-        $username = $this->getNode($endpointKey)->getUsername();
-        $password = $this->getNode($endpointKey)->getPassword();
-        $this->setAuthenticationOnAllEndpoints($client, $username, $password);
+        $this->setAuthenticationOnAllEndpoints($client, $authentication['username'], $authentication['password']);
 
         return $client;
     }
@@ -236,7 +236,7 @@ protected function getClient(string $endpointKey): Client
         $client->getPlugin('postbigrequest');
         $client->clearEndpoints();
 
-        $newEndpointOptions = $this->getNode($endpointKey)->getSolariumClientOptions();
+        $newEndpointOptions = $this->getNode($endpointKey)->getOptions();
         $newEndpointOptions['key'] = $endpointKey;
         $client->createEndpoint($newEndpointOptions, true);
 

diff --git a/Tests/Unit/ConnectionManagerTest.php b/Tests/Unit/ConnectionManagerTest.php
@@ -21,7 +21,6 @@
 use ApacheSolrForTypo3\Solr\System\Configuration\TypoScriptConfiguration;
 use ApacheSolrForTypo3\Solr\System\Logging\SolrLogManager;
 use ApacheSolrForTypo3\Solr\System\Records\Pages\PagesRepository;
-use ApacheSolrForTypo3\Solr\System\Solr\Node;
 use ApacheSolrForTypo3\Solr\System\Solr\Parser\SchemaParser;
 use ApacheSolrForTypo3\Solr\System\Solr\Parser\StopWordParser;
 use ApacheSolrForTypo3\Solr\System\Solr\Parser\SynonymParser;
@@ -31,6 +30,7 @@
 use Psr\Http\Client\ClientInterface;
 use Psr\Http\Message\RequestFactoryInterface;
 use Psr\Http\Message\StreamFactoryInterface;
+use Solarium\Core\Client\Endpoint;
 use TYPO3\CMS\Frontend\Controller\TypoScriptFrontendController;
 use UnexpectedValueException;
 
@@ -92,8 +92,8 @@ public function canConnect(string $host, string|int $port, string $path, string
         $self = $this;
         $this->connectionManager->expects(self::once())->method('getSolrConnectionForNodes')->willReturnCallback(
             function ($readNode, $writeNode) use ($self) {
-                $readNode = Node::fromArray($readNode);
-                $writeNode = Node::fromArray($writeNode);
+                $readNode = new Endpoint($readNode);
+                $writeNode = new Endpoint($writeNode);
                 $typoScriptConfigurationMock = $self->createMock(TypoScriptConfiguration::class);
                 $synonymsParserMock = $self->createMock(SynonymParser::class);
                 $stopWordParserMock = $self->createMock(StopWordParser::class);

diff --git a/Tests/Unit/System/Solr/SolrConnectionTest.php b/Tests/Unit/System/Solr/SolrConnectionTest.php
@@ -17,7 +17,6 @@
 
 use ApacheSolrForTypo3\Solr\System\Configuration\TypoScriptConfiguration;
 use ApacheSolrForTypo3\Solr\System\Logging\SolrLogManager;
-use ApacheSolrForTypo3\Solr\System\Solr\Node;
 use ApacheSolrForTypo3\Solr\System\Solr\Parser\SchemaParser;
 use ApacheSolrForTypo3\Solr\System\Solr\Parser\StopWordParser;
 use ApacheSolrForTypo3\Solr\System\Solr\Parser\SynonymParser;
@@ -38,8 +37,8 @@
 class SolrConnectionTest extends SetUpUnitTestCase
 {
     /**
-     * @param Node|null $readNode
-     * @param Node|null $writeNode
+     * @param Endpoint|null $readNode
+     * @param Endpoint|null $writeNode
      * @param TypoScriptConfiguration|null $configuration
      * @param SynonymParser|null $synonymParser
      * @param StopWordParser|null $stopWordParser
@@ -49,11 +48,11 @@ class SolrConnectionTest extends SetUpUnitTestCase
      * @param RequestFactoryInterface|null $requestFactory
      * @param StreamFactoryInterface|null $streamFactory
      * @param EventDispatcherInterface|null $eventDispatcher
-     * @return SolrConnection
+     * @return SolrConnection|null
      */
     protected function getSolrConnectionWithDummyConstructorArgs(
-        Node $readNode = null,
-        Node $writeNode = null,
+        Endpoint $readNode = null,
+        Endpoint $writeNode = null,
         TypoScriptConfiguration $configuration = null,
         SynonymParser $synonymParser = null,
         StopWordParser $stopWordParser = null,
@@ -66,8 +65,8 @@ protected function getSolrConnectionWithDummyConstructorArgs(
     ): ?SolrConnection {
         try {
             return new SolrConnection(
-                $readNode ?? $this->createMock(Node::class),
-                $writeNode ?? $this->createMock(Node::class),
+                $readNode ?? $this->createMock(Endpoint::class),
+                $writeNode ?? $this->createMock(Endpoint::class),
                 $configuration ?? $this->createMock(TypoScriptConfiguration::class),
                 $synonymParser ?? $this->createMock(SynonymParser::class),
                 $stopWordParser ?? $this->createMock(StopWordParser::class),
@@ -93,7 +92,7 @@ public function authenticationIsNotTriggeredWithoutUsername()
         $clientMock = $this->createMock(Client::class);
         $clientMock->expects(self::any())->method('getEndpoints')->willReturn([$endpointMock]);
 
-        $readNode = Node::fromArray(
+        $readNode = new Endpoint(
             ['host' => 'localhost', 'port' => 8080, 'path' => '/solr/core_en/', 'scheme' => 'https', 'username' => '', 'password' => '']
         );
         $writeNode = $readNode;
@@ -113,7 +112,7 @@ public function authenticationIsTriggeredWhenUsernameIsPassed()
         $clientMock = $this->createMock(Client::class);
         $clientMock->expects(self::any())->method('getEndpoints')->willReturn([$endpointMock]);
 
-        $readNode = Node::fromArray(
+        $readNode = new Endpoint(
             ['host' => 'localhost', 'port' => 8080, 'path' => '/solr/core_en/', 'scheme' => 'https', 'username' => 'foo', 'password' => 'bar']
         );
         $writeNode = $readNode;
@@ -142,7 +141,7 @@ public function coreNameDataProvider(): array
     public function canGetCoreName($path, $expectedCoreName)
     {
         $fakeConfiguration = $this->createMock(TypoScriptConfiguration::class);
-        $readNode = Node::fromArray(
+        $readNode = new Endpoint(
             ['host' => 'localhost', 'port' => 8080, 'path' => $path, 'scheme' => 'http', 'username' => '', 'password' => '']
         );
         $writeNode = $readNode;
@@ -167,7 +166,7 @@ public function coreBasePathDataProvider(): array
      */
     public function canGetCoreBasePath($path, $expectedCoreBasePath)
     {
-        $readNode = Node::fromArray(
+        $readNode = new Endpoint(
             ['host' => 'localhost', 'port' => 8080, 'path' => $path, 'scheme' => 'http', 'username' => '', 'password' => '']
         );
         $writeNode = $readNode;
@@ -180,7 +179,7 @@ public function canGetCoreBasePath($path, $expectedCoreBasePath)
      */
     public function toStringContainsAllSegments()
     {
-        $readNode = Node::fromArray(
+        $readNode = new Endpoint(
             ['host' => 'localhost', 'port' => 8080, 'path' => '/core_de/', 'scheme' => 'http', 'username' => '', 'password' => '']
         );
         $writeNode = $readNode;