Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Appearance settings

Commit bcedbc6

Browse filesBrowse files
ycerutoyceruto
committed
Add CallableWrapper component and framework integration
1 parent aa23093 commit bcedbc6
Copy full SHA for bcedbc6

40 files changed

+1245
-0
lines changed

‎composer.json

Copy file name to clipboardExpand all lines: composer.json
+1Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,7 @@
6666
"symfony/config": "self.version",
6767
"symfony/console": "self.version",
6868
"symfony/css-selector": "self.version",
69+
"symfony/callable-wrapper": "self.version",
6970
"symfony/dependency-injection": "self.version",
7071
"symfony/debug-bundle": "self.version",
7172
"symfony/doctrine-bridge": "self.version",

‎src/Symfony/Bridge/Doctrine/CHANGELOG.md

Copy file name to clipboardExpand all lines: src/Symfony/Bridge/Doctrine/CHANGELOG.md
+1Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ CHANGELOG
55
---
66

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

910
7.1
1011
---

‎src/Symfony/Bridge/Doctrine/CallableWrapper/Transactional.php

Copy file name to clipboard
+31Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
<?php
2+
3+
/*
4+
* This file is part of the Symfony package.
5+
*
6+
* (c) Fabien Potencier <fabien@symfony.com>
7+
*
8+
* For the full copyright and license information, please view the LICENSE
9+
* file that was distributed with this source code.
10+
*/
11+
12+
namespace Symfony\Bridge\Doctrine\CallableWrapper;
13+
14+
use Symfony\Component\CallableWrapper\Attribute\CallableWrapperAttribute;
15+
16+
/**
17+
* Wraps persistence method operations within a single Doctrine transaction.
18+
*
19+
* @author Yonel Ceruto <open@yceruto.dev>
20+
*/
21+
#[\Attribute(\Attribute::TARGET_METHOD)]
22+
class Transactional extends CallableWrapperAttribute
23+
{
24+
/**
25+
* @param string|null $name The entity manager name (null for the default one)
26+
*/
27+
public function __construct(
28+
public ?string $name = null,
29+
) {
30+
}
31+
}

‎src/Symfony/Bridge/Doctrine/CallableWrapper/TransactionalCallableWrapper.php

Copy file name to clipboard
+54Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
<?php
2+
3+
/*
4+
* This file is part of the Symfony package.
5+
*
6+
* (c) Fabien Potencier <fabien@symfony.com>
7+
*
8+
* For the full copyright and license information, please view the LICENSE
9+
* file that was distributed with this source code.
10+
*/
11+
12+
namespace Symfony\Bridge\Doctrine\CallableWrapper;
13+
14+
use Doctrine\ORM\EntityManagerInterface;
15+
use Doctrine\Persistence\ManagerRegistry;
16+
use Symfony\Component\CallableWrapper\CallableWrapperInterface;
17+
18+
/**
19+
* @author Yonel Ceruto <open@yceruto.dev>
20+
*/
21+
class TransactionalCallableWrapper implements CallableWrapperInterface
22+
{
23+
public function __construct(
24+
private readonly ManagerRegistry $managerRegistry,
25+
) {
26+
}
27+
28+
public function wrap(\Closure $func, Transactional $transactional = new Transactional()): \Closure
29+
{
30+
$entityManager = $this->managerRegistry->getManager($transactional->name);
31+
32+
if (!$entityManager instanceof EntityManagerInterface) {
33+
throw new \RuntimeException(\sprintf('The manager "%s" is not an entity manager.', $transactional->name));
34+
}
35+
36+
return static function (mixed ...$args) use ($func, $entityManager) {
37+
$entityManager->getConnection()->beginTransaction();
38+
39+
try {
40+
$return = $func(...$args);
41+
42+
$entityManager->flush();
43+
$entityManager->getConnection()->commit();
44+
45+
return $return;
46+
} catch (\Throwable $e) {
47+
$entityManager->close();
48+
$entityManager->getConnection()->rollBack();
49+
50+
throw $e;
51+
}
52+
};
53+
}
54+
}

‎src/Symfony/Bridge/Doctrine/Tests/CallableWrapper/TransactionalCallableWrapperTest.php

