ChoiceFilter is not working properly when 'multiple' => true option is used

[phansys]

Environment

Sonata packages

show

$ composer show --latest 'sonata-project/*'
sonata-project/admin-bundle              3.90.0 3.90.0 The missing Symfony Admin Generator
sonata-project/block-bundle              3.22.0 4.5.0  Symfony SonataBlockBundle
sonata-project/cache                     2.0.1  2.1.1  Cache library
sonata-project/datagrid-bundle           3.3.0  3.3.0  Symfony SonataDatagridBundle
sonata-project/doctrine-extensions       1.11.0 1.11.0 Doctrine2 behavioral extensions
sonata-project/doctrine-orm-admin-bundle 3.28.0 3.30.0 Integrate Doctrine ORM into the SonataAdminBundle
sonata-project/exporter                  2.5.0  2.5.1  Lightweight Exporter library
sonata-project/form-extensions           1.8.1  1.9.0  Symfony form extensions
sonata-project/intl-bundle               2.10.0 2.10.1 Symfony SonataIntlBundle
sonata-project/media-bundle              3.29.0 3.30.0 Symfony SonataMediaBundle
sonata-project/twig-extensions           1.5.0  1.5.1  Sonata twig extensions
sonata-project/user-bundle               4.10.1 4.11.0 Symfony SonataUserBundle

Symfony packages

show

$ composer show --latest 'symfony/*'
symfony/amazon-sqs-messenger       v5.2.2  v5.2.3  Symfony Amazon SQS extension Messenger Bridge
symfony/amqp-messenger             v5.2.2  v5.2.3  Symfony AMQP extension Messenger Bridge
symfony/asset                      v4.4.19 v5.2.3  Manages URL generation and versioning of web assets such as CSS stylesheets, JavaScript files and image files
symfony/browser-kit                v5.2.2  v5.2.3  Simulates the behavior of a web browser, allowing you to make requests, click on links and submit forms programmatically
symfony/cache                      v5.2.2  v5.2.3  Provides an extended PSR-6, PSR-16 (and tags) implementation
symfony/cache-contracts            v2.2.0  v2.2.0  Generic abstractions related to caching
symfony/config                     v4.4.19 v5.2.3  Helps you find, load, combine, autofill and validate configuration values of any kind
symfony/console                    v4.4.19 v5.2.3  Eases the creation of beautiful and testable command line interfaces
symfony/css-selector               v5.2.2  v5.2.3  Converts CSS selectors to XPath expressions
symfony/debug                      v4.4.19 v4.4.19 Provides tools to ease debugging PHP code
symfony/debug-bundle               v5.1.11 v5.2.3  Provides a tight integration of the Symfony Debug component into the Symfony full-stack framework
symfony/debug-pack                 v1.0.9  v1.0.9  A debug pack for Symfony projects
symfony/dependency-injection       v4.4.19 v5.2.3  Allows you to standardize and centralize the way objects are constructed in your application
symfony/deprecation-contracts      v2.2.0  v2.2.0  A generic function and convention to trigger deprecation notices
symfony/doctrine-bridge            v4.4.19 v5.2.3  Provides integration for Doctrine with various Symfony components
symfony/doctrine-messenger         v5.2.2  v5.2.3  Symfony Doctrine Messenger Bridge
symfony/dom-crawler                v5.2.2  v5.2.3  Eases DOM navigation for HTML and XML documents
symfony/dotenv                     v5.2.2  v5.2.3  Registers environment variables from a .env file
symfony/error-handler              v4.4.19 v5.2.3  Provides tools to manage errors and ease debugging PHP code
symfony/event-dispatcher           v4.4.19 v5.2.3  Provides tools that allow your application components to communicate with each other by dispatching events and listening to them
symfony/event-dispatcher-contracts v1.1.9  v2.2.0  Generic abstractions related to dispatching event
symfony/expression-language        v5.2.2  v5.2.3  Provides an engine that can compile and evaluate expressions
symfony/filesystem                 v4.4.19 v5.2.3  Provides basic utilities for the filesystem
symfony/finder                     v4.4.19 v5.2.3  Finds files and directories via an intuitive fluent interface
symfony/flex                       v1.11.0 v1.12.2 Composer plugin for Symfony
symfony/form                       v4.4.19 v5.2.3  Allows to easily create, process and reuse HTML forms
symfony/framework-bundle           v4.4.19 v5.2.3  Provides a tight integration between Symfony components and the Symfony full-stack framework
symfony/http-client                v5.2.2  v5.2.3  Provides powerful methods to fetch HTTP resources synchronously or asynchronously
symfony/http-client-contracts      v2.3.1  v2.3.1  Generic abstractions related to HTTP clients
symfony/http-foundation            v4.4.19 v5.2.3  Defines an object-oriented layer for the HTTP specification
symfony/http-kernel                v4.4.19 v5.2.3  Provides a structured process for converting a Request into a Response
symfony/intl                       v5.2.2  v5.2.3  Provides a PHP replacement layer for the C intl extension that includes additional data from the ICU library
symfony/mailer                     v5.2.2  v5.2.3  Helps sending emails
symfony/maker-bundle               v1.28.0 v1.29.1 Symfony Maker helps you create empty commands, controllers, form classes, tests and more so you can forget about writing boilerplate code.
symfony/messenger                  v5.2.2  v5.2.3  Helps applications send and receive messages to/from other applications or via message queues
symfony/mime                       v5.2.2  v5.2.3  Allows manipulating MIME messages
symfony/monolog-bridge             v5.2.2  v5.2.3  Provides integration for Monolog with various Symfony components
symfony/monolog-bundle             v3.6.0  v3.6.0  Symfony MonologBundle
symfony/options-resolver           v5.2.2  v5.2.3  Provides an improved replacement for the array_replace PHP function
symfony/phpunit-bridge             v5.2.2  v5.2.3  Provides utilities for PHPUnit, especially user deprecation notices management
symfony/polyfill-php80             v1.22.0 v1.22.1 Symfony polyfill backporting some PHP 8.0+ features to lower PHP versions
symfony/process                    v4.4.19 v5.2.3  Executes commands in sub-processes
symfony/profiler-pack              v1.0.5  v1.0.5  A pack for the Symfony web profiler
symfony/property-access            v5.2.2  v5.2.3  Provides functions to read and write from/to an object or array using a simple string notation
symfony/property-info              v5.2.2  v5.2.3  Extracts information about PHP class' properties using metadata of popular sources
symfony/proxy-manager-bridge       v4.4.18 v5.2.3  Symfony ProxyManager Bridge
symfony/redis-messenger            v5.2.2  v5.2.3  Symfony Redis extension Messenger Bridge
symfony/requirements-checker       v1.1.8  v2.0.0  Check Symfony requirements and give recommendations
symfony/routing                    v4.4.19 v5.2.3  Maps an HTTP request to a set of configuration variables
symfony/security                   v4.4.19 v4.4.19 Provides a complete security system for your web application
symfony/security-acl               v3.1.1  v3.1.1  Symfony Security Component - ACL (Access Control List)
symfony/security-bundle            v4.4.19 v5.2.3  Provides a tight integration of the Security component into the Symfony full-stack framework
symfony/serializer                 v5.2.2  v5.2.3  Handles serializing and deserializing data structures, including object graphs, into array structures or other formats like XML and JSON.
symfony/service-contracts          v2.2.0  v2.2.0  Generic abstractions related to writing services
symfony/stopwatch                  v5.2.2  v5.2.3  Provides a way to profile code
symfony/string                     v5.2.2  v5.2.3  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.2  v3.5.2  Symfony SwiftmailerBundle
symfony/templating                 v4.4.19 v5.2.3  Provides all the tools needed to build any kind of template system
symfony/translation                v4.4.19 v5.2.3  Provides tools to internationalize your application
symfony/translation-contracts      v2.3.0  v2.3.0  Generic abstractions related to translation
symfony/twig-bridge                v4.4.19 v5.2.3  Provides integration for Twig with various Symfony components
symfony/twig-bundle                v4.4.19 v5.2.3  Provides a tight integration of Twig into the Symfony full-stack framework
symfony/validator                  v4.4.19 v5.2.3  Provides tools to validate values
symfony/var-dumper                 v5.2.2  v5.2.3  Provides mechanisms for walking through any arbitrary PHP variable
symfony/var-exporter               v5.2.2  v5.2.3  Allows exporting any serializable PHP data structure to plain PHP code
symfony/web-profiler-bundle        v5.0.11 v5.2.3  Symfony WebProfilerBundle
symfony/web-server-bundle          v4.4.19 v4.4.19 Provides commands for running applications using the PHP built-in web server
symfony/webpack-encore-bundle      v1.9.0  v1.11.1 Integration with your Symfony app & Webpack Encore!
symfony/workflow                   v5.2.2  v5.2.3  Provides tools for managing a workflow or finite state machine
symfony/yaml                       v4.4.19 v5.2.3  Loads and dumps YAML files

PHP version

$ php -v
7.3.24

Subject

ChoiceFilter is not working properly when 'multiple' => true option is used.
The behavior introduced at #6700 is identifying as default and removing more filter values than it should.

Minimal repository with the bug

N/A

Steps to reproduce

protected function configureDefaultFilterValues(array &$filterValues)
{
    $filterValues['country']['value'] = ['ar', 'fr'];

    parent::configureDefaultFilterValues($filterValues);
}

protected function configureDatagridFilters(DatagridMapper $datagridMapper)
{
    $datagridMapper
        ->add('country', ChoiceFilter::class, [], ChoiceType::class, [
            'choices' => ['ar' => 'ar', 'fr' => 'fr'],
            'multiple' => true,
        ]);
}

Expected results

The result filters to respect the user's selection.

Actual results

Since the default filter names evaluated here can have duplicated names ('filter[country][value][]' in this case), the logic around removing the filters that have default values is not working properly, given the filter names that use array offsets are not exposing these offsets explicitly ('filter[country][value][0]', 'filter[country][value][1]', etc.).
By the other hand, I think we could also evaluate to express the array values as a list in order to distinguish the values that are really the default ones (by instance, ['ar', 'fr']).
IMO, all the required fixes should be applied at Admin.js:convert_query_string_to_object() or its callers.

[VincentLanglet]

cc @kirya-dev

[VincentLanglet]

After some debug

$form.find('[name*=filter]').each(function (i, field) {
    if ((defaults[field.name] || '') === field.value) {
        field.removeAttribute('name');
    }
});

Does not work for multiple select.

field.value is returning only one value of the select.
$(field).val() can be a solution, it returns ['ar', 'fr'] in your case.

And convert_query_string_to_object need to be improved.
If the filter name end with [] the value has to be an array.

So

convert_query_string_to_object: function (str) {
        return str.split('&').reduce(function (accumulator, keyValue) {
            var key = decodeURIComponent(keyValue.split('=')[0]);

            if (key.endsWith('[]')) {
                if (undefined === accumulator[key]) {
                    accumulator[key] = [keyValue.split('=')[1]];
                } else {
                    accumulator[key].push(keyValue.split('=')[1])
                }
            } else {
                accumulator[key] = keyValue.split('=')[1];
            }

            return accumulator;
        }, {});
    },

Can be a solution.

Tested locally and it works @phansys

[phansys]

The proposed solution works very well @VincentLanglet! 🎉