Skip to content

[FrameworkBundle][Notifier] Allow to configure or disable the message bus to use #39353

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 2 commits into from
Dec 11, 2022
Merged

[FrameworkBundle][Notifier] Allow to configure or disable the message bus to use #39353

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
215e802
Allow to configure or disable the message bus to use
jschaedl Dec 6, 2020
fc7aaa6
Fix logic and tests
fabpot Jul 21, 2022
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
3 changes: 3 additions & 0 deletions src/Symfony/Bundle/FrameworkBundle/DependencyInjection/Configuration.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2014,6 +2014,9 @@ private function addNotifierSection(ArrayNodeDefinition $rootNode, callable $ena
->arrayNode('notifier')
->info('Notifier configuration')
->{$enableIfStandalone('symfony/notifier', Notifier::class)}()
->children()
->scalarNode('message_bus')->defaultNull()->info('The message bus to use. Defaults to the default bus if the Messenger component is installed.')->end()
->end()
->fixXmlConfig('chatter_transport')
->children()
->arrayNode('chatter_transports')
Expand Down
12 changes: 12 additions & 0 deletions src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2522,6 +2522,18 @@ private function registerNotifierConfiguration(array $config, ContainerBuilder $
$container->removeDefinition('notifier.channel.email');
}

foreach (['texter', 'chatter', 'notifier.channel.chat', 'notifier.channel.email', 'notifier.channel.sms'] as $serviceId) {
if (!$container->hasDefinition($serviceId)) {
continue;
}

if (false === $messageBus = $config['message_bus']) {
$container->getDefinition($serviceId)->replaceArgument(1, null);
} else {
$container->getDefinition($serviceId)->replaceArgument(1, $messageBus ? new Reference($messageBus) : new Reference('messenger.default_bus', ContainerInterface::NULL_ON_INVALID_REFERENCE));
}
}

if ($this->isInitializedConfigEnabled('messenger')) {
if ($config['notification_on_failed_messages']) {
$container->getDefinition('notifier.failed_message_listener')->addTag('kernel.event_subscriber');
Expand Down
19 changes: 14 additions & 5 deletions src/Symfony/Bundle/FrameworkBundle/Resources/config/notifier.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,15 +52,24 @@
->tag('notifier.channel', ['channel' => 'browser'])

->set('notifier.channel.chat', ChatChannel::class)
->args([service('chatter.transports'), service('messenger.default_bus')->ignoreOnInvalid()])
->args([
service('chatter.transports'),
abstract_arg('message bus'),
])
->tag('notifier.channel', ['channel' => 'chat'])

->set('notifier.channel.sms', SmsChannel::class)
->args([service('texter.transports'), service('messenger.default_bus')->ignoreOnInvalid()])
->args([
service('texter.transports'),
abstract_arg('message bus'),
])
->tag('notifier.channel', ['channel' => 'sms'])

->set('notifier.channel.email', EmailChannel::class)
->args([service('mailer.transports'), service('messenger.default_bus')->ignoreOnInvalid()])
->args([
service('mailer.transports'),
abstract_arg('message bus'),
])
->tag('notifier.channel', ['channel' => 'email'])

->set('notifier.channel.push', PushChannel::class)
Expand All @@ -76,7 +85,7 @@
->set('chatter', Chatter::class)
->args([
service('chatter.transports'),
service('messenger.default_bus')->ignoreOnInvalid(),
abstract_arg('message bus'),
service('event_dispatcher')->ignoreOnInvalid(),
])

Expand All @@ -96,7 +105,7 @@
->set('texter', Texter::class)
->args([
service('texter.transports'),
service('messenger.default_bus')->ignoreOnInvalid(),
abstract_arg('message bus'),
service('event_dispatcher')->ignoreOnInvalid(),
])

Expand Down
1 change: 1 addition & 0 deletions src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/ConfigurationTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -655,6 +655,7 @@ class_exists(SemaphoreStore::class) && SemaphoreStore::isSupported() ? 'semaphor
],
'notifier' => [
'enabled' => !class_exists(FullStack::class) && class_exists(Notifier::class),
'message_bus' => null,
'chatter_transports' => [],
'texter_transports' => [],
'channel_policy' => [],
Expand Down
19 changes: 19 additions & 0 deletions ...eworkBundle/Tests/DependencyInjection/Fixtures/php/notifier_with_disabled_message_bus.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
<?php

$container->loadFromExtension('framework', [
'messenger' => [
'enabled' => true,
],
'mailer' => [
'dsn' => 'smtp://example.com',
],
'notifier' => [
'message_bus' => false,
'chatter_transports' => [
'test' => 'null'
],
'texter_transports' => [
'test' => 'null'
],
],
]);
19 changes: 19 additions & 0 deletions ...eworkBundle/Tests/DependencyInjection/Fixtures/php/notifier_with_specific_message_bus.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
<?php

$container->loadFromExtension('framework', [
'messenger' => [
'enabled' => true,
],
'mailer' => [
'dsn' => 'smtp://example.com',
],
'notifier' => [
'message_bus' => 'app.another_bus',
'chatter_transports' => [
'test' => 'null'
],
'texter_transports' => [
'test' => 'null'
],
],
]);
17 changes: 17 additions & 0 deletions ...eworkBundle/Tests/DependencyInjection/Fixtures/xml/notifier_with_disabled_message_bus.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
<?xml version="1.0" ?>

<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>
<framework:messenger enabled="true" />
<framework:mailer dsn="smtp://example.com" />
<framework:notifier enabled="true" message-bus="false">
<framework:chatter-transport name="test">null</framework:chatter-transport>
<framework:texter-transport name="test">null</framework:texter-transport>
</framework:notifier>
</framework:config>
</container>
17 changes: 17 additions & 0 deletions ...eworkBundle/Tests/DependencyInjection/Fixtures/xml/notifier_with_specific_message_bus.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
<?xml version="1.0" ?>

<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>
<framework:messenger enabled="true" />
<framework:mailer dsn="smtp://example.com" />
<framework:notifier enabled="true" message-bus="app.another_bus">
<framework:chatter-transport name="test">null</framework:chatter-transport>
<framework:texter-transport name="test">null</framework:texter-transport>
</framework:notifier>
</framework:config>
</container>
11 changes: 11 additions & 0 deletions ...eworkBundle/Tests/DependencyInjection/Fixtures/yml/notifier_with_disabled_message_bus.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
framework:
messenger:
enabled: true
mailer:
dsn: 'smtp://example.com'
notifier:
message_bus: false
chatter_transports:
test: 'null'
texter_transports:
test: 'null'
11 changes: 11 additions & 0 deletions ...eworkBundle/Tests/DependencyInjection/Fixtures/yml/notifier_with_specific_message_bus.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
framework:
messenger:
enabled: true
mailer:
dsn: 'smtp://example.com'
notifier:
message_bus: 'app.another_bus'
chatter_transports:
test: 'null'
texter_transports:
test: 'null'
22 changes: 22 additions & 0 deletions src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/FrameworkExtensionTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2173,6 +2173,28 @@ public function testHtmlSanitizerDefaultConfig()
$this->assertSame('html_sanitizer', (string) $container->getAlias(HtmlSanitizerInterface::class));
}

public function testNotifierWithDisabledMessageBus()
{
$container = $this->createContainerFromFile('notifier_with_disabled_message_bus');

$this->assertNull($container->getDefinition('chatter')->getArgument(1));
$this->assertNull($container->getDefinition('texter')->getArgument(1));
$this->assertNull($container->getDefinition('notifier.channel.chat')->getArgument(1));
$this->assertNull($container->getDefinition('notifier.channel.email')->getArgument(1));
$this->assertNull($container->getDefinition('notifier.channel.sms')->getArgument(1));
}

public function testNotifierWithSpecificMessageBus()
{
$container = $this->createContainerFromFile('notifier_with_specific_message_bus');

$this->assertEquals(new Reference('app.another_bus'), $container->getDefinition('chatter')->getArgument(1));
$this->assertEquals(new Reference('app.another_bus'), $container->getDefinition('texter')->getArgument(1));
$this->assertEquals(new Reference('app.another_bus'), $container->getDefinition('notifier.channel.chat')->getArgument(1));
$this->assertEquals(new Reference('app.another_bus'), $container->getDefinition('notifier.channel.email')->getArgument(1));
$this->assertEquals(new Reference('app.another_bus'), $container->getDefinition('notifier.channel.sms')->getArgument(1));
}

protected function createContainer(array $data = [])
{
return new ContainerBuilder(new EnvPlaceholderParameterBag(array_merge([
Expand Down