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

Weird bug with Symfony DomCrawler and ModelListType (Form Theme) #7197

Closed jeroendk closed 3 years ago

jeroendk commented 3 years ago

Environment

Sonata packages

show

``` $ composer show --latest 'sonata-project/*' sonata-project/admin-bundle 3.99.1 3.99.1 The missing Symfony Admin Generator sonata-project/block-bundle 3.23.1 4.5.3 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.12.0 1.12.0 Doctrine2 behavioral extensions sonata-project/doctrine-orm-admin-bundle 3.34.0 3.34.0 Integrate Doctrine ORM into the SonataAdminBundle sonata-project/easy-extends-bundle 2.5.0 2.5.0 Symfony SonataEasyExtendsBundle sonata-project/exporter 2.6.2 2.6.2 Lightweight Exporter library sonata-project/form-extensions 1.9.0 1.9.0 Symfony form extensions sonata-project/media-bundle 3.31.1 3.31.1 Symfony SonataMediaBundle sonata-project/twig-extensions 1.5.1 1.5.1 Sonata twig extensions sonata-project/user-bundle 4.11.1 4.11.1 Symfony SonataUserBundle ```

Symfony packages

show

``` $ composer show --latest 'symfony/*' symfony/asset v4.4.22 v4.4.22 Manages URL generation and versioning of web assets such as CSS stylesheets, JavaScript files and image files symfony/browser-kit v4.4.22 v4.4.22 Simulates the behavior of a web browser, allowing you to make requests, click on links and submit forms programmatically symfony/cache v4.4.23 v4.4.23 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 v4.4.23 Helps you find, load, combine, autofill and validate configuration values of any kind symfony/console v4.4.23 v4.4.23 Eases the creation of beautiful and testable command line interfaces symfony/css-selector v4.4.22 v4.4.22 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 v4.4.20 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.23 v4.4.23 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.22 v4.4.22 Provides integration for Doctrine with various Symfony components symfony/dom-crawler v4.4.20 v4.4.20 Eases DOM navigation for HTML and XML documents symfony/dotenv v4.4.20 v4.4.20 Registers environment variables from a .env file symfony/error-handler v4.4.23 v4.4.23 Provides tools to manage errors and ease debugging PHP code symfony/event-dispatcher v4.4.20 v4.4.20 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 v4.4.22 Provides an engine that can compile and evaluate expressions symfony/filesystem v4.4.22 v4.4.22 Provides basic utilities for the filesystem symfony/finder v4.4.23 v4.4.23 Finds files and directories via an intuitive fluent interface symfony/flex v1.12.2 v1.12.2 Composer plugin for Symfony symfony/form v4.4.22 v4.4.22 Allows to easily create, process and reuse HTML forms symfony/framework-bundle v4.4.22 v4.4.22 Provides a tight integration between Symfony components and the Symfony full-stack framework symfony/http-client v4.4.23 v4.4.23 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.23 Defines an object-oriented layer for the HTTP specification symfony/http-kernel v4.4.23 v4.4.23 Provides a structured process for converting a Request into a Response symfony/inflector v4.4.23 v4.4.23 Converts words between their singular and plural forms (English only) symfony/intl v4.4.22 v4.4.22 Provides a PHP replacement layer for the C intl extension that includes additional data from the ICU library symfony/mailer v4.4.22 v4.4.22 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/messenger v4.4.22 v4.4.22 Helps applications send and receive messages to/from other applications or via message queues symfony/mime v4.4.22 v4.4.22 Allows manipulating MIME messages symfony/monolog-bridge v4.4.22 v4.4.22 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 v4.4.20 Provides an improved replacement for the array_replace PHP function symfony/orm-pack v1.2.0 v2.1.0 A pack for the Doctrine ORM symfony/phpunit-bridge v4.4.22 v5.2.8 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 v4.4.22 Executes commands in sub-processes symfony/profiler-pack v1.0.5 v1.0.5 A pack for the Symfony web profiler symfony/property-access v4.4.20 v4.4.20 Provides functions to read and write from/to an object or array using a simple string notation symfony/property-info v4.4.23 v4.4.23 Extracts information about PHP class' properties using metadata of popular sources symfony/routing v4.4.22 v4.4.22 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 v4.4.23 Provides a tight integration of the Security component into the Symfony full-stack framework symfony/security-core v4.4.23 v4.4.23 Symfony Security Component - Core Library symfony/security-csrf v4.4.22 v4.4.22 Symfony Security Component - CSRF Library symfony/security-guard v4.4.23 v4.4.23 Symfony Security Component - Guard symfony/security-http v4.4.22 v4.4.22 Symfony Security Component - HTTP Integration symfony/sendgrid-mailer v4.4.20 v4.4.20 Symfony Sendgrid Mailer Bridge symfony/serializer v4.4.22 v4.4.22 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.20 v4.4.20 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/swiftmailer-bundle v3.5.2 v3.5.2 Symfony SwiftmailerBundle symfony/templating v4.4.20 v4.4.20 Provides all the tools needed to build any kind of template system symfony/test-pack v1.0.7 v1.0.7 A pack for functional and end-to-end testing within a Symfony app symfony/translation v4.4.23 v4.4.23 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 v4.4.22 Provides integration for Twig with various Symfony components symfony/twig-bundle v4.4.20 v4.4.20 Provides a tight integration of Twig into the Symfony full-stack framework symfony/validator v4.4.22 v4.4.22 Provides tools to validate values symfony/var-dumper v4.4.22 v4.4.22 Provides mechanisms for walking through any arbitrary PHP variable symfony/var-exporter v4.4.23 v4.4.23 Allows exporting any serializable PHP data structure to plain PHP code symfony/web-link v4.4.21 v4.4.21 Manages links between resources symfony/web-profiler-bundle v4.4.23 v4.4.23 Provides a development tool that gives detailed information about the execution of any request symfony/web-server-bundle v4.4.22 v4.4.22 Provides commands for running applications using the PHP built-in web server symfony/webpack-encore-bundle v1.11.2 v1.11.2 Integration with your Symfony app & Webpack Encore! symfony/yaml v4.4.22 v4.4.22 Loads and dumps YAML files ```

