search

sonata-project / SonataAdminBundle

The missing Symfony Admin Generator
https://docs.sonata-project.org/projects/SonataAdminBundle
MIT License
2.11k stars 1.26k forks source link

ModelAutocompleteType does not display the previously selected value when editing an entity #7210

Closed alistairstead closed 3 years ago

alistairstead commented 3 years ago

Environment

Sonata packages

show

``` sonata-project/admin-bundle 3.100.1 3.100.1 The missing Symfony Admin Generator sonata-project/block-bundle 3.23.1 4.5.3 Symfony SonataBlockBundle sonata-project/cache 2.1.1 2.1.1 Cache library sonata-project/core-bundle 3.20.0 3.20.0 Symfony SonataCoreBundle (abandoned) sonata-project/doctrine-extensions 1.12.0 1.12.0 Doctrine2 behavioral extensions sonata-project/doctrine-orm-admin-bundle 3.34.1 3.34.1 Integrate Doctrine ORM into the SonataAdminBundle sonata-project/exporter 2.6.2 2.6.2 Lightweight Exporter library sonata-project/form-extensions 0.1.2 1.9.0 Symfony form extensions sonata-project/twig-extensions 0.1.1 1.6.0 Sonata twig extensions ```

Symfony packages

show

``` symfony/asset v4.4.22 v5.2.7 Manages URL generation and versioning of web assets such as CSS stylesheets, JavaScript files and image files symfony/browser-kit v4.4.24 v5.2.9 Simulates the behavior of a web browser, allowing you to make requests, click on links and submit forms programmatically symfony/cache v4.4.24 v5.2.9 Provides an extended PSR-6, PSR-16 (and tags) implementation symfony/cache-contracts v2.4.0 v2.4.0 Generic abstractions related to caching symfony/config v4.4.23 v5.2.8 Helps you find, load, combine, autofill and validate configuration values of any kind symfony/console v4.4.24 v5.2.8 Eases the creation of beautiful and testable command line interfaces symfony/css-selector v4.4.24 v5.2.9 Converts CSS selectors to XPath expressions symfony/debug v4.4.22 v4.4.22 Provides tools to ease debugging PHP code symfony/debug-bundle v4.4.20 v5.2.4 Provides a tight integration of the Symfony Debug component into the Symfony full-stack framework symfony/dependency-injection v4.4.24 v5.2.9 Allows you to standardize and centralize the way objects are constructed in your application symfony/deprecation-contracts v2.4.0 v2.4.0 A generic function and convention to trigger deprecation notices symfony/doctrine-bridge v4.4.24 v5.2.9 Provides integration for Doctrine with various Symfony components symfony/dom-crawler v4.4.24 v5.2.9 Eases DOM navigation for HTML and XML documents symfony/dotenv v4.4.20 v5.2.4 Registers environment variables from a .env file symfony/error-handler v4.4.23 v5.2.8 Provides tools to manage errors and ease debugging PHP code symfony/event-dispatcher v4.4.20 v5.2.4 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.22 v5.2.7 Provides an engine that can compile and evaluate expressions symfony/filesystem v4.4.22 v5.2.7 Provides basic utilities for the filesystem symfony/finder v4.4.24 v5.2.9 Finds files and directories via an intuitive fluent interface symfony/flex v1.13.3 v1.13.3 Composer plugin for Symfony symfony/form v4.4.24 v5.2.9 Allows to easily create, process and reuse HTML forms symfony/framework-bundle v4.4.24 v5.2.9 Provides a tight integration between Symfony components and the Symfony full-stack framework symfony/http-client v4.4.24 v5.2.9 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 v5.2.8 Defines an object-oriented layer for the HTTP specification symfony/http-kernel v4.4.24 v5.2.9 Provides a structured process for converting a Request into a Response symfony/inflector v4.4.23 v5.2.8 Converts words between their singular and plural forms (English only) symfony/intl v4.4.22 v5.2.7 Provides a PHP replacement layer for the C intl extension that includes additional data from the ICU library symfony/mailer v4.4.22 v5.2.7 Helps sending emails symfony/maker-bundle v1.31.1 v1.31.1 Symfony Maker helps you create empty commands, controllers, form classes, tests and more so you can forget about writing boilerplate code. symfony/mime v4.4.24 v5.2.9 Allows manipulating MIME messages symfony/monolog-bridge v4.4.22 v5.2.7 Provides integration for Monolog with various Symfony components symfony/monolog-bundle v3.7.0 v3.7.0 Symfony MonologBundle symfony/options-resolver v4.4.20 v5.2.4 Provides an improved replacement for the array_replace PHP function symfony/phpunit-bridge v5.2.9 v5.2.9 Provides utilities for PHPUnit, especially user deprecation notices management symfony/polyfill-intl-grapheme v1.22.1 v1.22.1 Symfony polyfill for intl's grapheme_* functions symfony/polyfill-intl-icu v1.22.1 v1.22.1 Symfony polyfill for intl's ICU-related data and classes symfony/polyfill-intl-idn v1.22.1 v1.22.1 Symfony polyfill for intl's idn_to_ascii and idn_to_utf8 functions symfony/polyfill-intl-normalizer v1.22.1 v1.22.1 Symfony polyfill for intl's Normalizer class and related functions symfony/polyfill-mbstring v1.22.1 v1.22.1 Symfony polyfill for the Mbstring extension symfony/polyfill-php72 v1.22.1 v1.22.1 Symfony polyfill backporting some PHP 7.2+ features to lower PHP versions symfony/polyfill-php73 v1.22.1 v1.22.1 Symfony polyfill backporting some PHP 7.3+ features to lower PHP versions symfony/polyfill-php80 v1.22.1 v1.22.1 Symfony polyfill backporting some PHP 8.0+ features to lower PHP versions symfony/process v4.4.22 v5.2.7 Executes commands in sub-processes symfony/property-access v4.4.20 v5.2.4 Provides functions to read and write from/to an object or array using a simple string notation symfony/property-info v4.4.23 v5.2.8 Extracts information about PHP class' properties using metadata of popular sources symfony/routing v4.4.24 v5.2.9 Maps an HTTP request to a set of configuration variables symfony/security-acl v3.1.2 v3.1.2 Symfony Security Component - ACL (Access Control List) symfony/security-bundle v4.4.23 v5.2.9 Provides a tight integration of the Security component into the Symfony full-stack framework symfony/security-core v4.4.24 v5.2.9 Symfony Security Component - Core Library symfony/security-csrf v4.4.22 v5.2.7 Symfony Security Component - CSRF Library symfony/security-guard v4.4.23 v5.2.8 Symfony Security Component - Guard symfony/security-http v4.4.24 v5.2.9 Symfony Security Component - HTTP Integration symfony/serializer v4.4.24 v5.2.9 Handles serializing and deserializing data structures, including object graphs, into array structures or other formats like XML and JSON. symfony/service-contracts v2.4.0 v2.4.0 Generic abstractions related to writing services symfony/stopwatch v4.4.20 v5.2.7 Provides a way to profile code symfony/string v5.2.8 v5.2.8 Provides an object-oriented API to strings and deals with bytes, UTF-8 code points and grapheme clusters in a unified way symfony/templating v4.4.20 v5.2.4 Provides all the tools needed to build any kind of template system symfony/translation v4.4.24 v5.2.9 Provides tools to internationalize your application symfony/translation-contracts v2.4.0 v2.4.0 Generic abstractions related to translation symfony/twig-bridge v4.4.22 v5.2.8 Provides integration for Twig with various Symfony components symfony/twig-bundle v4.4.24 v5.2.9 Provides a tight integration of Twig into the Symfony full-stack framework symfony/validator v4.4.24 v5.2.9 Provides tools to validate values symfony/var-dumper v4.4.22 v5.2.8 Provides mechanisms for walking through any arbitrary PHP variable symfony/var-exporter v4.4.23 v5.2.8 Allows exporting any serializable PHP data structure to plain PHP code symfony/web-link v4.4.21 v5.2.5 Manages links between resources symfony/web-profiler-bundle v4.4.23 v5.2.8 Provides a development tool that gives detailed information about the execution of any request symfony/webpack-encore-bundle v1.11.2 v1.11.2 Integration with your Symfony app & Webpack Encore! symfony/yaml v4.4.24 v5.2.9 Loads and dumps YAML files ```

