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

Batch actions are broken since upgrade from sonata v3 to v4 #7975

Closed jeroendesloovere closed 1 year ago

jeroendesloovere commented 1 year ago

Environment

Sonata packages

show

``` $ composer show --latest 'sonata-project/*' # Put the result here. sonata-project/admin-bundle 4.20.0 4.21.0 The missing Symfony Admin Generator sonata-project/block-bundle 4.19.0 4.19.0 Symfony SonataBlockBundle sonata-project/cache 2.2.0 2.2.0 Cache library Package sonata-project/cache is abandoned, you should avoid using it. No replacement was suggested. sonata-project/doctrine-extensions 2.0.1 2.0.1 Doctrine2 behavioral extensions sonata-project/doctrine-orm-admin-bundle 4.8.0 4.8.0 Integrate Doctrine ORM into the SonataAdminBundle sonata-project/exporter 2.13.0 3.0.0 Lightweight Exporter library sonata-project/form-extensions 1.18.0 1.18.0 Symfony form extensions sonata-project/translation-bundle 3.1.0 3.1.0 SonataTranslationBundle sonata-project/twig-extensions 1.12.0 2.0.0 Sonata twig extensions sonata-project/user-bundle 5.4.0 5.4.0 Symfony SonataUserBundle ```

Symfony packages

show

