Skip to content

Add priority field to processor tags #485

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

Open
wants to merge 6 commits into
base: master
Choose a base branch
from
Open

Add priority field to processor tags #485

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
13c5025
Add priority field to processor tags
Mar 17, 2023
2a8fd3b
spaceship!
Mar 20, 2023
c14c9d4
Use `PriorityTaggedServiceTrait`
HypeMC Jul 28, 2024
b5c88cc
Add comment
HypeMC Aug 6, 2024
adb5d1c
Fix for multiple tags
HypeMC Oct 8, 2024
bb83881
Fix priority with logger_prototype
HypeMC Aug 22, 2025
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
85 changes: 58 additions & 27 deletions DependencyInjection/Compiler/AddProcessorsPass.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,11 @@

namespace Symfony\Bundle\MonologBundle\DependencyInjection\Compiler;

use Symfony\Component\DependencyInjection\Argument\TaggedIteratorArgument;
use Symfony\Component\DependencyInjection\ChildDefinition;
use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
use Symfony\Component\DependencyInjection\Compiler\PriorityTaggedServiceTrait;
use Symfony\Component\DependencyInjection\ContainerBuilder;
use Symfony\Component\DependencyInjection\Reference;

/**
* Registers processors in Monolog loggers or handlers.
Expand All @@ -25,44 +26,74 @@
*/
class AddProcessorsPass implements CompilerPassInterface
{
use PriorityTaggedServiceTrait;

private $channelPass;

public function __construct(?LoggerChannelPass $channelPass = null)
{
$this->channelPass = $channelPass;
}

public function process(ContainerBuilder $container)
{
if (!$container->hasDefinition('monolog.logger')) {
return;
}

$indexedTags = [];
$i = 1;

foreach ($container->findTaggedServiceIds('monolog.processor') as $id => $tags) {
foreach ($tags as $tag) {
if (!empty($tag['channel']) && !empty($tag['handler'])) {
throw new \InvalidArgumentException(\sprintf('you cannot specify both the "handler" and "channel" attributes for the "monolog.processor" tag on service "%s"', $id));
}
foreach ($tags as &$tag) {
$indexedTags[$tag['index'] = $i++] = $tag;
}
unset($tag);
$definition = $container->getDefinition($id);
$definition->setTags(array_merge($definition->getTags(), ['monolog.processor' => $tags]));
}

if (!empty($tag['handler'])) {
$definition = $container->findDefinition(\sprintf('monolog.handler.%s', $tag['handler']));
$parentDef = $definition;
while (!$parentDef->getClass() && $parentDef instanceof ChildDefinition) {
$parentDef = $container->findDefinition($parentDef->getParent());
}
$class = $container->getParameterBag()->resolveValue($parentDef->getClass());
if (!method_exists($class, 'pushProcessor')) {
throw new \InvalidArgumentException(\sprintf('The "%s" handler does not accept processors', $tag['handler']));
}
} elseif (!empty($tag['channel'])) {
if ('app' === $tag['channel']) {
$definition = $container->getDefinition('monolog.logger');
} else {
$definition = $container->getDefinition(\sprintf('monolog.logger.%s', $tag['channel']));
$taggedIteratorArgument = new TaggedIteratorArgument('monolog.processor', 'index', null, true);
// array_reverse is used because ProcessableHandlerTrait::pushProcessor prepends processors to the beginning of the stack
foreach (array_reverse($this->findAndSortTaggedServices($taggedIteratorArgument, $container), true) as $index => $reference) {
$tag = $indexedTags[$index];

if (!empty($tag['channel']) && !empty($tag['handler'])) {
throw new \InvalidArgumentException(\sprintf('you cannot specify both the "handler" and "channel" attributes for the "monolog.processor" tag on service "%s"', $reference));
}

if (!empty($tag['handler'])) {
$parentDef = $container->findDefinition(\sprintf('monolog.handler.%s', $tag['handler']));
$definitions = [$parentDef];
while (!$parentDef->getClass() && $parentDef instanceof ChildDefinition) {
$parentDef = $container->findDefinition($parentDef->getParent());
}
$class = $container->getParameterBag()->resolveValue($parentDef->getClass());
if (!method_exists($class, 'pushProcessor')) {
throw new \InvalidArgumentException(\sprintf('The "%s" handler does not accept processors', $tag['handler']));
}
} elseif (!empty($tag['channel'])) {
$loggerId = 'app' === $tag['channel'] ? 'monolog.logger' : \sprintf('monolog.logger.%s', $tag['channel']);
$definitions = [$container->getDefinition($loggerId)];
} else {
if ($this->channelPass) {
$definitions = [];
foreach ($this->channelPass->getChannels() as $channel) {
$loggerId = 'app' === $channel ? 'monolog.logger' : \sprintf('monolog.logger.%s', $channel);
$definitions[] = $container->getDefinition($loggerId);
}
} else {
$definition = $container->getDefinition('monolog.logger_prototype');
$definitions = [$container->getDefinition('monolog.logger_prototype')];
}
}

if (!empty($tag['method'])) {
$processor = [new Reference($id), $tag['method']];
} else {
// If no method is defined, fallback to use __invoke
$processor = new Reference($id);
}
if (!empty($tag['method'])) {
$processor = [$reference, $tag['method']];
} else {
// If no method is defined, fallback to use __invoke
$processor = $reference;
}
foreach ($definitions as $definition) {
$definition->addMethodCall('pushProcessor', [$processor]);
}
}
Expand Down
2 changes: 1 addition & 1 deletion MonologBundle.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ public function build(ContainerBuilder $container)

$container->addCompilerPass($channelPass = new LoggerChannelPass());
$container->addCompilerPass(new FixEmptyLoggerPass($channelPass));
$container->addCompilerPass(new AddProcessorsPass());
$container->addCompilerPass(new AddProcessorsPass($channelPass));
$container->addCompilerPass(new AddSwiftMailerTransportPass());
}

Expand Down
78 changes: 73 additions & 5 deletions Tests/DependencyInjection/Compiler/AddProcessorsPassTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,13 @@
use PHPUnit\Framework\TestCase;
use Symfony\Bridge\Monolog\Handler\ConsoleHandler;
use Symfony\Bundle\MonologBundle\DependencyInjection\Compiler\AddProcessorsPass;
use Symfony\Bundle\MonologBundle\DependencyInjection\Compiler\LoggerChannelPass;
use Symfony\Component\Config\FileLocator;
use Symfony\Component\DependencyInjection\ContainerBuilder;
use Symfony\Component\DependencyInjection\Definition;
use Symfony\Component\DependencyInjection\Loader\XmlFileLoader;
use Symfony\Component\DependencyInjection\Reference;
use Symfony\Component\DependencyInjection\TypedReference;

class AddProcessorsPassTest extends TestCase
{
Expand All @@ -31,12 +33,40 @@ public function testHandlerProcessors()
$service = $container->getDefinition('monolog.handler.test');
$calls = $service->getMethodCalls();
$this->assertCount(1, $calls);
$this->assertEquals(['pushProcessor', [new Reference('test')]], $calls[0]);
$this->assertEquals(['pushProcessor', [new TypedReference('test', 'TestClass')]], $calls[0]);

$service = $container->getDefinition('handler_test');
$calls = $service->getMethodCalls();
$this->assertCount(1, $calls);
$this->assertEquals(['pushProcessor', [new Reference('test2')]], $calls[0]);
$this->assertEquals(['pushProcessor', [new TypedReference('test2', 'TestClass')]], $calls[0]);

$service = $container->getDefinition('monolog.handler.priority_test');
Copy link

Choose a reason for hiding this comment

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

Can we add a case when the processor has a channel?

Copy link
Member Author

Choose a reason for hiding this comment

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

Done

$calls = $service->getMethodCalls();
$this->assertCount(5, $calls);
$this->assertEquals(['pushProcessor', [new TypedReference('processor-10', 'TestClass')]], $calls[0]);
$this->assertEquals(['pushProcessor', [new TypedReference('processor+10', 'TestClass')]], $calls[1]);
$this->assertEquals(['pushProcessor', [new TypedReference('processor+20', 'TestClass')]], $calls[2]);
$this->assertEquals(['pushProcessor', [new TypedReference('processor+20', 'TestClass')]], $calls[2]);
$this->assertEquals(['pushProcessor', [new TypedReference('processor+25+35', 'TestClass')]], $calls[3]);
$this->assertEquals(['pushProcessor', [new TypedReference('processor+35+25', 'TestClass')]], $calls[4]);

$service = $container->getDefinition('monolog.handler.priority_test_2');
$calls = $service->getMethodCalls();
$this->assertCount(2, $calls);
$this->assertEquals(['pushProcessor', [new TypedReference('processor+35+25', 'TestClass')]], $calls[0]);
$this->assertEquals(['pushProcessor', [new TypedReference('processor+25+35', 'TestClass')]], $calls[1]);

$service = $container->getDefinition('monolog.logger');
$calls = $service->getMethodCalls();
$this->assertCount(2, $calls);
$this->assertEquals(['useMicrosecondTimestamps', ['%monolog.use_microseconds%']], $calls[0]);
$this->assertEquals(['pushProcessor', [new TypedReference('processor_all_channels+0', 'TestClass')]], $calls[1]);

$service = $container->getDefinition('monolog.logger.test');
$calls = $service->getMethodCalls();
$this->assertCount(2, $calls);
$this->assertEquals(['pushProcessor', [new TypedReference('processor_test_channel-25', 'TestClass')]], $calls[0]);
$this->assertEquals(['pushProcessor', [new TypedReference('processor_all_channels+0', 'TestClass')]], $calls[1]);
}

public function testFailureOnHandlerWithoutPushProcessor()
Expand Down Expand Up @@ -71,25 +101,63 @@ protected function getContainer()
$loader = new XmlFileLoader($container, new FileLocator(__DIR__.'/../../../Resources/config'));
$loader->load('monolog.xml');

$container->setParameter('monolog.additional_channels', ['test']);
$container->setParameter('monolog.handlers_to_channels', []);

$definition = $container->getDefinition('monolog.logger_prototype');
$container->setParameter('monolog.handler.console.class', ConsoleHandler::class);
$container->setDefinition('monolog.handler.test', new Definition('%monolog.handler.console.class%', [100, false]));
$container->setDefinition('handler_test', new Definition('%monolog.handler.console.class%', [100, false]));
$container->setDefinition('monolog.handler.priority_test', new Definition('%monolog.handler.console.class%', [100, false]));
$container->setDefinition('monolog.handler.priority_test_2', new Definition('%monolog.handler.console.class%', [100, false]));
$container->setAlias('monolog.handler.test2', 'handler_test');
$definition->addMethodCall('pushHandler', [new Reference('monolog.handler.test')]);
$definition->addMethodCall('pushHandler', [new Reference('monolog.handler.test2')]);
$definition->addMethodCall('pushHandler', [new Reference('monolog.handler.priority_test')]);
$definition->addMethodCall('pushHandler', [new Reference('monolog.handler.priority_test_2')]);

$service = new Definition('TestClass', ['false', new Reference('logger')]);
$service = new Definition('TestClass');
$service->addTag('monolog.processor', ['handler' => 'test']);
$container->setDefinition('test', $service);

$service = new Definition('TestClass', ['false', new Reference('logger')]);
$service = new Definition('TestClass');
$service->addTag('monolog.processor', ['handler' => 'test2']);
$container->setDefinition('test2', $service);

$service = new Definition('TestClass');
$service->addTag('monolog.processor', ['handler' => 'priority_test', 'priority' => 10]);
$container->setDefinition('processor+10', $service);

$service = new Definition('TestClass');
$service->addTag('monolog.processor', ['handler' => 'priority_test', 'priority' => -10]);
$container->setDefinition('processor-10', $service);

$service = new Definition('TestClass');
$service->addTag('monolog.processor', ['handler' => 'priority_test', 'priority' => 20]);
$container->setDefinition('processor+20', $service);

$service = new Definition('TestClass');
$service->addTag('monolog.processor', ['handler' => 'priority_test', 'priority' => 35]);
$service->addTag('monolog.processor', ['handler' => 'priority_test_2', 'priority' => 25]);
$container->setDefinition('processor+35+25', $service);

$service = new Definition('TestClass');
$service->addTag('monolog.processor', ['handler' => 'priority_test', 'priority' => 25]);
$service->addTag('monolog.processor', ['handler' => 'priority_test_2', 'priority' => 35]);
$container->setDefinition('processor+25+35', $service);

$service = new Definition('TestClass');
$service->addTag('monolog.processor', ['priority' => 0]);
$container->setDefinition('processor_all_channels+0', $service);

$service = new Definition('TestClass');
$service->addTag('monolog.processor', ['channel' => 'test', 'priority' => -25]);
$container->setDefinition('processor_test_channel-25', $service);

$container->getCompilerPassConfig()->setOptimizationPasses([]);
$container->getCompilerPassConfig()->setRemovingPasses([]);
$container->addCompilerPass(new AddProcessorsPass());
$container->addCompilerPass($channelPass = new LoggerChannelPass());
$container->addCompilerPass(new AddProcessorsPass($channelPass));
$container->compile();

return $container;
Expand Down
Loading