PHP version

$ php -v
PHP 7.4.11

Subject

After updating the admin bundle to 3.98.2 or up, we got some weird behavior in our functional test cases within the admin bundle. I can't quite pin down what is causing this, I'll try to explain it as best as I can:

The error is thrown when trying to get the form element from one of the submit buttons in the admin form:

 $buttonCrawlerNode = $crawler->selectButton('btn_create_and_list');
 $form = $buttonCrawlerNode->form();

Error: LogicException: The selected node does not have a form ancestor.

It only occurs when there is a * to Many field included in the form like: Sonata\AdminBundle\Form\Type\ModelListType

It seems related to one of the change, but can't tell why (commit):

// src/DependencyInjection/Compiler/AddDependencyCallsCompilerPass.php
if (!$definition->hasMethodCall('setFormTheme')) {
     $definition->addMethodCall('setFormTheme', [$overwriteAdminConfiguration['templates']['form'] ?? []]);
}

If I remove this change, the error is gone. If I leave this in and remove all the Javascript in: sonata-project/admin-bundle/src/Resources/views/CRUD/Association/edit_many_script.html.twig the error is gone too, which makes no sense to me....

I am not overwriting any form themes in the Sonata bundles.

Steps to reproduce

Expected results

No error

Actual results

Error: LogicException: The selected node does not have a form ancestor.

VincentLanglet commented 3 years ago

What is your sonata_admin and sonata_doctrine_orm config ? Do you use setFormTheme or override the getFormTheme method ?

jeroendk commented 3 years ago

sonata_admin.yaml

sonata_admin:
    title: "..."
    title_logo: "/assets/images/logo-horizontal.svg"
    assets:
        extra_stylesheets:
            - assets/admin/css/admin.css
        extra_javascripts:
            - assets/admin/js/admin.js
    dashboard:
        blocks:
            ...

    security:
        handler: App\Security\Handler\RoleSecurityHandler
        role_admin: ROLE_ADMIN
        role_super_admin: ROLE_SUPER_ADMIN

no custom sonata_doctrine_orm config.

Do you use setFormTheme or override the getFormTheme method

No I do not.

VincentLanglet commented 3 years ago

You could try to dump the html in order to see if there is not an error message.

jeroendk commented 3 years ago

I did and validated it with an HTML validator, no errors. Visually the Form tag is still an ancestor of the button. I'll try to set up a test repository if that would help.

dmaicher commented 3 years ago

I think I also noticed something like this on one of my projects. Some inlined JS of SonataAdmin was causing issues for the DomCrawler.

See https://github.com/symfony/symfony/issues/40789

My fix was to require masterminds/html5 to make Symfony's DomCrawler more robust.

Could this also be your issue?

jeroendk commented 3 years ago

Thanks @dmaicher, installing masterminds/html5 fixes the issue indeed! Still not sure why this was not a problem in the earlier versions of Sonata Admin, the same Javascript was rendered before as far as I can see.

Unless we want to update the Javascript and split strings as '<' + '/form>' in inline JS I'll close this issue.

EmmanuelVella commented 3 years ago

Hello, I had the same problem (using behat), installing masterminds/html5 fixed the issue too, thank you for the hint !

FYI, it was caused by this block of code : https://github.com/sonata-project/SonataAdminBundle/pull/6889/files#diff-14850f444507f5d5f4c2fa1ad05550de212d87e5b6656ad5b0eb8f43ff816ed1R356

eerison commented 3 years ago

Thank you @EmmanuelVella to share the fix.

I had the same problem! Using admin-bundle version 3.86.0 it works fine, But 3.87.0 or higher I needed to use masterminds/html5, for behat tests pass

mvhirsch commented 1 year ago

You saved my day, thank you! :heart: