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

Abstract classes make the update translation throw a \RuntimeException #6931

Closed Martin1982 closed 3 years ago

Martin1982 commented 3 years ago

Environment

Dev - Ubuntu - PHP 7.4

Sonata packages

show

``` $ composer show --latest 'sonata-project/*' sonata-project/admin-bundle 3.91.1 3.91.1 The missing Symfony Admin Generator sonata-project/block-bundle 3.22.1 4.5.2 Symfony SonataBlockBundle sonata-project/cache 2.0.1 2.1.1 Cache library sonata-project/cache-bundle 3.2.1 3.2.1 This bundle provides caching services sonata-project/classification-bundle 3.15.0 3.15.0 Symfony SonataClassificationBundle sonata-project/datagrid-bundle 3.3.0 3.3.0 Symfony SonataDatagridBundle sonata-project/doctrine-extensions 1.11.0 1.12.0 Doctrine2 behavioral extensions sonata-project/doctrine-orm-admin-bundle 3.30.0 3.31.0 Integrate Doctrine ORM into the SonataAdminBundle sonata-project/exporter 2.5.1 2.5.1 Lightweight Exporter library sonata-project/form-extensions 1.9.0 1.9.0 Symfony form extensions sonata-project/formatter-bundle 4.4.0 4.4.0 Symfony SonataFormatterBundle sonata-project/intl-bundle 2.10.1 2.10.1 Symfony SonataIntlBundle sonata-project/media-bundle 3.30.0 3.30.0 Symfony SonataMediaBundle sonata-project/seo-bundle 2.13.0 2.13.0 Symfony SonataSeoBundle sonata-project/twig-extensions 1.5.1 1.5.1 Sonata twig extensions ```

Symfony packages

show

``` $ composer show --latest 'symfony/*' symfony/acl-bundle v2.1.0 v2.1.0 Symfony AclBundle symfony/asset v4.4.20 v5.2.4 Manages URL generation and versioning of web assets such as CSS stylesheets, JavaScript files and image files symfony/browser-kit v4.4.20 v5.2.4 Simulates the behavior of a web browser, allowing you to make requests, click on links and submit forms programmatically symfony/cache v4.4.20 v5.2.4 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.20 v5.2.4 Helps you find, load, combine, autofill and validate configuration values of any kind symfony/console v4.4.20 v5.2.5 Eases the creation of beautiful and testable command line interfaces symfony/css-selector v4.4.20 v5.2.4 Converts CSS selectors to XPath expressions symfony/debug v4.4.20 v4.4.20 Provides tools to ease debugging PHP code symfony/dependency-injection v4.4.20 v5.2.5 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.20 v5.2.5 Provides integration for Doctrine with various Symfony components symfony/dom-crawler v4.4.20 v5.2.4 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.20 v5.2.4 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.2.0 Generic abstractions related to dispatching event symfony/expression-language v4.4.20 v5.2.4 Provides an engine that can compile and evaluate expressions symfony/filesystem v4.4.20 v5.2.4 Provides basic utilities for the filesystem symfony/finder v4.4.20 v5.2.4 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.20 v5.2.5 Allows to easily create, process and reuse HTML forms symfony/framework-bundle v4.4.20 v5.2.5 Provides a tight integration between Symfony components and the Symfony full-stack framework symfony/http-client v4.4.20 v5.2.4 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.20 v5.2.4 Defines an object-oriented layer for the HTTP specification symfony/http-kernel v4.4.20 v5.2.5 Provides a structured process for converting a Request into a Response symfony/inflector v4.4.20 v5.2.4 Converts words between their singular and plural forms (English only) symfony/intl v4.4.20 v5.2.4 Provides a PHP replacement layer for the C intl extension that includes additional data from the ICU library symfony/mailer v4.4.20 v5.2.5 Helps sending emails symfony/maker-bundle v1.29.1 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 v4.4.20 v5.2.5 Helps applications send and receive messages to/from other applications or via message queues symfony/mime v4.4.20 v5.2.5 Allows manipulating MIME messages symfony/monolog-bridge v4.4.20 v5.2.5 Provides integration for Monolog with various Symfony components symfony/monolog-bundle v3.6.0 v3.6.0 Symfony MonologBundle symfony/options-resolver v4.4.20 v5.2.4 Provides an improved replacement for the array_replace PHP function symfony/orm-pack v1.0.8 v2.1.0 A pack for the Doctrine ORM symfony/phpunit-bridge v5.2.4 v5.2.4 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.20 v5.2.4 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 v5.2.4 Provides functions to read and write from/to an object or array using a simple string notation symfony/psr-http-message-bridge v2.1.0 v2.1.0 PSR HTTP message bridge symfony/routing v4.4.20 v5.2.4 Maps an HTTP request to a set of configuration variables symfony/security-acl v3.1.1 v3.1.1 Symfony Security Component - ACL (Access Control List) symfony/security-bundle v4.4.20 v5.2.5 Provides a tight integration of the Security component into the Symfony full-stack framework symfony/security-core v4.4.20 v5.2.5 Symfony Security Component - Core Library symfony/security-csrf v4.4.20 v5.2.4 Symfony Security Component - CSRF Library symfony/security-guard v4.4.20 v5.2.4 Symfony Security Component - Guard symfony/security-http v4.4.20 v5.2.5 Symfony Security Component - HTTP Integration symfony/serializer v4.4.20 v5.2.4 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 v4.4.20 v5.2.4 Provides a way to profile code symfony/string v5.2.4 v5.2.4 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 v5.2.4 Provides all the tools needed to build any kind of template system symfony/translation v4.4.20 v5.2.5 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.20 v5.2.5 Provides integration for Twig with various Symfony components symfony/twig-bundle v4.4.20 v5.2.4 Provides a tight integration of Twig into the Symfony full-stack framework symfony/validator v4.4.20 v5.2.5 Provides tools to validate values symfony/var-dumper v4.4.20 v5.2.5 Provides mechanisms for walking through any arbitrary PHP variable symfony/var-exporter v4.4.20 v5.2.4 Allows exporting any serializable PHP data structure to plain PHP code symfony/web-profiler-bundle v4.4.20 v5.2.4 Provides a development tool that gives detailed information about the execution of any request symfony/webpack-encore-bundle v1.11.1 v1.11.1 Integration with your Symfony app & Webpack Encore! symfony/yaml v4.4.20 v5.2.5 Loads and dumps YAML files ```

