add current_user_role to project details endpoint

Author: kelvin-muchiri

onadata/apps/api/tests/viewsets/test_project_viewset.py

@@ -61,6 +61,7 @@
 from onadata.libs.serializers.metadata_serializer import MetaDataSerializer
 from onadata.libs.serializers.project_serializer import (
     BaseProjectSerializer,
+    ProjectPrivateSerializer,
     ProjectSerializer,
 )
 from onadata.libs.utils.cache_tools import PROJ_OWNER_CACHE, safe_key
@@ -309,11 +310,14 @@ def test_projects_get(self):
         self.assertEqual(response.status_code, 200)
 
         # test serialized data
-        serializer = ProjectSerializer(self.project, context={"request": request})
-        self.assertEqual(response.data, serializer.data)
+        public_data = ProjectSerializer(self.project, context={"request": request}).data
+        private_data = ProjectPrivateSerializer(
+            self.project, context={"request": request}
+        ).data
+        self.assertEqual(response.data, {**public_data, **private_data})
 
         self.assertIsNotNone(self.project_data)
-        self.assertEqual(response.data, self.project_data)
+        self.assertEqual(response.data, {**self.project_data, **private_data})
         res_user_props = list(response.data["users"][0])
         res_user_props.sort()
         self.assertEqual(res_user_props, user_props)
@@ -1678,7 +1682,10 @@ def test_cache_updated_on_project_update(self):
         self.assertEqual(response.status_code, 200)
         self.assertEqual(False, response.data.get("public"))
         cached_project = cache.get(f"{PROJ_OWNER_CACHE}{self.project.pk}")
-        self.assertEqual(cached_project, response.data)
+        # Response without user specific fields
+        res_wo_private = {**response.data}
+        res_wo_private.pop("current_user_role")
+        self.assertEqual(cached_project, res_wo_private)
 
         projectid = self.project.pk
         data = {"public": True}
@@ -1694,7 +1701,10 @@ def test_cache_updated_on_project_update(self):
         self.assertEqual(response.status_code, 200)
         self.assertEqual(True, response.data.get("public"))
         cached_project = cache.get(f"{PROJ_OWNER_CACHE}{self.project.pk}")
-        self.assertEqual(cached_project, response.data)
+        # Response without user specific fields
+        res_wo_private = {**response.data}
+        res_wo_private.pop("current_user_role")
+        self.assertEqual(cached_project, res_wo_private)
 
     def test_project_put_updates(self):
         self._project_create()

onadata/apps/api/viewsets/project_viewset.py

@@ -35,6 +35,7 @@
 )
 from onadata.libs.serializers.project_serializer import (
     BaseProjectSerializer,
+    ProjectPrivateSerializer,
     ProjectSerializer,
 )
 from onadata.libs.serializers.share_project_serializer import (
@@ -124,14 +125,18 @@ def update(self, request, *args, **kwargs):
 
     def retrieve(self, request, *args, **kwargs):
         """Retrieve single project"""
-        project_id = kwargs.get("pk")
-        project = safe_cache_get(f"{PROJ_OWNER_CACHE}{project_id}")
-        if project:
-            return Response(project)
-        # pylint: disable=attribute-defined-outside-init
-        self.object = self.get_object()
-        serializer = ProjectSerializer(self.object, context={"request": request})
-        return Response(serializer.data)
+        project = self.get_object()
+        public_data = safe_cache_get(f"{PROJ_OWNER_CACHE}{project.pk}")
+
+        if not public_data:
+            public_data = ProjectSerializer(project, context={"request": request}).data
+
+        # Inject user specific fields
+        private_data = ProjectPrivateSerializer(
+            project, context={"request": request}
+        ).data
+
+        return Response({**public_data, **private_data})
 
     def list(self, request, *args, **kwargs):
         """Returns a list of projects"""

onadata/libs/serializers/project_serializer.py

@@ -669,3 +669,23 @@ def get_data_views(self, obj):
         safe_cache_set(project_dataview_cache_key, data_views)
 
         return data_views
+
+
+class ProjectPrivateSerializer(serializers.ModelSerializer):
+    """User specific fields for a Project"""
+
+    current_user_role = serializers.SerializerMethodField()
+
+    def get_current_user_role(self, obj):
+        """
+        Return the role of the request user in the project.
+        """
+        if self.context["request"].user.is_anonymous:
+            return None
+
+        perms = get_perms(self.context["request"].user, obj)
+        return get_role(perms, obj)
+
+    class Meta:
+        model = Project
+        fields = ("current_user_role",)