Copy file name to clipboard
+103Lines changed: 103 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,103 @@
1+
<?php
2+
3+
/*
4+
* This file is part of the Symfony package.
5+
*
6+
* (c) Fabien Potencier <fabien@symfony.com>
7+
*
8+
* For the full copyright and license information, please view the LICENSE
9+
* file that was distributed with this source code.
10+
*/
11+
12+
namespace Symfony\Bridge\Doctrine\Tests\CallableWrapper;
13+
14+
use Doctrine\DBAL\Connection;
15+
use Doctrine\ORM\EntityManagerInterface;
16+
use Doctrine\Persistence\ManagerRegistry;
17+
use PHPUnit\Framework\TestCase;
18+
use Symfony\Bridge\Doctrine\CallableWrapper\Transactional;
19+
use Symfony\Bridge\Doctrine\CallableWrapper\TransactionalCallableWrapper;
20+
use Symfony\Component\CallableWrapper\CallableWrapper;
21+
use Symfony\Component\CallableWrapper\Resolver\CallableWrapperResolver;
22+
23+
class TransactionalCallableWrapperTest extends TestCase
24+
{
25+
private ManagerRegistry $managerRegistry;
26+
private Connection $connection;
27+
private EntityManagerInterface $entityManager;
28+
private CallableWrapper $wrapper;
29+
30+
protected function setUp(): void
31+
{
32+
$this->connection = $this->createMock(Connection::class);
33+
34+
$this->entityManager = $this->createMock(EntityManagerInterface::class);
35+
$this->entityManager->method('getConnection')->willReturn($this->connection);
36+
37+
$this->managerRegistry = $this->createMock(ManagerRegistry::class);
38+
$this->managerRegistry->method('getManager')->willReturn($this->entityManager);
39+
40+
$this->wrapper = new CallableWrapper(new CallableWrapperResolver([
41+
TransactionalCallableWrapper::class => fn () => new TransactionalCallableWrapper($this->managerRegistry),
42+
]));
43+
}
44+
45+
public function testWrapInTransactionAndFlushes()
46+
{
47+
$handler = new TestHandler();
48+
49+
$this->connection->expects($this->once())->method('beginTransaction');
50+
$this->connection->expects($this->once())->method('commit');
51+
$this->entityManager->expects($this->once())->method('flush');
52+
53+
$result = $this->wrapper->call($handler->handle(...));
54+
$this->assertSame('success', $result);
55+
}
56+
57+
public function testTransactionIsRolledBackOnException()
58+
{
59+
$this->connection->expects($this->once())->method('beginTransaction');
60+
$this->connection->expects($this->once())->method('rollBack');
61+
62+
$handler = new TestHandler();
63+
64+
$this->expectException(\RuntimeException::class);
65+
$this->expectExceptionMessage('A runtime error.');
66+
67+
$this->wrapper->call($handler->handleWithError(...));
68+
}
69+
70+
public function testInvalidEntityManagerThrowsException()
71+
{
72+
$this->managerRegistry
73+
->method('getManager')
74+
->with('unknown_manager')
75+
->willThrowException(new \InvalidArgumentException());
76+
77+
$handler = new TestHandler();
78+
79+
$this->expectException(\InvalidArgumentException::class);
80+
81+
$this->wrapper->call($handler->handleWithUnknownManager(...));
82+
}
83+
}
84+
85+
class TestHandler
86+
{
87+
#[Transactional]
88+
public function handle(): string
89+
{
90+
return 'success';
91+
}
92+
93+
#[Transactional]
94+
public function handleWithError(): void
95+
{
96+
throw new \RuntimeException('A runtime error.');
97+
}
98+
99+
#[Transactional('unknown_manager')]
100+
public function handleWithUnknownManager(): void
101+
{
102+
}
103+
}

‎src/Symfony/Bridge/Doctrine/composer.json