PHP version

$ php -v
PHP 7.4.14 (cli) (built: Jan 13 2021 08:04:06) ( NTS )
Copyright (c) The PHP Group
Zend Engine v3.4.0, Copyright (c) Zend Technologies
    with Zend OPcache v7.4.14, Copyright (c), by Zend Technologies

Subject

In my admin definitions I have a class defined with an abstract base class, when running the translation update command for translations I get a \RuntimeError with the message ' Cannot initialize abstract class: Spinnin\Entity\Campaign\AbstractBaseCampaign'

Minimal repository with the bug

As mentioned in the composer output above

Steps to reproduce

Create an abstract entity-class with the following orm definition;

/**
 * Class BaseCampaign
 *
 * @ORM\Entity(repositoryClass="Spinnin\Repository\CampaignRepository")
 * @ORM\Table(name="campaign", options={"collate"="utf8mb4_general_ci", "charset"="utf8mb4"})
 * @ORM\InheritanceType("JOINED")
 * @ORM\DiscriminatorColumn(name="discr", type="string")
 */
abstract class AbstractBaseCampaign
{ ... }

Make some entity-classes which inherit from this class e.g.;

class Demo extends AbstractBaseCampaign {}

Define an admin in the services config:

    Spinnin\Admin\CampaignAdmin:
        tags:
            - name: sonata.admin
              manager_type: orm
              label: "Campaigns"
        arguments:
            - null
            - Spinnin\Entity\Campaign\AbstractBaseCampaign
            - Spinnin\Controller\Admin\CampaignCrudController
        calls:
            - [ setTranslationDomain, ['spinnin']]
            - [ setTemplate, ['edit', 'interaction/crud/base_entity_edit.html.twig']]
            - [ setSubClasses, [ { "Demo Drop": Spinnin\Entity\Campaign\Demo, "Finish the Track":  Spinnin\Entity\Campaign\FinishTheTrack, "Prize Question": Spinnin\Entity\Campaign\PrizeQuestion, "Remix Contest": Spinnin\Entity\Campaign\RemixCompetition, "Sweepstakes": Spinnin\Entity\Campaign\Sweepstakes, "Pre-Save": Spinnin\Entity\Campaign\PreSave, "Playlist Generator": Spinnin\Entity\Campaign\PlaylistGenerator, "Best Of": Spinnin\Entity\Campaign\BestOf, "Release voting": Spinnin\Entity\Campaign\ReleaseVote } ] ]

