ModelsToArrayTransformer does not respect order of IDs in reverseTransform()

[ZZromanZZ]

Environment

Sonata packages

show

$ composer show --latest 'sonata-project/*'
sonata-project/admin-bundle              3.91.0 4.0.1  The missing Symfony Admin Generator
sonata-project/block-bundle              4.5.0  4.7.0  Symfony SonataBlockBundle
sonata-project/cache                     2.1.1  2.2.0  Cache library
sonata-project/doctrine-extensions       1.11.0 1.14.0 Doctrine2 behavioral extensions
sonata-project/doctrine-orm-admin-bundle 3.30.0 4.0.0  Integrate Doctrine ORM into the SonataAdminBundle
sonata-project/exporter                  2.5.1  2.8.0  Lightweight Exporter library
sonata-project/form-extensions           1.9.0  1.12.0 Symfony form extensions
sonata-project/twig-extensions           1.5.1  1.9.0  Sonata twig extensions

Symfony packages

show

$ composer show --latest 'symfony/*'
symfony/asset                      v4.4.19 v4.4.27 Manages URL generation and versioning of web assets such as CSS stylesheets, JavaScript files and image files
symfony/browser-kit                v4.4.19 v4.4.27 Simulates the behavior of a web browser, allowing you to make requests, click on links and submit forms programmatically
symfony/cache                      v4.4.19 v4.4.31 Provides an extended PSR-6, PSR-16 (and tags) implementation
symfony/cache-contracts            v2.2.0  v2.4.0  Generic abstractions related to caching
symfony/config                     v4.4.23 v4.4.30 Helps you find, load, combine, autofill and validate configuration values of any kind
symfony/console                    v4.4.23 v4.4.30 Eases the creation of beautiful and testable command line interfaces
symfony/css-selector               v4.4.19 v4.4.27 Converts CSS selectors to XPath expressions
symfony/debug                      v4.4.22 v4.4.31 Provides tools to ease debugging PHP code
symfony/debug-bundle               v4.4.19 v4.4.27 Provides a tight integration of the Symfony Debug component into the Symfony full-stack framework
symfony/debug-pack                 v1.0.9  v1.0.10 A debug pack for Symfony projects
symfony/dependency-injection       v4.4.23 v4.4.31 Allows you to standardize and centralize the way objects are constructed in your application
symfony/deprecation-contracts      v2.2.0  v2.4.0  A generic function and convention to trigger deprecation notices
symfony/doctrine-bridge            v4.4.19 v4.4.31 Provides integration for Doctrine with various Symfony components
symfony/dom-crawler                v4.4.19 v4.4.30 Eases DOM navigation for HTML and XML documents
symfony/dotenv                     v4.4.19 v4.4.29 Registers environment variables from a .env file
symfony/error-handler              v4.4.23 v4.4.30 Provides tools to manage errors and ease debugging PHP code
symfony/event-dispatcher           v4.4.20 v4.4.30 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.4.0  Generic abstractions related to dispatching event
symfony/expression-language        v4.4.19 v4.4.30 Provides an engine that can compile and evaluate expressions
symfony/filesystem                 v4.4.22 v4.4.27 Provides basic utilities for the filesystem
symfony/finder                     v4.4.19 v4.4.30 Finds files and directories via an intuitive fluent interface
symfony/flex                       v1.12.2 v1.17.1 Composer plugin for Symfony
symfony/form                       v4.4.19 v4.4.31 Allows to easily create, process and reuse HTML forms
symfony/framework-bundle           v4.4.19 v4.4.31 Provides a tight integration between Symfony components and the Symfony full-stack framework
symfony/http-client                v4.4.23 v4.4.31 Provides powerful methods to fetch HTTP resources synchronously or asynchronously
symfony/http-client-contracts      v2.4.0  v2.4.0  Generic abstractions related to HTTP clients
symfony/http-foundation            v4.4.23 v4.4.30 Defines an object-oriented layer for the HTTP specification
symfony/http-kernel                v4.4.23 v4.4.32 Provides a structured process for converting a Request into a Response
symfony/inflector                  v4.4.23 v4.4.27 Converts words between their singular and plural forms (English only)
Package symfony/inflector is abandoned, you should avoid using it. Use use `EnglishInflector` from the String component instead instead.
symfony/intl                       v4.4.19 v4.4.31 Provides a PHP replacement layer for the C intl extension that includes additional data from the ICU library
symfony/lock                       v4.4.19 v4.4.27 Creates and manages locks, a mechanism to provide exclusive access to a shared resource
symfony/maker-bundle               v1.31.1 v1.34.1 Symfony Maker helps you create empty commands, controllers, form classes, tests and more so you can forget about writing boilerplate code.
symfony/messenger                  v4.4.19 v4.4.32 Helps applications send and receive messages to/from other applications or via message queues
symfony/mime                       v4.4.22 v4.4.31 Allows manipulating MIME messages
symfony/monolog-bridge             v4.4.19 v4.4.27 Provides integration for Monolog with various Symfony components
symfony/monolog-bundle             v3.6.0  v3.7.0  Symfony MonologBundle
symfony/options-resolver           v4.4.20 v4.4.30 Provides an improved replacement for the array_replace PHP function
symfony/orm-pack                   v1.1.0  v2.1.0  A pack for the Doctrine ORM
symfony/phpunit-bridge             v4.4.19 v5.3.8  Provides utilities for PHPUnit, especially user deprecation notices management
symfony/polyfill-intl-grapheme     v1.22.1 v1.23.1 Symfony polyfill for intl's grapheme_* functions
symfony/polyfill-intl-icu          v1.22.1 v1.23.0 Symfony polyfill for intl's ICU-related data and classes
symfony/polyfill-intl-idn          v1.22.1 v1.23.0 Symfony polyfill for intl's idn_to_ascii and idn_to_utf8 functions
symfony/polyfill-intl-normalizer   v1.22.1 v1.23.0 Symfony polyfill for intl's Normalizer class and related functions
symfony/polyfill-mbstring          v1.22.1 v1.23.1 Symfony polyfill for the Mbstring extension
symfony/polyfill-php72             v1.22.1 v1.23.0 Symfony polyfill backporting some PHP 7.2+ features to lower PHP versions
symfony/polyfill-php73             v1.22.1 v1.23.0 Symfony polyfill backporting some PHP 7.3+ features to lower PHP versions
symfony/polyfill-php80             v1.22.1 v1.23.1 Symfony polyfill backporting some PHP 8.0+ features to lower PHP versions
symfony/polyfill-uuid              v1.22.1 v1.23.0 Symfony polyfill for uuid functions
symfony/process                    v4.4.19 v4.4.30 Executes commands in sub-processes
symfony/profiler-pack              v1.0.5  v1.0.6  A pack for the Symfony web profiler
symfony/property-access            v4.4.20 v4.4.30 Provides functions to read and write from/to an object or array using a simple string notation
symfony/property-info              v4.4.19 v4.4.31 Extracts information about PHP class' properties using metadata of popular sources
symfony/proxy-manager-bridge       v4.4.19 v4.4.27 Provides integration for ProxyManager with various Symfony components
symfony/psr-http-message-bridge    v2.1.0  v2.1.1  PSR HTTP message bridge
symfony/routing                    v4.4.19 v4.4.30 Maps an HTTP request to a set of configuration variables
symfony/security-acl               v3.1.1  v3.2.0  Symfony Security Component - ACL (Access Control List)
symfony/security-bundle            v4.4.19 v4.4.27 Provides a tight integration of the Security component into the Symfony full-stack framework
symfony/security-core              v4.4.24 v4.4.31 Symfony Security Component - Core Library
symfony/security-csrf              v4.4.19 v4.4.27 Symfony Security Component - CSRF Library
symfony/security-guard             v4.4.23 v4.4.27 Symfony Security Component - Guard
symfony/security-http              v4.4.22 v4.4.30 Symfony Security Component - HTTP Integration
symfony/serializer                 v4.4.19 v4.4.31 Handles serializing and deserializing data structures, including object graphs, into array structures or other formats like XML and JSON.
symfony/serializer-pack            v1.0.4  v1.0.4  A pack for the Symfony serializer
symfony/service-contracts          v2.4.0  v2.4.0  Generic abstractions related to writing services
symfony/stopwatch                  v4.4.19 v4.4.27 Provides a way to profile code
symfony/string                     v5.2.3  v5.3.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.2  v3.5.2  Symfony SwiftmailerBundle
symfony/test-pack                  v1.0.7  v1.0.9  A pack for functional and end-to-end testing within a Symfony app
symfony/translation                v4.4.19 v4.4.32 Provides tools to internationalize your application
symfony/translation-contracts      v2.3.0  v2.4.0  Generic abstractions related to translation
symfony/twig-bridge                v4.4.19 v4.4.27 Provides integration for Twig with various Symfony components
symfony/twig-bundle                v4.4.19 v4.4.30 Provides a tight integration of Twig into the Symfony full-stack framework
symfony/validator                  v4.4.19 v4.4.31 Provides tools to validate values
symfony/var-dumper                 v4.4.22 v4.4.31 Provides mechanisms for walking through any arbitrary PHP variable
symfony/var-exporter               v4.4.19 v4.4.31 Allows exporting any serializable PHP data structure to plain PHP code
symfony/web-link                   v4.4.19 v4.4.27 Manages links between resources
symfony/web-profiler-bundle        v4.4.19 v4.4.31 Provides a development tool that gives detailed information about the execution of any request
symfony/web-server-bundle          v4.4.19 v4.4.27 Provides commands for running applications using the PHP built-in web server
symfony/webpack-encore-bundle      v1.11.1 v1.12.0 Integration with your Symfony app & Webpack Encore!
symfony/yaml                       v4.4.19 v4.4.29 Loads and dumps YAML files

