[MonologBridge] Add ability to react to console input being interactive or not

dkarlovi · fabpot · commit ace90547fced · 2025-09-24T08:49:22.000+02:00
diff --git a/src/Symfony/Bridge/Monolog/Handler/ConsoleHandler.php b/src/Symfony/Bridge/Monolog/Handler/ConsoleHandler.php
@@ -20,6 +20,7 @@
 use Symfony\Component\Console\ConsoleEvents;
 use Symfony\Component\Console\Event\ConsoleCommandEvent;
 use Symfony\Component\Console\Event\ConsoleTerminateEvent;
+use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Output\ConsoleOutputInterface;
 use Symfony\Component\Console\Output\OutputInterface;
 use Symfony\Component\EventDispatcher\EventSubscriberInterface;
@@ -52,6 +53,8 @@ final class ConsoleHandler extends AbstractProcessingHandler implements EventSub
         OutputInterface::VERBOSITY_DEBUG => Level::Debug,
     ];
 
+    private ?InputInterface $input = null;
+
     /**
      * @param OutputInterface|null $output            The console output to use (the handler remains disabled when passing null
      *                                                until the output is set, e.g. by using console events)
@@ -64,6 +67,7 @@ public function __construct(
         bool $bubble = true,
         array $verbosityLevelMap = [],
         private array $consoleFormatterOptions = [],
+        private bool $interactiveOnly = false,
     ) {
         parent::__construct(Level::Debug, $bubble);
 
@@ -74,7 +78,20 @@ public function __construct(
 
     public function isHandling(LogRecord $record): bool
     {
-        return $this->updateLevel() && parent::isHandling($record);
+        return
+            $this->updateLevel()
+            && parent::isHandling($record)
+            && (!$this->interactiveOnly || $this->input?->isInteractive())
+        ;
+    }
+
+    public function getBubble(): bool
+    {
+        if ($this->interactiveOnly && $this->input?->isInteractive()) {
+            return false;
+        }
+
+        return parent::getBubble();
     }
 
     public function handle(LogRecord $record): bool
@@ -84,6 +101,11 @@ public function handle(LogRecord $record): bool
         return $this->updateLevel() && parent::handle($record);
     }
 
+    public function setInput(InputInterface $input): void
+    {
+        $this->input = $input;
+    }
+
     /**
      * Sets the console output to use for printing logs.
      */
@@ -97,6 +119,7 @@ public function setOutput(OutputInterface $output): void
      */
     public function close(): void
     {
+        $this->input = null;
         $this->output = null;
 
         parent::close();
@@ -108,6 +131,8 @@ public function close(): void
      */
     public function onCommand(ConsoleCommandEvent $event): void
     {
+        $this->setInput($event->getInput());
+
         $output = $event->getOutput();
         if ($output instanceof ConsoleOutputInterface) {
             $output = $output->getErrorOutput();
diff --git a/src/Symfony/Bridge/Monolog/Tests/Handler/ConsoleHandlerTest.php b/src/Symfony/Bridge/Monolog/Tests/Handler/ConsoleHandlerTest.php
@@ -235,4 +235,30 @@ public function testLogsFromListeners()
         $this->assertStringContainsString('Before terminate message.', $out = $output->fetch());
         $this->assertStringContainsString('After terminate message.', $out);
     }
+
+    public function testInteractiveOnly()
+    {
+        $output = $this->createMock(OutputInterface::class);
+
+        $message = RecordFactory::create(Level::Info, 'My info message');
+        $interactiveInput = $this->createMock(InputInterface::class);
+        $interactiveInput
+            ->method('isInteractive')
+            ->willReturn(true);
+        $handler = new ConsoleHandler(interactiveOnly: true);
+        $handler->setInput($interactiveInput);
+        $handler->setOutput($output);
+        self::assertTrue($handler->isHandling($message), '->isHandling returns true when input is interactive');
+        self::assertFalse($handler->getBubble(), '->getBubble returns false when input is interactive and interactiveOnly is true');
+
+        $nonInteractiveInput = $this->createMock(InputInterface::class);
+        $nonInteractiveInput
+            ->method('isInteractive')
+            ->willReturn(false);
+        $handler = new ConsoleHandler(interactiveOnly: true);
+        $handler->setInput($nonInteractiveInput);
+        $handler->setOutput($output);
+        self::assertFalse($handler->isHandling($message), '->isHandling returns false when input is not interactive');
+        self::assertTrue($handler->getBubble(), '->getBubble returns true when input is not interactive and interactiveOnly is true');
+    }
 }
