Catch errors thrown from commands (#186)

Author: indykoning

Model/SentryPerformance.php

@@ -21,6 +21,7 @@
 use Sentry\Tracing\Transaction;
 use Sentry\Tracing\TransactionContext;
 use Sentry\Tracing\TransactionSource;
+use Symfony\Component\Console\Command\Command;
 use Throwable;
 
 use function Sentry\startTransaction;
@@ -49,11 +50,11 @@ public function __construct(
     /**
      * Starts a new transaction.
      *
-     * @param AppInterface $app
+     * @param Command|AppInterface $app
      *
      * @return void
      */
-    public function startTransaction(AppInterface $app): void
+    public function startTransaction(Command|AppInterface $app): void
     {
         if (!$app instanceof Http) {
             // We only support profiling of http requests right now.

Plugin/GlobalExceptionCatcher.php

@@ -13,10 +13,19 @@
 use Magento\Framework\DataObjectFactory;
 use Magento\Framework\Event\ManagerInterface as EventManagerInterface;
 use Sentry\Integration\IntegrationInterface;
+use Symfony\Component\Console\Command\Command;
 use Throwable;
 
+/**
+ * Catch all uncaught exceptions globally, and send them to Sentry.
+ *
+ * It wraps the launch and run methods of the application and command classes.
+ */
 class GlobalExceptionCatcher
 {
+    /** @var bool Whether the globalExceptionHandler is already attached */
+    private bool $booted = false;
+
     /**
      * GlobalExceptionCatcher constructor.
      *
@@ -42,13 +51,56 @@ public function __construct(
      *
      * @param AppInterface $subject
      * @param callable     $proceed
+     * @param mixed        $args
      *
      * @return \Magento\Framework\App\ResponseInterface
      */
-    public function aroundLaunch(AppInterface $subject, callable $proceed)
+    public function aroundLaunch(AppInterface $subject, callable $proceed, ...$args)
+    {
+        return $this->globalCatcher(
+            $subject,
+            $proceed,
+            ...$args
+        );
+    }
+
+    /**
+     * Wrap command run, start watching for exceptions.
+     *
+     * @param Command  $subject
+     * @param callable $proceed
+     * @param mixed    $args
+     *
+     * @return int
+     */
+    public function aroundRun(Command $subject, callable $proceed, ...$args)
+    {
+        return $this->globalCatcher(
+            $subject,
+            $proceed,
+            ...$args
+        );
+    }
+
+    /**
+     * Catch anything coming out of the proceed function.
+     *
+     * @param mixed    $subject
+     * @param callable $proceed
+     * @param mixed    $args
+     *
+     * @return mixed
+     */
+    public function globalCatcher($subject, $proceed, ...$args)
     {
+        if ($this->booted) {
+            return $proceed(...$args);
+        }
+
+        $this->booted = true;
+
         if ((!$this->sentryHelper->isActive()) || (!$this->sentryHelper->isPhpTrackingEnabled())) {
-            return $proceed();
+            return $proceed(...$args);
         }
 
         $config = $this->prepareConfig();
@@ -57,7 +109,7 @@ public function aroundLaunch(AppInterface $subject, callable $proceed)
         $this->sentryPerformance->startTransaction($subject);
 
         try {
-            return $response = $proceed();
+            return $response = $proceed(...$args);
         } catch (Throwable $exception) {
             $this->sentryInteraction->captureException($exception);
 

etc/di.xml

@@ -7,6 +7,10 @@
         <plugin disabled="false" name="GlobalExceptionCatcher" type="JustBetter\Sentry\Plugin\GlobalExceptionCatcher"
                 sortOrder="0"/>
     </type>
+    <type name="Symfony\Component\Console\Command\Command">
+        <plugin disabled="false" name="CliExceptionCatcher" type="JustBetter\Sentry\Plugin\GlobalExceptionCatcher"
+                sortOrder="0"/>
+    </type>
 
     <type name="Magento\Customer\CustomerData\Customer">
         <plugin name="LogrocketCustomerInfo" type="JustBetter\Sentry\Plugin\LogrocketCustomerInfo"
@@ -20,7 +24,7 @@
             </argument>
         </arguments>
     </type>
-        
+
     <type name="JustBetter\Sentry\Model\SentryLog">
         <arguments>
             <argument name="customerSession" xsi:type="object">Magento\Customer\Model\Session\Proxy</argument>