!!![TASK:BP:11.6] Introduce specific EXT:solr exceptions

Existing exceptions are now based on the recently introduced
generic EXT:solr exception.

Additionally based on the new generic EXT:solr exception a further
exception is introduced, allowing more targeted handling of exceptions:
InvalidIndexQueueInitizalizationPostProcessorException

This is a breaking change as the base excepion changed and the new
exception is no longer based on \UnexpectedValueException.

Ports: TYPO3-Solr#3764
Resolves: TYPO3-Solr#3763

Classes/Access/RootlineElementFormatException.php

@@ -15,11 +15,13 @@
 
 namespace ApacheSolrForTypo3\Solr\Access;
 
+use ApacheSolrForTypo3\Solr\Exception\InvalidArgumentException;
+
 /**
  * Signals a wrong format for the access definition of a page or the content.
  *
  * @author Ingo Renner <ingo@typo3.org>
  */
-class RootlineElementFormatException extends \InvalidArgumentException
+class RootlineElementFormatException extends InvalidArgumentException
 {
 }

Classes/ConnectionManager.php

@@ -19,13 +19,13 @@
 
 use ApacheSolrForTypo3\Solr\Domain\Site\Site;
 use ApacheSolrForTypo3\Solr\Domain\Site\SiteRepository;
+use ApacheSolrForTypo3\Solr\Exception\InvalidArgumentException;
 use ApacheSolrForTypo3\Solr\System\Records\Pages\PagesRepository as PagesRepositoryAtExtSolr;
 use ApacheSolrForTypo3\Solr\System\Records\SystemLanguage\SystemLanguageRepository;
 use ApacheSolrForTypo3\Solr\System\Solr\Node;
 use ApacheSolrForTypo3\Solr\System\Solr\SolrConnection;
 use ApacheSolrForTypo3\Solr\System\Util\SiteUtility;
 use Doctrine\DBAL\Driver\Exception as DBALDriverException;
-use InvalidArgumentException;
 use function json_encode;
 use Throwable;
 use TYPO3\CMS\Core\SingletonInterface;

Classes/ContentObject/Classification.php

@@ -17,7 +17,7 @@
 
 use ApacheSolrForTypo3\Solr\Domain\Index\Classification\Classification as ClassificationItem;
 use ApacheSolrForTypo3\Solr\Domain\Index\Classification\ClassificationService;
-use InvalidArgumentException;
+use ApacheSolrForTypo3\Solr\Exception\InvalidArgumentException;
 use TYPO3\CMS\Core\Utility\GeneralUtility;
 use TYPO3\CMS\Frontend\ContentObject\AbstractContentObject;
 

Classes/Controller/Backend/Search/AbstractModuleController.php

@@ -18,12 +18,12 @@
 use ApacheSolrForTypo3\Solr\ConnectionManager;
 use ApacheSolrForTypo3\Solr\Domain\Site\Site;
 use ApacheSolrForTypo3\Solr\Domain\Site\SiteRepository;
+use ApacheSolrForTypo3\Solr\Exception\InvalidArgumentException;
 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;
-use InvalidArgumentException;
 use Psr\Http\Message\ResponseInterface;
 use Throwable;
 use TYPO3\CMS\Backend\Template\Components\Menu\Menu;

Classes/Domain/Index/Queue/GarbageRemover/AbstractStrategy.php

@@ -16,12 +16,12 @@
 namespace ApacheSolrForTypo3\Solr\Domain\Index\Queue\GarbageRemover;
 
 use ApacheSolrForTypo3\Solr\ConnectionManager;
