✨(backend) add is_masked to document list view

We added the `is_masked` annotation to the
document list view to indicate whether a document
is masked for the current user.
This will allow the frontend to handle
masked documents appropriately in the UI.

Author: AntoLC

src/backend/core/api/serializers.py

@@ -66,6 +66,7 @@ class ListDocumentSerializer(serializers.ModelSerializer):
     """Serialize documents with limited fields for display in lists."""
 
     is_favorite = serializers.BooleanField(read_only=True)
+    is_masked = serializers.BooleanField(read_only=True)
     nb_accesses_ancestors = serializers.IntegerField(read_only=True)
     nb_accesses_direct = serializers.IntegerField(read_only=True)
     user_role = serializers.SerializerMethodField(read_only=True)
@@ -85,6 +86,7 @@ class Meta:
             "depth",
             "excerpt",
             "is_favorite",
+            "is_masked",
             "link_role",
             "link_reach",
             "nb_accesses_ancestors",
@@ -107,6 +109,7 @@ class Meta:
             "depth",
             "excerpt",
             "is_favorite",
+            "is_masked",
             "link_role",
             "link_reach",
             "nb_accesses_ancestors",

src/backend/core/api/viewsets.py

@@ -405,6 +405,7 @@ def filter_queryset(self, queryset):
         queryset = super().filter_queryset(queryset)
         user = self.request.user
         queryset = queryset.annotate_is_favorite(user)
+        queryset = queryset.annotate_is_masked(user)
         queryset = queryset.annotate_user_roles(user)
         return queryset
 
@@ -453,8 +454,9 @@ def list(self, request, *args, **kwargs):
         )
         queryset = queryset.filter(path__in=root_paths)
 
-        # Annotate favorite status and filter if applicable as late as possible
+        # Annotate favorite and masked status and filter if applicable as late as possible
         queryset = queryset.annotate_is_favorite(user)
+        queryset = queryset.annotate_is_masked(user)
         for field in ["is_favorite", "is_masked"]:
             queryset = filterset.filters[field].filter(queryset, filter_data[field])
 

src/backend/core/models.py

@@ -326,6 +326,18 @@ def annotate_is_favorite(self, user):
 
         return self.annotate(is_favorite=models.Value(False))
 
+    def annotate_is_masked(self, user):
+        """
+        Annotate document queryset with the masked status for the current user.
+        """
+        if user.is_authenticated:
+            masked_exists_subquery = LinkTrace.objects.filter(
+                document_id=models.OuterRef("pk"), user=user, is_masked=True
+            )
+            return self.annotate(is_masked=models.Exists(masked_exists_subquery))
+
+        return self.annotate(is_masked=models.Value(False))
+
     def annotate_user_roles(self, user):
         """
         Annotate document queryset with the roles of the current user

src/backend/core/tests/documents/test_api_documents_children_list.py

@@ -45,6 +45,7 @@ def test_api_documents_children_list_anonymous_public_standalone(
                 "excerpt": child1.excerpt,
                 "id": str(child1.id),
                 "is_favorite": False,
+                "is_masked": False,
                 "link_reach": child1.link_reach,
                 "link_role": child1.link_role,
                 "numchild": 0,
@@ -67,6 +68,7 @@ def test_api_documents_children_list_anonymous_public_standalone(
                 "excerpt": child2.excerpt,
                 "id": str(child2.id),
                 "is_favorite": False,
+                "is_masked": False,
                 "link_reach": child2.link_reach,
                 "link_role": child2.link_role,
                 "numchild": 0,
@@ -119,6 +121,7 @@ def test_api_documents_children_list_anonymous_public_parent(django_assert_num_q
                 "excerpt": child1.excerpt,
                 "id": str(child1.id),
                 "is_favorite": False,
+                "is_masked": False,
                 "link_reach": child1.link_reach,
                 "link_role": child1.link_role,
                 "numchild": 0,
@@ -141,6 +144,7 @@ def test_api_documents_children_list_anonymous_public_parent(django_assert_num_q
                 "excerpt": child2.excerpt,
                 "id": str(child2.id),
                 "is_favorite": False,
+                "is_masked": False,
                 "link_reach": child2.link_reach,
                 "link_role": child2.link_role,
                 "numchild": 0,
@@ -212,6 +216,7 @@ def test_api_documents_children_list_authenticated_unrelated_public_or_authentic
                 "excerpt": child1.excerpt,
                 "id": str(child1.id),
                 "is_favorite": False,
+                "is_masked": False,
                 "link_reach": child1.link_reach,
                 "link_role": child1.link_role,
                 "numchild": 0,
@@ -234,6 +239,7 @@ def test_api_documents_children_list_authenticated_unrelated_public_or_authentic
                 "excerpt": child2.excerpt,
                 "id": str(child2.id),
                 "is_favorite": False,
+                "is_masked": False,
                 "link_reach": child2.link_reach,
                 "link_role": child2.link_role,
                 "numchild": 0,
@@ -291,6 +297,7 @@ def test_api_documents_children_list_authenticated_public_or_authenticated_paren
                 "excerpt": child1.excerpt,
                 "id": str(child1.id),
                 "is_favorite": False,
+                "is_masked": False,
                 "link_reach": child1.link_reach,
                 "link_role": child1.link_role,
                 "numchild": 0,
@@ -313,6 +320,7 @@ def test_api_documents_children_list_authenticated_public_or_authenticated_paren
                 "excerpt": child2.excerpt,
                 "id": str(child2.id),
                 "is_favorite": False,
+                "is_masked": False,
                 "link_reach": child2.link_reach,
                 "link_role": child2.link_role,
                 "numchild": 0,
@@ -397,6 +405,7 @@ def test_api_documents_children_list_authenticated_related_direct(
                 "excerpt": child1.excerpt,
                 "id": str(child1.id),
                 "is_favorite": False,
+                "is_masked": False,
                 "link_reach": child1.link_reach,
                 "link_role": child1.link_role,
                 "numchild": 0,
@@ -419,6 +428,7 @@ def test_api_documents_children_list_authenticated_related_direct(
                 "excerpt": child2.excerpt,
                 "id": str(child2.id),
                 "is_favorite": False,
+                "is_masked": False,
                 "link_reach": child2.link_reach,
                 "link_role": child2.link_role,
                 "numchild": 0,
@@ -479,6 +489,7 @@ def test_api_documents_children_list_authenticated_related_parent(
                 "excerpt": child1.excerpt,
                 "id": str(child1.id),
                 "is_favorite": False,
+                "is_masked": False,
                 "link_reach": child1.link_reach,
                 "link_role": child1.link_role,
                 "numchild": 0,
@@ -501,6 +512,7 @@ def test_api_documents_children_list_authenticated_related_parent(
                 "excerpt": child2.excerpt,
                 "id": str(child2.id),
                 "is_favorite": False,
+                "is_masked": False,
                 "link_reach": child2.link_reach,
                 "link_role": child2.link_role,
                 "numchild": 0,
@@ -613,6 +625,7 @@ def test_api_documents_children_list_authenticated_related_team_members(
                 "excerpt": child1.excerpt,
                 "id": str(child1.id),
                 "is_favorite": False,
+                "is_masked": False,
                 "link_reach": child1.link_reach,
                 "link_role": child1.link_role,
                 "numchild": 0,
@@ -635,6 +648,7 @@ def test_api_documents_children_list_authenticated_related_team_members(
                 "excerpt": child2.excerpt,
                 "id": str(child2.id),
                 "is_favorite": False,
+                "is_masked": False,
                 "link_reach": child2.link_reach,
                 "link_role": child2.link_role,
                 "numchild": 0,