PHP version

PHP 7.3.28 (cli) (built: May 12 2021 13:40:34) ( NTS )
Copyright (c) 1997-2018 The PHP Group
Zend Engine v3.3.28, Copyright (c) 1998-2018 Zend Technologies

Subject

When using ModelAutocompleteType to allow the selection of a related entity the functionality to select the entity and then save the form persisting the data works perfectly. However, if you then return to the form to edit the entity the value of the selected related entity is not displayed.

Minimal repository with the bug

protected function configureFormFields(FormMapper $formMapper): void
    {
        $subject = $formMapper->getAdmin()->getSubject();

        $formMapper
            ->add(
                'merchant',
                ModelAutocompleteType::class,
                [
                    'property' => 'name',
                    'minimum_input_length' => 2,
                    'required'   => true,
                    'btn_add' => 'Add new merchant'
                ]
            );
    }

Steps to reproduce

Expected results

I would expect the '__toString()' representation of the selected related entity to be visible in the input.

Actual results

The input is blank. The value is present in a hidden input so the entity can be saved and the value remains unchanged but it is not possible to see the value within the form.

VincentLanglet commented 3 years ago

Did it work with a previous version ?

willemverspyck commented 3 years ago

I have the same problem. The problem is since SonataDoctrineORMAdminBundle 3.34.1. If I rollback to 3.34.0 it works again.