PHP version

$ php -v
PHP 7.3.26 (cli) (built: Jan 16 2021 00:46:13) ( NTS )
Copyright (c) 1997-2018 The PHP Group
Zend Engine v3.3.26, Copyright (c) 1998-2018 Zend Technologies
    with Zend OPcache v7.3.26, Copyright (c) 1999-2018, by Zend Technologies

Subject

Minimal repository with the bug

Steps to reproduce

Consider this use case:
User <-> UserHasExpectation <-> Expectation

After using "sortable" option, I would expect that collection passed to reverseTransform() method of my UserHasExpectatioToExpectationModelTransformer (model transformer) will be sorted as user sorted in UI.

IDs are sorted correctly in array passed to reverseTransforme() method of Sonata`s ModelsToArrayTransformer (view transformer), however transformed collection does not respect this order.

// UserAdmin.php
$formMapper->add("expectations", \Sonata\AdminBundle\Form\Type\ModelType::class, [
    "btn_add" => false,
    "by_reference" => false,
    "class" => Expectation::class,
    "choice_translation_domain" => false,
    "multiple" => true,
    "property" => "name",
    "query" => $this->getModelManager()->createQuery(Expectation::class),
    "required" => false,
    "sortable" => true,
]);
$formMapper->get("expectations")->addModelTransformer(new UserHasExpectatioToExpectationModelTransformer($this->getSubject(), $this->getModelManager()));

Expected results

Reverse-transformed collection of ModelsToArrayTransformer which respects order of IDs provided.

Actual results

Reverse-transformed collection of ModelsToArrayTransformer does not respect order of IDs provided.

[VincentLanglet]

Hi

The Datatransformer is transforming the data here:

SonataAdminBundle/src/Form/DataTransformer/ModelsToArrayTransformer.php

Lines 99 to 101 in 0a032a2

	$query = $this->modelManager->createQuery($this->class);
	$this->modelManager->addIdentifiersToQuery($this->class, $query, $value);
	$result = $this->modelManager->executeQuery($query);

so it rely on the ModelManager and the behavior depends on the persistence bundle.

In SonataDoctrineORMAdminBundle, it's done this way:
https://github.com/sonata-project/SonataDoctrineORMAdminBundle/blob/4.x/src/Model/ModelManager.php#L301-L333
I dunno if we can modify the query to respect the order...

The other solution would be to reorder the result of the query.
This would be possible by computing for each result the identifier

implode(AdapterInterface::ID_SEPARATOR, $this->getIdentifierValues($model))

and reorder the collection in order to respect the same order than the array passed as argument.

Do you want to make a try @ZZromanZZ ?

[VincentLanglet]

Should be fixed by #7673 if you wanna try @ZZromanZZ