+use ApacheSolrForTypo3\Solr\Exception\InvalidArgumentException;
 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;
 use TYPO3\CMS\Core\Utility\GeneralUtility;
 
 /**

Classes/Domain/Index/Queue/QueueInitializationService.php

@@ -18,15 +18,15 @@
 namespace ApacheSolrForTypo3\Solr\Domain\Index\Queue;
 
 use ApacheSolrForTypo3\Solr\Domain\Site\Site;
+use ApacheSolrForTypo3\Solr\Exception\Index\Queue\InvalidIndexQueueInitizalizationPostProcessorException;
 use ApacheSolrForTypo3\Solr\IndexQueue\InitializationPostProcessor;
 use ApacheSolrForTypo3\Solr\IndexQueue\Initializer\AbstractInitializer;
+use ApacheSolrForTypo3\Solr\IndexQueue\QueueInitializationServiceAwareInterface;
 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
@@ -96,6 +96,7 @@ public function initializeBySitesAndConfigurations(array $sites, array $indexing
      * @throws ConnectionException
      * @throws Throwable
      * @throws DBALException
+     * @throws InvalidIndexQueueInitizalizationPostProcessorException
      */
     public function initializeBySiteAndIndexConfigurations(Site $site, array $indexingConfigurationNames): array
     {
@@ -116,7 +117,10 @@ public function initializeBySiteAndIndexConfigurations(Site $site, array $indexi
             if ($indexQueueInitializationPostProcessor instanceof InitializationPostProcessor) {
                 $indexQueueInitializationPostProcessor->postProcessIndexQueueInitialization($site, $indexingConfigurationNames, $initializationStatus);
             } else {
-                throw new UnexpectedValueException(get_class($indexQueueInitializationPostProcessor) . ' must implement interface ' . InitializationPostProcessor::class, 1345815561);
+                throw new InvalidIndexQueueInitizalizationPostProcessorException(
+                    get_class($indexQueueInitializationPostProcessor) . ' must implement interface ' . InitializationPostProcessor::class,
+                    1345815561
+                );
             }
         }
 

Classes/Domain/Index/Queue/RecordMonitor/Helper/RootPageResolver.php

@@ -19,11 +19,11 @@
 
 use ApacheSolrForTypo3\Solr\Domain\Site\Site;
 use ApacheSolrForTypo3\Solr\Domain\Site\SiteRepository;
+use ApacheSolrForTypo3\Solr\Exception\InvalidArgumentException;
 use ApacheSolrForTypo3\Solr\System\Cache\TwoLevelCache;
 use ApacheSolrForTypo3\Solr\System\Configuration\ExtensionConfiguration;
 use ApacheSolrForTypo3\Solr\System\Page\Rootline;
 use Doctrine\DBAL\Driver\Exception as DBALDriverException;
-use InvalidArgumentException;
 use RuntimeException;
 use Throwable;
 use TYPO3\CMS\Backend\Utility\BackendUtility;

Classes/Domain/Index/Queue/UpdateHandler/DataUpdateHandler.php

@@ -22,6 +22,7 @@
 use ApacheSolrForTypo3\Solr\Domain\Index\Queue\RecordMonitor\Helper\RootPageResolver;
 use ApacheSolrForTypo3\Solr\Domain\Site\SiteInterface;
 use ApacheSolrForTypo3\Solr\Domain\Site\SiteRepository;
+use ApacheSolrForTypo3\Solr\Exception\InvalidArgumentException;
 use ApacheSolrForTypo3\Solr\FrontendEnvironment;
 use ApacheSolrForTypo3\Solr\IndexQueue\Queue;
 use ApacheSolrForTypo3\Solr\System\Configuration\TypoScriptConfiguration;
@@ -31,7 +32,6 @@
 use ApacheSolrForTypo3\Solr\Util;
 use Doctrine\DBAL\Driver\Exception as DBALDriverException;
 use Doctrine\DBAL\Exception as DBALException;
-use InvalidArgumentException;
 use Throwable;
 use TYPO3\CMS\Backend\Utility\BackendUtility;
 use TYPO3\CMS\Core\Context\Exception\AspectNotFoundException;

Classes/Domain/Index/Queue/UpdateHandler/EventListener/AbstractBaseEventListener.php

@@ -21,8 +21,8 @@
 use ApacheSolrForTypo3\Solr\Domain\Index\Queue\UpdateHandler\EventListener\Events\ProcessingFinishedEventInterface;
 use ApacheSolrForTypo3\Solr\Domain\Index\Queue\UpdateHandler\Events\DataUpdateEventInterface;
 use ApacheSolrForTypo3\Solr\Domain\Index\Queue\UpdateHandler\GarbageHandler;
+use ApacheSolrForTypo3\Solr\Exception\InvalidArgumentException;
 use ApacheSolrForTypo3\Solr\System\Configuration\ExtensionConfiguration;
-use InvalidArgumentException;
 use Psr\EventDispatcher\EventDispatcherInterface;
 use TYPO3\CMS\Core\Utility\GeneralUtility;
 

Classes/Domain/Search/LastSearches/LastSearchesRepository.php

@@ -15,10 +15,10 @@
 
 namespace ApacheSolrForTypo3\Solr\Domain\Search\LastSearches;
 
+use ApacheSolrForTypo3\Solr\Exception\InvalidArgumentException;
 use ApacheSolrForTypo3\Solr\System\Records\AbstractRepository;
 use Doctrine\DBAL\Driver\Exception as DBALDriverException;
 use Doctrine\DBAL\Exception as DBALException;
-use InvalidArgumentException;
 use function json_encode;
 
 class LastSearchesRepository extends AbstractRepository

Classes/Domain/Search/Query/ParameterBuilder/Operator.php

@@ -15,7 +15,7 @@
 
 namespace ApacheSolrForTypo3\Solr\Domain\Search\Query\ParameterBuilder;
 
-use InvalidArgumentException;
+use ApacheSolrForTypo3\Solr\Exception\InvalidArgumentException;
 
 /**
  * The Operator ParameterProvider is responsible to build the solr query parameters

Classes/Domain/Search/ResultSet/Facets/FacetRegistry.php

@@ -22,8 +22,8 @@
 use ApacheSolrForTypo3\Solr\Domain\Search\ResultSet\Facets\OptionBased\QueryGroup\QueryGroupPackage;
 use ApacheSolrForTypo3\Solr\Domain\Search\ResultSet\Facets\RangeBased\DateRange\DateRangePackage;
 use ApacheSolrForTypo3\Solr\Domain\Search\ResultSet\Facets\RangeBased\NumericRange\NumericRangePackage;
+use ApacheSolrForTypo3\Solr\Exception\InvalidArgumentException;
 use ApacheSolrForTypo3\Solr\System\Object\AbstractClassRegistry;
-use InvalidArgumentException;
 
 /**
  * Class FacetRegistry

Classes/Domain/Search/ResultSet/Facets/InvalidFacetPackageException.php

@@ -15,6 +15,8 @@
 
 namespace ApacheSolrForTypo3\Solr\Domain\Search\ResultSet\Facets;
 
-class InvalidFacetPackageException extends \Exception
+use ApacheSolrForTypo3\Solr\Exception;
+
+class InvalidFacetPackageException extends Exception
 {
 }

Classes/Domain/Search/ResultSet/Facets/InvalidFacetParserException.php

@@ -15,6 +15,8 @@
 
 namespace ApacheSolrForTypo3\Solr\Domain\Search\ResultSet\Facets;
 
-class InvalidFacetParserException extends \Exception
+use ApacheSolrForTypo3\Solr\Exception;
+
+class InvalidFacetParserException extends Exception
 {
 }

Classes/Domain/Search/ResultSet/Facets/InvalidQueryBuilderException.php

@@ -15,6 +15,8 @@
 
 namespace ApacheSolrForTypo3\Solr\Domain\Search\ResultSet\Facets;
 
-class InvalidQueryBuilderException extends \Exception
+use ApacheSolrForTypo3\Solr\Exception;
+
+class InvalidQueryBuilderException extends Exception
 {
 }

Classes/Domain/Search/ResultSet/Facets/InvalidUrlDecoderException.php

@@ -17,7 +17,7 @@
 
 namespace ApacheSolrForTypo3\Solr\Domain\Search\ResultSet\Facets;
 
-use Exception;
+use ApacheSolrForTypo3\Solr\Exception;
 
 class InvalidUrlDecoderException extends Exception
 {

Classes/Domain/Search/ResultSet/Facets/RangeBased/NumericRange/NumericRangeUrlDecoder.php

@@ -18,7 +18,7 @@
 namespace ApacheSolrForTypo3\Solr\Domain\Search\ResultSet\Facets\RangeBased\NumericRange;
 
 use ApacheSolrForTypo3\Solr\Domain\Search\ResultSet\Facets\FacetUrlDecoderInterface;
-use InvalidArgumentException;
+use ApacheSolrForTypo3\Solr\Exception\InvalidArgumentException;
 
 /**
  * Parser to build Solr range queries from tx_solr[filter]

Classes/Domain/Search/ResultSet/Facets/RequirementsService.php

@@ -15,6 +15,7 @@
 
 namespace ApacheSolrForTypo3\Solr\Domain\Search\ResultSet\Facets;
 
+use ApacheSolrForTypo3\Solr\Exception\InvalidArgumentException;
 use TYPO3\CMS\Core\Utility\GeneralUtility;
 
 /**
@@ -83,12 +84,13 @@ protected function getRequirementMet(AbstractFacet $facet, $requirement = [])
      *
      * @param string $facetNameToCheckRequirementsOn
      * @return AbstractFacetItem[]
+     * @throws InvalidArgumentException
      */
     protected function getSelectedItemValues(AbstractFacet $facet, $facetNameToCheckRequirementsOn)
     {
         $facetToCheckRequirements = $facet->getResultSet()->getFacets()->getByName($facetNameToCheckRequirementsOn)->getByPosition(0);
         if (!$facetToCheckRequirements instanceof AbstractFacet) {
-            throw new \InvalidArgumentException('Requirement for unexisting facet configured');
+            throw new InvalidArgumentException('Requirement for unexisting facet configured');
         }
 
         if (!$facetToCheckRequirements->getIsUsed()) {

Classes/Domain/Search/ResultSet/Result/Parser/ResultParserRegistry.php

@@ -18,7 +18,7 @@
 namespace ApacheSolrForTypo3\Solr\Domain\Search\ResultSet\Result\Parser;
 
 use ApacheSolrForTypo3\Solr\Domain\Search\ResultSet\SearchResultSet;
-use InvalidArgumentException;
+use ApacheSolrForTypo3\Solr\Exception\InvalidArgumentException;
 use TYPO3\CMS\Core\SingletonInterface;
 use TYPO3\CMS\Core\Utility\GeneralUtility;
 

Classes/Domain/Search/ResultSet/Result/SearchResultBuilder.php

@@ -17,8 +17,8 @@
 
 namespace ApacheSolrForTypo3\Solr\Domain\Search\ResultSet\Result;
 
+use ApacheSolrForTypo3\Solr\Exception\InvalidArgumentException;
 use ApacheSolrForTypo3\Solr\System\Solr\Document\Document;
-use InvalidArgumentException;
 use TYPO3\CMS\Core\Utility\GeneralUtility;
 
 /**

Classes/Domain/Search/ResultSet/Sorting/Sorting.php

@@ -18,7 +18,7 @@
 namespace ApacheSolrForTypo3\Solr\Domain\Search\ResultSet\Sorting;
 
 use ApacheSolrForTypo3\Solr\Domain\Search\ResultSet\SearchResultSet;
-use InvalidArgumentException;
+use ApacheSolrForTypo3\Solr\Exception\InvalidArgumentException;
 
 /**
  * Class Sorting

Classes/Domain/Search/ResultSet/Sorting/SortingHelper.php

@@ -17,7 +17,7 @@
 
 namespace ApacheSolrForTypo3\Solr\Domain\Search\ResultSet\Sorting;
 
-use InvalidArgumentException;
+use ApacheSolrForTypo3\Solr\Exception\InvalidArgumentException;
 use TYPO3\CMS\Core\Utility\GeneralUtility;
 
 /**

Classes/Domain/Site/Exception/InvalidSiteConfigurationCombinationException.php

@@ -17,7 +17,7 @@
 
 namespace ApacheSolrForTypo3\Solr\Domain\Site\Exception;
 
-use Exception;
+use ApacheSolrForTypo3\Solr\Exception;
 
 class InvalidSiteConfigurationCombinationException extends Exception
 {

Classes/Domain/Site/Exception/InvalidSiteRootPageException.php

@@ -0,0 +1,24 @@
+<?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\Domain\Site\Exception;
+
+use ApacheSolrForTypo3\Solr\Exception;
+
+class InvalidSiteRootPageException extends Exception
+{
+}

Classes/Domain/Site/SiteRepository.php

@@ -18,13 +18,13 @@
 namespace ApacheSolrForTypo3\Solr\Domain\Site;
 
 use ApacheSolrForTypo3\Solr\Domain\Index\Queue\RecordMonitor\Helper\RootPageResolver;
+use ApacheSolrForTypo3\Solr\Exception\InvalidArgumentException;
 use ApacheSolrForTypo3\Solr\FrontendEnvironment;
 use ApacheSolrForTypo3\Solr\System\Cache\TwoLevelCache;
 use ApacheSolrForTypo3\Solr\System\Configuration\ExtensionConfiguration;
 use ApacheSolrForTypo3\Solr\System\Records\Pages\PagesRepository;
 use ApacheSolrForTypo3\Solr\System\Util\SiteUtility;
 use Doctrine\DBAL\Driver\Exception as DBALDriverException;
-use InvalidArgumentException;
 use Throwable;
 use TYPO3\CMS\Backend\Utility\BackendUtility;
 use TYPO3\CMS\Core\Registry;

Classes/Domain/Variants/IdBuilder.php

@@ -17,7 +17,7 @@
 
 namespace ApacheSolrForTypo3\Solr\Domain\Variants;
 
-use InvalidArgumentException;
+use ApacheSolrForTypo3\Solr\Exception\InvalidArgumentException;
 use TYPO3\CMS\Core\Utility\GeneralUtility;
 
 /**

Classes/Exception/Index/Queue/InvalidIndexQueueInitizalizationPostProcessorException.php

@@ -0,0 +1,27 @@
+<?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\Index\Queue;
+
+use ApacheSolrForTypo3\Solr\Exception;
+
+/**
+ * Exception that is thrown if an index queue post processor is invalid.
+ */
+class InvalidIndexQueueInitizalizationPostProcessorException extends Exception
+{
+}

Classes/Exception/InvalidArgumentException.php

@@ -0,0 +1,27 @@
+<?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 given argument is invalid.
+ */
+class InvalidArgumentException extends Exception
+{
+}