Run the Symfony command to update translations;

bin/console translation:update -vvv --dump-messages --sort=asc src

Expected results

A list of translations to update where abstract classes are not being instantiated.

Actual results

In ModelManager.php line 627:

  [RuntimeException]                                                              
  Cannot initialize abstract class: Spinnin\Entity\Campaign\AbstractBaseCampaign  

Exception trace:
  at /var/www/spinninrecords/vendor/sonata-project/doctrine-orm-admin-bundle/src/Model/ModelManager.php:627
 Sonata\DoctrineORMAdminBundle\Model\ModelManager->getModelInstance() at /var/www/spinninrecords/vendor/sonata-project/admin-bundle/src/Admin/AbstractAdmin.php:2903
 Sonata\AdminBundle\Admin\AbstractAdmin->createNewInstance() at /var/www/spinninrecords/vendor/sonata-project/admin-bundle/src/Admin/AbstractAdmin.php:1253
 Sonata\AdminBundle\Admin\AbstractAdmin->getNewInstance() at /var/www/spinninrecords/vendor/sonata-project/admin-bundle/src/Translator/Extractor/AdminExtractor.php:104
 Sonata\AdminBundle\Translator\Extractor\AdminExtractor->extract() at /var/www/spinninrecords/vendor/symfony/translation/Extractor/ChainExtractor.php:56
 Symfony\Component\Translation\Extractor\ChainExtractor->extract() at /var/www/spinninrecords/vendor/symfony/framework-bundle/Command/TranslationUpdateCommand.php:226
 Symfony\Bundle\FrameworkBundle\Command\TranslationUpdateCommand->execute() at /var/www/spinninrecords/vendor/symfony/console/Command/Command.php:255
 Symfony\Component\Console\Command\Command->run() at /var/www/spinninrecords/vendor/symfony/console/Application.php:1027
 Symfony\Component\Console\Application->doRunCommand() at /var/www/spinninrecords/vendor/symfony/framework-bundle/Console/Application.php:97
 Symfony\Bundle\FrameworkBundle\Console\Application->doRunCommand() at /var/www/spinninrecords/vendor/symfony/console/Application.php:273
 Symfony\Component\Console\Application->doRun() at /var/www/spinninrecords/vendor/symfony/framework-bundle/Console/Application.php:83
 Symfony\Bundle\FrameworkBundle\Console\Application->doRun() at /var/www/spinninrecords/vendor/symfony/console/Application.php:149
 Symfony\Component\Console\Application->run() at /var/www/spinninrecords/bin/console:42
VincentLanglet commented 3 years ago

Hi @Martin1982, how do you manage to create an entity with this admin ?

VincentLanglet commented 3 years ago

I would say that the issue is the fact that createNewInstance is not working in your admin since you're using an Abstract class. You should override this method.

Gielovic commented 1 year ago

I do think the issue raised here is valid. I experienced the same. In the admin area, everything is working fine, as the objects instantiated are of the types of the subclasses. When extracting translations however, no subclass is considered 'active' and thus the returned class to be instantiated is the baseclass, which is abstract.

VincentLanglet commented 1 year ago

When extracting translations however, no subclass is considered 'active' and thus the returned class to be instantiated is the baseclass, which is abstract.

PR is welcome.

It will certainly require to do something in the AdminExtractor like

            if ($admin->getSubClasses() !== []) {
                foreach ($admin->getSubClasses() as $subClass) {
                    // TODO: SOME WAY TO SET THE SUBCLASS

                    $admin->setSubject($admin->getNewInstance());

                    foreach (self::PUBLIC_ADMIN_METHODS as $method) {
                        $admin->$method();
                    }

                    foreach (self::BREADCRUMB_ACTIONS as $action) {
                        $this->breadcrumbsBuilder->getBreadcrumbs($admin, $action);
                    }
                }
            } else {
                $admin->setSubject($admin->getNewInstance());

                foreach (self::PUBLIC_ADMIN_METHODS as $method) {
                    $admin->$method();
                }

                foreach (self::BREADCRUMB_ACTIONS as $action) {
                    $this->breadcrumbsBuilder->getBreadcrumbs($admin, $action);
                }
            }