``` $ composer show --latest 'symfony/*' symfony/apache-pack v1.0.1 v1.0.1 A pack for Apache support in Symfony symfony/asset v5.4.13 v6.1.5 Manages URL generation and versioning of web assets such as CSS stylesheets, JavaScript files and image files symfony/browser-kit v5.4.11 v6.1.3 Simulates the behavior of a web browser, allowing you to make requests, click on links and submit forms programmatically symfony/cache v5.4.15 v6.1.7 Provides extended PSR-6, PSR-16 (and tags) implementations symfony/cache-contracts v2.5.2 v3.1.1 Generic abstractions related to caching symfony/config v5.4.11 v6.1.3 Helps you find, load, combine, autofill and validate configuration values of any kind symfony/console v5.4.15 v6.1.7 Eases the creation of beautiful and testable command line interfaces symfony/css-selector v5.4.11 v6.1.3 Converts CSS selectors to XPath expressions symfony/debug-bundle v5.4.11 v6.1.3 Provides a tight integration of the Symfony VarDumper component and the ServerLogCommand from MonologBridge into the Symfony full-stack framework symfony/dependency-injection v5.4.13 v6.1.5 Allows you to standardize and centralize the way objects are constructed in your application symfony/deprecation-contracts v3.1.1 v3.1.1 A generic function and convention to trigger deprecation notices symfony/doctrine-bridge v5.4.15 v6.1.7 Provides integration for Doctrine with various Symfony components symfony/dom-crawler v5.4.15 v6.1.7 Eases DOM navigation for HTML and XML documents symfony/dotenv v5.4.5 v6.1.0 Registers environment variables from a .env file symfony/error-handler v5.4.15 v6.1.7 Provides tools to manage errors and ease debugging PHP code symfony/event-dispatcher v5.4.9 v6.1.0 Provides tools that allow your application components to communicate with each other by dispatching events and listening to them symfony/event-dispatcher-contracts v3.1.1 v3.1.1 Generic abstractions related to dispatching event symfony/expression-language v5.4.14 v6.1.6 Provides an engine that can compile and evaluate expressions symfony/filesystem v5.4.13 v6.1.5 Provides basic utilities for the filesystem symfony/finder v5.4.11 v6.1.3 Finds files and directories via an intuitive fluent interface symfony/flex v2.2.3 v2.2.3 Composer plugin for Symfony symfony/form v5.4.15 v6.1.7 Allows to easily create, process and reuse HTML forms symfony/framework-bundle v5.4.14 v6.1.7 Provides a tight integration between Symfony components and the Symfony full-stack framework symfony/http-client v5.4.15 v6.1.7 Provides powerful methods to fetch HTTP resources synchronously or asynchronously symfony/http-client-contracts v2.5.2 v3.1.1 Generic abstractions related to HTTP clients symfony/http-foundation v5.4.15 v6.1.7 Defines an object-oriented layer for the HTTP specification symfony/http-kernel v5.4.15 v6.1.7 Provides a structured process for converting a Request into a Response symfony/intl v5.4.15 v6.1.7 Provides a PHP replacement layer for the C intl extension that includes additional data from the ICU library symfony/mailer v5.4.15 v6.1.7 Helps sending emails symfony/maker-bundle v1.47.0 v1.47.0 Symfony Maker helps you create empty commands, controllers, form classes, tests and more so you can forget about writing boilerplate code. symfony/mime v5.4.14 v6.1.7 Allows manipulating MIME messages symfony/monolog-bridge v5.4.10 v6.1.2 Provides integration for Monolog with various Symfony components symfony/monolog-bundle v3.8.0 v3.8.0 Symfony MonologBundle symfony/options-resolver v5.4.11 v6.1.0 Provides an improved replacement for the array_replace PHP function symfony/password-hasher v5.4.11 v6.1.3 Provides password hashing utilities symfony/phpunit-bridge v6.1.6 v6.1.6 Provides utilities for PHPUnit, especially user deprecation notices management symfony/polyfill-intl-grapheme v1.27.0 v1.27.0 Symfony polyfill for intl's grapheme_* functions symfony/polyfill-intl-icu v1.27.0 v1.27.0 Symfony polyfill for intl's ICU-related data and classes symfony/polyfill-intl-idn v1.27.0 v1.27.0 Symfony polyfill for intl's idn_to_ascii and idn_to_utf8 functions symfony/polyfill-intl-normalizer v1.27.0 v1.27.0 Symfony polyfill for intl's Normalizer class and related functions symfony/polyfill-mbstring v1.27.0 v1.27.0 Symfony polyfill for the Mbstring extension symfony/polyfill-php72 v1.27.0 v1.27.0 Symfony polyfill backporting some PHP 7.2+ features to lower PHP versions symfony/polyfill-php73 v1.27.0 v1.27.0 Symfony polyfill backporting some PHP 7.3+ features to lower PHP versions symfony/polyfill-php80 v1.27.0 v1.27.0 Symfony polyfill backporting some PHP 8.0+ features to lower PHP versions symfony/polyfill-php81 v1.27.0 v1.27.0 Symfony polyfill backporting some PHP 8.1+ features to lower PHP versions symfony/process v5.4.11 v6.1.3 Executes commands in sub-processes symfony/property-access v5.4.15 v6.1.7 Provides functions to read and write from/to an object or array using a simple string notation symfony/property-info v5.4.15 v6.1.7 Extracts information about PHP class' properties using metadata of popular sources symfony/routing v5.4.15 v6.1.7 Maps an HTTP request to a set of configuration variables symfony/security-acl v3.3.2 v3.3.2 Symfony Security Component - ACL (Access Control List) symfony/security-bundle v5.4.11 v6.1.3 Provides a tight integration of the Security component into the Symfony full-stack framework symfony/security-core v5.4.15 v6.1.7 Symfony Security Component - Core Library symfony/security-csrf v5.4.11 v6.1.0 Symfony Security Component - CSRF Library symfony/security-guard v5.4.13 v5.4.13 Symfony Security Component - Guard symfony/security-http v5.4.15 v6.1.7 Symfony Security Component - HTTP Integration symfony/serializer v5.4.15 v6.1.6 Handles serializing and deserializing data structures, including object graphs, into array structures or other formats like XML and JSON. symfony/service-contracts v2.5.2 v3.1.1 Generic abstractions related to writing services symfony/stopwatch v5.4.13 v6.1.5 Provides a way to profile code symfony/string v5.4.15 v6.1.7 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.4.14 v6.1.6 Provides tools to internationalize your application symfony/translation-contracts v2.5.2 v3.1.1 Generic abstractions related to translation symfony/twig-bridge v5.4.14 v6.1.7 Provides integration for Twig with various Symfony components symfony/twig-bundle v5.4.8 v6.1.1 Provides a tight integration of Twig into the Symfony full-stack framework symfony/validator v5.4.15 v6.1.7 Provides tools to validate values symfony/var-dumper v5.4.14 v6.1.6 Provides mechanisms for walking through any arbitrary PHP variable symfony/var-exporter v5.4.10 v6.1.3 Allows exporting any serializable PHP data structure to plain PHP code symfony/web-link v5.4.3 v6.1.0 Manages links between resources symfony/web-profiler-bundle v5.4.14 v6.1.6 Provides a development tool that gives detailed information about the execution of any request symfony/webpack-encore-bundle v1.16.0 v1.16.0 Integration with your Symfony app & Webpack Encore! symfony/workflow v5.4.11 v6.1.3 Provides tools for managing a workflow or finite state machine symfony/yaml v5.4.14 v6.1.6 Loads and dumps YAML files ```

