(chore) Add api fallback exception handler. (#430)

Signed-off-by: Joe Shimkus <[email protected]>

src/aap_eda/api/exceptions.py

@@ -11,6 +11,7 @@
 #  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 #  See the License for the specific language governing permissions and
 #  limitations under the License.
+from django.conf import settings
 from django.utils.translation import gettext_lazy as _
 from rest_framework import status
 from rest_framework.exceptions import (
@@ -20,6 +21,8 @@
     NotFound,
     PermissionDenied,
 )
+from rest_framework.response import Response
+from rest_framework.views import exception_handler
 
 __all__ = (
     "AuthenticationFailed",
@@ -29,9 +32,26 @@
     "Conflict",
     "Unprocessable",
     "PermissionDenied",
+    "api_fallback_handler",
 )
 
 
+def api_fallback_handler(exc, context):
+    response = exception_handler(exc, context)
+    if (response is None) and (not settings.DEBUG):
+        response = Response(
+            status=status.HTTP_500_INTERNAL_SERVER_ERROR,
+            data={
+                "detail": (
+                    "Unexpected server error"
+                    "; contact your system administrator"
+                )
+            },
+        )
+        response["context"] = context
+    return response
+
+
 class BadRequest(APIException):
     status = status.HTTP_400_BAD_REQUEST
     default_code = "bad_request"

src/aap_eda/settings/default.py

@@ -238,6 +238,7 @@ def _get_secret_key() -> str:
         "aap_eda.api.permissions.RoleBasedPermission",
     ],
     "TEST_REQUEST_DEFAULT_FORMAT": "json",
+    "EXCEPTION_HANDLER": "aap_eda.api.exceptions.api_fallback_handler",
 }
 
 # ---------------------------------------------------------

tests/integration/api/test_fallback_handler.py

@@ -0,0 +1,38 @@
+from unittest import mock
+
+import pytest
+from rest_framework import status
+from rest_framework.test import APIClient
+
+from tests.integration.constants import api_url_v1
+
+
+class FallbackException(Exception):
+    pass
+
+
+def raise_exception(self, request):
+    raise FallbackException
+
+
+@pytest.mark.django_db
+@mock.patch(
+    "aap_eda.api.views.project.ProjectViewSet.list", new=raise_exception
+)
+def test_debug_unexpected_exception(client: APIClient, settings):
+    settings.DEBUG = True
+    with pytest.raises(FallbackException):
+        client.get(f"{api_url_v1}/projects/")
+
+
+@pytest.mark.django_db
+@mock.patch(
+    "aap_eda.api.views.project.ProjectViewSet.list", new=raise_exception
+)
+def test_non_debug_unexpected_exception(client: APIClient, settings):
+    settings.DEBUG = False
+    response = client.get(f"{api_url_v1}/projects/")
+    assert response.status_code == status.HTTP_500_INTERNAL_SERVER_ERROR
+
+    data = response.json()
+    assert data["detail"].startswith("Unexpected server error")