Return JSON for InternalServerErrors

README.md

@@ -41,6 +41,30 @@ REST_FRAMEWORK = {
 }
 ```
 
+### 5XX
+
+You need to add `json_internal_server_error_middleware` to your `MIDDLEWARES` for having JSON 5XXs.
+
+```
+MIDDLEWARE = [
+    ..
+    'hipo_drf_exceptions.middlewares.json_internal_server_error_middleware',
+]
+```
+
+### Settings
+
+```json
+HIPO_DRF_EXCEPTIONS_SETTINGS = {
+  "INTERNAL_SERVER_ERROR_FALLBACK_MESSAGE": "Something is technically wrong."
+}
+```
+
+- `INTERNAL_SERVER_ERROR_FALLBACK_MESSAGE` *optional*
+
+default: `'Our servers are unreachable at the moment. Please try again a few minutes later.'`
+
+
 ### Example Error Responses
 
 #### Field Error

hipo_drf_exceptions/exceptions.py

@@ -1,7 +1,13 @@
 from rest_framework.exceptions import APIException
-from rest_framework.status import HTTP_400_BAD_REQUEST
+from rest_framework.status import HTTP_400_BAD_REQUEST, HTTP_500_INTERNAL_SERVER_ERROR
+
+from hipo_drf_exceptions import settings
 
 
 class BaseAPIException(APIException):
     status_code = HTTP_400_BAD_REQUEST
 
+
+class InternalServerError(APIException):
+    status_code = HTTP_500_INTERNAL_SERVER_ERROR
+    default_detail = settings.INTERNAL_SERVER_ERROR_FALLBACK_MESSAGE

hipo_drf_exceptions/middlewares.py

@@ -0,0 +1,15 @@
+from hipo_drf_exceptions import handler
+from hipo_drf_exceptions.exceptions import InternalServerError
+
+
+def json_internal_server_error_middleware(get_response):
+
+    def middleware(request):
+        json_content_type = "application/json"
+        response = get_response(request)
+
+        if str(response.status_code).startswith("5") and request.content_type == json_content_type:
+            response = handler(InternalServerError(), {})
+        return response
+
+    return middleware

hipo_drf_exceptions/settings.py

@@ -0,0 +1,9 @@
+from django.conf import settings as django_settings
+from django.utils.translation import gettext_lazy as _
+
+HIPO_DRF_EXCEPTIONS_SETTINGS = getattr(django_settings, "HIPO_DRF_EXCEPTIONS_SETTINGS", {})
+
+INTERNAL_SERVER_ERROR_FALLBACK_MESSAGE = HIPO_DRF_EXCEPTIONS_SETTINGS.get(
+    "INTERNAL_SERVER_ERROR_FALLBACK_MESSAGE",
+    _('Our servers are unreachable at the moment. Please try again a few minutes later.')
+)