PHP version

$ php -v
# Put the result here.
PHP 8.1.6 (cli) (built: May 17 2022 16:48:41) (NTS)
Copyright (c) The PHP Group
Zend Engine v4.1.6, Copyright (c) Zend Technologies
    with Zend OPcache v8.1.6, Copyright (c), by Zend Technologies
    with Xdebug v3.1.2, Copyright (c) 2002-2021, by Derick Rethans

Subject

We upgrade our sonata v3 (symfony 3) project to sonata v4 and symfony 5 and now all batch actions are broken across our entire application. Result

Minimal repository with the bug

Steps to reproduce

We have an EvacuationAdmin.php

    protected function configureBatchActions(array $actions): array
    {
        // note: removed an if around this for simplification (hasRoute & isGranted)
        $actions['send_batch_sms'] = [
            'label'            => 'action.send_evacuation_sms',
            'ask_confirmation' => true,
            // Initially we had no "controller" parameter, but we already tried everything here
            //'controller' => SendEvacuationSmsController::class . '::batchSendEvacuationSmsAction',
        ];

        return $actions;
    }

We have a controller 


    App\Infrastructure\Controller\Admin\BaseController:
        parent: 'sonata.admin.controller.crud'
        class: App\Infrastructure\Controller\Admin\BaseController
        calls:
            - ['setContainer', ['@service_container']]
            - ['setRestrictionUtility', ['@app.utility.restriction']]
        tags: ['controller.service_arguments', 'container.service_subscriber']
        public: true
    App\Infrastructure\Controller\Admin\EvacuationController:
        parent: App\Infrastructure\Controller\Admin\BaseController
        class: App\Infrastructure\Controller\Admin\EvacuationController
        arguments:
            - '@app.sms.sms_box_api'
            - '@app.repository.sms_template'
            - '@app.services.template_parser'
            - '@app.smser.sms_helper'
        calls:
            - ['setContainer', ['@service_container']]
            - ['setRestrictionUtility', ['@app.utility.restriction']]
        tags: ['controller.service_arguments', 'container.service_subscriber']
        public: true

Expected results

Actual results

In the \Sonata\AdminBundle\Controller\CRUDController::getBatchActionExecutable method, on the following line

        // This will throw an exception when called so we know if it's possible or not to call the controller.
        $exists = false !== $this->container
            ->get('controller_resolver')
            ->getController(new Request([], [], ['_controller' => $controller]));

An exception is being thrown because of the following error:

The "controller_resolver" service or alias has been removed or inlined when the container was compiled. You should either make it public, or stop using the container directly and use dependency injection instead.

Entire stack trace

