Merge pull request '# Improve exception reporting for API' (#515) from improve_exception_reporting into master

Reviewed-on: #515

api/tests/v1/create/test_api_create.py

@@ -71,7 +71,7 @@ class APIV1CreateTestCase(BaseAPIV1TestCase):
         # Expect this first request to fail, since user has no shared access on the intervention, we want to create
         # a compensation for
         response = self._run_create_request(url, post_body)
-        self.assertEqual(response.status_code, 500, msg=response.content)
+        self.assertEqual(response.status_code, 400, msg=response.content)
         content = json.loads(response.content)
         self.assertGreater(len(content.get("errors", [])), 0, msg=response.content)
 

api/views/v1/views.py

@@ -6,7 +6,9 @@ Created on: 21.01.22
 
 """
 import json
+from json import JSONDecodeError
 
+from django.core.exceptions import ObjectDoesNotExist
 from django.http import JsonResponse, HttpRequest
 
 from api.utils.serializer.v1.compensation import CompensationAPISerializerV1
@@ -66,8 +68,12 @@ class AbstractAPIViewV1(AbstractAPIView):
             body = request.body.decode("utf-8")
             body = json.loads(body)
             created_id = self.serializer.create_model_from_json(body, self.user)
-        except Exception as e:
+        except (JSONDecodeError,
-            return self._return_error_response(e, 500)
+                AssertionError,
+                ValueError,
+                PermissionError,
+                ObjectDoesNotExist) as e:
+            return self._return_error_response(e, 400)
         return JsonResponse({"id": created_id})
 
     def put(self, request: HttpRequest, id=None):

api/views/views.py

@@ -81,9 +81,7 @@ class AbstractAPIView(View):
         Returns:
 
         """
-        content = [error.__str__()]
+        content = [f"{error.__class__.__name__}: {str(error)}"]
-        if hasattr(error, "messages"):
-            content = error.messages
         return JsonResponse(
             {
                 "errors": content

compensation/templates/compensation/detail/eco_account/includes/deductions.html

@@ -53,7 +53,7 @@
                 </td>
                 <td class="align-middle">
                     {% if deduction.intervention.recorded %}
-                        <em title="{% trans 'Recorded on' %} {{obj.recorded.timestamp}} {% trans 'by' %} {{obj.recorded.user}}" class='fas fa-bookmark registered-bookmark'></em>
+                        <em title="{% trans 'Recorded on' %} {{deduction.intervention.recorded.timestamp}} {% trans 'by' %} {{deduction.intervention.recorded.user}}" class='fas fa-bookmark registered-bookmark'></em>
                     {% else %}
                         <em title="{% trans 'Not recorded yet' %}" class='far fa-bookmark'></em>
                     {% endif %}

konova/forms/geometry_form.py

@@ -54,7 +54,7 @@ class SimpleGeomForm(BaseForm):
             geom = json.dumps(geojson)
         except AttributeError:
             # If no geometry exists for this form, we simply set the value to None and zoom to the maximum level
-            geom = ""
+            geom = json.dumps({})
             self.empty = True
 
         self.initialize_form_field("output", geom)
@@ -72,20 +72,12 @@ class SimpleGeomForm(BaseForm):
         self.initialize_form_field("output", json.dumps(submitted_data))
 
         # Get geojson from form for validity checking
-        geom = self.data.get("output", None)
+        geom = self.data.get("output", json.dumps({}))
-        geom_is_empty = geom is None or len(geom) == 0
+        geom = json.loads(geom)
-        if geom_is_empty:
-            # If no geometry has been submitted, we create an empty geometry object since
-            # an empty geometry is a valid geometry
-            self.cleaned_data["output"] = MultiPolygon(srid=DEFAULT_SRID_RLP).ewkt
-            return is_valid
 
         # Initialize features list with empty MultiPolygon, so that an empty input will result in a
         # proper empty MultiPolygon object
         features = []
-
-        # Prepare geometry for validity checks (create iterable dict)
-        geom = json.loads(geom)
         features_json = geom.get("features", [])
         accepted_ogr_types = [
             "Polygon",
@@ -141,6 +133,7 @@ class SimpleGeomForm(BaseForm):
         if features:
             form_geom = MultiPolygon(*features, srid=DEFAULT_SRID_RLP).unary_union
         else:
+            # If no features have been processed, this indicates an empty geometry - so we store an empty geometry
             form_geom = MultiPolygon(srid=DEFAULT_SRID_RLP)
 
         # Make sure to convert into a MultiPolygon. Relevant if a single Polygon is provided.

konova/models/geometry.py

@@ -407,7 +407,10 @@ class Geometry(BaseResource):
         """
         output_geom = input_geom
         if not isinstance(input_geom, MultiPolygon):
-            output_geom = MultiPolygon(input_geom, srid=DEFAULT_SRID_RLP)
+            try:
+                output_geom = MultiPolygon(input_geom, srid=DEFAULT_SRID_RLP)
+            except TypeError as e:
+                raise AssertionError(f"Only (Multi)Polygon allowed! Could not convert {input_geom.geom_type} to MultiPolygon")
         return output_geom
 
     @staticmethod

konova/utils/exception_reporter.py

@@ -5,6 +5,9 @@ Contact: ksp-servicestelle@sgdnord.rlp.de
 Created on: 11.12.23
 
 """
+import json
+from json import JSONDecodeError
+
 from django.views.debug import ExceptionReporter
 
 
@@ -30,7 +33,7 @@ class KonovaExceptionReporter(ExceptionReporter):
         """
         whitelist = [
             "is_email",
-            "unicdoe_hint",
+            "unicode_hint",
             "frames",
             "request",
             "user_str",
@@ -39,6 +42,8 @@ class KonovaExceptionReporter(ExceptionReporter):
             "raising_view_name",
             "exception_type",
             "exception_value",
+            "filtered_GET_items",
+            "filtered_POST_items",
         ]
         clean_data = dict()
         for entry in whitelist:
@@ -56,7 +61,28 @@ class KonovaExceptionReporter(ExceptionReporter):
         """
         tb_data = super().get_traceback_data()
 
+        return_data = tb_data
         if self.is_email:
-            tb_data = self._filter_traceback_data(tb_data)
+            filtered_data = dict()
+            filtered_data.update(self._filter_traceback_data(tb_data))
+            filtered_data.update(self._filter_POST_body(tb_data))
+            return_data = filtered_data
+        return return_data
 
-        return tb_data
+    def _filter_POST_body(self, tb_data: dict):
+        """ Filters POST body from traceback data
+
+        """
+        post_data = tb_data.get("request", None)
+        if post_data:
+            post_data = post_data.body
+            try:
+                post_data = json.loads(post_data)
+            except JSONDecodeError:
+                pass
+        post_data = {
+            "filtered_POST_items": [
+                ("body", post_data),
+            ]
+        }
+        return post_data