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

dkarlovi · dkarlovi · commit 0fbbc35374b8 · 2025-03-14T12:49:08.000+01: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;
@@ -64,6 +65,8 @@ public function __construct(
         bool $bubble = true,
         array $verbosityLevelMap = [],
         private array $consoleFormatterOptions = [],
+        private ?InputInterface $input = null,
+        private bool $interactiveOnly = false,
     ) {
         parent::__construct(Level::Debug, $bubble);
 
@@ -74,7 +77,16 @@ public function __construct(
 
     public function isHandling(LogRecord $record): bool
     {
-        return $this->updateLevel() && parent::isHandling($record);
+        return $this->isInteractiveOnlyEnabled() || ($this->updateLevel() && parent::isHandling($record));
+    }
+
+    public function getBubble(): bool
+    {
+        if ($this->isInteractiveOnlyEnabled()) {
+            return false;
+        }
+
+        return parent::getBubble();
     }
 
     public function handle(LogRecord $record): bool
@@ -84,6 +96,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.
      */
@@ -108,6 +125,9 @@ public function close(): void
      */
     public function onCommand(ConsoleCommandEvent $event): void
     {
+        $input = $event->getInput();
+        $this->setInput($input);
+
         $output = $event->getOutput();
         if ($output instanceof ConsoleOutputInterface) {
             $output = $output->getErrorOutput();
@@ -173,4 +193,9 @@ private function updateLevel(): bool
 
         return true;
     }
+
+    private function isInteractiveOnlyEnabled(): bool
+    {
+        return $this->interactiveOnly && $this->input !== null && $this->input->isInteractive();
+    }
 }
diff --git a/src/Symfony/Bridge/Monolog/Tests/Handler/ConsoleHandlerTest.php b/src/Symfony/Bridge/Monolog/Tests/Handler/ConsoleHandlerTest.php
@@ -186,4 +186,26 @@ public function testLogsFromListeners()
         $this->assertStringContainsString('Before terminate message.', $out = $output->fetch());
         $this->assertStringContainsString('After terminate message.', $out);
     }
+
+    public function testInteractiveOnly()
+    {
+        $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);
+        self::assertTrue($handler->isHandling($message));
+        self::assertFalse($handler->getBubble());
+
+        $nonInteractiveInput = $this->createMock(InputInterface::class);
+        $nonInteractiveInput
+            ->method('isInteractive')
+            ->willReturn(false);
+        $handler = new ConsoleHandler(interactiveOnly: true);
+        $handler->setInput($nonInteractiveInput);
+        self::assertFalse($handler->isHandling($message));
+        self::assertTrue($handler->getBubble());
+    }
 }
