Incorrect display acl privileges grid, when exists two admin entity with the same name (in other groups).

[TomaszFilipek]

Environment

Sonata packages

show

sonata-project/admin-bundle              4.18.0 ! 4.21.0 The missing Symfony Admin Generator
sonata-project/block-bundle              4.16.2 ! 4.19.0 Symfony SonataBlockBundle
sonata-project/cache                     2.2.0  = 2.2.0  Cache library
sonata-project/cache-bundle              3.4.0  = 3.4.0  This bundle provides caching services
sonata-project/doctrine-extensions       1.18.0 ~ 2.0.1  Doctrine2 behavioral extensions
sonata-project/doctrine-orm-admin-bundle 4.6.0  ! 4.8.0  Integrate Doctrine ORM into the SonataAdminBundle
sonata-project/exporter                  3.0.0  = 3.0.0  Lightweight Exporter library
sonata-project/form-extensions           1.18.0 = 1.18.0 Symfony form extensions
sonata-project/intl-bundle               2.14.0 ~ 3.0.2  Symfony SonataIntlBundle
sonata-project/media-bundle              4.2.0  ! 4.5.1  Symfony SonataMediaBundle
sonata-project/translation-bundle        3.1.0  = 3.1.0  SonataTranslationBundle
sonata-project/twig-extensions           1.12.0 ~ 2.0.0  Sonata twig extensions
sonata-project/user-bundle               5.4.0  = 5.4.0  Symfony SonataUserBundle

Symfony packages

show

