add framework integration and controller decoration support

yceruto · yceruto · commit 4c04c38d92d6 · 2024-08-25T14:29:37.000-04:00
diff --git a/src/Symfony/Bundle/FrameworkBundle/CHANGELOG.md b/src/Symfony/Bundle/FrameworkBundle/CHANGELOG.md
@@ -12,6 +12,7 @@ CHANGELOG
  * Deprecate making `cache.app` adapter taggable, use the `cache.app.taggable` adapter instead
  * Enable `json_decode_detailed_errors` in the default serializer context in debug mode by default when `seld/jsonlint` is installed
  * Register `Symfony\Component\Serializer\NameConverter\SnakeCaseToCamelCaseNameConverter` as a service named `serializer.name_converter.snake_case_to_camel_case` if available
+ * Add Decorator component integration and controller decoration support
 
 7.1
 ---
diff --git a/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php b/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php
@@ -52,6 +52,7 @@
 use Symfony\Component\Console\DataCollector\CommandDataCollector;
 use Symfony\Component\Console\Debug\CliRequest;
 use Symfony\Component\Console\Messenger\RunCommandMessageHandler;
+use Symfony\Component\Decorator\DecoratorInterface;
 use Symfony\Component\DependencyInjection\Alias;
 use Symfony\Component\DependencyInjection\Argument\ServiceLocatorArgument;
 use Symfony\Component\DependencyInjection\ChildDefinition;
@@ -224,6 +225,10 @@ public function load(array $configs, ContainerBuilder $container): void
         $loader->load('fragment_renderer.php');
         $loader->load('error_renderer.php');
 
+        if (ContainerBuilder::willBeAvailable('symfony/decorator', DecoratorInterface::class, ['symfony/framework-bundle'])) {
+            $loader->load('decorator.php');
+        }
+
         if (!ContainerBuilder::willBeAvailable('symfony/clock', ClockInterface::class, ['symfony/framework-bundle'])) {
             $container->removeDefinition('clock');
             $container->removeAlias(ClockInterface::class);
@@ -658,6 +663,8 @@ public function load(array $configs, ContainerBuilder $container): void
             ->addTag('mime.mime_type_guesser');
         $container->registerForAutoconfiguration(LoggerAwareInterface::class)
             ->addMethodCall('setLogger', [new Reference('logger')]);
+        $container->registerForAutoconfiguration(DecoratorInterface::class)
+            ->addTag('decorator');
 
         $container->registerAttributeForAutoconfiguration(AsEventListener::class, static function (ChildDefinition $definition, AsEventListener $attribute, \ReflectionClass|\ReflectionMethod $reflector) {
             $tagAttributes = get_object_vars($attribute);
diff --git a/src/Symfony/Bundle/FrameworkBundle/EventListener/DecorateControllerListener.php b/src/Symfony/Bundle/FrameworkBundle/EventListener/DecorateControllerListener.php
@@ -0,0 +1,40 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Bundle\FrameworkBundle\EventListener;
+
+use Symfony\Component\Decorator\DecoratorInterface;
+use Symfony\Component\EventDispatcher\EventSubscriberInterface;
+use Symfony\Component\HttpKernel\Event\ControllerArgumentsEvent;
+use Symfony\Component\HttpKernel\KernelEvents;
+
+/**
+ * @author Yonel Ceruto <open@yceruto.dev>
+ */
+final readonly class DecorateControllerListener implements EventSubscriberInterface
+{
+    public function __construct(
+        private DecoratorInterface $decorator,
+    ) {
+    }
+
+    public function decorate(ControllerArgumentsEvent $event): void
+    {
+        $event->setController($this->decorator->decorate($event->getController()(...)));
+    }
+
+    public static function getSubscribedEvents(): array
+    {
+        return [
+            KernelEvents::CONTROLLER_ARGUMENTS => ['decorate', -1024],
+        ];
+    }
+}
diff --git a/src/Symfony/Bundle/FrameworkBundle/FrameworkBundle.php b/src/Symfony/Bundle/FrameworkBundle/FrameworkBundle.php
@@ -33,6 +33,7 @@
 use Symfony\Component\Config\Resource\ClassExistenceResource;
 use Symfony\Component\Console\ConsoleEvents;
 use Symfony\Component\Console\DependencyInjection\AddConsoleCommandPass;
+use Symfony\Component\Decorator\DependencyInjection\DecoratorsPass;
 use Symfony\Component\DependencyInjection\Compiler\PassConfig;
 use Symfony\Component\DependencyInjection\Compiler\RegisterReverseContainerPass;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
@@ -173,6 +174,7 @@ public function build(ContainerBuilder $container): void
         // must be registered after MonologBundle's LoggerChannelPass
         $container->addCompilerPass(new ErrorLoggerCompilerPass(), PassConfig::TYPE_BEFORE_OPTIMIZATION, -32);
         $container->addCompilerPass(new VirtualRequestStackPass());
+        $this->addCompilerPassIfExists($container, DecoratorsPass::class);
 
         if ($container->getParameter('kernel.debug')) {
             $container->addCompilerPass(new AddDebugLogProcessorPass(), PassConfig::TYPE_BEFORE_OPTIMIZATION, 2);
diff --git a/src/Symfony/Bundle/FrameworkBundle/Resources/config/decorator.php b/src/Symfony/Bundle/FrameworkBundle/Resources/config/decorator.php
@@ -0,0 +1,33 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\DependencyInjection\Loader\Configurator;
+
+use Symfony\Bundle\FrameworkBundle\EventListener\DecorateControllerListener;
+use Symfony\Component\Decorator\DecoratorChain;
+use Symfony\Component\Decorator\DecoratorInterface;
+
+return static function (ContainerConfigurator $container) {
+    $container->services()
+        ->set('decorator.chain', DecoratorChain::class)
+            ->args([
+                abstract_arg('decorators locator, set in DecoratorsPass')
+            ])
+
+        ->set('decorator.listener.controller', DecorateControllerListener::class)
+            ->args([
+                service('decorator.chain')
+            ])
+            ->tag('kernel.event_subscriber')
+
+        ->alias(DecoratorInterface::class, 'decorator.chain')
+    ;
+};
diff --git a/src/Symfony/Bundle/FrameworkBundle/composer.json b/src/Symfony/Bundle/FrameworkBundle/composer.json
@@ -42,6 +42,7 @@
         "symfony/console": "^6.4|^7.0",
         "symfony/clock": "^6.4|^7.0",
         "symfony/css-selector": "^6.4|^7.0",
+        "symfony/decorator": "^7.2",
         "symfony/dom-crawler": "^6.4|^7.0",
         "symfony/dotenv": "^6.4|^7.0",
         "symfony/polyfill-intl-icu": "~1.0",
diff --git a/src/Symfony/Component/Decorator/DecoratorChain.php b/src/Symfony/Component/Decorator/DecoratorChain.php
@@ -17,6 +17,8 @@
 
 /**
  * @author Yonel Ceruto <open@yceruto.dev>
+ *
+ * @experimental
  */
 readonly class DecoratorChain implements DecoratorInterface
 {

Original file line number	Diff line number	Diff line change
`@@ -17,6 +17,8 @@`
`17`	`17`
`18`	`18`	`/**`
`19`	`19`	`* @author Yonel Ceruto <open@yceruto.dev>`
	`20`	`+ *`
	`21`	`+ * @experimental`
`20`	`22`	`*/`
`21`	`23`	`readonly class DecoratorChain implements DecoratorInterface`
`22`	`24`	`{`