VincentLanglet commented 3 years ago

I have the same problem. The problem is since SonataDoctrineORMAdminBundle 3.34.1. If I rollback to 3.34.0 it works again.

Thanks. There is not a lot of changes https://github.com/sonata-project/SonataDoctrineORMAdminBundle/compare/3.34.0...3.34.1

cc @franmomu @phansys.

I'm moving this to SonataDoctrineORMAdminBundle repository

willemverspyck commented 3 years ago

I'm not sure anymore where the problem is. After revert back to 3.34.0 it works on my dev environment, but in production I still have the same problem (with exact the same composer.lock file). I will investigate tomorrow.

franmomu commented 3 years ago

It doesn't look like a problem of this bundle, at least in those versions, could it be problem of sonata-project/admin-bundle? can you please try for example 3.99?

franmomu commented 3 years ago

maybe https://github.com/sonata-project/SonataAdminBundle/pull/7196?

willemverspyck commented 3 years ago

Yes, the problem is related to #7196. If I revert line 265 from this commit: https://github.com/sonata-project/SonataAdminBundle/pull/7196/commits/9509437a5347e20512e2a4c74cb90df7849ac886 it works again.

VincentLanglet commented 3 years ago

Ping @cecicifu

alistairstead commented 3 years ago

I can also confirm that reverting the change in line 265 of sonata_type_model_autocomplete.html.twig resolves the problem

cecicifu commented 3 years ago

Its weird but, in my project works perfectly

