[!!!][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() - Change SolrConnection->getNode() to SolrConnection->getEndpoint Resolves: #3630
TYPO3-Solr · Sep 29, 2023 · f6e7fd4 · f6e7fd4
1 parent 81b8f2b
commit f6e7fd4
Show file tree

Hide file tree

Showing 19 changed files with 218 additions and 339 deletions.
diff --git a/Classes/ConnectionManager.php b/Classes/ConnectionManager.php
@@ -21,13 +21,15 @@
 use ApacheSolrForTypo3\Solr\Domain\Site\Site;
 use ApacheSolrForTypo3\Solr\Domain\Site\SiteRepository;
 use ApacheSolrForTypo3\Solr\Exception\InvalidArgumentException;
+use ApacheSolrForTypo3\Solr\Exception\InvalidConnectionException;
 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;
 
 use function json_encode;
@@ -57,25 +59,48 @@ public function __construct(
     }
 
     /**
-     * Creates a solr connection for read and write endpoints
+     * Creates a Solr connection for read and write endpoints
+     *
+     * @throw InvalidConnectionException
      */
-    public function getSolrConnectionForNodes(array $readNodeConfiguration, array $writeNodeConfiguration): SolrConnection
+    public function getSolrConnectionForEndpoints(array $readEndpointConfiguration, array $writeEndpointConfiguration): SolrConnection
     {
-        $connectionHash = md5(json_encode($readNodeConfiguration) . json_encode($writeNodeConfiguration));
+        $connectionHash = md5(json_encode($readEndpointConfiguration) . json_encode($writeEndpointConfiguration));
         if (!isset(self::$connections[$connectionHash])) {
-            $readNode = Node::fromArray($readNodeConfiguration);
-            $writeNode = Node::fromArray($writeNodeConfiguration);
-            self::$connections[$connectionHash] = GeneralUtility::makeInstance(SolrConnection::class, $readNode, $writeNode);
+            $readEndpoint = new Endpoint($readEndpointConfiguration);
+            if (!$this->isValidEndpoint($readEndpoint)) {
+                throw new InvalidConnectionException('Invalid read endpoint');
+            }
+
+            $writeEndpoint = new Endpoint($writeEndpointConfiguration);
+            if (!$this->isValidEndpoint($writeEndpoint)) {
+                throw new InvalidConnectionException('Invalid write endpoint');
+            }
+
+            self::$connections[$connectionHash] = GeneralUtility::makeInstance(SolrConnection::class, $readEndpoint, $writeEndpoint);
         }
+
         return self::$connections[$connectionHash];
     }
 
+    /**
+     * Checks if endpoint is valid
+     */
+    protected function isValidEndpoint(Endpoint $endpoint): bool
+    {
+        return
+            !empty($endpoint->getHost())
+            && !empty($endpoint->getPort())
+            && !empty($endpoint->getCore())
+        ;
+    }
+
     /**
      * Creates a solr configuration from the configuration array and returns it.
      */
     public function getConnectionFromConfiguration(array $solrConfiguration): SolrConnection
     {
-        return $this->getSolrConnectionForNodes($solrConfiguration['read'], $solrConfiguration['write']);
+        return $this->getSolrConnectionForEndpoints($solrConfiguration['read'], $solrConfiguration['write']);
     }
 
     /**

diff --git a/Classes/Exception/InvalidConnectionException.php b/Classes/Exception/InvalidConnectionException.php
@@ -0,0 +1,25 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of the TYPO3 CMS project.
+ *
+ * It is free software; you can redistribute it and/or modify it under
+ * the terms of the GNU General Public License, either version 2
+ * of the License, or any later version.
+ *
+ * For the full copyright and license information, please read the
+ * LICENSE.txt file that was distributed with this source code.
+ *
+ * The TYPO3 project - inspiring people to share!
+ */
+
+namespace ApacheSolrForTypo3\Solr\Exception;
+
+use ApacheSolrForTypo3\Solr\Exception;
+
+/**
+ * Exception that is thrown if a Solr connection is invalid
+ */
+class InvalidConnectionException extends Exception {}
diff --git a/Classes/IndexQueue/FrontendHelper/PageIndexer.php b/Classes/IndexQueue/FrontendHelper/PageIndexer.php
@@ -202,7 +202,7 @@ public function index(Item $indexQueueItem, TypoScriptFrontendController $tsfe):
         $this->responseData['solrConnection'] = [
             'rootPage' => $indexQueueItem->getRootPageUid(),
             'sys_language_uid' => $tsfe->getLanguage()->getLanguageId(),
-            'solr' => (string)$this->solrConnection->getNode('write'),
+            'solr' => $this->solrConnection->getEndpoint('write')->getCoreBaseUri(),
         ];
 
         foreach ($this->documentsSentToSolr as $document) {

diff --git a/Classes/Report/SolrStatus.php b/Classes/Report/SolrStatus.php
@@ -113,7 +113,7 @@ protected function getConnectionStatus(Site $site, array $solrConnection): Statu
         $this->responseStatus = ContextualFeedbackSeverity::OK;
 
         $solrAdmin = $this->connectionManager
-            ->getSolrConnectionForNodes($solrConnection['read'], $solrConnection['write'])
+            ->getSolrConnectionForEndpoints($solrConnection['read'], $solrConnection['write'])
             ->getAdminService();
 
         $solrVersion = $this->checkSolrVersion($solrAdmin);

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,9 +59,9 @@ class SolrConnection
     protected ?SchemaParser $schemaParser = null;
 
     /**
-     * @var Node[]
+     * @var Endpoint[]
      */
-    protected array $nodes = [];
+    protected array $endpoints = [];
 
     protected ?SolrLogManager $logger = null;
 
@@ -83,8 +84,8 @@ class SolrConnection
      * @throws NotFoundExceptionInterface
      */
     public function __construct(
-        Node $readNode,
-        Node $writeNode,
+        Endpoint $readEndpoint,
+        Endpoint $writeEndpoint,
         TypoScriptConfiguration $configuration = null,
         SynonymParser $synonymParser = null,
         StopWordParser $stopWordParser = null,
@@ -95,9 +96,9 @@ public function __construct(
         StreamFactoryInterface $streamFactory = null,
         EventDispatcherInterface $eventDispatcher = null,
     ) {
-        $this->nodes['read'] = $readNode;
-        $this->nodes['write'] = $writeNode;
-        $this->nodes['admin'] = $writeNode;
+        $this->endpoints['read'] = $readEndpoint;
+        $this->endpoints['write'] = $writeEndpoint;
+        $this->endpoints['admin'] = $writeEndpoint;
         $this->configuration = $configuration ?? Util::getSolrConfiguration();
         $this->synonymParser = $synonymParser;
         $this->stopWordParser = $stopWordParser;
@@ -112,9 +113,9 @@ public function __construct(
     /**
      * Returns Endpoint by key
      */
-    public function getNode(string $key): Node
+    public function getEndpoint(string $key): Endpoint
     {
-        return $this->nodes[$key];
+        return $this->endpoints[$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->getEndpoint($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->getEndpoint($endpointKey)->getOptions();
         $newEndpointOptions['key'] = $endpointKey;
         $client->createEndpoint($newEndpointOptions, true);
 

diff --git a/Classes/System/Util/SiteUtility.php b/Classes/System/Util/SiteUtility.php
@@ -104,21 +104,17 @@ public static function getSolrConnectionConfiguration(
                 'scheme' => self::getConnectionProperty($typo3Site, 'scheme', $languageUid, 'read', 'http'),
                 'host' => self::getConnectionProperty($typo3Site, 'host', $languageUid, 'read', 'localhost'),
                 'port' => (int)self::getConnectionProperty($typo3Site, 'port', $languageUid, 'read', 8983),
-                // @todo: transform core to path
-                'path' =>
-                self::getConnectionProperty($typo3Site, 'path', $languageUid, 'read', '/solr/') .
-                $solrReadCore . '/' ,
+                'path' => self::getConnectionProperty($typo3Site, 'path', $languageUid, 'read', ''),
+                'core' => $solrReadCore,
                 'username' => self::getConnectionProperty($typo3Site, 'username', $languageUid, 'read', ''),
                 'password' => self::getConnectionProperty($typo3Site, 'password', $languageUid, 'read', ''),
             ],
             'write' => [
                 'scheme' => self::getConnectionProperty($typo3Site, 'scheme', $languageUid, 'write', 'http'),
                 'host' => self::getConnectionProperty($typo3Site, 'host', $languageUid, 'write', 'localhost'),
                 'port' => (int)self::getConnectionProperty($typo3Site, 'port', $languageUid, 'write', 8983),
-                // @todo: transform core to path
-                'path' =>
-                self::getConnectionProperty($typo3Site, 'path', $languageUid, 'write', '/solr/') .
-                $solrWriteCore . '/' ,
+                'path' => self::getConnectionProperty($typo3Site, 'path', $languageUid, 'write', ''),
+                'core' => $solrWriteCore,
                 'username' => self::getConnectionProperty($typo3Site, 'username', $languageUid, 'write', ''),
                 'password' => self::getConnectionProperty($typo3Site, 'password', $languageUid, 'write', ''),
             ],

diff --git a/Configuration/SiteConfiguration/Overrides/sites.php b/Configuration/SiteConfiguration/Overrides/sites.php
@@ -60,7 +60,7 @@
 
 $GLOBALS['SiteConfiguration']['site']['columns']['solr_path_read'] = [
     'label' => 'URL path to Apache Solr server',
-    'description' => 'I.e. if you use Hosted-Solr.com the path inside the admin panel. Should not contain "/solr/".',
+    'description' => 'Must not contain "/solr/"! Unlesss you have an additional "solr" segment in your path like "http://localhost:8983/solr/solr/core_en".',
     'config' => [
         'type' => 'input',
         'eval' => 'trim',

diff --git a/Documentation/Backend/ConnectionManager.rst b/Documentation/Backend/ConnectionManager.rst
@@ -69,7 +69,7 @@ Example:
     rootPageId: 3
     routes: {  }
     solr_enabled_read: true
-    solr_path_read: /solr/
+    solr_path_read: /
     solr_port_read: 8983
     solr_scheme_read: http
     solr_use_write_connection: false