bug #3546 Added a compiler pass to create the controller registries (…

…javiereguiluz)

This PR was merged into the 3.0.x-dev branch.

Discussion
----------

Added a compiler pass to create the controller registries

Fixes #3541.

Commits
-------

e650e53 Added a compiler pass to create the controller registries

src/DependencyInjection/CreateControllerRegistriesPass.php

@@ -0,0 +1,51 @@
+<?php
+
+namespace EasyCorp\Bundle\EasyAdminBundle\DependencyInjection;
+
+use EasyCorp\Bundle\EasyAdminBundle\Registry\CrudControllerRegistry;
+use EasyCorp\Bundle\EasyAdminBundle\Registry\DashboardControllerRegistry;
+use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+
+/**
+ * Creates the services of the Dashboard and CRUD controller registries. They can't
+ * be defined as normal services because they cause circular dependencies.
+ * See https://github.com/EasyCorp/EasyAdminBundle/issues/3541
+ *
+ * @author Javier Eguiluz <javier.eguiluz@gmail.com>
+ */
+class CreateControllerRegistriesPass implements CompilerPassInterface
+{
+    public function process(ContainerBuilder $container)
+    {
+        $this->createDashboardControllerRegistryService($container);
+        $this->createCrudControllerRegistryService($container);
+    }
+
+    private function createDashboardControllerRegistryService(ContainerBuilder $container): void
+    {
+        $dashboardControllersFqcn = array_keys($container->findTaggedServiceIds(EasyAdminExtension::TAG_DASHBOARD_CONTROLLER, true));
+
+        $container
+            ->register(DashboardControllerRegistry::class, DashboardControllerRegistry::class)
+            ->setPublic(false)
+            ->setArguments([
+                $container->getParameter('kernel.secret'),
+                $container->getParameter('kernel.cache_dir'),
+                $dashboardControllersFqcn,
+            ]);
+    }
+
+    private function createCrudControllerRegistryService(ContainerBuilder $container): void
+    {
+        $crudControllersFqcn = array_keys($container->findTaggedServiceIds(EasyAdminExtension::TAG_CRUD_CONTROLLER, true));
+
+        $container
+            ->register(CrudControllerRegistry::class, CrudControllerRegistry::class)
+            ->setPublic(false)
+            ->setArguments([
+                $container->getParameter('kernel.secret'),
+                $crudControllersFqcn,
+            ]);
+    }
+}

src/EasyAdminBundle.php

@@ -2,6 +2,9 @@
 
 namespace EasyCorp\Bundle\EasyAdminBundle;
 
+use EasyCorp\Bundle\EasyAdminBundle\DependencyInjection\CreateControllerRegistriesPass;
+use Symfony\Component\DependencyInjection\Compiler\PassConfig;
+use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\HttpKernel\Bundle\Bundle;
 
 /**
@@ -11,4 +14,9 @@ class EasyAdminBundle extends Bundle
 {
     public const VERSION = '3.1.1-DEV';
     public const CONTEXT_ATTRIBUTE_NAME = 'easyadmin_context';
+
+    public function build(ContainerBuilder $container)
+    {
+        $container->addCompilerPass(new CreateControllerRegistriesPass(), PassConfig::TYPE_BEFORE_REMOVING);
+    }
 }

src/Registry/CrudControllerRegistry.php

@@ -17,11 +17,10 @@ final class CrudControllerRegistry
     /**
      * @param CrudControllerInterface[] $crudControllers
      */
-    public function __construct(string $kernelSecret, iterable $crudControllers)
+    public function __construct(string $kernelSecret, array $crudControllersFqcn)
     {
-        foreach (iterator_to_array($crudControllers, false) as $controller) {
-            $controllerFqcn = \get_class($controller);
-            $this->crudFqcnToEntityFqcnMap[$controllerFqcn] = $controller::getEntityFqcn();
+        foreach ($crudControllersFqcn as $controllerFqcn) {
+            $this->crudFqcnToEntityFqcnMap[$controllerFqcn] = $controllerFqcn::getEntityFqcn();
             $this->crudFqcnToCrudIdMap[$controllerFqcn] = substr(sha1($kernelSecret.$controllerFqcn), 0, 7);
         }
 

src/Registry/DashboardControllerRegistry.php

@@ -15,10 +15,9 @@ final class DashboardControllerRegistry
     private $controllerFqcnToRouteMap = [];
     private $routeToControllerFqcnMap = [];
 
-    public function __construct(string $kernelSecret, string $cacheDir, iterable $dashboardControllers)
+    public function __construct(string $kernelSecret, string $cacheDir, array $dashboardControllersFqcn)
     {
-        foreach (iterator_to_array($dashboardControllers, false) as $controller) {
-            $controllerFqcn = \get_class($controller);
+        foreach ($dashboardControllersFqcn as $controllerFqcn) {
             $this->controllerFqcnToContextIdMap[$controllerFqcn] = substr(sha1($kernelSecret.$controllerFqcn), 0, 7);
         }
 

src/Resources/config/services.php

@@ -169,15 +169,6 @@
             ->arg(4, new Reference(CrudControllerRegistry::class))
             ->arg(5, new Reference(EntityFactory::class))
 
-        ->set(DashboardControllerRegistry::class)
-            ->arg(0, '%kernel.secret%')
-            ->arg(1, '%kernel.cache_dir%')
-            ->arg(2, tagged_iterator(EasyAdminExtension::TAG_DASHBOARD_CONTROLLER))
-
-        ->set(CrudControllerRegistry::class)
-            ->arg(0, '%kernel.secret%')
-            ->arg(1, tagged_iterator(EasyAdminExtension::TAG_CRUD_CONTROLLER))
-
         ->set(CrudUrlGenerator::class)
             ->arg(0, new Reference(AdminContextProvider::class))
             ->arg(1, new Reference('router.default'))