IBX-8399: Moved RepositoryConfigurationProvider to Repository layer (#383)

For more details see https://issues.ibexa.co/browse/IBX-8399 and #383

Key changes:

* Changed Core Bundle ApiLoader Exception to be Repository Exceptions

* Extracted an interface from RepositoryConfigurationProvider

* Refactored StorageConnectionFactory to rely on ServiceProviderInterface

* Added missing readonly keyword in relevant places

* Deprecated RepositoryConfigurationProvider located in Core Bundle namespace

* [Tests] Aligned tests with the changes

* [PHPStan] Aligned baseline with the changes

* [PHPStan] Updated baseline after PHPStan release

---------

Co-Authored-By: Paweł Niedzielski <[email protected]>
Co-Authored-By: Konrad Oboza <[email protected]>

Author: 3 people

src/bundle/Core/ApiLoader/Exception/InvalidRepositoryException.php

@@ -4,11 +4,12 @@
  * @copyright Copyright (C) Ibexa AS. All rights reserved.
  * @license For full copyright and license information view LICENSE file distributed with this source code.
  */
+declare(strict_types=1);
 
 namespace Ibexa\Bundle\Core\ApiLoader\Exception;
 
-use InvalidArgumentException;
+use Ibexa\Contracts\Core\Repository\Exceptions\InvalidArgumentException;
 
-class InvalidRepositoryException extends InvalidArgumentException
+final class InvalidRepositoryException extends InvalidArgumentException
 {
 }

src/bundle/Core/ApiLoader/Exception/InvalidSearchEngine.php

@@ -4,11 +4,12 @@
  * @copyright Copyright (C) Ibexa AS. All rights reserved.
  * @license For full copyright and license information view LICENSE file distributed with this source code.
  */
+declare(strict_types=1);
 
 namespace Ibexa\Bundle\Core\ApiLoader\Exception;
 
-use InvalidArgumentException;
+use Ibexa\Contracts\Core\Repository\Exceptions\InvalidArgumentException;
 
-class InvalidSearchEngine extends InvalidArgumentException
+final class InvalidSearchEngine extends InvalidArgumentException
 {
 }

src/bundle/Core/ApiLoader/Exception/InvalidSearchEngineIndexer.php

@@ -4,11 +4,12 @@
  * @copyright Copyright (C) Ibexa AS. All rights reserved.
  * @license For full copyright and license information view LICENSE file distributed with this source code.
  */
+declare(strict_types=1);
 
 namespace Ibexa\Bundle\Core\ApiLoader\Exception;
 
-use InvalidArgumentException;
+use Ibexa\Contracts\Core\Repository\Exceptions\InvalidArgumentException;
 
-class InvalidSearchEngineIndexer extends InvalidArgumentException
+final class InvalidSearchEngineIndexer extends InvalidArgumentException
 {
 }

src/bundle/Core/ApiLoader/Exception/InvalidStorageEngine.php

@@ -4,11 +4,12 @@
  * @copyright Copyright (C) Ibexa AS. All rights reserved.
  * @license For full copyright and license information view LICENSE file distributed with this source code.
  */
+declare(strict_types=1);
 
 namespace Ibexa\Bundle\Core\ApiLoader\Exception;
 
-use InvalidArgumentException;
+use Ibexa\Contracts\Core\Repository\Exceptions\InvalidArgumentException;
 
-class InvalidStorageEngine extends InvalidArgumentException
+final class InvalidStorageEngine extends InvalidArgumentException
 {
 }

src/bundle/Core/ApiLoader/RepositoryConfigurationProvider.php

@@ -4,72 +4,39 @@
  * @copyright Copyright (C) Ibexa AS. All rights reserved.
  * @license For full copyright and license information view LICENSE file distributed with this source code.
  */
+declare(strict_types=1);
 
 namespace Ibexa\Bundle\Core\ApiLoader;
 
-use Ibexa\Bundle\Core\ApiLoader\Exception\InvalidRepositoryException;
-use Ibexa\Contracts\Core\SiteAccess\ConfigResolverInterface;
+use Ibexa\Contracts\Core\Container\ApiLoader\RepositoryConfigurationProviderInterface;
 
 /**
- * The repository configuration provider.
+ * @deprecated 5.0.0 The "\Ibexa\Bundle\Core\ApiLoader\RepositoryConfigurationProvider" class is deprecated, will be removed in 6.0.0.
+ * Inject {@see \Ibexa\Contracts\Core\Container\ApiLoader\RepositoryConfigurationProviderInterface} from Dependency Injection Container instead.
  */
-class RepositoryConfigurationProvider
+final readonly class RepositoryConfigurationProvider implements RepositoryConfigurationProviderInterface
 {
-    private const REPOSITORY_STORAGE = 'storage';
-    private const REPOSITORY_CONNECTION = 'connection';
-    private const DEFAULT_CONNECTION_NAME = 'default';
-
-    /** @var \Ibexa\Contracts\Core\SiteAccess\ConfigResolverInterface */
-    private $configResolver;
-
-    /** @var array */
-    private $repositories;
-
-    public function __construct(ConfigResolverInterface $configResolver, array $repositories)
+    public function __construct(private RepositoryConfigurationProviderInterface $configurationProvider)
     {
-        $this->configResolver = $configResolver;
-        $this->repositories = $repositories;
     }
 
-    /**
-     * @return array
-     *
-     * @throws \Ibexa\Bundle\Core\ApiLoader\Exception\InvalidRepositoryException
-     */
-    public function getRepositoryConfig()
+    public function getRepositoryConfig(): array
     {
-        // Takes configured repository as the reference, if it exists.
-        // If not, the first configured repository is considered instead.
-        $repositoryAlias = $this->configResolver->getParameter('repository');
-        $repositoryAlias = $repositoryAlias ?: $this->getDefaultRepositoryAlias();
-
-        if (empty($repositoryAlias) || !isset($this->repositories[$repositoryAlias])) {
-            throw new InvalidRepositoryException(
-                "Undefined Repository '$repositoryAlias'. Check if the Repository is configured in your project's ibexa.yaml."
-            );
-        }
-
-        return ['alias' => $repositoryAlias] + $this->repositories[$repositoryAlias];
+        return $this->configurationProvider->getRepositoryConfig();
     }
 
     public function getCurrentRepositoryAlias(): string
     {
-        return $this->getRepositoryConfig()['alias'];
+        return $this->configurationProvider->getCurrentRepositoryAlias();
     }
 
     public function getDefaultRepositoryAlias(): ?string
     {
-        $aliases = array_keys($this->repositories);
-
-        return array_shift($aliases);
+        return $this->configurationProvider->getDefaultRepositoryAlias();
     }
 
     public function getStorageConnectionName(): string
     {
-        $repositoryConfig = $this->getRepositoryConfig();
-
-        return $repositoryConfig[self::REPOSITORY_STORAGE][self::REPOSITORY_CONNECTION]
-            ? $repositoryConfig[self::REPOSITORY_STORAGE][self::REPOSITORY_CONNECTION]
-            : self::DEFAULT_CONNECTION_NAME;
+        return $this->configurationProvider->getStorageConnectionName();
     }
 }

src/bundle/Core/ApiLoader/RepositoryFactory.php

@@ -7,6 +7,7 @@
 
 namespace Ibexa\Bundle\Core\ApiLoader;
 
+use Ibexa\Contracts\Core\Container\ApiLoader\RepositoryConfigurationProviderInterface;
 use Ibexa\Contracts\Core\Persistence\Filter\Content\Handler as ContentFilteringHandler;
 use Ibexa\Contracts\Core\Persistence\Filter\Location\Handler as LocationFilteringHandler;
 use Ibexa\Contracts\Core\Persistence\Handler as PersistenceHandler;
@@ -59,6 +60,7 @@ public function __construct(
         $repositoryClass,
         array $policyMap,
         LanguageResolver $languageResolver,
+        private readonly RepositoryConfigurationProviderInterface $repositoryConfigurationProvider,
         LoggerInterface $logger = null
     ) {
         $this->configResolver = $configResolver;
@@ -94,9 +96,9 @@ public function buildRepository(
         LocationFilteringHandler $locationFilteringHandler,
         PasswordValidatorInterface $passwordValidator,
         ConfigResolverInterface $configResolver,
-        NameSchemaServiceInterface $nameSchemaService
+        NameSchemaServiceInterface $nameSchemaService,
     ): Repository {
-        $config = $this->container->get(RepositoryConfigurationProvider::class)->getRepositoryConfig();
+        $config = $this->repositoryConfigurationProvider->getRepositoryConfig();
 
         return new $this->repositoryClass(
             $persistenceHandler,

src/bundle/Core/ApiLoader/SearchEngineFactory.php

@@ -8,16 +8,14 @@
 namespace Ibexa\Bundle\Core\ApiLoader;
 
 use Ibexa\Bundle\Core\ApiLoader\Exception\InvalidSearchEngine;
+use Ibexa\Contracts\Core\Container\ApiLoader\RepositoryConfigurationProviderInterface;
 use Ibexa\Contracts\Core\Search\Handler as SearchHandler;
 
 /**
  * The search engine factory.
  */
 class SearchEngineFactory
 {
-    /** @var \Ibexa\Bundle\Core\ApiLoader\RepositoryConfigurationProvider */
-    private $repositoryConfigurationProvider;
-
     /**
      * Hash of registered search engines.
      * Key is the search engine identifier, value search handler itself.
@@ -26,9 +24,9 @@ class SearchEngineFactory
      */
     protected $searchEngines = [];
 
-    public function __construct(RepositoryConfigurationProvider $repositoryConfigurationProvider)
-    {
-        $this->repositoryConfigurationProvider = $repositoryConfigurationProvider;
+    public function __construct(
+        private readonly RepositoryConfigurationProviderInterface $repositoryConfigurationProvider,
+    ) {
     }
 
     /**

src/bundle/Core/ApiLoader/SearchEngineIndexerFactory.php

@@ -9,16 +9,14 @@
 
 use Ibexa\Bundle\Core\ApiLoader\Exception\InvalidSearchEngine;
 use Ibexa\Bundle\Core\ApiLoader\Exception\InvalidSearchEngineIndexer;
+use Ibexa\Contracts\Core\Container\ApiLoader\RepositoryConfigurationProviderInterface;
 use Ibexa\Core\Search\Common\Indexer as SearchEngineIndexer;
 
 /**
  * The search engine indexer factory.
  */
 class SearchEngineIndexerFactory
 {
-    /** @var \Ibexa\Bundle\Core\ApiLoader\RepositoryConfigurationProvider */
-    private $repositoryConfigurationProvider;
-
     /**
      * Hash of registered search engine indexers.
      * Key is the search engine identifier, value indexer itself.
@@ -27,9 +25,9 @@ class SearchEngineIndexerFactory
      */
     protected $searchEngineIndexers = [];
 
-    public function __construct(RepositoryConfigurationProvider $repositoryConfigurationProvider)
-    {
-        $this->repositoryConfigurationProvider = $repositoryConfigurationProvider;
+    public function __construct(
+        private readonly RepositoryConfigurationProviderInterface $repositoryConfigurationProvider,
+    ) {
     }
 
     /**

src/bundle/Core/ApiLoader/StorageConnectionFactory.php

@@ -7,49 +7,44 @@
 
 namespace Ibexa\Bundle\Core\ApiLoader;
 
+use Doctrine\DBAL\Connection;
+use Ibexa\Contracts\Core\Container\ApiLoader\RepositoryConfigurationProviderInterface;
 use InvalidArgumentException;
-use Symfony\Component\DependencyInjection\ContainerAwareInterface;
-use Symfony\Component\DependencyInjection\ContainerAwareTrait;
+use Symfony\Contracts\Service\ServiceProviderInterface;
 
-class StorageConnectionFactory implements ContainerAwareInterface
+/**
+ * @internal
+ */
+final readonly class StorageConnectionFactory
 {
-    use ContainerAwareTrait;
-
-    /** @var \Ibexa\Bundle\Core\ApiLoader\RepositoryConfigurationProvider */
-    protected $repositoryConfigurationProvider;
-
-    public function __construct(RepositoryConfigurationProvider $repositoryConfigurationProvider)
-    {
-        $this->repositoryConfigurationProvider = $repositoryConfigurationProvider;
+    public function __construct(
+        private RepositoryConfigurationProviderInterface $repositoryConfigurationProvider,
+        private ServiceProviderInterface $serviceLocator,
+    ) {
     }
 
     /**
      * Returns database connection used by database handler.
      *
      * @throws \InvalidArgumentException
-     *
-     * @return \Doctrine\DBAL\Connection
+     * @throws \Ibexa\Contracts\Core\Repository\Exceptions\InvalidArgumentException
+     * @throws \Psr\Container\ContainerExceptionInterface
+     * @throws \Psr\Container\NotFoundExceptionInterface
      */
-    public function getConnection()
+    public function getConnection(): Connection
     {
         $repositoryConfig = $this->repositoryConfigurationProvider->getRepositoryConfig();
         // Taking provided connection name if any.
         // Otherwise, just fallback to the default connection.
 
-        if (isset($repositoryConfig['storage']['connection'])) {
-            $doctrineConnectionId = sprintf('doctrine.dbal.%s_connection', $repositoryConfig['storage']['connection']);
-        } else {
-            // "database_connection" is an alias to the default connection, set up by DoctrineBundle.
-            $doctrineConnectionId = 'database_connection';
-        }
-
-        if (!$this->container->has($doctrineConnectionId)) {
+        $connectionName = $repositoryConfig['storage']['connection'] ?? 'default';
+        if (!$this->serviceLocator->has($connectionName)) {
             throw new InvalidArgumentException(
-                "Invalid Doctrine connection '{$repositoryConfig['storage']['connection']}' for Repository '{$repositoryConfig['alias']}'." .
-                'Valid connections are: ' . implode(', ', array_keys($this->container->getParameter('doctrine.connections')))
+                "Invalid Doctrine connection '$connectionName' for Repository '{$repositoryConfig['alias']}'. " .
+                'Valid connections are: ' . implode(', ', array_keys($this->serviceLocator->getProvidedServices()))
             );
         }
 
-        return $this->container->get($doctrineConnectionId);
+        return $this->serviceLocator->get($connectionName);
     }
 }

src/bundle/Core/ApiLoader/StorageEngineFactory.php

@@ -8,54 +8,49 @@
 namespace Ibexa\Bundle\Core\ApiLoader;
 
 use Ibexa\Bundle\Core\ApiLoader\Exception\InvalidStorageEngine;
+use Ibexa\Contracts\Core\Container\ApiLoader\RepositoryConfigurationProviderInterface;
 use Ibexa\Contracts\Core\Persistence\Handler as PersistenceHandler;
 
 /**
  * The storage engine factory.
  */
 class StorageEngineFactory
 {
-    /** @var \Ibexa\Bundle\Core\ApiLoader\RepositoryConfigurationProvider */
-    private $repositoryConfigurationProvider;
-
     /**
      * Hash of registered storage engines.
      * Key is the storage engine identifier, value persistence handler itself.
      *
      * @var \Ibexa\Contracts\Core\Persistence\Handler[]
      */
-    protected $storageEngines = [];
+    protected array $storageEngines = [];
 
-    public function __construct(RepositoryConfigurationProvider $repositoryConfigurationProvider)
-    {
-        $this->repositoryConfigurationProvider = $repositoryConfigurationProvider;
+    public function __construct(
+        private readonly RepositoryConfigurationProviderInterface $repositoryConfigurationProvider,
+    ) {
     }
 
     /**
      * Registers $persistenceHandler as a valid storage engine, with identifier $storageEngineIdentifier.
      *
      * Note: It is strongly recommenced to register a lazy persistent handler.
-     *
-     * @param \Ibexa\Contracts\Core\Persistence\Handler $persistenceHandler
-     * @param string $storageEngineIdentifier
      */
-    public function registerStorageEngine(PersistenceHandler $persistenceHandler, $storageEngineIdentifier)
+    public function registerStorageEngine(PersistenceHandler $persistenceHandler, string $storageEngineIdentifier): void
     {
         $this->storageEngines[$storageEngineIdentifier] = $persistenceHandler;
     }
 
     /**
      * @return \Ibexa\Contracts\Core\Persistence\Handler[]
      */
-    public function getStorageEngines()
+    public function getStorageEngines(): array
     {
         return $this->storageEngines;
     }
 
     /**
      * Builds storage engine identified by $storageEngineIdentifier (the "alias" attribute in the service tag).
      *
-     * @throws \Ibexa\Bundle\Core\ApiLoader\Exception\InvalidStorageEngine
+     * @throws \Ibexa\Contracts\Core\Repository\Exceptions\InvalidArgumentException
      */
     public function buildStorageEngine(): PersistenceHandler
     {
@@ -73,9 +68,9 @@ public function buildStorageEngine(): PersistenceHandler
 
         if (!isset($this->storageEngines[$storageEngineAlias])) {
             throw new InvalidStorageEngine(
-                "Invalid storage engine '{$storageEngineAlias}'. " .
+                "Invalid storage engine '$storageEngineAlias'. " .
                 'Could not find any service tagged with ibexa.storage ' .
-                "with alias {$storageEngineAlias}."
+                "with alias $storageEngineAlias."
             );
         }