π₯π₯π₯ Open-source Jira, Linear, Monday, and ClickUp alternative. Plane is a modern project management platform to manage tasks, sprints, docs, and triage.
TypeScript boardsbug-trackerdjangodockerganttissue-trackerjirajira-alternativekanbanlinearpostgresqlproduct-managementproject-managementproject-planningpythonreactredistypesciptvitework-management
[GIT-213] fix: return HTTP response from dispatch() exception handler (#9179)
sriram veeraghanta011328c79300
diff --git a/apps/api/plane/api/views/base.py b/apps/api/plane/api/views/base.pyindex 2fb20c8d17..11e0b5a621 100644--- a/apps/api/plane/api/views/base.py+++ b/apps/api/plane/api/views/base.py@@ -110,7 +110,7 @@ class BaseAPIView(TimezoneMixin, GenericAPIView, ReadReplicaControlMixin, BasePareturn responseexcept Exception as exc:response = self.handle_exception(exc)- return exc+ return responsedef finalize_response(self, request, response, *args, **kwargs):# Call super to get the default responsediff --git a/apps/api/plane/app/views/base.py b/apps/api/plane/app/views/base.pyindex db5469de58..798845b22b 100644--- a/apps/api/plane/app/views/base.py+++ b/apps/api/plane/app/views/base.py@@ -120,7 +120,7 @@ class BaseViewSet(TimezoneMixin, ReadReplicaControlMixin, ModelViewSet, BasePagireturn responseexcept Exception as exc:response = self.handle_exception(exc)- return exc+ return response@propertydef workspace_slug(self):@@ -215,7 +215,7 @@ class BaseAPIView(TimezoneMixin, ReadReplicaControlMixin, APIView, BasePaginatorexcept Exception as exc:response = self.handle_exception(exc)- return exc+ return response@propertydef workspace_slug(self):diff --git a/apps/api/plane/license/api/views/base.py b/apps/api/plane/license/api/views/base.pyindex 8d0d39ac38..ea404dd4f3 100644--- a/apps/api/plane/license/api/views/base.py+++ b/apps/api/plane/license/api/views/base.py@@ -106,7 +106,7 @@ class BaseAPIView(TimezoneMixin, APIView, BasePaginator):except Exception as exc:response = self.handle_exception(exc)- return exc+ return response@propertydef fields(self):diff --git a/apps/api/plane/space/views/base.py b/apps/api/plane/space/views/base.pyindex cf8cdbdc5c..fea0a873d9 100644--- a/apps/api/plane/space/views/base.py+++ b/apps/api/plane/space/views/base.py@@ -114,7 +114,7 @@ class BaseViewSet(TimezoneMixin, ModelViewSet, BasePaginator):return responseexcept Exception as exc:response = self.handle_exception(exc)- return exc+ return response@propertydef workspace_slug(self):@@ -197,7 +197,7 @@ class BaseAPIView(TimezoneMixin, APIView, BasePaginator):except Exception as exc:response = self.handle_exception(exc)- return exc+ return response@propertydef workspace_slug(self):diff --git a/apps/api/plane/tests/unit/views/__init__.py b/apps/api/plane/tests/unit/views/__init__.pynew file mode 100644index 0000000000..fcc34a703d--- /dev/null+++ b/apps/api/plane/tests/unit/views/__init__.py@@ -0,0 +1,3 @@+# Copyright (c) 2023-present Plane Software, Inc. and contributors+# SPDX-License-Identifier: AGPL-3.0-only+# See the LICENSE file for details.diff --git a/apps/api/plane/tests/unit/views/test_base_dispatch.py b/apps/api/plane/tests/unit/views/test_base_dispatch.pynew file mode 100644index 0000000000..22e390dce5--- /dev/null+++ b/apps/api/plane/tests/unit/views/test_base_dispatch.py@@ -0,0 +1,69 @@+# Copyright (c) 2023-present Plane Software, Inc. and contributors+# SPDX-License-Identifier: AGPL-3.0-only+# See the LICENSE file for details.++"""+Regression tests for the ``dispatch()`` exception handling on the shared+``BaseAPIView`` / ``BaseViewSet`` classes.++When ``super().dispatch()`` raises an unhandled exception, ``dispatch()`` must+return the HTTP ``Response`` produced by ``handle_exception()`` -- not the raw+exception object. Returning the exception causes Django's response pipeline to+fail with ``TypeError: 'Exception' object is not a valid HTTP response``.++See: https://github.com/makeplane/plane/issues/9157+"""++import pytest+from unittest.mock import patch++from rest_framework import status+from rest_framework.response import Response+from rest_framework.test import APIRequestFactory++from plane.api.views.base import BaseAPIView as ApiBaseAPIView, BaseViewSet as ApiBaseViewSet+from plane.app.views.base import BaseAPIView as AppBaseAPIView, BaseViewSet as AppBaseViewSet+from plane.license.api.views.base import BaseAPIView as LicenseBaseAPIView+from plane.space.views.base import BaseAPIView as SpaceBaseAPIView, BaseViewSet as SpaceBaseViewSet+++# Every shared base view that wraps ``super().dispatch()`` in a try/except.+VIEW_CLASSES = [+ ApiBaseAPIView,+ ApiBaseViewSet,+ AppBaseAPIView,+ AppBaseViewSet,+ LicenseBaseAPIView,+ SpaceBaseAPIView,+ SpaceBaseViewSet,+]+++ "view_class",+ VIEW_CLASSES,+ ids=lambda c: f"{c.__module__}.{c.__name__}",+)+def test_dispatch_returns_response_when_super_dispatch_raises(view_class):+ """dispatch() must return handle_exception()'s Response, not the exception."""+ request = APIRequestFactory().get("/api/test/")+ view = view_class()++ sentinel = Response(+ {"error": "Something went wrong please try again later"},+ status=status.HTTP_500_INTERNAL_SERVER_ERROR,+ )++ with (+ patch("rest_framework.views.APIView.dispatch", side_effect=RuntimeError("boom")),+ patch.object(view_class, "handle_exception", return_value=sentinel) as mock_handle,+ ):+ result = view.dispatch(request)++ mock_handle.assert_called_once()+ assert isinstance(result, Response), (+ f"{view_class.__module__}.{view_class.__name__}.dispatch() returned "+ f"{type(result).__name__} instead of an HTTP Response"+ )+ assert result is sentinel