!!![TASK:BP:11.6] Introduce queue and queue item interfaces

As an initial steps to allow custom index queue types interfaces for queue and queue items are introduced. Additionally custom queue classes can be configured via: plugin.tx_solr.index.queue.<configurationName>.indexQueue This is a breaking change for all instances that implemented own queues and queue items! Ports: TYPO3-Solr#3764 Resolves: TYPO3-Solr#3763
dkd-friedrich · Aug 22, 2023 · 3aa93ff · 3aa93ff
1 parent 93bc3bd
commit 3aa93ff
Show file tree

Hide file tree

Showing 18 changed files with 746 additions and 127 deletions.
diff --git a/Classes/Controller/Backend/Search/AbstractModuleController.php b/Classes/Controller/Backend/Search/AbstractModuleController.php
@@ -19,6 +19,7 @@
 use ApacheSolrForTypo3\Solr\Domain\Site\Site;
 use ApacheSolrForTypo3\Solr\Domain\Site\SiteRepository;
 use ApacheSolrForTypo3\Solr\IndexQueue\Queue;
+use ApacheSolrForTypo3\Solr\IndexQueue\QueueInterface;
 use ApacheSolrForTypo3\Solr\System\Mvc\Backend\Service\ModuleDataStorageService;
 use ApacheSolrForTypo3\Solr\System\Solr\SolrConnection as SolrCoreConnection;
 use Doctrine\DBAL\Driver\Exception as DBALDriverException;
@@ -91,9 +92,9 @@ abstract class AbstractModuleController extends ActionController
     protected ModuleDataStorageService $moduleDataStorageService;
 
     /**
-     * @var Queue
+     * @var QueueInterface
      */
-    protected Queue $indexQueue;
+    protected QueueInterface $indexQueue;
 
     /**
      * @var SiteFinder

diff --git a/Classes/Controller/Backend/Search/IndexQueueModuleController.php b/Classes/Controller/Backend/Search/IndexQueueModuleController.php
@@ -17,7 +17,10 @@
 
 use ApacheSolrForTypo3\Solr\Backend\IndexingConfigurationSelectorField;
 use ApacheSolrForTypo3\Solr\Domain\Index\IndexService;
+use ApacheSolrForTypo3\Solr\Domain\Index\Queue\QueueInitializationService;
 use ApacheSolrForTypo3\Solr\IndexQueue\Queue;
+use ApacheSolrForTypo3\Solr\IndexQueue\QueueInterface;
+use ApacheSolrForTypo3\Solr\IndexQueue\QueueInitializationServiceAwareInterface;
 use Psr\Http\Message\ResponseInterface;
 use TYPO3\CMS\Backend\Form\Exception as BackendFormException;
 use TYPO3\CMS\Core\Http\RedirectResponse;
@@ -34,9 +37,9 @@
 class IndexQueueModuleController extends AbstractModuleController
 {
     /**
-     * @var Queue
+     * @var QueueInterface
      */
-    protected Queue $indexQueue;
+    protected QueueInterface $indexQueue;
 
     /**
      * Initializes the controller before invoking an action method.
@@ -48,9 +51,9 @@ protected function initializeAction()
     }
 
     /**
-     * @param Queue $indexQueue
+     * @param QueueInterface $indexQueue
      */
-    public function setIndexQueue(Queue $indexQueue)
+    public function setIndexQueue(QueueInterface $indexQueue)
     {
         $this->indexQueue = $indexQueue;
     }
