move test commands into tests/ dir and add docs

Author: Litarnus

src/EventListener/BufferFlusher.php

@@ -13,6 +13,13 @@
 use Symfony\Component\HttpKernel\Event\TerminateEvent;
 use Symfony\Component\HttpKernel\KernelEvents;
 
+/**
+ * Class that wraps Sentry monolog handlers to flush them for certain lifecycle events.
+ * This is required to emit proper scope based information like tags and breadcrumbs.
+ *
+ * Without this class, buffered monolog messages are flushed when the request finishes at which
+ * point breadcrumbs and tags are no longer present in the scope.
+ */
 class BufferFlusher implements EventSubscriberInterface
 {
     /**
@@ -30,9 +37,15 @@ public function __construct(array $bufferHandlers = [])
 
     public static function getSubscribedEvents(): array
     {
+        // Flush the Monolog buffer before any scope is destroyed so that events
+        // get augmented with properly scoped data.
+        // For ConsoleEvents::COMMAND, we have to flush before ConsoleListener::handleConsoleCommandEvent(..)
+        // runs so that the proper tags get attached to the event.
+        // Running with lower priority will make the ConsoleListener run before and create a new scope
+        // with the new command name when running a symfony Command within another Command.
         return [
             KernelEvents::TERMINATE => ['onKernelTerminate', 10],
-            ConsoleEvents::COMMAND => ['onConsoleCommand', 10],
+            ConsoleEvents::COMMAND => ['onConsoleCommand', 150],
             ConsoleEvents::TERMINATE => ['onConsoleTerminate', 10],
             ConsoleEvents::ERROR => ['onConsoleError', 10],
         ];

tests/Command/BreadcrumbTestCommandTest.php

@@ -2,14 +2,14 @@
 
 declare(strict_types=1);
 
-namespace Sentry\SentryBundle\Command;
+namespace Sentry\SentryBundle\Tests\End2End\App\Command;
 
 use Psr\Log\LoggerInterface;
 use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Output\OutputInterface;
 
-class SentryBreadcrumbTestCommand extends Command
+class BreadcrumbTestCommand extends Command
 {
     /**
      * @var LoggerInterface
@@ -18,13 +18,13 @@ class SentryBreadcrumbTestCommand extends Command
 
     public function __construct(LoggerInterface $logger)
     {
-        parent::__construct('sentry:breadcrumb:test');
+        parent::__construct();
         $this->logger = $logger;
     }
 
     protected function execute(InputInterface $input, OutputInterface $output): int
     {
-        $this->logger->error('Breadcrumb error log line');
+        $this->logger->error('breadcrumb 1 error');
 
         throw new \RuntimeException('Breadcrumb error');
     }

…/Command/SentryBreadcrumbTestCommand.php …nd/App/Command/BreadcrumbTestCommand.phpsrc/Command/SentryBreadcrumbTestCommand.php renamed to tests/End2End/App/Command/BreadcrumbTestCommand.php src/Command/SentryBreadcrumbTestCommand.php renamed to tests/End2End/App/Command/BreadcrumbTestCommand.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace Sentry\SentryBundle\Command;
+namespace Sentry\SentryBundle\Tests\End2End\App\Command;
 
 use Psr\Log\LoggerInterface;
 use Symfony\Component\Console\Command\Command;
@@ -11,34 +11,28 @@
 use Symfony\Component\Console\Output\NullOutput;
 use Symfony\Component\Console\Output\OutputInterface;
 
-class SentrySubcommandTestCommand extends Command
+class CrashingSubcommandTestCommand extends Command
 {
     /**
      * @var LoggerInterface
      */
     private $logger;
 
-    /**
-     * @var Command
-     */
-    private $subcommand;
-
-    public function __construct(LoggerInterface $logger, Command $subcommand)
+    public function __construct(LoggerInterface $logger)
     {
-        parent::__construct('sentry:subcommand:test');
+        parent::__construct();
         $this->logger = $logger;
-        $this->subcommand = $subcommand;
     }
 
     protected function execute(InputInterface $input, OutputInterface $output): int
     {
-        $this->logger->error('Subcommand will run now');
+        $this->logger->error('subcommand crash 1 error');
 
         if (null !== $this->getApplication()) {
-            $this->getApplication()->doRun(new ArrayInput(['command' => $this->subcommand->getName()]), new NullOutput());
+            $this->getApplication()->doRun(new ArrayInput(['command' => "sentry:breadcrumb:test"]), new NullOutput());
         }
 
-        $this->logger->error('Breadcrumb after subcommand');
+        $this->logger->error('subcommand error 2 error');
 
         return 0;
     }