[2/2] RuntimeException
RuntimeException:
A `App\Infrastructure\Controller\Admin\EvacuationController::batchActionSendBatchSms` method must be callable or create a `controller` configuration for your batch action.

  at vendor/sonata-project/admin-bundle/src/Controller/CRUDController.php:454
  at Sonata\AdminBundle\Controller\CRUDController->batchAction()
     (vendor/symfony/http-kernel/HttpKernel.php:163)
  at Symfony\Component\HttpKernel\HttpKernel->handleRaw()
     (vendor/symfony/http-kernel/HttpKernel.php:75)
  at Symfony\Component\HttpKernel\HttpKernel->handle()
     (vendor/symfony/http-kernel/Kernel.php:202)
  at Symfony\Component\HttpKernel\Kernel->handle()
     (public/index.php:25)                

[1/2] ServiceNotFoundException
Symfony\Component\DependencyInjection\Exception\ServiceNotFoundException:
The "controller_resolver" service or alias has been removed or inlined when the container was compiled. You should either make it public, or stop using the container directly and use dependency injection instead.

  at vendor/symfony/dependency-injection/Container.php:257
  at Symfony\Component\DependencyInjection\Container->make()
     (vendor/symfony/dependency-injection/Container.php:219)
  at Symfony\Component\DependencyInjection\Container->get()
     (vendor/sonata-project/admin-bundle/src/Controller/CRUDController.php:1500)
  at Sonata\AdminBundle\Controller\CRUDController->getBatchActionExecutable()
     (vendor/sonata-project/admin-bundle/src/Controller/CRUDController.php:451)
  at Sonata\AdminBundle\Controller\CRUDController->batchAction()
     (vendor/symfony/http-kernel/HttpKernel.php:163)
  at Symfony\Component\HttpKernel\HttpKernel->handleRaw()
     (vendor/symfony/http-kernel/HttpKernel.php:75)
  at Symfony\Component\HttpKernel\HttpKernel->handle()
     (vendor/symfony/http-kernel/Kernel.php:202)
  at Symfony\Component\HttpKernel\Kernel->handle()
     (public/index.php:25)
jeroendesloovere commented 1 year ago

We just tested the SonataAdminBundle default batchActionDelete and it seems to be a core sonata error. Because the default "delete" batch action which is in the SonataAdminBundle, seems to also break (we are not getting in that method) Error

A `Gatehouse\Infrastructure\Controller\Admin\RegistrationController::batchActionDelete` method must be callable or create a `controller` configuration for your batch action.

Logic of that \Sonata\AdminBundle\Controller\CRUDController::batchActionDelete method:


    /**
     * NEXT_MAJOR: Change signature to `(ProxyQueryInterface $query, Request $request).
     *
     * Execute a batch delete.
     *
     * @throws AccessDeniedException If access is not granted
     *
     * @phpstan-param ProxyQueryInterface<T> $query
     */
    public function batchActionDelete(ProxyQueryInterface $query): Response
    {
        $this->admin->checkAccess('batchDelete');

        $modelManager = $this->admin->getModelManager();

        try {
            $modelManager->batchDelete($this->admin->getClass(), $query);
            $this->addFlash(
                'sonata_flash_success',
                $this->trans('flash_batch_delete_success', [], 'SonataAdminBundle')
            );
        } catch (ModelManagerException $e) {
            // NEXT_MAJOR: Remove this catch.
            $this->handleModelManagerException($e);

            $this->addFlash(
                'sonata_flash_error',
                $this->trans('flash_batch_delete_error', [], 'SonataAdminBundle')
            );
        } catch (ModelManagerThrowable $e) {
            $errorMessage = $this->handleModelManagerThrowable($e);

            $this->addFlash(
                'sonata_flash_error',
                $errorMessage ?? $this->trans('flash_batch_delete_error', [], 'SonataAdminBundle')
            );
        }

        return $this->redirectToList();
    }
VincentLanglet commented 1 year ago

