chore: add logging to exception handler (#20)

Author: ricklambrechts

src/Services/ExceptionHandler.php

@@ -5,11 +5,18 @@
 namespace MinVWS\OpenIDConnectLaravel\Services;
 
 use Exception;
+use Illuminate\Http\Request;
 use Jumbojett\OpenIDConnectClientException;
+use Psr\Log\LoggerInterface;
 use Symfony\Component\HttpFoundation\Response;
 
 class ExceptionHandler implements ExceptionHandlerInterface
 {
+    public function __construct(
+        protected ?LoggerInterface $logger = null,
+    ) {
+    }
+
     public function handleExceptionWhileAuthenticate(OpenIDConnectClientException $exception): Response
     {
         if (str_starts_with($exception->getMessage(), 'Error: ')) {
@@ -20,6 +27,9 @@ public function handleExceptionWhileAuthenticate(OpenIDConnectClientException $e
             return $this->handleUnableToDetermineState($exception);
         }
 
+        $this->logger?->error('OIDC Exception occurred while authenticating', [
+            'exception' => $exception,
+        ]);
         return $this->defaultResponse($exception);
     }
 
@@ -30,11 +40,19 @@ public function handleExceptionWhileAuthenticate(OpenIDConnectClientException $e
      */
     public function handleExceptionWhileRequestUserInfo(OpenIDConnectClientException $exception): Response
     {
+        $this->logger?->error('OIDC Exception occurred while requesting user info', [
+            'exception' => $exception,
+        ]);
+
         return $this->defaultResponse($exception);
     }
 
     public function handleException(Exception $exception): Response
     {
+        $this->logger?->error('OIDC Generic exception occurred', [
+            'exception' => $exception,
+        ]);
+
         return $this->defaultResponseGenericException($exception);
     }
 
@@ -46,6 +64,11 @@ public function handleException(Exception $exception): Response
      */
     protected function handleRequestError(OpenIDConnectClientException $exception): Response
     {
+        $this->logger?->debug('OIDC Request error', [
+            'exception' => $exception,
+            'query' => $this->getRequest()?->query->all(),
+        ]);
+
         return $this->default400Response($exception);
     }
 
@@ -56,6 +79,10 @@ protected function handleRequestError(OpenIDConnectClientException $exception):
      */
     protected function handleUnableToDetermineState(OpenIDConnectClientException $exception): Response
     {
+        $this->logger?->debug('OIDC State in url does not match with session', [
+            'exception' => $exception,
+        ]);
+
         return $this->default400Response($exception);
     }
 
@@ -73,4 +100,14 @@ protected function default400Response(OpenIDConnectClientException $exception):
     {
         abort(400, $exception->getMessage());
     }
+
+    protected function getRequest(): ?Request
+    {
+        $request = request();
+        if (!($request instanceof Request)) {
+            return null;
+        }
+
+        return $request;
+    }
 }