@@ -121,7 +124,13 @@ public function initializeIndexQueueAction(): ResponseInterface
         if ((!empty($indexingConfigurationsToInitialize)) && (is_array($indexingConfigurationsToInitialize))) {
             // initialize selected indexing configuration
             try {
-                $initializedIndexingConfigurations = $this->indexQueue->getInitializationService()->initializeBySiteAndIndexConfigurations($this->selectedSite, $indexingConfigurationsToInitialize);
+                if ($this->indexQueue instanceof QueueInitializationServiceAwareInterface) {
+                    $initializationService = $this->indexQueue->getQueueInitializationService();
+                } else {
+                    $initializationService = GeneralUtility::makeInstance(QueueInitializationService::class);
+                }
+
+                $initializedIndexingConfigurations = $initializationService->initializeBySiteAndIndexConfigurations($this->selectedSite, $indexingConfigurationsToInitialize);
             } catch (\Throwable $e) {
                 $this->addFlashMessage(
                     sprintf(

diff --git a/Classes/Domain/Index/IndexService.php b/Classes/Domain/Index/IndexService.php
@@ -20,6 +20,7 @@
 use ApacheSolrForTypo3\Solr\IndexQueue\Indexer;
 use ApacheSolrForTypo3\Solr\IndexQueue\Item;
 use ApacheSolrForTypo3\Solr\IndexQueue\Queue;
+use ApacheSolrForTypo3\Solr\IndexQueue\QueueInterface;
 use ApacheSolrForTypo3\Solr\System\Configuration\TypoScriptConfiguration;
 use ApacheSolrForTypo3\Solr\System\Logging\SolrLogManager;
 use ApacheSolrForTypo3\Solr\Task\IndexQueueWorkerTask;
@@ -48,9 +49,9 @@ class IndexService
     protected ?IndexQueueWorkerTask $contextTask = null;
 
     /**
-     * @var Queue
+     * @var QueueInterface
      */
-    protected Queue $indexQueue;
+    protected QueueInterface $indexQueue;
 
     /**
      * @var Dispatcher
@@ -71,7 +72,7 @@ class IndexService
      */
     public function __construct(
         Site $site,
-        Queue $queue = null,
+        QueueInterface $queue = null,
         Dispatcher $dispatcher = null,
         SolrLogManager $solrLogManager = null
     ) {

diff --git a/Classes/Domain/Index/Queue/GarbageRemover/AbstractStrategy.php b/Classes/Domain/Index/Queue/GarbageRemover/AbstractStrategy.php
@@ -18,6 +18,7 @@
 use ApacheSolrForTypo3\Solr\ConnectionManager;
 use ApacheSolrForTypo3\Solr\GarbageCollectorPostProcessor;
 use ApacheSolrForTypo3\Solr\IndexQueue\Queue;
+use ApacheSolrForTypo3\Solr\IndexQueue\QueueInterface;
 use ApacheSolrForTypo3\Solr\System\Logging\SolrLogManager;
 use ApacheSolrForTypo3\Solr\System\Solr\SolrConnection;
 use InvalidArgumentException;
@@ -30,9 +31,9 @@
 abstract class AbstractStrategy
 {
     /**
-     * @var Queue
+     * @var QueueInterface
      */
-    protected Queue $queue;
+    protected QueueInterface $queue;
 
     /**
      * @var ConnectionManager
@@ -41,11 +42,11 @@ abstract class AbstractStrategy
 
     /**
      * AbstractStrategy constructor.
-     * @param Queue|null $queue
+     * @param QueueInterface|null $queue
      * @param ConnectionManager|null $connectionManager
      */
     public function __construct(
-        Queue $queue = null,
+        QueueInterface $queue = null,
         ConnectionManager $connectionManager = null
     ) {
         $this->queue = $queue ?? GeneralUtility::makeInstance(Queue::class);

diff --git a/Classes/Domain/Index/Queue/QueueInitializationService.php b/Classes/Domain/Index/Queue/QueueInitializationService.php
@@ -20,12 +20,13 @@
 use ApacheSolrForTypo3\Solr\Domain\Site\Site;
 use ApacheSolrForTypo3\Solr\IndexQueue\InitializationPostProcessor;
 use ApacheSolrForTypo3\Solr\IndexQueue\Initializer\AbstractInitializer;
-use ApacheSolrForTypo3\Solr\IndexQueue\Queue;
+use ApacheSolrForTypo3\Solr\IndexQueue\QueueInterface;
 use Doctrine\DBAL\ConnectionException;
 use Doctrine\DBAL\Exception as DBALException;
 use Throwable;
 use TYPO3\CMS\Core\Utility\GeneralUtility;
 use UnexpectedValueException;
+use ApacheSolrForTypo3\Solr\IndexQueue\QueueInitializationServiceAwareInterface;
 
 /**
  * The queue initialization service is responsible to run the initialization of the index queue for a combination of sites
@@ -36,17 +37,14 @@
  */
 class QueueInitializationService
 {
-    /**
-     * @var Queue
-     */
-    protected Queue $queue;
+    protected bool $clearQueueOnInitialization = true;
 
     /**
-     * QueueInitializationService constructor.
+     * @param bool $clearQueueOnInitialization
      */
-    public function __construct(Queue $queue)
+    public function setClearQueueOnInitialization(bool $clearQueueOnInitialization): void
     {
-        $this->queue = $queue;
+        $this->clearQueueOnInitialization = $clearQueueOnInitialization;
     }
 
     /**
@@ -138,10 +136,21 @@ public function initializeBySiteAndIndexConfigurations(Site $site, array $indexi
      */
     protected function applyInitialization(Site $site, string $indexingConfigurationName): bool
     {
+        $solrConfiguration = $site->getSolrConfiguration();
+
+        /** @var QueueInterface $queue */
+        $queue = GeneralUtility::makeInstance(
+            $solrConfiguration->getIndexQueueClassByConfigurationName($indexingConfigurationName)
+        );
+        if ($queue instanceof QueueInitializationServiceAwareInterface) {
+            $queue->setQueueInitializationService($this);
+        }
+
         // clear queue
-        $this->queue->deleteItemsBySite($site, $indexingConfigurationName);
+        if ($this->clearQueueOnInitialization) {
+            $queue->deleteItemsBySite($site, $indexingConfigurationName);
+        }
 
-        $solrConfiguration = $site->getSolrConfiguration();
         $type = $solrConfiguration->getIndexQueueTypeOrFallbackToConfigurationName($indexingConfigurationName);
         $initializerClass = $solrConfiguration->getIndexQueueInitializerClassByConfigurationName($indexingConfigurationName);
         $indexConfiguration = $solrConfiguration->getIndexQueueConfigurationByName($indexingConfigurationName);

diff --git a/Classes/Domain/Index/Queue/QueueItemRepository.php b/Classes/Domain/Index/Queue/QueueItemRepository.php
@@ -19,6 +19,7 @@
 
 use ApacheSolrForTypo3\Solr\Domain\Site\Site;
 use ApacheSolrForTypo3\Solr\IndexQueue\Item;
+use ApacheSolrForTypo3\Solr\IndexQueue\ItemInterface;
 use ApacheSolrForTypo3\Solr\System\Logging\SolrLogManager;
 use ApacheSolrForTypo3\Solr\System\Records\AbstractRepository;
 use Doctrine\DBAL\ConnectionException;
@@ -150,12 +151,12 @@ public function flushErrorsBySite(Site $site): int
     /**
      * Flushes the error for a single item.
      *
-     * @param Item $item
+     * @param ItemInterface $item
      * @return int affected rows
      *
      * @throws DBALException|\Doctrine\DBAL\DBALException
      */
-    public function flushErrorByItem(Item $item): int
+    public function flushErrorByItem(ItemInterface $item): int
     {
         $queryBuilder = $this->getQueryBuilder();
         return (int)$this->getPreparedFlushErrorQuery($queryBuilder)
@@ -1000,12 +1001,12 @@ public function markItemAsFailed($item, string $errorMessage = ''): int
     /**
      * Sets the timestamp of when an item last has been indexed.
      *
-     * @param Item $item
+     * @param ItemInterface $item
      * @return int affected rows
      *
      * @throws DBALException|\Doctrine\DBAL\DBALException
      */
-    public function updateIndexTimeByItem(Item $item): int
+    public function updateIndexTimeByItem(ItemInterface $item): int
     {
         $queryBuilder = $this->getQueryBuilder();
         return (int)$queryBuilder
@@ -1018,13 +1019,13 @@ public function updateIndexTimeByItem(Item $item): int
     /**
      * Sets the change timestamp of an item.
      *
-     * @param Item $item
+     * @param ItemInterface $item
      * @param int $changedTime
      * @return int affected rows
      *
      * @throws DBALException|\Doctrine\DBAL\DBALException
      */
-    public function updateChangedTimeByItem(Item $item, int $changedTime = 0): int
+    public function updateChangedTimeByItem(ItemInterface $item, int $changedTime = 0): int
     {
         $queryBuilder = $this->getQueryBuilder();
         return (int)$queryBuilder