IBX-8400: Fixed redundancy in RepositoryFactory implementations (#384)

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

Key changes:

* Dropped support for dynamic Core Repository class in RepositoryFactory

* Made RepositoryFactory not Container-aware

* Deprecated Core Bundle RepositoryFactory in favor of Repository's one

* Combined Bundle and core RepositoryFactory into one

* [Tests] Added needed RepositoryFactory configuration to test setup

* [PHPStan] Introduced role policy map array shape as TPolicyMap

* [PHPStan] Aligned baseline after the changes

Author: alongosz

src/bundle/Core/ApiLoader/RepositoryFactory.php

@@ -25,23 +25,23 @@
 use Ibexa\Core\Repository\Mapper;
 use Ibexa\Core\Repository\Permission\LimitationService;
 use Ibexa\Core\Repository\ProxyFactory\ProxyDomainMapperFactoryInterface;
+use Ibexa\Core\Repository\Repository as CoreRepository;
 use Ibexa\Core\Repository\User\PasswordValidatorInterface;
 use Ibexa\Core\Search\Common\BackgroundIndexer;
 use Psr\Log\LoggerInterface;
 use Psr\Log\NullLogger;
-use Symfony\Component\DependencyInjection\ContainerAwareInterface;
-use Symfony\Component\DependencyInjection\ContainerAwareTrait;
 
-class RepositoryFactory implements ContainerAwareInterface
+/**
+ * @internal
+ *
+ * @deprecated 5.0.0 The "\Ibexa\Bundle\Core\ApiLoader\RepositoryFactory" class is deprecated, will be removed in 6.0.
+ * Use {@see \Ibexa\Core\Base\Container\ApiLoader\RepositoryFactory instead}.
+ */
+class RepositoryFactory
 {
-    use ContainerAwareTrait;
-
     /** @var \Ibexa\Contracts\Core\SiteAccess\ConfigResolverInterface */
     private $configResolver;
 
-    /** @var string */
-    private $repositoryClass;
-
     /**
      * Map of system configured policies.
      *
@@ -57,14 +57,12 @@ class RepositoryFactory implements ContainerAwareInterface
 
     public function __construct(
         ConfigResolverInterface $configResolver,
-        $repositoryClass,
         array $policyMap,
         LanguageResolver $languageResolver,
         private readonly RepositoryConfigurationProviderInterface $repositoryConfigurationProvider,
         LoggerInterface $logger = null
     ) {
         $this->configResolver = $configResolver;
-        $this->repositoryClass = $repositoryClass;
         $this->policyMap = $policyMap;
         $this->languageResolver = $languageResolver;
         $this->logger = $logger ?? new NullLogger();
@@ -100,7 +98,7 @@ public function buildRepository(
     ): Repository {
         $config = $this->repositoryConfigurationProvider->getRepositoryConfig();
 
-        return new $this->repositoryClass(
+        return new CoreRepository(
             $persistenceHandler,
             $searchHandler,
             $backgroundIndexer,

src/bundle/Core/Resources/config/papi.yml

@@ -11,15 +11,16 @@ parameters:
 services:
     # API
     Ibexa\Bundle\Core\ApiLoader\RepositoryFactory:
+        deprecated:
+            package: 'ibexa/core'
+            version: '5.0'
+            message: 'Since ibexa/core 5.0: The "%service_id%" service is deprecated and will be removed in 6.0. Use Ibexa\Core\Base\Container\ApiLoader\RepositoryFactory instead'
         arguments:
-            - '@ibexa.config.resolver'
-            - Ibexa\Core\Repository\Repository
-            - '%ibexa.api.role.policy_map%'
-            - '@Ibexa\Contracts\Core\Repository\LanguageResolver'
-            - '@Ibexa\Contracts\Core\Container\ApiLoader\RepositoryConfigurationProviderInterface'
-            - "@?logger"
-        calls:
-            - [setContainer, ["@service_container"]]
+            $configResolver: '@Ibexa\Contracts\Core\SiteAccess\ConfigResolverInterface'
+            $policyMap: '%ibexa.api.role.policy_map%'
+            $languageResolver: '@Ibexa\Contracts\Core\Repository\LanguageResolver'
+            $repositoryConfigurationProvider: '@Ibexa\Contracts\Core\Container\ApiLoader\RepositoryConfigurationProviderInterface'
+            $logger: "@?logger"
 
     Ibexa\Bundle\Core\ApiLoader\StorageEngineFactory:
         arguments:

src/bundle/Core/Resources/config/storage_engines.yml

@@ -1,12 +1,4 @@
 services:
-    Ibexa\Contracts\Core\Container\ApiLoader\RepositoryConfigurationProviderInterface:
-        alias: Ibexa\Core\Base\Container\ApiLoader\RepositoryConfigurationProvider
-
-    Ibexa\Core\Base\Container\ApiLoader\RepositoryConfigurationProvider:
-        arguments:
-            $configResolver: '@Ibexa\Contracts\Core\SiteAccess\ConfigResolverInterface'
-            $repositories: '%ibexa.repositories%'
-
     Ibexa\Bundle\Core\ApiLoader\RepositoryConfigurationProvider:
         deprecated:
             package: 'ibexa/core'

src/contracts/Repository/RoleService.php

@@ -23,6 +23,8 @@
 
 /**
  * This service provides methods for managing Roles and Policies.
+ *
+ * @phpstan-type TPolicyMap array<string, array<string, array<string, boolean|null>>>
  */
 interface RoleService
 {

src/lib/Base/Container/ApiLoader/RepositoryFactory.php

@@ -7,6 +7,7 @@
 
 namespace Ibexa\Core\Base\Container\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;
@@ -25,36 +26,40 @@
 use Ibexa\Core\Repository\Mapper;
 use Ibexa\Core\Repository\Permission\LimitationService;
 use Ibexa\Core\Repository\ProxyFactory\ProxyDomainMapperFactoryInterface;
+use Ibexa\Core\Repository\Repository as CoreRepository;
 use Ibexa\Core\Repository\User\PasswordValidatorInterface;
 use Ibexa\Core\Search\Common\BackgroundIndexer;
-use Symfony\Component\DependencyInjection\ContainerAwareInterface;
-use Symfony\Component\DependencyInjection\ContainerAwareTrait;
+use Psr\Log\LoggerAwareInterface;
+use Psr\Log\LoggerAwareTrait;
+use Psr\Log\NullLogger;
 
-class RepositoryFactory implements ContainerAwareInterface
+/**
+ * @internal
+ *
+ * @phpstan-import-type TPolicyMap from \Ibexa\Contracts\Core\Repository\RoleService
+ */
+final class RepositoryFactory implements LoggerAwareInterface
 {
-    use ContainerAwareTrait;
+    use LoggerAwareTrait;
 
-    /** @var string */
-    private $repositoryClass;
+    /** @phpstan-var TPolicyMap */
+    private array $policyMap;
 
-    /**
-     * Policies map.
-     *
-     * @var array
-     */
-    protected $policyMap = [];
+    private LanguageResolver $languageResolver;
 
-    /** @var \Ibexa\Contracts\Core\Repository\LanguageResolver */
-    private $languageResolver;
+    private RepositoryConfigurationProviderInterface $repositoryConfigurationProvider;
 
+    /**
+     * @phpstan-param TPolicyMap $policyMap
+     */
     public function __construct(
-        $repositoryClass,
         array $policyMap,
-        LanguageResolver $languageResolver
+        LanguageResolver $languageResolver,
+        RepositoryConfigurationProviderInterface $repositoryConfigurationProvider
     ) {
-        $this->repositoryClass = $repositoryClass;
         $this->policyMap = $policyMap;
         $this->languageResolver = $languageResolver;
+        $this->repositoryConfigurationProvider = $repositoryConfigurationProvider;
     }
 
     /**
@@ -63,7 +68,7 @@ public function __construct(
      * This always returns the true inner Repository, please depend on ezpublish.api.repository and not this method
      * directly to make sure you get an instance wrapped inside Event / Cache / * functionality.
      *
-     * @param string[] $languages
+     * @throws \Ibexa\Contracts\Core\Repository\Exceptions\InvalidArgumentException
      */
     public function buildRepository(
         PersistenceHandler $persistenceHandler,
@@ -85,10 +90,11 @@ public function buildRepository(
         LocationFilteringHandler $locationFilteringHandler,
         PasswordValidatorInterface $passwordValidator,
         ConfigResolverInterface $configResolver,
-        NameSchemaServiceInterface $nameSchemaService,
-        array $languages
+        NameSchemaServiceInterface $nameSchemaService
     ): Repository {
-        return new $this->repositoryClass(
+        $config = $this->repositoryConfigurationProvider->getRepositoryConfig();
+
+        return new CoreRepository(
             $persistenceHandler,
             $searchHandler,
             $backgroundIndexer,
@@ -114,8 +120,13 @@ public function buildRepository(
                 'role' => [
                     'policyMap' => $this->policyMap,
                 ],
-                'languages' => $languages,
+                'languages' => $configResolver->getParameter('languages'),
+                'content' => [
+                    'default_version_archive_limit' => $config['options']['default_version_archive_limit'],
+                    'remove_archived_versions_on_publish' => $config['options']['remove_archived_versions_on_publish'],
+                ],
             ],
+            $this->logger ?? new NullLogger()
         );
     }
 

src/lib/Repository/RoleService.php

@@ -42,6 +42,8 @@
 
 /**
  * This service provides methods for managing Roles and Policies.
+ *
+ * @phpstan-import-type TPolicyMap from \Ibexa\Contracts\Core\Repository\RoleService
  */
 class RoleService implements RoleServiceInterface
 {
@@ -57,20 +59,16 @@ class RoleService implements RoleServiceInterface
     /** @var \Ibexa\Core\Repository\Mapper\RoleDomainMapper */
     protected $roleDomainMapper;
 
-    /** @var array */
-    protected $settings;
+    /** @phpstan-var array{policyMap: TPolicyMap}|array{} */
+    protected array $settings;
 
     /** @var \Ibexa\Contracts\Core\Repository\PermissionResolver */
     private $permissionResolver;
 
     /**
      * Setups service with reference to repository object that created it & corresponding handler.
      *
-     * @param \Ibexa\Contracts\Core\Repository\Repository $repository
-     * @param \Ibexa\Contracts\Core\Persistence\User\Handler $userHandler
-     * @param \Ibexa\Core\Repository\Permission\LimitationService $limitationService
-     * @param \Ibexa\Core\Repository\Mapper\RoleDomainMapper $roleDomainMapper
-     * @param array $settings
+     * @phpstan-param array{policyMap: TPolicyMap}|array{} $settings
      */
     public function __construct(
         RepositoryInterface $repository,

src/lib/Resources/settings/repository/autowire.yml

@@ -1,4 +1,6 @@
 services:
+    Ibexa\Contracts\Core\Container\ApiLoader\RepositoryConfigurationProviderInterface: '@Ibexa\Core\Base\Container\ApiLoader\RepositoryConfigurationProvider'
+
     Ibexa\Contracts\Core\Repository\Repository: '@ibexa.api.repository'
 
     Ibexa\Contracts\Core\SiteAccess\ConfigResolverInterface: '@ibexa.config.resolver'

src/lib/Resources/settings/repository/inner.yml

@@ -6,39 +6,40 @@ parameters:
 
     # intentionally defined class parameter to be used by the Repository Factory
 services:
-    Ibexa\Bundle\Core\ApiLoader\RepositoryFactory:
-        class: Ibexa\Core\Base\Container\ApiLoader\RepositoryFactory
+    Ibexa\Core\Base\Container\ApiLoader\RepositoryConfigurationProvider:
         arguments:
-            - Ibexa\Core\Repository\Repository
-            - '%ibexa.api.role.policy_map%'
-            - '@Ibexa\Contracts\Core\Repository\LanguageResolver'
-        calls:
-            - [setContainer, ["@service_container"]]
+            $configResolver: '@Ibexa\Contracts\Core\SiteAccess\ConfigResolverInterface'
+            $repositories: '%ibexa.repositories%'
+
+    Ibexa\Core\Base\Container\ApiLoader\RepositoryFactory:
+        arguments:
+            $policyMap: '%ibexa.api.role.policy_map%'
+            $languageResolver: '@Ibexa\Contracts\Core\Repository\LanguageResolver'
+            $repositoryConfigurationProvider: '@Ibexa\Contracts\Core\Container\ApiLoader\RepositoryConfigurationProviderInterface'
 
     Ibexa\Core\Repository\Repository:
-        factory: ['@Ibexa\Bundle\Core\ApiLoader\RepositoryFactory', buildRepository]
+        factory: ['@Ibexa\Core\Base\Container\ApiLoader\RepositoryFactory', buildRepository]
         arguments:
-            - '@ibexa.api.persistence_handler'
-            - '@ibexa.spi.search'
-            - '@Ibexa\Bundle\Core\EventListener\BackgroundIndexingTerminateListener'
-            - '@Ibexa\Core\Repository\Helper\RelationProcessor'
-            - '@Ibexa\Core\FieldType\FieldTypeRegistry'
-            - '@Ibexa\Core\Repository\User\PasswordHashService'
-            - '@Ibexa\Core\Repository\Strategy\ContentThumbnail\ThumbnailChainStrategy'
-            - '@Ibexa\Core\Repository\ProxyFactory\ProxyDomainMapperFactory'
-            - '@Ibexa\Core\Repository\Mapper\ContentDomainMapper'
-            - '@Ibexa\Core\Repository\Mapper\ContentTypeDomainMapper'
-            - '@Ibexa\Core\Repository\Mapper\RoleDomainMapper'
-            - '@Ibexa\Core\Repository\Mapper\ContentMapper'
-            - '@Ibexa\Contracts\Core\Repository\Validator\ContentValidator'
-            - '@Ibexa\Core\Repository\Permission\LimitationService'
-            - '@Ibexa\Contracts\Core\Repository\PermissionService'
-            - '@Ibexa\Contracts\Core\Persistence\Filter\Content\Handler'
-            - '@Ibexa\Contracts\Core\Persistence\Filter\Location\Handler'
-            - '@Ibexa\Core\Repository\User\PasswordValidatorInterface'
-            - '@ibexa.config.resolver'
-            - '@Ibexa\Contracts\Core\Repository\NameSchema\NameSchemaServiceInterface'
-            - '%languages%'
+            $persistenceHandler: '@ibexa.api.persistence_handler'
+            $searchHandler: '@ibexa.spi.search'
+            $backgroundIndexer: '@Ibexa\Bundle\Core\EventListener\BackgroundIndexingTerminateListener'
+            $relationProcessor: '@Ibexa\Core\Repository\Helper\RelationProcessor'
+            $fieldTypeRegistry: '@Ibexa\Core\FieldType\FieldTypeRegistry'
+            $passwordHashService: '@Ibexa\Core\Repository\User\PasswordHashService'
+            $thumbnailStrategy: '@Ibexa\Core\Repository\Strategy\ContentThumbnail\ThumbnailChainStrategy'
+            $proxyDomainMapperFactory: '@Ibexa\Core\Repository\ProxyFactory\ProxyDomainMapperFactory'
+            $contentDomainMapper: '@Ibexa\Core\Repository\Mapper\ContentDomainMapper'
+            $contentTypeDomainMapper: '@Ibexa\Core\Repository\Mapper\ContentTypeDomainMapper'
+            $roleDomainMapper: '@Ibexa\Core\Repository\Mapper\RoleDomainMapper'
+            $contentMapper: '@Ibexa\Core\Repository\Mapper\ContentMapper'
+            $contentValidator: '@Ibexa\Contracts\Core\Repository\Validator\ContentValidator'
+            $limitationService: '@Ibexa\Core\Repository\Permission\LimitationService'
+            $permissionService: '@Ibexa\Contracts\Core\Repository\PermissionService'
+            $contentFilteringHandler: '@Ibexa\Contracts\Core\Persistence\Filter\Content\Handler'
+            $locationFilteringHandler: '@Ibexa\Contracts\Core\Persistence\Filter\Location\Handler'
+            $passwordValidator: '@Ibexa\Core\Repository\User\PasswordValidatorInterface'
+            $configResolver: '@Ibexa\Contracts\Core\SiteAccess\ConfigResolverInterface'
+            $nameSchemaService: '@Ibexa\Contracts\Core\Repository\NameSchema\NameSchemaServiceInterface'
 
     Ibexa\Core\Repository\ContentService:
         class: Ibexa\Core\Repository\ContentService

tests/integration/Core/Resources/settings/integration_legacy.yml

@@ -14,6 +14,22 @@ parameters:
 
     ibexa.site_access.config.default.user_content_type_identifier: ['user']
 
+    ibexa.repositories:
+        default:
+            storage: ~
+            search:
+                engine: '%env(SEARCH_ENGINE)%'
+                connection: default
+            fields_groups:
+                list: [content, metadata]
+                default: content
+            options:
+                default_version_archive_limit: 5
+                remove_archived_versions_on_publish: true
+
+    ibexa.site_access.config.default.repository: default
+    ibexa.site_access.config.default.languages: '%languages%'
+
 services:
     Ibexa\Core\FieldType\ImageAsset\AssetMapper:
         arguments: