From a1741736c5b14af81e398d228e22d85de51d2c4b Mon Sep 17 00:00:00 2001
From: Frederick Muriuki Muriithi
Date: Tue, 30 Jan 2024 07:14:07 +0300
Subject: Add the traceback to the exceptions for display.

---
 gn3/errors.py | 24 +++++++++++++++++-------
 1 file changed, 17 insertions(+), 7 deletions(-)

diff --git a/gn3/errors.py b/gn3/errors.py
index cd707f3..ec0088d 100644
--- a/gn3/errors.py
+++ b/gn3/errors.py
@@ -1,32 +1,42 @@
 """Handle application level errors."""
+import traceback
+
 from sqlite3 import OperationalError
+from werkzeug.exceptions import NotFound
 from flask import Flask, jsonify, current_app
 from authlib.oauth2.rfc6749.errors import OAuth2Error
 
 from gn3.auth.authorisation.errors import AuthorisationError
 
+def add_trace(exc: Exception, jsonmsg: dict) -> dict:
+    """Add the traceback to the error handling object."""
+    return {
+        **jsonmsg,
+        "error-trace": "".join(traceback.format_exception(exc))
+    }
+
 def page_not_found(pnf):
     """Generic 404 handler."""
-    return jsonify({
+    return jsonify(add_trace(pnf, {
         "error": pnf.name,
         "error_description": pnf.description
-    }), 404
+    })), 404
 
 def handle_authorisation_error(exc: AuthorisationError):
     """Handle AuthorisationError if not handled anywhere else."""
     current_app.logger.error(exc)
-    return jsonify({
+    return jsonify(add_trace(exc, {
         "error": type(exc).__name__,
         "error_description": " :: ".join(exc.args)
-    }), exc.error_code
+    })), exc.error_code
 
 def handle_oauth2_errors(exc: OAuth2Error):
     """Handle OAuth2Error if not handled anywhere else."""
     current_app.logger.error(exc)
-    return jsonify({
+    return jsonify(add_trace(exc, {
         "error": exc.error,
         "error_description": exc.description,
-    }), exc.status_code
+    })), exc.status_code
 
 def handle_sqlite3_errors(exc: OperationalError):
     """Handle sqlite3 errors if not handled anywhere else."""
@@ -38,7 +48,7 @@ def handle_sqlite3_errors(exc: OperationalError):
 
 def register_error_handlers(app: Flask):
     """Register application-level error handlers."""
-    app.register_error_handler(404, page_not_found)
+    app.register_error_handler(NotFound, page_not_found)
     app.register_error_handler(OAuth2Error, handle_oauth2_errors)
     app.register_error_handler(OperationalError, handle_sqlite3_errors)
     app.register_error_handler(AuthorisationError, handle_authorisation_error)
-- 
cgit v1.2.3