Use throwable instead of exception (#31)

* Use throwable instead of exception * Use correct namespace * Remove superfloous typehinting * Use FQCN for Throwable * Added changelog
gmponos · Jul 5, 2020 · 8f355d9 · 8f355d9
1 parent 64a67a6
commit 8f355d9
Show file tree

Hide file tree

Showing 9 changed files with 47 additions and 56 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,21 @@
 
 All Notable changes to `gmponos/guzzle_logger` will be documented in this file
 
+## 2.0.0 - 2020-07-05
+
+### Changed
+- [BC] Changed the signature of `HandlerInterface::log` to allow Throwables. Now the signature is
+```php
+HandlerInterface::log(
+    LoggerInterface $logger,
+    RequestInterface $request,
+    ?ResponseInterface $response = null,
+    ?Throwable $exception = null,
+    ?TransferStats $stats = null,
+    array $options = []
+)
+```
+
 ## 1.1.0 - 2019-09-03
 
 ### Added

diff --git a/README.md b/README.md
@@ -80,10 +80,10 @@ final class SimpleHandler implements HandlerInterface
     public function log(
         LoggerInterface $logger,
         RequestInterface $request,
-        ?ResponseInterface $response,
-        ?\Exception $exception,
-        ?TransferStats $stats,
-        array $options
+        ?ResponseInterface $response = null,
+        ?\Throwable $exception = null,
+        ?TransferStats $stats = null,
+        array $options = []
     ): void {
         $logger->debug('Guzzle HTTP request: ' . \GuzzleHttp\Psr7\str($request));
         return;

diff --git a/src/Handler/HandlerInterface.php b/src/Handler/HandlerInterface.php
@@ -4,15 +4,15 @@
 
 namespace GuzzleLogMiddleware\Handler;
 
-use Exception;
 use GuzzleHttp\TransferStats;
 use Psr\Http\Message\RequestInterface;
 use Psr\Http\Message\ResponseInterface;
 use Psr\Log\LoggerInterface;
+use Throwable;
 
 /**
  * Classes that will implement this interface are responsible
- * to log the MessageInterface|\Exception|TransferStats that are
+ * to log the MessageInterface|\Throwable|TransferStats that are
  * passed as values.
  *
  * @author George Mponos <gmponos@gmail.com>
@@ -22,9 +22,9 @@ interface HandlerInterface
     public function log(
         LoggerInterface $logger,
         RequestInterface $request,
-        ?ResponseInterface $response,
-        ?Exception $exception,
-        ?TransferStats $stats,
-        array $options
+        ?ResponseInterface $response = null,
+        ?Throwable $exception = null,
+        ?TransferStats $stats = null,
+        array $options = []
     ): void;
 }
diff --git a/src/Handler/LogLevelStrategy/FixedStrategy.php b/src/Handler/LogLevelStrategy/FixedStrategy.php
@@ -56,16 +56,15 @@ public function __construct(
     /**
      * Returns the log level.
      *
-     * @param MessageInterface|\Exception|TransferStats $value
-     * @param array $options
+     * @param MessageInterface|\Throwable|TransferStats $value
      */
     public function getLevel($value, array $options): string
     {
         if ($value instanceof RequestException) {
             return $this->defaultLevel;
         }
 
-        if ($value instanceof \Exception) {
+        if ($value instanceof \Throwable) {
             return $this->exceptionLevel;
         }
 

diff --git a/src/Handler/LogLevelStrategy/LogLevelStrategyInterface.php b/src/Handler/LogLevelStrategy/LogLevelStrategyInterface.php
@@ -30,9 +30,7 @@ interface LogLevelStrategyInterface
     /**
      * Returns the log level.
      *
-     * @param MessageInterface|\Exception|TransferStats $value
-     * @param array $options
-     * @return string The LogLevel
+     * @param MessageInterface|\Throwable|TransferStats $value
      */
     public function getLevel($value, array $options): string;
 }
diff --git a/src/Handler/LogLevelStrategy/StatusCodeStrategy.php b/src/Handler/LogLevelStrategy/StatusCodeStrategy.php
@@ -4,8 +4,6 @@
 
 namespace GuzzleLogMiddleware\Handler\LogLevelStrategy;
 
-use GuzzleHttp\TransferStats;
-use Psr\Http\Message\RequestInterface;
 use Psr\Http\Message\ResponseInterface;
 use Psr\Log\LogLevel;
 
@@ -53,7 +51,7 @@ public function setLevel(int $statusCode, string $level): void
     public function getLevel($value, array $options): string
     {
         $this->setOptions($options);
-        if ($value instanceof \Exception) {
+        if ($value instanceof \Throwable) {
             return $this->exceptionLevel;
         }
 

diff --git a/src/Handler/LogLevelStrategy/ThresholdStrategy.php b/src/Handler/LogLevelStrategy/ThresholdStrategy.php
@@ -57,7 +57,6 @@ final class ThresholdStrategy implements LogLevelStrategyInterface
      *
      * @param array $thresholds An array of thresholds.
      * @param string $defaultLevel The that will be used for the requests and as a default one.
-     * @param string $exceptionLevel
      */
     public function __construct(
         array $thresholds = [],
@@ -71,7 +70,7 @@ public function __construct(
 
     public function getLevel($value, array $options): string
     {
-        if ($value instanceof \Exception) {
+        if ($value instanceof \Throwable) {
             return $this->exceptionLevel;
         }
 

diff --git a/src/Handler/MultiRecordArrayHandler.php b/src/Handler/MultiRecordArrayHandler.php
@@ -4,13 +4,13 @@
 
 namespace GuzzleLogMiddleware\Handler;
 
-use Exception;
 use GuzzleHttp\TransferStats;
 use GuzzleLogMiddleware\Handler\LogLevelStrategy\LogLevelStrategyInterface;
 use Psr\Http\Message\MessageInterface;
 use Psr\Http\Message\RequestInterface;
 use Psr\Http\Message\ResponseInterface;
 use Psr\Log\LoggerInterface;
+use Throwable;
 
 /**
  * @author George Mponos <gmponos@gmail.com>
@@ -28,12 +28,14 @@ final class MultiRecordArrayHandler extends AbstractHandler
     private $summarySize;
 
     /**
-     * @param LogLevelStrategyInterface|null $logLevelStrategy
      * @param int $truncateSize If the body of the request/response is greater than the size of this integer the body will be truncated
      * @param int $summarySize The size to use for the summary of a truncated body
      */
-    public function __construct(LogLevelStrategyInterface $logLevelStrategy = null, int $truncateSize = 3500, int $summarySize = 200)
-    {
+    public function __construct(
+        LogLevelStrategyInterface $logLevelStrategy = null,
+        int $truncateSize = 3500,
+        int $summarySize = 200
+    ) {
         $this->logLevelStrategy = $logLevelStrategy === null ? $this->getDefaultStrategy() : $logLevelStrategy;
         $this->truncateSize = $truncateSize;
         $this->summarySize = $summarySize;
@@ -42,10 +44,10 @@ public function __construct(LogLevelStrategyInterface $logLevelStrategy = null,
     public function log(
         LoggerInterface $logger,
         RequestInterface $request,
-        ?ResponseInterface $response,
-        ?Exception $exception,
-        ?TransferStats $stats,
-        array $options
+        ?ResponseInterface $response = null,
+        ?Throwable $exception = null,
+        ?TransferStats $stats = null,
+        array $options = []
     ): void {
         $this->logRequest($logger, $request, $options);
 
@@ -75,12 +77,6 @@ private function logRequest(LoggerInterface $logger, RequestInterface $request,
         $logger->log($level, 'Guzzle HTTP request', $context);
     }
 
-    /**
-     * @param LoggerInterface $logger
-     * @param ResponseInterface $response
-     * @param array $options
-     * @return void
-     */
     private function logResponse(LoggerInterface $logger, ResponseInterface $response, array $options): void
     {
         $context['response']['headers'] = $response->getHeaders();
@@ -96,13 +92,7 @@ private function logResponse(LoggerInterface $logger, ResponseInterface $respons
         $logger->log($level, 'Guzzle HTTP response', $context);
     }
 
-    /**
-     * @param LoggerInterface $logger
-     * @param Exception|null $exception
-     * @param array $options
-     * @return void
-     */
-    private function logReason(LoggerInterface $logger, ?Exception $exception, array $options): void
+    private function logReason(LoggerInterface $logger, ?Throwable $exception, array $options): void
     {
         if ($exception === null) {
             return;
@@ -117,12 +107,6 @@ private function logReason(LoggerInterface $logger, ?Exception $exception, array
         $logger->log($level, 'Guzzle HTTP exception', $context);
     }
 
-    /**
-     * @param LoggerInterface $logger
-     * @param TransferStats $stats
-     * @param array $options
-     * @return void
-     */
     private function logStats(LoggerInterface $logger, TransferStats $stats, array $options): void
     {
         $this->logLevelStrategy->getLevel($stats, $options);
@@ -133,8 +117,6 @@ private function logStats(LoggerInterface $logger, TransferStats $stats, array $
     }
 
     /**
-     * @param MessageInterface $message
-     * @param array $options
      * @return string|array
      */
     private function formatBody(MessageInterface $message, array $options)

diff --git a/src/Handler/StringHandler.php b/src/Handler/StringHandler.php
@@ -4,12 +4,12 @@
 
 namespace GuzzleLogMiddleware\Handler;
 
-use Exception;
 use GuzzleHttp\TransferStats;
 use GuzzleLogMiddleware\Handler\LogLevelStrategy\LogLevelStrategyInterface;
 use Psr\Http\Message\RequestInterface;
 use Psr\Http\Message\ResponseInterface;
 use Psr\Log\LoggerInterface;
+use Throwable;
 
 /**
  * @author George Mponos <gmponos@gmail.com>
@@ -24,10 +24,10 @@ public function __construct(LogLevelStrategyInterface $logLevelStrategy = null)
     public function log(
         LoggerInterface $logger,
         RequestInterface $request,
-        ?ResponseInterface $response,
-        ?Exception $exception,
-        ?TransferStats $stats,
-        array $options
+        ?ResponseInterface $response = null,
+        ?Throwable $exception = null,
+        ?TransferStats $stats = null,
+        array $options = []
     ): void {
         $this->logRequest($logger, $request, $options);
 
@@ -73,7 +73,7 @@ private function logResponse(LoggerInterface $logger, ResponseInterface $value,
         $logger->log($level, 'Guzzle HTTP response:' . "\n" . $str);
     }
 
-    private function logReason(LoggerInterface $logger, Exception $exception, array $options): void
+    private function logReason(LoggerInterface $logger, Throwable $exception, array $options): void
     {
         $level = $this->logLevelStrategy->getLevel($exception, $options);
         $logger->log($level, sprintf('Guzzle HTTP exception: %s', $exception->getMessage()), [