PHP version 
PHP 7.4.5 (cli) (built: Apr 14 2020 16:17:34) ( ZTS Visual C++ 2017 x64 )
Copyright (c) The PHP Group
Zend Engine v3.4.0, Copyright (c) Zend Technologies
Sonata packages 
sonata-project/admin-bundle              dev-master 37bd817 The missing Symfony Admin Generator
sonata-project/block-bundle              4.5.3              Symfony SonataBlockBundle
sonata-project/cache                     2.1.1              Cache library
sonata-project/doctrine-extensions       1.12.0             Doctrine2 behavioral extensions
sonata-project/doctrine-orm-admin-bundle dev-master 178cd0b Integrate Doctrine ORM into the SonataAdminBundle
sonata-project/exporter                  2.6.2              Lightweight Exporter library
sonata-project/form-extensions           1.9.0              Symfony form extensions
sonata-project/twig-extensions           1.6.0              Sonata twig extensions
Symfony packages 
symfony/apache-pack                v1.0.1  A pack for Apache support in Symfony
symfony/asset                      v5.2.7  Manages URL generation and versioning of web assets such as CSS stylesheets, JavaScript files and image files
symfony/browser-kit                v5.2.7  Simulates the behavior of a web browser, allowing you to make requests, click on links and submit forms programmatically
symfony/cache                      v5.2.8  Provides an extended PSR-6, PSR-16 (and tags) implementation
symfony/cache-contracts            v2.4.0  Generic abstractions related to caching
symfony/config                     v5.2.8  Helps you find, load, combine, autofill and validate configuration values of any kind
symfony/console                    v5.2.8  Eases the creation of beautiful and testable command line interfaces
symfony/css-selector               v5.2.7  Converts CSS selectors to XPath expressions
symfony/debug-bundle               v5.2.4  Provides a tight integration of the Symfony Debug component into the Symfony full-stack framework
symfony/dependency-injection       v5.2.8  Allows you to standardize and centralize the way objects are constructed in your application
symfony/deprecation-contracts      v2.4.0  A generic function and convention to trigger deprecation notices
symfony/doctrine-bridge            v5.2.7  Provides integration for Doctrine with various Symfony components
symfony/dom-crawler                v5.2.4  Eases DOM navigation for HTML and XML documents
symfony/dotenv                     v5.2.4  Registers environment variables from a .env file
symfony/error-handler              v5.2.8  Provides tools to manage errors and ease debugging PHP code
symfony/event-dispatcher           v5.2.4  Provides tools that allow your application components to communicate with each other by dispatching events and listening to them
symfony/event-dispatcher-contracts v2.4.0  Generic abstractions related to dispatching event
symfony/expression-language        v5.2.7  Provides an engine that can compile and evaluate expressions
symfony/filesystem                 v5.2.7  Provides basic utilities for the filesystem
symfony/finder                     v5.2.8  Finds files and directories via an intuitive fluent interface
symfony/flex                       v1.13.2 Composer plugin for Symfony
symfony/form                       v5.2.8  Allows to easily create, process and reuse HTML forms
symfony/framework-bundle           v5.2.7  Provides a tight integration between Symfony components and the Symfony full-stack framework
symfony/http-client                v5.2.8  Provides powerful methods to fetch HTTP resources synchronously or asynchronously
symfony/http-client-contracts      v2.4.0  Generic abstractions related to HTTP clients
symfony/http-foundation            v5.2.8  Defines an object-oriented layer for the HTTP specification
symfony/http-kernel                v5.2.8  Provides a structured process for converting a Request into a Response
symfony/intl                       v5.2.7  Provides a PHP replacement layer for the C intl extension that includes additional data from the ICU library
symfony/mailer                     v5.2.7  Helps sending emails
symfony/maker-bundle               v1.31.1 Symfony Maker helps you create empty commands, controllers, form classes, tests and more so you can forget about writing boilerplate code.
symfony/mime                       v5.2.7  Allows manipulating MIME messages
symfony/monolog-bridge             v5.2.7  Provides integration for Monolog with various Symfony components
symfony/monolog-bundle             v3.7.0  Symfony MonologBundle
symfony/notifier                   v5.2.8  Sends notifications via one or more channels (email, SMS, ...)
symfony/options-resolver           v5.2.4  Provides an improved replacement for the array_replace PHP function
symfony/phpunit-bridge             v5.2.8  Provides utilities for PHPUnit, especially user deprecation notices management
symfony/polyfill-intl-grapheme     v1.22.1 Symfony polyfill for intl's grapheme_* functions
symfony/polyfill-intl-icu          v1.22.1 Symfony polyfill for intl's ICU-related data and classes
symfony/polyfill-intl-idn          v1.22.1 Symfony polyfill for intl's idn_to_ascii and idn_to_utf8 functions
symfony/polyfill-intl-normalizer   v1.22.1 Symfony polyfill for intl's Normalizer class and related functions
symfony/polyfill-mbstring          v1.22.1 Symfony polyfill for the Mbstring extension
symfony/polyfill-php73             v1.22.1 Symfony polyfill backporting some PHP 7.3+ features to lower PHP versions
symfony/polyfill-php80             v1.22.1 Symfony polyfill backporting some PHP 8.0+ features to lower PHP versions
symfony/process                    v5.2.7  Executes commands in sub-processes
symfony/property-access            v5.2.4  Provides functions to read and write from/to an object or array using a simple string notation
symfony/property-info              v5.2.8  Extracts information about PHP class' properties using metadata of popular sources
symfony/proxy-manager-bridge       v5.2.4  Provides integration for ProxyManager with various Symfony components
symfony/routing                    v5.2.7  Maps an HTTP request to a set of configuration variables
symfony/security-acl               v3.1.2  Symfony Security Component - ACL (Access Control List)
symfony/security-bundle            v5.2.8  Provides a tight integration of the Security component into the Symfony full-stack framework
symfony/security-core              v5.2.8  Symfony Security Component - Core Library
symfony/security-csrf              v5.2.7  Symfony Security Component - CSRF Library
symfony/security-guard             v5.2.8  Symfony Security Component - Guard
symfony/security-http              v5.2.8  Symfony Security Component - HTTP Integration
symfony/serializer                 v5.2.7  Handles serializing and deserializing data structures, including object graphs, into array structures or other formats like XML and JSON.
symfony/service-contracts          v2.4.0  Generic abstractions related to writing services
symfony/stopwatch                  v5.2.7  Provides a way to profile code
symfony/string                     v5.2.8  Provides an object-oriented API to strings and deals with bytes, UTF-8 code points and grapheme clusters in a unified way
symfony/translation                v5.2.8  Provides tools to internationalize your application
symfony/translation-contracts      v2.4.0  Generic abstractions related to translation
symfony/twig-bridge                v5.2.8  Provides integration for Twig with various Symfony components
symfony/twig-bundle                v5.2.4  Provides a tight integration of Twig into the Symfony full-stack framework
symfony/validator                  v5.2.7  Provides tools to validate values
symfony/var-dumper                 v5.2.8  Provides mechanisms for walking through any arbitrary PHP variable
symfony/var-exporter               v5.2.8  Allows exporting any serializable PHP data structure to plain PHP code
symfony/web-link                   v5.2.5  Manages links between resources
symfony/web-profiler-bundle        v5.2.8  Provides a development tool that gives detailed information about the execution of any request
symfony/webpack-encore-bundle      v1.11.2 Integration with your Symfony app & Webpack Encore!
symfony/yaml                       v5.2.7  Loads and dumps YAML files