symfony/acl-bundle                 v2.3.0  = v2.3.0  Symfony AclBundle
symfony/amqp-messenger             v5.4.11 ~ v6.1.7  Symfony AMQP extension Messenger Bridge
symfony/apache-pack                v1.0.1  = v1.0.1  A pack for Apache support in Symfony
symfony/asset                      v5.4.7  ~ v6.1.5  Manages URL generation and versioning of web assets such as CSS stylesheets, JavaScript files and image files
symfony/browser-kit                v5.4.11 ~ v6.1.3  Simulates the behavior of a web browser, allowing you to make requests, click on links and submit forms programmatically
symfony/cache                      v5.4.11 ~ v6.1.7  Provides an extended PSR-6, PSR-16 (and tags) implementation
symfony/cache-contracts            v2.5.2  ~ v3.1.1  Generic abstractions related to caching
symfony/config                     v5.4.11 ~ v6.1.3  Helps you find, load, combine, autofill and validate configuration values of any kind
symfony/console                    v5.4.11 ~ v6.1.7  Eases the creation of beautiful and testable command line interfaces
symfony/css-selector               v5.4.11 ~ v6.1.3  Converts CSS selectors to XPath expressions
symfony/debug-bundle               v5.4.11 ~ v6.1.3  Provides a tight integration of the Symfony VarDumper component and the ServerLogCommand from MonologBridge into the Symfony full-stack framework
symfony/dependency-injection       v5.4.11 ~ v6.1.5  Allows you to standardize and centralize the way objects are constructed in your application
symfony/deprecation-contracts      v3.1.1  = v3.1.1  A generic function and convention to trigger deprecation notices
symfony/doctrine-bridge            v5.4.11 ~ v6.1.7  Provides integration for Doctrine with various Symfony components
symfony/doctrine-messenger         v5.4.11 ~ v6.1.4  Symfony Doctrine Messenger Bridge
symfony/dom-crawler                v5.4.11 ~ v6.1.7  Eases DOM navigation for HTML and XML documents
symfony/dotenv                     v5.4.5  ~ v6.1.0  Registers environment variables from a .env file
symfony/error-handler              v5.4.11 ~ v6.1.7  Provides tools to manage errors and ease debugging PHP code
symfony/event-dispatcher           v5.4.9  ~ v6.1.0  Provides tools that allow your application components to communicate with each other by dispatching events and listening to them
symfony/event-dispatcher-contracts v3.1.1  = v3.1.1  Generic abstractions related to dispatching event
symfony/expression-language        v5.4.11 ~ v6.1.6  Provides an engine that can compile and evaluate expressions
symfony/filesystem                 v5.4.11 ~ v6.1.5  Provides basic utilities for the filesystem
symfony/finder                     v5.4.11 ~ v6.1.3  Finds files and directories via an intuitive fluent interface
symfony/flex                       v2.2.3  = v2.2.3  Composer plugin for Symfony
symfony/form                       v5.4.11 ~ v6.1.7  Allows to easily create, process and reuse HTML forms
symfony/framework-bundle           v5.4.11 ~ v6.1.7  Provides a tight integration between Symfony components and the Symfony full-stack framework
symfony/http-client                v5.4.11 ~ v6.1.7  Provides powerful methods to fetch HTTP resources synchronously or asynchronously
symfony/http-client-contracts      v2.5.2  ~ v3.1.1  Generic abstractions related to HTTP clients
symfony/http-foundation            v5.4.11 ~ v6.1.7  Defines an object-oriented layer for the HTTP specification
symfony/http-kernel                v5.4.11 ~ v6.1.7  Provides a structured process for converting a Request into a Response
symfony/intl                       v5.4.11 ~ v6.1.7  Provides a PHP replacement layer for the C intl extension that includes additional data from the ICU library
symfony/mailer                     v5.4.11 ~ v6.1.7  Helps sending emails
symfony/maker-bundle               v1.45.0 ! v1.48.0 Symfony Maker helps you create empty commands, controllers, form classes, tests and more so you can forget about writing boilerplate code.
symfony/messenger                  v5.4.11 ~ v6.1.6  Helps applications send and receive messages to/from other applications or via message queues
symfony/mime                       v5.4.11 ~ v6.1.7  Allows manipulating MIME messages
symfony/monolog-bridge             v5.4.10 ~ v6.1.2  Provides integration for Monolog with various Symfony components
symfony/monolog-bundle             v3.8.0  = v3.8.0  Symfony MonologBundle
symfony/notifier                   v5.4.8  ~ v6.1.0  Sends notifications via one or more channels (email, SMS, ...)
symfony/options-resolver           v5.4.11 ~ v6.1.0  Provides an improved replacement for the array_replace PHP function
symfony/password-hasher            v5.4.11 ~ v6.1.3  Provides password hashing utilities
symfony/phpunit-bridge             v6.1.3  ! v6.1.6  Provides utilities for PHPUnit, especially user deprecation notices management
symfony/polyfill-intl-grapheme     v1.26.0 ! v1.27.0 Symfony polyfill for intl's grapheme_* functions
symfony/polyfill-intl-icu          v1.26.0 ! v1.27.0 Symfony polyfill for intl's ICU-related data and classes
symfony/polyfill-intl-idn          v1.26.0 ! v1.27.0 Symfony polyfill for intl's idn_to_ascii and idn_to_utf8 functions
symfony/polyfill-intl-normalizer   v1.26.0 ! v1.27.0 Symfony polyfill for intl's Normalizer class and related functions
symfony/polyfill-mbstring          v1.26.0 ! v1.27.0 Symfony polyfill for the Mbstring extension
symfony/polyfill-php56             v1.20.0 = v1.20.0 Symfony polyfill backporting some PHP 5.6+ features to lower PHP versions
symfony/polyfill-php73             v1.26.0 ! v1.27.0 Symfony polyfill backporting some PHP 7.3+ features to lower PHP versions
symfony/polyfill-php80             v1.26.0 ! v1.27.0 Symfony polyfill backporting some PHP 8.0+ features to lower PHP versions
symfony/polyfill-php81             v1.26.0 ! v1.27.0 Symfony polyfill backporting some PHP 8.1+ features to lower PHP versions
symfony/process                    v5.4.11 ~ v6.1.3  Executes commands in sub-processes
symfony/property-access            v5.4.11 ~ v6.1.7  Provides functions to read and write from/to an object or array using a simple string notation
symfony/property-info              v5.4.11 ~ v6.1.7  Extracts information about PHP class' properties using metadata of popular sources
symfony/proxy-manager-bridge       v5.4.6  ~ v6.1.0  Provides integration for ProxyManager with various Symfony components
symfony/redis-messenger            v5.4.6  ~ v6.1.7  Symfony Redis extension Messenger Bridge
symfony/routing                    v5.4.11 ~ v6.1.7  Maps an HTTP request to a set of configuration variables
symfony/runtime                    v5.4.11 ~ v6.1.3  Enables decoupling PHP applications from global state
symfony/security-acl               v3.3.1  ! v3.3.2  Symfony Security Component - ACL (Access Control List)
symfony/security-bundle            v5.4.11 ~ v6.1.3  Provides a tight integration of the Security component into the Symfony full-stack framework
symfony/security-core              v5.4.11 ~ v6.1.7  Symfony Security Component - Core Library
symfony/security-csrf              v5.4.11 ~ v6.1.0  Symfony Security Component - CSRF Library
symfony/security-guard             v5.4.9  ! v5.4.13 Symfony Security Component - Guard
symfony/security-http              v5.4.11 ~ v6.1.7  Symfony Security Component - HTTP Integration
symfony/serializer                 v5.4.11 ~ v6.1.6  Handles serializing and deserializing data structures, including object graphs, into array structures or other formats like XML and JSON.
symfony/service-contracts          v2.5.2  ~ v3.1.1  Generic abstractions related to writing services
symfony/stopwatch                  v5.4.5  ~ v6.1.5  Provides a way to profile code
symfony/string                     v5.4.11 ~ v6.1.7  Provides an object-oriented API to strings and deals with bytes, UTF-8 code points and grapheme clusters in a unified way
symfony/swiftmailer-bundle         v3.5.4  = v3.5.4  Symfony SwiftmailerBundle
symfony/templating                 v5.4.11 ~ v6.1.3  Provides all the tools needed to build any kind of template system
symfony/translation                v5.4.11 ~ v6.1.6  Provides tools to internationalize your application
symfony/translation-contracts      v2.5.2  ~ v3.1.1  Generic abstractions related to translation
symfony/twig-bridge                v5.4.11 ~ v6.1.7  Provides integration for Twig with various Symfony components
symfony/twig-bundle                v5.4.8  ~ v6.1.1  Provides a tight integration of Twig into the Symfony full-stack framework
symfony/validator                  v5.4.11 ~ v6.1.7  Provides tools to validate values
symfony/var-dumper                 v5.4.11 ~ v6.1.6  Provides mechanisms for walking through any arbitrary PHP variable
symfony/var-exporter               v5.4.10 ~ v6.1.3  Allows exporting any serializable PHP data structure to plain PHP code
symfony/web-link                   v5.4.3  ~ v6.1.0  Manages links between resources
symfony/web-profiler-bundle        v5.4.10 ~ v6.1.6  Provides a development tool that gives detailed information about the execution of any request
symfony/webpack-encore-bundle      v1.15.1 ! v1.16.0 Integration with your Symfony app & Webpack Encore!
symfony/yaml                       v5.4.11 ~ v6.1.6  Loads and dumps YAML files

