bug #6734 Fix Dashboard menu item highlighting (javiereguiluz)

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

Discussion
----------

Fix Dashboard menu item highlighting

Fixes #6701.

Commits
-------

c4a848c Fix Dashboard menu item highlighting

Author: javiereguiluz

config/services.php

@@ -235,6 +235,7 @@
 
         ->set(MenuItemMatcher::class)
             ->arg(0, service(AdminUrlGenerator::class))
+            ->arg(1, service(AdminRouteGenerator::class))
 
         ->alias(MenuItemMatcherInterface::class, MenuItemMatcher::class)
 

src/Menu/MenuItemMatcher.php

@@ -7,6 +7,7 @@
 use EasyCorp\Bundle\EasyAdminBundle\Config\Option\EA;
 use EasyCorp\Bundle\EasyAdminBundle\Contracts\Menu\MenuItemMatcherInterface;
 use EasyCorp\Bundle\EasyAdminBundle\Dto\MenuItemDto;
+use EasyCorp\Bundle\EasyAdminBundle\Router\AdminRouteGenerator;
 use EasyCorp\Bundle\EasyAdminBundle\Router\AdminUrlGenerator;
 use Symfony\Component\HttpFoundation\Request;
 
@@ -17,6 +18,7 @@ class MenuItemMatcher implements MenuItemMatcherInterface
 {
     public function __construct(
         private AdminUrlGenerator $adminUrlGenerator,
+        private AdminRouteGenerator $adminRouteGenerator,
     ) {
     }
 
@@ -35,8 +37,7 @@ public function __construct(
      */
     public function markSelectedMenuItem(array $menuItems, Request $request): array
     {
-        $usePrettyUrls = true === (bool) $request->attributes->get(EA::ROUTE_CREATED_BY_EASYADMIN);
-        if ($usePrettyUrls) {
+        if ($this->adminRouteGenerator->usesPrettyUrls()) {
             $menuItems = $this->doMarkSelectedPrettyUrlsMenuItem($menuItems, $request);
         } else {
             $menuItems = $this->doMarkSelectedLegacyMenuItem($menuItems, $request);

tests/Controller/PrettyUrls/PrettyUrlsControllerTest.php

@@ -297,15 +297,14 @@ public function testAdminUrlGenerator(): void
             ->setAction('customAction')
             ->generateUrl()
         ;
-       $client->request('GET', $url);
+        $client->request('GET', $url);
 
         $this->assertSelectorTextSame('#url1', 'http://localhost/admin/pretty/urls?'.http_build_query([
             'crudAction' => 'customAction',
             'crudControllerFqcn' => CategoryCrudController::class,
             'dashboardControllerFqcn' => DashboardController::class,
         ]));
 
-
         $this->assertSelectorTextSame('#url2', 'http://localhost/admin/pretty/urls?'.http_build_query([
             'crudAction' => 'customAction',
             'crudControllerFqcn' => CategoryCrudController::class,

tests/Menu/MenuItemMatcherTest.php

@@ -6,6 +6,7 @@
 use EasyCorp\Bundle\EasyAdminBundle\Config\Option\EA;
 use EasyCorp\Bundle\EasyAdminBundle\Dto\MenuItemDto;
 use EasyCorp\Bundle\EasyAdminBundle\Menu\MenuItemMatcher;
+use EasyCorp\Bundle\EasyAdminBundle\Router\AdminRouteGenerator;
 use EasyCorp\Bundle\EasyAdminBundle\Router\AdminUrlGenerator;
 use Symfony\Bundle\FrameworkBundle\Test\KernelTestCase;
 use Symfony\Component\HttpFoundation\InputBag;
@@ -19,7 +20,8 @@ public function testIsSelectedWhenContextIsNull()
 
         self::bootKernel();
         $adminUrlGenerator = self::getContainer()->get(AdminUrlGenerator::class);
-        $menuItemMatcher = new MenuItemMatcher($adminUrlGenerator);
+        $adminRouteGenerator = self::getContainer()->get(AdminRouteGenerator::class);
+        $menuItemMatcher = new MenuItemMatcher($adminUrlGenerator, $adminRouteGenerator);
         $menuItemDto = new MenuItemDto();
 
         $menuItemMatcher->markSelectedMenuItem([$menuItemDto], $request);
@@ -33,7 +35,8 @@ public function testIsSelectedWhenMenuItemIsSection()
 
         self::bootKernel();
         $adminUrlGenerator = self::getContainer()->get(AdminUrlGenerator::class);
-        $menuItemMatcher = new MenuItemMatcher($adminUrlGenerator);
+        $adminRouteGenerator = self::getContainer()->get(AdminRouteGenerator::class);
+        $menuItemMatcher = new MenuItemMatcher($adminUrlGenerator, $adminRouteGenerator);
         $menuItemDto = new MenuItemDto();
         $menuItemDto->setType(MenuItemDto::TYPE_SECTION);
 
@@ -50,7 +53,8 @@ public function testIsSelectedWithCrudControllers()
 
         self::bootKernel();
         $adminUrlGenerator = self::getContainer()->get(AdminUrlGenerator::class);
-        $menuItemMatcher = new MenuItemMatcher($adminUrlGenerator);
+        $adminRouteGenerator = self::getContainer()->get(AdminRouteGenerator::class);
+        $menuItemMatcher = new MenuItemMatcher($adminUrlGenerator, $adminRouteGenerator);
         $menuItemDto = $this->getMenuItemDto();
         $menuItemMatcher->markSelectedMenuItem([$menuItemDto], $request);
 
@@ -101,7 +105,8 @@ public function testIsSelectedWithRoutes()
 
         self::bootKernel();
         $adminUrlGenerator = self::getContainer()->get(AdminUrlGenerator::class);
-        $menuItemMatcher = new MenuItemMatcher($adminUrlGenerator);
+        $adminRouteGenerator = self::getContainer()->get(AdminRouteGenerator::class);
+        $menuItemMatcher = new MenuItemMatcher($adminUrlGenerator, $adminRouteGenerator);
         $menuItemDto = $this->getMenuItemDto(routeName: 'some_route');
 
         $menuItemMatcher->markSelectedMenuItem([$menuItemDto], $request);
@@ -142,7 +147,8 @@ public function testIsSelectedWithUrls()
 
         self::bootKernel();
         $adminUrlGenerator = self::getContainer()->get(AdminUrlGenerator::class);
-        $menuItemMatcher = new MenuItemMatcher($adminUrlGenerator);
+        $adminRouteGenerator = self::getContainer()->get(AdminRouteGenerator::class);
+        $menuItemMatcher = new MenuItemMatcher($adminUrlGenerator, $adminRouteGenerator);
         $menuItemDto = new MenuItemDto();
 
         $menuItemMatcher->markSelectedMenuItem([$menuItemDto], $request);
@@ -182,7 +188,8 @@ public function testMenuWithDashboardItem()
 
         self::bootKernel();
         $adminUrlGenerator = self::getContainer()->get(AdminUrlGenerator::class);
-        $menuItemMatcher = new MenuItemMatcher($adminUrlGenerator);
+        $adminRouteGenerator = self::getContainer()->get(AdminRouteGenerator::class);
+        $menuItemMatcher = new MenuItemMatcher($adminUrlGenerator, $adminRouteGenerator);
         $menuItems = $menuItemMatcher->markSelectedMenuItem($menuItems, $request);
 
         $this->assertSame('item2', $this->getSelectedMenuItemLabel($menuItems), 'Perfect match: Dashboard item');
@@ -197,7 +204,8 @@ public function testComplexMenu()
 
         self::bootKernel();
         $adminUrlGenerator = self::getContainer()->get(AdminUrlGenerator::class);
-        $menuItemMatcher = new MenuItemMatcher($adminUrlGenerator);
+        $adminRouteGenerator = self::getContainer()->get(AdminRouteGenerator::class);
+        $menuItemMatcher = new MenuItemMatcher($adminUrlGenerator, $adminRouteGenerator);
 
         $menuItems = $menuItemMatcher->markSelectedMenuItem($menuItems, $request);