Add CallableWrapper component and framework integration

symfony · yceruto · Aug 23, 2024 · Dec 13, 2024 · bcedbc64ba5e561babbe648b9cf38a24b26e4b17
commit bcedbc64ba5e561babbe648b9cf38a24b26e4b17
diff --git a/composer.json b/composer.json
@@ -66,6 +66,7 @@
        "symfony/config": "self.version",
        "symfony/console": "self.version",
        "symfony/css-selector": "self.version",
+        "symfony/callable-wrapper": "self.version",
        "symfony/dependency-injection": "self.version",
        "symfony/debug-bundle": "self.version",
        "symfony/doctrine-bridge": "self.version",

diff --git a/src/Symfony/Bridge/Doctrine/CHANGELOG.md b/src/Symfony/Bridge/Doctrine/CHANGELOG.md
@@ -5,6 +5,7 @@ CHANGELOG
 ---

 * Accept `ReadableCollection` in `CollectionToArrayTransformer`
+ * Add `Transactional` attribute and `TransactionalCallableWrapper`

 7.1
 ---

diff --git a/src/Symfony/Bridge/Doctrine/CallableWrapper/Transactional.php b/src/Symfony/Bridge/Doctrine/CallableWrapper/Transactional.php
@@ -0,0 +1,31 @@
+<?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\Bridge\Doctrine\CallableWrapper;
+
+use Symfony\Component\CallableWrapper\Attribute\CallableWrapperAttribute;
+
+/**
+ * Wraps persistence method operations within a single Doctrine transaction.
+ *
+ * @author Yonel Ceruto <open@yceruto.dev>
+ */
+#[\Attribute(\Attribute::TARGET_METHOD)]
+class Transactional extends CallableWrapperAttribute
+{
+    /**
+     * @param string|null $name The entity manager name (null for the default one)
+     */
+    public function __construct(
+        public ?string $name = null,
+    ) {
+    }
+}
diff --git a/src/Symfony/Bridge/Doctrine/CallableWrapper/TransactionalCallableWrapper.php b/src/Symfony/Bridge/Doctrine/CallableWrapper/TransactionalCallableWrapper.php
@@ -0,0 +1,54 @@
+<?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\Bridge\Doctrine\CallableWrapper;
+
+use Doctrine\ORM\EntityManagerInterface;
+use Doctrine\Persistence\ManagerRegistry;
+use Symfony\Component\CallableWrapper\CallableWrapperInterface;
+
+/**
+ * @author Yonel Ceruto <open@yceruto.dev>
+ */
+class TransactionalCallableWrapper implements CallableWrapperInterface
+{
+    public function __construct(
+        private readonly ManagerRegistry $managerRegistry,
+    ) {
+    }
+
+    public function wrap(\Closure $func, Transactional $transactional = new Transactional()): \Closure
+    {
+        $entityManager = $this->managerRegistry->getManager($transactional->name);
+
+        if (!$entityManager instanceof EntityManagerInterface) {
+            throw new \RuntimeException(\sprintf('The manager "%s" is not an entity manager.', $transactional->name));
+        }
+
+        return static function (mixed ...$args) use ($func, $entityManager) {
+            $entityManager->getConnection()->beginTransaction();
+
+            try {
+                $return = $func(...$args);
+
+                $entityManager->flush();
+                $entityManager->getConnection()->commit();
+
+                return $return;
+            } catch (\Throwable $e) {
+                $entityManager->close();
+                $entityManager->getConnection()->rollBack();
+
+                throw $e;
+            }
+        };
+    }
+}
diff --git a/src/Symfony/Bridge/Doctrine/Tests/CallableWrapper/TransactionalCallableWrapperTest.php b/src/Symfony/Bridge/Doctrine/Tests/CallableWrapper/TransactionalCallableWrapperTest.php
@@ -0,0 +1,103 @@
+<?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\Bridge\Doctrine\Tests\CallableWrapper;
+
+use Doctrine\DBAL\Connection;
+use Doctrine\ORM\EntityManagerInterface;
+use Doctrine\Persistence\ManagerRegistry;
+use PHPUnit\Framework\TestCase;
+use Symfony\Bridge\Doctrine\CallableWrapper\Transactional;
+use Symfony\Bridge\Doctrine\CallableWrapper\TransactionalCallableWrapper;
+use Symfony\Component\CallableWrapper\CallableWrapper;
+use Symfony\Component\CallableWrapper\Resolver\CallableWrapperResolver;
+
+class TransactionalCallableWrapperTest extends TestCase
+{
+    private ManagerRegistry $managerRegistry;
+    private Connection $connection;
+    private EntityManagerInterface $entityManager;
+    private CallableWrapper $wrapper;
+
+    protected function setUp(): void
+    {
+        $this->connection = $this->createMock(Connection::class);
+
+        $this->entityManager = $this->createMock(EntityManagerInterface::class);
+        $this->entityManager->method('getConnection')->willReturn($this->connection);
+
+        $this->managerRegistry = $this->createMock(ManagerRegistry::class);
+        $this->managerRegistry->method('getManager')->willReturn($this->entityManager);
+
+        $this->wrapper = new CallableWrapper(new CallableWrapperResolver([
+            TransactionalCallableWrapper::class => fn () => new TransactionalCallableWrapper($this->managerRegistry),
+        ]));
+    }
+
+    public function testWrapInTransactionAndFlushes()
+    {
+        $handler = new TestHandler();
+
+        $this->connection->expects($this->once())->method('beginTransaction');
+        $this->connection->expects($this->once())->method('commit');
+        $this->entityManager->expects($this->once())->method('flush');
+
+        $result = $this->wrapper->call($handler->handle(...));
+        $this->assertSame('success', $result);
+    }
+
+    public function testTransactionIsRolledBackOnException()
+    {
+        $this->connection->expects($this->once())->method('beginTransaction');
+        $this->connection->expects($this->once())->method('rollBack');
+
+        $handler = new TestHandler();
+
+        $this->expectException(\RuntimeException::class);
+        $this->expectExceptionMessage('A runtime error.');
+
+        $this->wrapper->call($handler->handleWithError(...));
+    }
+
+    public function testInvalidEntityManagerThrowsException()
+    {
+        $this->managerRegistry
+            ->method('getManager')
+            ->with('unknown_manager')
+            ->willThrowException(new \InvalidArgumentException());
+
+        $handler = new TestHandler();
+
+        $this->expectException(\InvalidArgumentException::class);
+
+        $this->wrapper->call($handler->handleWithUnknownManager(...));
+    }
+}
+
+class TestHandler
+{
+    #[Transactional]
+    public function handle(): string
+    {
+        return 'success';
+    }
+
+    #[Transactional]
+    public function handleWithError(): void
+    {
+        throw new \RuntimeException('A runtime error.');
+    }
+
+    #[Transactional('unknown_manager')]
+    public function handleWithUnknownManager(): void
+    {
+    }
+}
diff --git a/src/Symfony/Bridge/Doctrine/composer.json b/src/Symfony/Bridge/Doctrine/composer.json
@@ -27,6 +27,7 @@
    "require-dev": {
        "symfony/cache": "^6.4|^7.0",
        "symfony/config": "^6.4|^7.0",
+        "symfony/callable-wrapper": "^7.3",
        "symfony/dependency-injection": "^6.4|^7.0",
        "symfony/doctrine-messenger": "^6.4|^7.0",
        "symfony/expression-language": "^6.4|^7.0",

diff --git a/src/Symfony/Bundle/FrameworkBundle/CHANGELOG.md b/src/Symfony/Bundle/FrameworkBundle/CHANGELOG.md
@@ -7,6 +7,7 @@ CHANGELOG
 * Add support for assets pre-compression
 * Rename `TranslationUpdateCommand` to `TranslationExtractCommand`
 * Add JsonEncoder services and configuration
+ * Add CallableWrapper services and support

 7.2
 ---

diff --git a/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php b/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php
@@ -41,6 +41,7 @@
 use Symfony\Component\Cache\DependencyInjection\CachePoolPass;
 use Symfony\Component\Cache\Marshaller\MarshallerInterface;
 use Symfony\Component\Cache\ResettableInterface;
+use Symfony\Component\CallableWrapper\CallableWrapperInterface;
 use Symfony\Component\Clock\ClockInterface;
 use Symfony\Component\Config\Definition\ConfigurationInterface;
 use Symfony\Component\Config\FileLocator;
@@ -235,6 +236,10 @@ public function load(array $configs, ContainerBuilder $container): void
        $loader->load('fragment_renderer.php');
        $loader->load('error_renderer.php');

+        if (ContainerBuilder::willBeAvailable('symfony/callable-wrapper', CallableWrapperInterface::class, ['symfony/framework-bundle'])) {
+            $loader->load('callable_wrapper.php');
+        }
+
        if (!ContainerBuilder::willBeAvailable('symfony/clock', ClockInterface::class, ['symfony/framework-bundle'])) {
            $container->removeDefinition('clock');
            $container->removeAlias(ClockInterface::class);
@@ -683,6 +688,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(CallableWrapperInterface::class)
+            ->addTag('callable_wrapper');

        $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/WrapControllerListener.php b/src/Symfony/Bundle/FrameworkBundle/EventListener/WrapControllerListener.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\CallableWrapper\CallableWrapperInterface;
+use Symfony\Component\EventDispatcher\EventSubscriberInterface;
+use Symfony\Component\HttpKernel\Event\ControllerArgumentsEvent;
+use Symfony\Component\HttpKernel\KernelEvents;
+
+/**
+ * @author Yonel Ceruto <open@yceruto.dev>
+ */
+class WrapControllerListener implements EventSubscriberInterface
+{
+    public function __construct(
+        private readonly CallableWrapperInterface $wrapper,
+    ) {
+    }
+
+    public function decorate(ControllerArgumentsEvent $event): void
+    {
+        $event->setController($this->wrapper->wrap($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
@@ -30,6 +30,7 @@
 use Symfony\Component\Cache\DependencyInjection\CachePoolClearerPass;
 use Symfony\Component\Cache\DependencyInjection\CachePoolPass;
 use Symfony\Component\Cache\DependencyInjection\CachePoolPrunerPass;
+use Symfony\Component\CallableWrapper\DependencyInjection\CallableWrappersPass;
 use Symfony\Component\Config\Resource\ClassExistenceResource;
 use Symfony\Component\Console\ConsoleEvents;
 use Symfony\Component\Console\DependencyInjection\AddConsoleCommandPass;
@@ -181,6 +182,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, CallableWrappersPass::class);

        if ($container->getParameter('kernel.debug')) {
            $container->addCompilerPass(new AddDebugLogProcessorPass(), PassConfig::TYPE_BEFORE_OPTIMIZATION, 2);

diff --git a/src/Symfony/Bundle/FrameworkBundle/Resources/config/callable_wrapper.php b/src/Symfony/Bundle/FrameworkBundle/Resources/config/callable_wrapper.php
@@ -0,0 +1,34 @@
+<?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\WrapControllerListener;
+use Symfony\Component\CallableWrapper\CallableWrapper;
+use Symfony\Component\CallableWrapper\CallableWrapperInterface;
+use Symfony\Component\CallableWrapper\Resolver\CallableWrapperResolverInterface;
+
+return static function (ContainerConfigurator $container) {
+    $container->services()
+        ->set('callable_wrapper', CallableWrapper::class)
+            ->args([
+                service(CallableWrapperResolverInterface::class),
+            ])
+
+        ->alias(CallableWrapperInterface::class, 'callable_wrapper')
+
+        ->set('callable_wrapper.wrap_controller.listener', WrapControllerListener::class)
+            ->args([
+                service('callable_wrapper'),
+            ])
+            ->tag('kernel.event_subscriber')
+    ;
+};
diff --git a/src/Symfony/Bundle/FrameworkBundle/Resources/config/messenger.php b/src/Symfony/Bundle/FrameworkBundle/Resources/config/messenger.php
@@ -82,6 +82,8 @@
            ->abstract()
            ->args([
                abstract_arg('bus handler resolver'),
+                false,
+                service('callable_wrapper')->ignoreOnInvalid(),
            ])
            ->tag('monolog.logger', ['channel' => 'messenger'])
            ->call('setLogger', [service('logger')->ignoreOnInvalid()])

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/callable-wrapper": "^7.3",
        "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/CallableWrapper/.gitattributes b/src/Symfony/Component/CallableWrapper/.gitattributes
@@ -0,0 +1,3 @@
+/Tests export-ignore
+/phpunit.xml.dist export-ignore
+/.git* export-ignore
diff --git a/src/Symfony/Component/CallableWrapper/.gitignore b/src/Symfony/Component/CallableWrapper/.gitignore
@@ -0,0 +1,3 @@
+vendor/
+composer.lock
+phpunit.xml