PHP version

PHP 8.1.12 (cli) (built: Oct 28 2022 17:39:37) (NTS)
Copyright (c) The PHP Group
Zend Engine v4.1.12, Copyright (c) Zend Technologies
    with Zend OPcache v8.1.12, Copyright (c), by Zend Technologies

Subject

Incorrect display acl privileges grid, when exists two admin entity with the same name (in other groups).

Steps to reproduce

Create two admin entity with the same name.
For example:

    admin.menu:
      class: App\Admin\MenuAdmin
      arguments: [~, App\Entity\Menu, 'App\Controller\Admin\SortableController', '@doctrine.orm.default_entity_manager']
      tags:
        - { name: sonata.admin, manager_type: orm, group: 'Menu', label: 'List' }
    
    admin.news:
      class: App\Admin\NewsAdmin
      arguments: [~, App\Entity\News, ~, '@doctrine.orm.default_entity_manager']
      tags:
        - { name: sonata.admin, manager_type: orm, group: 'Article', label: 'List'}

Expected results

Actual results

I think an attribute that allows to change the name displayed in the ACL editor would be a good solution.

[VincentLanglet]

I think an attribute that allows to change the name displayed in the ACL editor would be a good solution.

There is already to much attribute IMHO
Moreover acl should become optional sonata-project/SonataAdminBundle#7303
So I don't think that's the right solution.

