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

[FrameworkBundle] the DeduplicateMiddleware requires the lock feature to be enabled #59735

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Feb 10, 2025
+138 −50
Merged

[FrameworkBundle] the DeduplicateMiddleware requires the lock feature to be enabled #59735

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions 6 src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -538,7 +538,7 @@ public function load(array $configs, ContainerBuilder $container): void

// messenger depends on validation being registered
if ($messengerEnabled) {
$this->registerMessengerConfiguration($config['messenger'], $container, $loader, $this->readConfigEnabled('validation', $container, $config['validation']));
$this->registerMessengerConfiguration($config['messenger'], $container, $loader, $this->readConfigEnabled('validation', $container, $config['validation']), $this->readConfigEnabled('lock', $container, $config['lock']));
} else {
$container->removeDefinition('console.command.messenger_consume_messages');
$container->removeDefinition('console.command.messenger_stats');
Expand Down Expand Up @@ -2228,7 +2228,7 @@ private function registerSchedulerConfiguration(ContainerBuilder $container, Php
}
}

private function registerMessengerConfiguration(array $config, ContainerBuilder $container, PhpFileLoader $loader, bool $validationEnabled): void
private function registerMessengerConfiguration(array $config, ContainerBuilder $container, PhpFileLoader $loader, bool $validationEnabled, bool $lockEnabled): void
{
if (!interface_exists(MessageBusInterface::class)) {
throw new LogicException('Messenger support cannot be enabled as the Messenger component is not installed. Try running "composer require symfony/messenger".');
Expand Down Expand Up @@ -2284,7 +2284,7 @@ private function registerMessengerConfiguration(array $config, ContainerBuilder
],
];

if (class_exists(DeduplicateMiddleware::class) && class_exists(LockFactory::class)) {
if ($lockEnabled && class_exists(DeduplicateMiddleware::class) && class_exists(LockFactory::class)) {
$defaultMiddleware['before'][] = ['id' => 'deduplicate_middleware'];
} else {
$container->removeDefinition('messenger.middleware.deduplicate_middleware');
Expand Down
27 changes: 27 additions & 0 deletions 27 ...DependencyInjection/Fixtures/php/messenger_multiple_buses_with_deduplicate_middleware.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
<?php

$container->loadFromExtension('framework', [
'annotations' => false,
'http_method_override' => false,
'handle_all_throwables' => true,
'php_errors' => ['log' => true],
'lock' => null,
'messenger' => [
'default_bus' => 'messenger.bus.commands',
'buses' => [
'messenger.bus.commands' => null,
'messenger.bus.events' => [
'middleware' => [
['with_factory' => ['foo', true, ['bar' => 'baz']]],
],
],
'messenger.bus.queries' => [
'default_middleware' => false,
'middleware' => [
'send_message',
'handle_message',
],
],
],
],
]);
0 ...Fixtures/php/messenger_multiple_buses.php → ..._buses_without_deduplicate_middleware.php
View file
Open in desktop
File renamed without changes.
29 changes: 29 additions & 0 deletions 29 ...DependencyInjection/Fixtures/xml/messenger_multiple_buses_with_deduplicate_middleware.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
<?xml version="1.0" encoding="utf-8" ?>
<container xmlns="http://symfony.com/schema/dic/services"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:framework="http://symfony.com/schema/dic/symfony"
xsi:schemaLocation="http://symfony.com/schema/dic/services https://symfony.com/schema/dic/services/services-1.0.xsd
http://symfony.com/schema/dic/symfony https://symfony.com/schema/dic/symfony/symfony-1.0.xsd">

<framework:config http-method-override="false" handle-all-throwables="true">
<framework:annotations enabled="false" />
<framework:php-errors log="true" />
<framework:lock />
<framework:messenger default-bus="messenger.bus.commands">
<framework:bus name="messenger.bus.commands" />
<framework:bus name="messenger.bus.events">
<framework:middleware id="with_factory">
<framework:argument>foo</framework:argument>
<framework:argument>true</framework:argument>
<framework:argument>
<framework:bar>baz</framework:bar>
</framework:argument>
</framework:middleware>
</framework:bus>
<framework:bus name="messenger.bus.queries" default-middleware="false">
<framework:middleware id="send_message" />
<framework:middleware id="handle_message" />
</framework:bus>
</framework:messenger>
</framework:config>
</container>
0 ...Fixtures/xml/messenger_multiple_buses.xml → ..._buses_without_deduplicate_middleware.xml
View file
Open in desktop
File renamed without changes.
19 changes: 19 additions & 0 deletions 19 ...DependencyInjection/Fixtures/yml/messenger_multiple_buses_with_deduplicate_middleware.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
framework:
annotations: false
http_method_override: false
handle_all_throwables: true
php_errors:
log: true
lock: ~
messenger:
default_bus: messenger.bus.commands
buses:
messenger.bus.commands: ~
messenger.bus.events:
middleware:
- with_factory: [foo, true, { bar: baz }]
messenger.bus.queries:
default_middleware: false
middleware:
- "send_message"
- "handle_message"
0 ...Fixtures/yml/messenger_multiple_buses.yml → ..._buses_without_deduplicate_middleware.yml
View file
Open in desktop
File renamed without changes.
103 changes: 58 additions & 45 deletions 103 src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/FrameworkExtensionTestCase.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1056,60 +1056,73 @@ public function testMessengerTransportConfiguration()
$this->assertSame(['enable_max_depth' => true], $serializerTransportDefinition->getArgument(2));
}

public function testMessengerWithMultipleBuses()
public function testMessengerWithMultipleBusesWithoutDeduplicateMiddleware()
{
$container = $this->createContainerFromFile('messenger_multiple_buses');
$container = $this->createContainerFromFile('messenger_multiple_buses_without_deduplicate_middleware');

$this->assertTrue($container->has('messenger.bus.commands'));
$this->assertSame([], $container->getDefinition('messenger.bus.commands')->getArgument(0));

if (class_exists(DeduplicateMiddleware::class)) {
$this->assertEquals([
['id' => 'add_bus_name_stamp_middleware', 'arguments' => ['messenger.bus.commands']],
['id' => 'reject_redelivered_message_middleware'],
['id' => 'dispatch_after_current_bus'],
['id' => 'failed_message_processing_middleware'],
['id' => 'deduplicate_middleware'],
['id' => 'send_message', 'arguments' => [true]],
['id' => 'handle_message', 'arguments' => [false]],
], $container->getParameter('messenger.bus.commands.middleware'));
} else {
$this->assertEquals([
['id' => 'add_bus_name_stamp_middleware', 'arguments' => ['messenger.bus.commands']],
['id' => 'reject_redelivered_message_middleware'],
['id' => 'dispatch_after_current_bus'],
['id' => 'failed_message_processing_middleware'],
['id' => 'send_message', 'arguments' => [true]],
['id' => 'handle_message', 'arguments' => [false]],
], $container->getParameter('messenger.bus.commands.middleware'));
}

$this->assertEquals([
['id' => 'add_bus_name_stamp_middleware', 'arguments' => ['messenger.bus.commands']],
['id' => 'reject_redelivered_message_middleware'],
['id' => 'dispatch_after_current_bus'],
['id' => 'failed_message_processing_middleware'],
['id' => 'send_message', 'arguments' => [true]],
['id' => 'handle_message', 'arguments' => [false]],
], $container->getParameter('messenger.bus.commands.middleware'));
$this->assertTrue($container->has('messenger.bus.events'));
$this->assertSame([], $container->getDefinition('messenger.bus.events')->getArgument(0));
$this->assertEquals([
['id' => 'add_bus_name_stamp_middleware', 'arguments' => ['messenger.bus.events']],
['id' => 'reject_redelivered_message_middleware'],
['id' => 'dispatch_after_current_bus'],
['id' => 'failed_message_processing_middleware'],
['id' => 'with_factory', 'arguments' => ['foo', true, ['bar' => 'baz']]],
['id' => 'send_message', 'arguments' => [true]],
['id' => 'handle_message', 'arguments' => [false]],
], $container->getParameter('messenger.bus.events.middleware'));
$this->assertTrue($container->has('messenger.bus.queries'));
$this->assertSame([], $container->getDefinition('messenger.bus.queries')->getArgument(0));
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's convert all $this->assertSame([], ...) to assertEmpty() while at it maybe?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this isn't the same - assertEmpty accepts zero or the empty string, null, etc

$this->assertEquals([
['id' => 'send_message', 'arguments' => []],
['id' => 'handle_message', 'arguments' => []],
], $container->getParameter('messenger.bus.queries.middleware'));

if (class_exists(DeduplicateMiddleware::class)) {
$this->assertEquals([
['id' => 'add_bus_name_stamp_middleware', 'arguments' => ['messenger.bus.events']],
['id' => 'reject_redelivered_message_middleware'],
['id' => 'dispatch_after_current_bus'],
['id' => 'failed_message_processing_middleware'],
['id' => 'deduplicate_middleware'],
['id' => 'with_factory', 'arguments' => ['foo', true, ['bar' => 'baz']]],
['id' => 'send_message', 'arguments' => [true]],
['id' => 'handle_message', 'arguments' => [false]],
], $container->getParameter('messenger.bus.events.middleware'));
} else {
$this->assertEquals([
['id' => 'add_bus_name_stamp_middleware', 'arguments' => ['messenger.bus.events']],
['id' => 'reject_redelivered_message_middleware'],
['id' => 'dispatch_after_current_bus'],
['id' => 'failed_message_processing_middleware'],
['id' => 'with_factory', 'arguments' => ['foo', true, ['bar' => 'baz']]],
['id' => 'send_message', 'arguments' => [true]],
['id' => 'handle_message', 'arguments' => [false]],
], $container->getParameter('messenger.bus.events.middleware'));
$this->assertTrue($container->hasAlias('messenger.default_bus'));
$this->assertSame('messenger.bus.commands', (string) $container->getAlias('messenger.default_bus'));
}

public function testMessengerWithMultipleBusesWithDeduplicateMiddleware()
{
if (!class_exists(DeduplicateMiddleware::class)) {
$this->markTestSkipped('DeduplicateMiddleware not available.');
}

$container = $this->createContainerFromFile('messenger_multiple_buses_with_deduplicate_middleware');

$this->assertTrue($container->has('messenger.bus.commands'));
$this->assertSame([], $container->getDefinition('messenger.bus.commands')->getArgument(0));
$this->assertEquals([
['id' => 'add_bus_name_stamp_middleware', 'arguments' => ['messenger.bus.commands']],
['id' => 'reject_redelivered_message_middleware'],
['id' => 'dispatch_after_current_bus'],
['id' => 'failed_message_processing_middleware'],
['id' => 'deduplicate_middleware'],
['id' => 'send_message', 'arguments' => [true]],
['id' => 'handle_message', 'arguments' => [false]],
], $container->getParameter('messenger.bus.commands.middleware'));
$this->assertTrue($container->has('messenger.bus.events'));
$this->assertSame([], $container->getDefinition('messenger.bus.events')->getArgument(0));
$this->assertEquals([
['id' => 'add_bus_name_stamp_middleware', 'arguments' => ['messenger.bus.events']],
['id' => 'reject_redelivered_message_middleware'],
['id' => 'dispatch_after_current_bus'],
['id' => 'failed_message_processing_middleware'],
['id' => 'deduplicate_middleware'],
['id' => 'with_factory', 'arguments' => ['foo', true, ['bar' => 'baz']]],
['id' => 'send_message', 'arguments' => [true]],
['id' => 'handle_message', 'arguments' => [false]],
], $container->getParameter('messenger.bus.events.middleware'));
$this->assertTrue($container->has('messenger.bus.queries'));
$this->assertSame([], $container->getDefinition('messenger.bus.queries')->getArgument(0));
$this->assertEquals([
Expand Down
2 changes: 1 addition & 1 deletion 2 src/Symfony/Component/Messenger/Middleware/DeduplicateMiddleware.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ public function handle(Envelope $envelope, StackInterface $stack): Envelope
}

if (!$envelope->last(ReceivedStamp::class)) {
$lock = $this->lockFactory->createLockFromKey($stamp->getKey(), $stamp->getTtl(), autoRelease: false);
$lock = $this->lockFactory->createLockFromKey($stamp->getKey(), $stamp->getTtl(), false);

if (!$lock->acquire()) {
return $envelope;
Expand Down
2 changes: 1 addition & 1 deletion 2 src/Symfony/Component/Messenger/Tests/Middleware/DeduplicateMiddlewareTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ public function testDeduplicateMiddlewareIgnoreIfMessageIsNotLockable()
$envelope = new Envelope($message);

$lockFactory = $this->createMock(LockFactory::class);
$lockFactory->expects($this->never())->method('createLock');
$lockFactory->expects($this->never())->method('createLockFromKey');

$decorator = new DeduplicateMiddleware($lockFactory);

Expand Down
Loading
Morty Proxy This is a proxified and sanitized view of the page, visit original site.