Keep the last scope

Author: Litarnus

src/EventListener/ConsoleListener.php

@@ -37,6 +37,11 @@ class ConsoleListener
      */
     private $commandHasErrors;
 
+    /**
+     * @var int tracks how many commands have been invoked from other commands
+     */
+    private $commandDepth;
+
     /**
      * Constructor.
      *
@@ -60,6 +65,7 @@ public function handleConsoleCommandEvent(ConsoleCommandEvent $event): void
         $scope = $this->hub->pushScope();
         $command = $event->getCommand();
         $input = $event->getInput();
+        ++$this->commandDepth;
 
         if (null !== $command && null !== $command->getName()) {
             $scope->setTag('console.command', $command->getName());
@@ -78,9 +84,10 @@ public function handleConsoleCommandEvent(ConsoleCommandEvent $event): void
      */
     public function handleConsoleTerminateEvent(ConsoleTerminateEvent $event): void
     {
-        // We need to keep the last scope around even until command termination to retain
-        // information when flushing buffered events.
-        if (false === $this->commandHasErrors) {
+        --$this->commandDepth;
+        // If a command encountered an error, we want to keep the scope to be able to populate the event.
+        // We also want to keep the last scope so that breadcrumbs are not deleted once the command terminates.
+        if (false === $this->commandHasErrors && $this->commandDepth > 0) {
             $this->hub->popScope();
         }
     }

tests/Command/BreadcrumbTestCommandTest.php

@@ -79,7 +79,7 @@ public function testBreadcrumbWithConsoleListener()
             $this->application->doRun(new ArgvInput(['bin/console', 'sentry:breadcrumb:test']), new NullOutput());
             $this->fail();
         } catch (\Throwable $e) {
-            $this->assertSame($e->getMessage(), 'Breadcrumb error');
+            $this->assertEquals('Breadcrumb error', $e->getMessage());
         }
 
         $event = Event::createEvent();
@@ -119,8 +119,8 @@ public function testSubCommandBreadcrumbs()
         });
 
         $this->assertNotNull($modifiedEvent);
-        // We do not have breadcrumbs here because no error happened and the scope was popped.
-        $this->assertCount(0, $modifiedEvent->getBreadcrumbs());
+        // We have breadcrumbs but only from the root console command.
+        $this->assertCount(2, $modifiedEvent->getBreadcrumbs());
     }
 
     /**
@@ -140,7 +140,7 @@ public function testCrashingSubcommand()
             $this->application->doRun(new ArgvInput(['bin/console', 'sentry:subcommand:test']), new NullOutput());
             $this->fail();
         } catch (\Throwable $e) {
-            $this->assertSame($e->getMessage(), 'Breadcrumb error');
+            $this->assertEquals('Breadcrumb error', $e->getMessage());
         }
 
         $event = Event::createEvent();
@@ -152,7 +152,7 @@ public function testCrashingSubcommand()
 
         $this->assertNotNull($modifiedEvent);
         $this->assertCount(2, $modifiedEvent->getBreadcrumbs());
-        $this->assertSame($modifiedEvent->getTags()['console.command'], 'sentry:breadcrumb:test');
+        $this->assertEquals('sentry:breadcrumb:test', $modifiedEvent->getTags()['console.command']);
     }
 
     /**
@@ -176,7 +176,7 @@ public function testRunSecondCommandAfterCrashingCommand()
             $this->application->doRun(new ArgvInput(['bin/console', 'sentry:subcommand:test']), new NullOutput());
             $this->fail();
         } catch (\Throwable $e) {
-            $this->assertSame($e->getMessage(), 'Breadcrumb error');
+            $this->assertEquals('Breadcrumb error', $e->getMessage());
         }
 
         $command = new SentryDummyTestCommand($this->logger);
@@ -195,6 +195,31 @@ public function testRunSecondCommandAfterCrashingCommand()
         // Breadcrumbs contain all log entries until the sentry:dummy:test command crash.
         $this->assertCount(3, $modifiedEvent->getBreadcrumbs());
         // console.command tag is properly set to the last command
-        $this->assertSame($modifiedEvent->getTags()['console.command'], 'sentry:dummy:test');
+        $this->assertEquals('sentry:dummy:test', $modifiedEvent->getTags()['console.command']);
+    }
+
+    /**
+     * Tests that even if no errors occur, breadcrumb information is available.
+     *
+     * @return void
+     * @throws \Throwable
+     */
+    public function testBreadcrumbsAreAvailableAfterCommandTermination()
+    {
+        $command = new SentryDummyTestCommand($this->logger);
+        $this->application->add($command);
+
+        $this->application->doRun(new ArgvInput(['bin/console', 'sentry:dummy:test']), new NullOutput());
+
+        $event = Event::createEvent();
+        $modifiedEvent = null;
+        $this->hub->configureScope(function (Scope $scope) use ($event, &$modifiedEvent) {
+            $modifiedEvent = $scope->applyToEvent($event);
+        });
+
+        $this->assertNotNull($modifiedEvent);
+        $this->assertCount(1, $modifiedEvent->getBreadcrumbs());
+        $this->assertEquals('This is a dummy message', $modifiedEvent->getBreadcrumbs()[0]->getMessage());
+        $this->assertEquals('sentry:dummy:test', $modifiedEvent->getTags()['console.command']);
     }
 }