I would say there is more chance it's something wrong in your service configuration because it's been one year Sonata 4 is released and nothing was reported on batch actions. And I know people using them.

jeroendesloovere commented 1 year ago

Our development team still believes this is a Sonata bug.

Since Symfony 5, services are private by default. It seems like Sonata is a little behind on best practices, because, instead of injecting the necessary services, you guys are still using $container->get('controller_resolver') in CRUDController.php: getBatchActionExecutable (such way is not a good practice anymore)

The code will always throw an exception, because "controller_resolver" is private. So you can not access it using $container->get('controller_resolver');

The following code is where it all goes wrong. 'controller_resolver' is private, since symfony 5. So this call will always throw exception.

// CRUDController.php: getBatchActionExecutable
        // This will throw an exception when called so we know if it's possible or not to call the controller.
        $exists = false !== $this->container
            ->get('controller_resolver')
            ->getController(new Request([], [], ['_controller' => $controller]));

        if (!$exists) {
            throw new \RuntimeException(sprintf('Controller for action `%s` cannot be resolved', $action));
        }

Which the following method will try/catch

// CRUDController.php: batchAction
try {
    $batchActionExecutable = $this->getBatchActionExecutable($action);
} catch (\Throwable $error) {
    $finalAction = sprintf('batchAction%s', $camelizedAction);
    throw new \RuntimeException(sprintf('A `%s::%s` method must be callable or create a `controller` configuration for your batch action.', $this->admin->getBaseControllerName(), $finalAction), 0, $error);
}

If you execute the following you will see this.

php bin/console debug:container controller_resolver --show-arguments
 // This service is a private alias for the service debug.controller_resolver                                           

Information for Service "debug.controller_resolver"
===================================================

 ---------------- --------------------------------------------------------------------- 
  Option           Value                                                                
 ---------------- --------------------------------------------------------------------- 
  Service ID       debug.controller_resolver                                            
  Class            Symfony\Component\HttpKernel\Controller\TraceableControllerResolver  
  Tags             monolog.logger (channel: request)                                    
  Public           no                                                                   
  Synthetic        no                                                                   
  Lazy             no                                                                   
  Shared           yes                                                                  
  Abstract         no                                                                   
  Autowired        no                                                                   
  Autoconfigured   no                                                                   
  Arguments        Service(debug.controller_resolver.inner)                             
                   Service(debug.stopwatch)

Any suggestions on how to fix it?

VincentLanglet commented 1 year ago

Since Symfony 5, services are private by default. It seems like Sonata is a little behind on best practices, because, instead of injecting the necessary services, you guys are still using $container->get('controller_resolver') in CRUDController.php: getBatchActionExecutable (such way is not a good practice anymore)

Please take a look at https://symfony.com/doc/current/service_container/service_subscribers_locators.html

And https://github.com/symfony/symfony/blob/6.2/src/Symfony/Bundle/FrameworkBundle/Controller/AbstractController.php#L85

The code will always throw an exception, because "controller_resolver" is private. So you can not access it using $container->get('controller_resolver');

If it "always" throw an exception, I wonder why it works fine on my two work projects using Symfony 6 and Sonata 4.

Any suggestions on how to fix it?

Maybe something similar to https://github.com/sonata-project/SonataAdminBundle/issues/7813 According to https://github.com/sonata-project/SonataAdminBundle/issues/7813#issuecomment-1312697419 it's because you added a call ['setContainer', ['@service_container']] in your controller config.

jeroendesloovere commented 1 year ago

Thank you very much for you last answer, that was part of a fix.

VincentLanglet commented 1 year ago

And we needed to add tags: ['controller.service_arguments', 'container.service_subscriber'] to every controller

I never needed to do this, I would say it's because I use autowire and autoconfigure. Am I wrong or you don't (and that's why you have to declare the services in your yaml).

All the doc rely on the fact the Controller is autoconfigure/autowire. Might be worth to add some information about the needed tag.