Copy file name to clipboardExpand all lines: src/Symfony/Bridge/Doctrine/composer.json
+1Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@
2727
"require-dev": {
2828
"symfony/cache": "^6.4|^7.0",
2929
"symfony/config": "^6.4|^7.0",
30+
"symfony/callable-wrapper": "^7.3",
3031
"symfony/dependency-injection": "^6.4|^7.0",
3132
"symfony/doctrine-messenger": "^6.4|^7.0",
3233
"symfony/expression-language": "^6.4|^7.0",

‎src/Symfony/Bundle/FrameworkBundle/CHANGELOG.md

Copy file name to clipboardExpand all lines: src/Symfony/Bundle/FrameworkBundle/CHANGELOG.md
+1Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ CHANGELOG
77
* Add support for assets pre-compression
88
* Rename `TranslationUpdateCommand` to `TranslationExtractCommand`
99
* Add JsonEncoder services and configuration
10+
* Add CallableWrapper services and support
1011

1112
7.2
1213
---

‎src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php

Copy file name to clipboardExpand all lines: src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php
+7Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,7 @@
4141
use Symfony\Component\Cache\DependencyInjection\CachePoolPass;
4242
use Symfony\Component\Cache\Marshaller\MarshallerInterface;
4343
use Symfony\Component\Cache\ResettableInterface;
44+
use Symfony\Component\CallableWrapper\CallableWrapperInterface;
4445
use Symfony\Component\Clock\ClockInterface;
4546
use Symfony\Component\Config\Definition\ConfigurationInterface;
4647
use Symfony\Component\Config\FileLocator;
@@ -235,6 +236,10 @@ public function load(array $configs, ContainerBuilder $container): void
235236
$loader->load('fragment_renderer.php');
236237
$loader->load('error_renderer.php');
237238

239+
if (ContainerBuilder::willBeAvailable('symfony/callable-wrapper', CallableWrapperInterface::class, ['symfony/framework-bundle'])) {
240+
$loader->load('callable_wrapper.php');
241+
}
242+
238243
if (!ContainerBuilder::willBeAvailable('symfony/clock', ClockInterface::class, ['symfony/framework-bundle'])) {
239244
$container->removeDefinition('clock');
240245
$container->removeAlias(ClockInterface::class);
@@ -683,6 +688,8 @@ public function load(array $configs, ContainerBuilder $container): void
683688
->addTag('mime.mime_type_guesser');
684689
$container->registerForAutoconfiguration(LoggerAwareInterface::class)
685690
->addMethodCall('setLogger', [new Reference('logger')]);
691+
$container->registerForAutoconfiguration(CallableWrapperInterface::class)
692+
->addTag('callable_wrapper');
686693

687694
$container->registerAttributeForAutoconfiguration(AsEventListener::class, static function (ChildDefinition $definition, AsEventListener $attribute, \ReflectionClass|\ReflectionMethod $reflector) {
688695
$tagAttributes = get_object_vars($attribute);

‎src/Symfony/Bundle/FrameworkBundle/EventListener/WrapControllerListener.php

Copy file name to clipboard
+40Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
<?php
2+
3+
/*
4+
* This file is part of the Symfony package.
5+
*
6+
* (c) Fabien Potencier <fabien@symfony.com>
7+
*
8+
* For the full copyright and license information, please view the LICENSE
9+
* file that was distributed with this source code.
10+
*/
11+
12+
namespace Symfony\Bundle\FrameworkBundle\EventListener;
13+
14+
use Symfony\Component\CallableWrapper\CallableWrapperInterface;
15+
use Symfony\Component\EventDispatcher\EventSubscriberInterface;
16+
use Symfony\Component\HttpKernel\Event\ControllerArgumentsEvent;
17+
use Symfony\Component\HttpKernel\KernelEvents;
18+
19+
/**
20+
* @author Yonel Ceruto <open@yceruto.dev>
21+
*/
22+
class WrapControllerListener implements EventSubscriberInterface
23+
{
24+
public function __construct(
25+
private readonly CallableWrapperInterface $wrapper,
26+
) {
27+
}
28+
29+
public function decorate(ControllerArgumentsEvent $event): void
30+
{
31+
$event->setController($this->wrapper->wrap($event->getController()(...)));
32+
}
33+
34+
public static function getSubscribedEvents(): array
35+
{
36+
return [
37+
KernelEvents::CONTROLLER_ARGUMENTS => ['decorate', -1024],
38+
];
39+
}
40+
}

‎src/Symfony/Bundle/FrameworkBundle/FrameworkBundle.php

Copy file name to clipboardExpand all lines: src/Symfony/Bundle/FrameworkBundle/FrameworkBundle.php
+2Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@
3030
use Symfony\Component\Cache\DependencyInjection\CachePoolClearerPass;
3131
use Symfony\Component\Cache\DependencyInjection\CachePoolPass;
3232
use Symfony\Component\Cache\DependencyInjection\CachePoolPrunerPass;
33+
use Symfony\Component\CallableWrapper\DependencyInjection\CallableWrappersPass;
3334
use Symfony\Component\Config\Resource\ClassExistenceResource;
3435
use Symfony\Component\Console\ConsoleEvents;
3536
use Symfony\Component\Console\DependencyInjection\AddConsoleCommandPass;
@@ -181,6 +182,7 @@ public function build(ContainerBuilder $container): void
181182
// must be registered after MonologBundle's LoggerChannelPass
182183
$container->addCompilerPass(new ErrorLoggerCompilerPass(), PassConfig::TYPE_BEFORE_OPTIMIZATION, -32);
183184
$container->addCompilerPass(new VirtualRequestStackPass());
185+
$this->addCompilerPassIfExists($container, CallableWrappersPass::class);
184186

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

‎src/Symfony/Bundle/FrameworkBundle/Resources/config/callable_wrapper.php

Copy file name to clipboard
+34Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
<?php
2+
3+
/*
4+
* This file is part of the Symfony package.
5+
*
6+
* (c) Fabien Potencier <fabien@symfony.com>
7+
*
8+
* For the full copyright and license information, please view the LICENSE
9+
* file that was distributed with this source code.
10+
*/
11+
12+
namespace Symfony\Component\DependencyInjection\Loader\Configurator;
13+
14+
use Symfony\Bundle\FrameworkBundle\EventListener\WrapControllerListener;
15+
use Symfony\Component\CallableWrapper\CallableWrapper;
16+
use Symfony\Component\CallableWrapper\CallableWrapperInterface;
17+
use Symfony\Component\CallableWrapper\Resolver\CallableWrapperResolverInterface;
18+
19+
return static function (ContainerConfigurator $container) {
20+
$container->services()
21+
->set('callable_wrapper', CallableWrapper::class)
22+
->args([
23+
service(CallableWrapperResolverInterface::class),
24+
])
25+
26+
->alias(CallableWrapperInterface::class, 'callable_wrapper')
27+
28+
->set('callable_wrapper.wrap_controller.listener', WrapControllerListener::class)
29+
->args([
30+
service('callable_wrapper'),
31+
])
32+
->tag('kernel.event_subscriber')
33+
;
34+
};

‎src/Symfony/Bundle/FrameworkBundle/Resources/config/messenger.php

Copy file name to clipboardExpand all lines: src/Symfony/Bundle/FrameworkBundle/Resources/config/messenger.php
+2Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -82,6 +82,8 @@
8282
->abstract()
8383
->args([
8484
abstract_arg('bus handler resolver'),
85+
false,
86+
service('callable_wrapper')->ignoreOnInvalid(),
8587
])
8688
->tag('monolog.logger', ['channel' => 'messenger'])
8789
->call('setLogger', [service('logger')->ignoreOnInvalid()])

‎src/Symfony/Bundle/FrameworkBundle/composer.json

Copy file name to clipboardExpand all lines: src/Symfony/Bundle/FrameworkBundle/composer.json
+1Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,7 @@
4242
"symfony/console": "^6.4|^7.0",
4343
"symfony/clock": "^6.4|^7.0",
4444
"symfony/css-selector": "^6.4|^7.0",
45+
"symfony/callable-wrapper": "^7.3",
4546
"symfony/dom-crawler": "^6.4|^7.0",
4647
"symfony/dotenv": "^6.4|^7.0",
4748
"symfony/polyfill-intl-icu": "~1.0",

‎src/Symfony/Component/CallableWrapper/.gitattributes

Copy file name to clipboard
+3Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
/Tests export-ignore
2+
/phpunit.xml.dist export-ignore
3+
/.git* export-ignore

‎src/Symfony/Component/CallableWrapper/.gitignore

Copy file name to clipboard
+3Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
vendor/
2+
composer.lock
3+
phpunit.xml

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.