To me the original issue #1582 was the correct one.

This is an issue for SonataUserBundle.
In the twig extensions roles are grouped by a non-unique value https://github.com/sonata-project/SonataUserBundle/blob/5.x/src/Twig/RolesMatrixExtension.php#L70-L90

Maybe something like

public function renderMatrix(Environment $environment, FormView $form): string
    {
        $groupedRoles = [];
        foreach ($this->rolesBuilder->getRoles() as $role => $attributes) {
            if (!isset($attributes['label'])) {
                continue;
            }

            $groupedRoles[$attributes['label']] = [
                'admin_label' => $attributes['admin_label'],
                'roles' => [$role => $attributes]
             ];
            foreach ($form->getIterator() as $child) {
                if ($child->vars['value'] === $role) {
                    $groupedRoles[$attributes['label']]['roles'][$role]['form'] = $child;
                }
            }
        }

        return $environment->render('@SonataUser/Form/roles_matrix.html.twig', [
            'grouped_roles' => $groupedRoles,
            'permission_labels' => $this->rolesBuilder->getPermissionLabels(),
        ]);
    }

would be better. Do you want to work on it @TomaszFilipek ?

[TomaszFilipek]

@VincentLanglet thank You for reply.

I thought of yet another solution.

What do you think about the solution to add the group name to the label?
This will not require setting additional labels for each admin entity.

This requires two changes.

1. Add admin group name in return array in getRoles function

/src/Security/RolesBuilder/AdminRolesBuilder.php

public function getRoles(?string $domain = null): array
    {
        foreach ($this->pool->getAdminServiceIds() as $id) {
            if (\in_array($id, $this->excludeAdmins, true)) {
                continue;
            }
            $admin = $this->pool->getInstance($id);
            $adminGroupName = $this->getAdminClassGroupName($admin->getCode());

            $securityHandler = $admin->getSecurityHandler();
            $baseRole = $securityHandler->getBaseRole($admin);
            foreach (array_keys($admin->getSecurityInformation()) as $key) {
                $role = sprintf($baseRole, $key);
                $adminRoles[$role] = [
                    'role' => $role,
                    'label' => $key,
                    'role_translated' => $this->translateRole($role, $domain),
                    'is_granted' => $this->isMaster($admin) || $this->authorizationChecker->isGranted($role),
                    'admin_label' => $admin->getTranslator()->trans($admin->getLabel() ?? ''),
                    'admin_group_name' => $adminGroupName
                ];
            }
        }

2. Change key in array in renderMatrix
src/Twig/RolesMatrixExtension.php

public function renderMatrix(Environment $environment, FormView $form): string
{
    $groupedRoles = [];
    foreach ($this->rolesBuilder->getRoles() as $role => $attributes) {
        if (!isset($attributes['admin_label'])) {
            continue;
        }

        $adminName = empty($attributes['admin_group_name']) ? $attributes['admin_label'] : $attributes['admin_group_name'] . ' - ' . $attributes['admin_label'];
        $groupedRoles[$adminName][$role] = $attributes;
        foreach ($form->getIterator() as $child) {
            if ($child->vars['value'] === $role) {
                $groupedRoles[$adminName][$role]['form'] = $child;
            }
        }
    }

    return $environment->render('@SonataUser/Form/roles_matrix.html.twig', [
        'grouped_roles' => $groupedRoles,
        'permission_labels' => $this->rolesBuilder->getPermissionLabels(),
    ]);
}

Then the ACL grid looks like this:

What do you thing about this solution?

[VincentLanglet]

This seems a nice improvement which avoid BC-break. So let's go with this then :)
Do you want to provide the PR ?

(Be aware our coding standard forbids empty)