Merge pull request #9 from flownative/7-method-signature-doesnt-match…

…-to-abstractexceptionhandler-anymore Adjust to changed signature of echoExceptionCli()
flownative · Jun 8, 2022 · f9d95d8 · f9d95d8
2 parents a816e2e + a055203
commit f9d95d8
Show file tree

Hide file tree

Showing 4 changed files with 71 additions and 47 deletions.
diff --git a/Classes/Exception/DebugExceptionHandler.php b/Classes/Exception/DebugExceptionHandler.php
@@ -14,37 +14,46 @@
  */
 
 use Flownative\Sentry\SentryClientTrait;
-use Throwable;
+use Neos\Flow\Log\ThrowableStorageInterface;
 
-class DebugExceptionHandler extends \Neos\Flow\Error\DebugExceptionHandler
+final class DebugExceptionHandler extends \Neos\Flow\Error\DebugExceptionHandler
 {
     use SentryClientTrait;
 
     /**
-     * @param Throwable $exception
+     * Handles the given exception
+     *
+     * @param \Throwable $exception The exception object
+     * @return void
      */
-    public function echoExceptionWeb($exception): void
+    public function handleException($exception)
     {
-        try {
-            if ($sentryClient = self::getSentryClient()) {
-                $sentryClient->captureThrowable($exception);
-            }
-        } catch (\Throwable $e) {
+        // Ignore if the error is suppressed by using the shut-up operator @
+        if (error_reporting() === 0) {
+            return;
+        }
+
+        $this->renderingOptions = $this->resolveCustomRenderingOptions($exception);
+
+        $exceptionWasLogged = false;
+        if ($this->throwableStorage instanceof ThrowableStorageInterface && isset($this->renderingOptions['logException']) && $this->renderingOptions['logException']) {
+            $message = $this->throwableStorage->logThrowable($exception);
+            $this->logger->critical($message);
+            $exceptionWasLogged = true;
         }
-        parent::echoExceptionWeb($exception);
-    }
 
-    /**
-     * @param Throwable $exception
-     */
-    public function echoExceptionCli(Throwable $exception): void
-    {
         try {
             if ($sentryClient = self::getSentryClient()) {
                 $sentryClient->captureThrowable($exception);
             }
         } catch (\Throwable $e) {
         }
-        parent::echoExceptionCli($exception);
+
+        if (PHP_SAPI === 'cli') {
+            # Doesn't return:
+            $this->echoExceptionCli($exception, $exceptionWasLogged);
+        } else {
+            $this->echoExceptionWeb($exception);
+        }
     }
 }
diff --git a/Classes/Exception/ProductionExceptionHandler.php b/Classes/Exception/ProductionExceptionHandler.php
@@ -14,38 +14,50 @@
  */
 
 use Flownative\Sentry\SentryClientTrait;
-use Throwable;
+use Neos\Flow\Log\ThrowableStorageInterface;
 
 class ProductionExceptionHandler extends \Neos\Flow\Error\ProductionExceptionHandler
 {
     use SentryClientTrait;
 
     /**
-     * @param Throwable $exception
+     * Handles the given exception
+     *
+     * @param \Throwable $exception The exception object
+     * @return void
      */
-    public function echoExceptionWeb($exception): void
+    public function handleException($exception)
     {
-        try {
-            if ($sentryClient = self::getSentryClient()) {
-                $sentryClient->captureThrowable($exception);
-            }
-        } catch (\Throwable $e) {
+        // Ignore if the error is suppressed by using the shut-up operator @
+        if (error_reporting() === 0) {
+            return;
         }
-        parent::echoExceptionWeb($exception);
-    }
 
-    /**
-     * @param Throwable $exception
-     */
-    public function echoExceptionCli(Throwable $exception): void
-    {
-        try {
-            if ($sentryClient = self::getSentryClient()) {
-                $sentryClient->captureThrowable($exception);
-            }
-        } catch (\Throwable $e) {
+        $this->renderingOptions = $this->resolveCustomRenderingOptions($exception);
+
+        if ($this->throwableStorage instanceof ThrowableStorageInterface && isset($this->renderingOptions['logException']) && $this->renderingOptions['logException']) {
+            $message = $this->throwableStorage->logThrowable($exception);
+            $this->logger->critical($message);
         }
-        parent::echoExceptionCli($exception);
-    }
 
+        switch (PHP_SAPI) {
+            case 'cli':
+                try {
+                    if ($sentryClient = self::getSentryClient()) {
+                        $sentryClient->captureThrowable($exception);
+                    }
+                } catch (\Throwable $e) {
+                }
+                echo $this->buildView($exception, $this->renderingOptions)->render();
+            break;
+            default:
+                try {
+                    if ($sentryClient = self::getSentryClient()) {
+                        $sentryClient->captureThrowable($exception);
+                    }
+                } catch (\Throwable $e) {
+                }
+                $this->echoExceptionWeb($exception);
+        }
+    }
 }
diff --git a/Classes/Log/SentryFileBackend.php b/Classes/Log/SentryFileBackend.php
@@ -27,15 +27,18 @@ class SentryFileBackend extends FileBackend
     private $capturingMessage = false;
 
     /**
-     * @param string $message
-     * @param int $severity
-     * @param null $additionalData
-     * @param null $packageKey
-     * @param null $className
-     * @param null $methodName
+     * Appends the given message along with the additional information into the log.
+     *
+     * @param string $message The message to log
+     * @param int $severity One of the LOG_* constants
+     * @param mixed $additionalData A variable containing more information about the event to be logged
+     * @param string|null $packageKey Key of the package triggering the log (determined automatically if not specified)
+     * @param string|null $className Name of the class triggering the log (determined automatically if not specified)
+     * @param string|null $methodName Name of the method triggering the log (determined automatically if not specified)
      * @return void
+     * @api
      */
-    public function append($message, $severity = LOG_INFO, $additionalData = null, $packageKey = null, $className = null, $methodName = null): void
+    public function append(string $message, int $severity = LOG_INFO, $additionalData = null, string $packageKey = null, string $className = null, string $methodName = null): void
     {
         if ($this->capturingMessage) {
             return;

diff --git a/Classes/SentryClient.php b/Classes/SentryClient.php
@@ -223,7 +223,7 @@ public function captureThrowable(Throwable $throwable, array $extraData = [], ar
             $this->logger->log(
                 ($captureException ? LogLevel::CRITICAL : LogLevel::NOTICE),
                 sprintf(
-                    'Exception %s: %s (Ref: %s | Sentry: %s)',
+                    'Exception #%s: %s (Ref: %s | Sentry: %s)',
                     $throwable->getCode(),
                     $throwable->getMessage(),
                     ($throwable instanceof WithReferenceCodeInterface ? $throwable->getReferenceCode() : '-'),