Maybe a bug with 3.x versions ?

VincentLanglet commented 3 years ago

I think the select 2 version is not the same anymore in 3.x and master (@jordisala1991 ?)

cecicifu commented 3 years ago

Select2 in master is ^4.0 and 3.x is 3.5.4, right ?

cecicifu commented 3 years ago

Can you try this ? @alistairstead @willemverspyck 

// append to Select2
autocompleteInput.append(data).trigger('change');

// manually trigger the `select2:select` event
autocompleteInput.trigger({
    type: 'select2:select',
    params: {
        data: data
    }
});

This changes works for me too (master) and its better code. @VincentLanglet

willemverspyck commented 3 years ago

@cecicifu: Code looks better indeed. But this change doesn't work for me, because the problem is in the change at line 265.

But if "Select2 in master is ^4.0 and 3.x is 3.5.4" is true, then we can maybe revert line 265 as this line only works for Select V3 (see comments above this line)?

VincentLanglet commented 3 years ago

Could you try the 3.x branch @cecicifu in order to see if you find something working for both master and 3.x ? If not, can you open a PR @willemverspyck ?

cecicifu commented 3 years ago

I tried to search for a proper solution, but i think the best way is revert changes for 3.x because Select2 v4 has a very different API than v3, and use the actual code for master with the improvements below.

Can you try this ? @alistairstead @willemverspyck

// append to Select2
autocompleteInput.append(data).trigger('change');

// manually trigger the `select2:select` event
autocompleteInput.trigger({
    type: 'select2:select',
    params: {
        data: data
    }
});

This changes works for me too (master) and its better code. @VincentLanglet

What do u think @VincentLanglet ? Can u do the PR's?

VincentLanglet commented 3 years ago

I would prefer the PR to be made by someone with the bug in order to be sure it'll fix the issue.

@alistairstead @willemverspyck Does one of you want to do the PR ?

willemverspyck commented 3 years ago

@VincentLanglet I will make PR for this (tomorrow)