bug #6661 Fix for issue #6519 (Pretty URLs in tests) (Matthieu Renard)

This PR was squashed before being merged into the 4.x branch.

Discussion
----------

Fix for issue #6519 (Pretty URLs in tests)

When using pretty URLs in tests, the AdminUrlGenerator fails to provide the pretty URLs because it checks the use of pretty URLs through the context, which is null when doing requests from tests. This fixes this behaviour by checking the use of pretty URLs directly from the UrlGenerator (Router), which is what is done by the context anyway.

Tests have been adapted to use pretty URLs.

<!--
Thanks for your contribution! If you are proposing a new feature that is complex,
please open an issue first so we can discuss about it.

Note: all your contributions adhere implicitly to the MIT license
-->

Commits
-------

8fdbca1 Fix for issue #6519 (Pretty URLs in tests)

Author: javiereguiluz

.ddev/example/Controller/Admin/DashboardController.php

@@ -7,9 +7,8 @@
 use EasyCorp\Bundle\EasyAdminBundle\Config\Dashboard;
 use EasyCorp\Bundle\EasyAdminBundle\Config\MenuItem;
 use EasyCorp\Bundle\EasyAdminBundle\Controller\AbstractDashboardController;
-use Symfony\Component\ExpressionLanguage\Expression;
 use Symfony\Component\HttpFoundation\Response;
-use Symfony\Component\Routing\Annotation\Route;
+use Symfony\Component\Routing\Attribute\Route;
 
 class DashboardController extends AbstractDashboardController
 {

src/Router/AdminUrlGenerator.php

@@ -222,6 +222,8 @@ public function generateUrl(): string
             $this->initialize();
         }
 
+        $usePrettyUrls = $this->adminRouteGenerator->usesPrettyUrls();
+
         if (true === $this->includeReferrer) {
             $this->setRouteParameter(EA::REFERRER, $this->customPageReferrer ?? $this->currentPageReferrer);
         }
@@ -239,7 +241,9 @@ public function generateUrl(): string
             }
 
             $this->dashboardRoute = $dashboardRoute;
-            $this->unset(EA::DASHBOARD_CONTROLLER_FQCN);
+            if (!$usePrettyUrls) {
+                $this->unset(EA::DASHBOARD_CONTROLLER_FQCN);
+            }
         }
 
         // if the current action is 'index' and an entity ID is defined, remove the entity ID to prevent exceptions automatically
@@ -276,20 +280,22 @@ public function generateUrl(): string
         }
 
         $context = $this->adminContextProvider->getContext();
-        $usePrettyUrls = null !== $context && $context->usePrettyUrls();
         $urlType = null !== $context && false === $context->getAbsoluteUrls() ? UrlGeneratorInterface::ABSOLUTE_PATH : UrlGeneratorInterface::ABSOLUTE_URL;
 
         if (null !== $this->get(EA::ROUTE_NAME)) {
             return $this->urlGenerator->generate($this->dashboardRoute, $routeParameters, $urlType);
         }
 
         if ($usePrettyUrls) {
-            $dashboardControllerFqcn = $this->get(EA::DASHBOARD_CONTROLLER_FQCN) ?? $context->getRequest()->attributes->get(EA::DASHBOARD_CONTROLLER_FQCN) ?? $this->dashboardControllerRegistry->getFirstDashboardFqcn();
-            $crudControllerFqcn = $this->get(EA::CRUD_CONTROLLER_FQCN) ?? $context->getRequest()->attributes->get(EA::CRUD_CONTROLLER_FQCN);
-            $actionName = $this->get(EA::CRUD_ACTION) ?? $context->getRequest()->attributes->get(EA::CRUD_ACTION);
+            $dashboardControllerFqcn = $this->get(EA::DASHBOARD_CONTROLLER_FQCN) ?? $context?->getRequest()->attributes->get(EA::DASHBOARD_CONTROLLER_FQCN) ?? $this->dashboardControllerRegistry->getFirstDashboardFqcn();
+            $crudControllerFqcn = $this->get(EA::CRUD_CONTROLLER_FQCN) ?? $context?->getRequest()->attributes->get(EA::CRUD_CONTROLLER_FQCN);
+            $actionName = $this->get(EA::CRUD_ACTION) ?? $context?->getRequest()->attributes->get(EA::CRUD_ACTION);
 
             if (null === $crudControllerFqcn || null === $routeName = $this->adminRouteGenerator->findRouteName($dashboardControllerFqcn, $crudControllerFqcn, $actionName)) {
                 $routeName = $this->dashboardRoute;
+                if (null === $crudControllerFqcn) {
+                    unset($routeParameters[EA::DASHBOARD_CONTROLLER_FQCN]);
+                }
             } else {
                 // remove these parameters so they don't appear in the query string when using pretty URLs
                 unset($routeParameters[EA::DASHBOARD_CONTROLLER_FQCN]);

tests/Controller/PrettyUrls/PrettyUrlsControllerTest.php

@@ -2,6 +2,10 @@
 
 namespace EasyCorp\Bundle\EasyAdminBundle\Tests\Controller\PrettyUrls;
 
+use EasyCorp\Bundle\EasyAdminBundle\Config\Action;
+use EasyCorp\Bundle\EasyAdminBundle\Router\AdminUrlGenerator;
+use EasyCorp\Bundle\EasyAdminBundle\Tests\PrettyUrlsTestApplication\Controller\BlogPostCrudController;
+use EasyCorp\Bundle\EasyAdminBundle\Tests\PrettyUrlsTestApplication\Controller\DashboardController;
 use EasyCorp\Bundle\EasyAdminBundle\Tests\PrettyUrlsTestApplication\Kernel;
 use Symfony\Bundle\FrameworkBundle\Test\WebTestCase;
 
@@ -256,6 +260,24 @@ public function testCustomSortLinksUsePrettyUrls()
         $this->assertSame('http://localhost/second/dashboard/user-editor/custom/path-for-index?page=1&sort%5Bemail%5D=DESC', $crawler->filter('th.searchable a')->eq(2)->attr('href'));
     }
 
+    public function testAdminUrlGeneratorUsePrettyUrls()
+    {
+        self::bootKernel();
+        $container = static::getContainer();
+        $adminUrlGenerator = $container->get(AdminUrlGenerator::class);
+
+        $this->assertInstanceOf(AdminUrlGenerator::class, $adminUrlGenerator);
+
+        $blogPostIndexUrl = $adminUrlGenerator
+            ->setDashboard(DashboardController::class)
+            ->setController(BlogPostCrudController::class)
+            ->setAction(Action::INDEX)
+            ->generateUrl()
+        ;
+
+        $this->assertSame('http://localhost/admin/pretty/urls/blog-post', $blogPostIndexUrl);
+    }
+
     public static function provideActiveMenuUrls(): iterable
     {
         yield ['/admin/pretty/urls/category'];