Countries filter for ChannelMetadataViewSet

Author: Jakoma02

contentcuration/kolibri_public/tests/test_channelmetadata_viewset.py

@@ -49,6 +49,10 @@ def setUp(self):
             8,
         ]
 
+        mixer.blend(Country, code="C1")
+        mixer.blend(Country, code="C2")
+        mixer.blend(Country, code="C3")
+
         self.user = testdata.user("[email protected]")
 
         # Manually set the bitmasks for testing
@@ -59,6 +63,7 @@ def setUp(self):
                 | self.category_bitmasks[1]
                 | self.category_bitmasks[3]
             ),
+            countries=["C1", "C3"],
         )
         self.metadata2 = mixer.blend(
             ChannelMetadata,
@@ -67,6 +72,7 @@ def setUp(self):
                 | self.category_bitmasks[2]
                 | self.category_bitmasks[3]
             ),
+            countries=["C1", "C2", "C3"],
         )
         self.metadata3 = mixer.blend(
             ChannelMetadata,
@@ -75,6 +81,7 @@ def setUp(self):
                 | self.category_bitmasks[1]
                 | self.category_bitmasks[2]
             ),
+            countries=["C3"],
         )
 
     def test_filter_by_categories_bitmask__provided(self):
@@ -105,3 +112,34 @@ def test_filter_by_categories_bitmask__not_provided(self):
             [UUID(item["id"]) for item in response.data],
             [UUID(self.metadata1.id), UUID(self.metadata2.id), UUID(self.metadata3.id)],
         )
+
+    def test_filter_by_countries(self):
+        self.client.force_authenticate(self.user)
+
+        filter_query = {"countries": "C1,C2"}
+
+        response = self.client.get(
+            reverse_with_query(
+                "publicchannel-list",
+                query=filter_query,
+            ),
+        )
+        self.assertEqual(response.status_code, 200, response.content)
+        self.assertCountEqual(
+            [UUID(item["id"]) for item in response.data],
+            [UUID(self.metadata1.id), UUID(self.metadata2.id)],
+        )
+
+        response1 = next(
+            filter(
+                lambda item: UUID(item["id"]) == UUID(self.metadata1.id), response.data
+            )
+        )
+        response2 = next(
+            filter(
+                lambda item: UUID(item["id"]) == UUID(self.metadata2.id), response.data
+            )
+        )
+
+        self.assertCountEqual(response1["countries"], ["C1", "C3"])
+        self.assertCountEqual(response2["countries"], ["C1", "C2", "C3"])

contentcuration/kolibri_public/views.py

@@ -91,14 +91,23 @@ def bitmask_contains_and(queryset, name, value):
     return queryset.has_all_labels(name, value.split(","))
 
 
+class UUIDInFilter(BaseInFilter, UUIDFilter):
+    pass
+
+
+class CharInFilter(BaseInFilter, CharFilter):
+    pass
+
+
 class ChannelMetadataFilter(FilterSet):
     available = BooleanFilter(method="filter_available", label="Available")
     has_exercise = BooleanFilter(method="filter_has_exercise", label="Has exercises")
     categories = CharFilter(method=bitmask_contains_and, label="Categories")
+    countries = CharInFilter(field_name="countries", label="Countries")
 
     class Meta:
         model = models.ChannelMetadata
-        fields = ("available", "has_exercise", "categories")
+        fields = ("available", "has_exercise", "categories", "countries")
 
     def filter_has_exercise(self, queryset, name, value):
         queryset = queryset.annotate(
@@ -159,6 +168,10 @@ def get_queryset(self):
         return models.ChannelMetadata.objects.all()
 
     def consolidate(self, items, queryset):
+        # Only keep a single item for every channel ID, to get rid of possible
+        # duplicates caused by filtering
+        items = list(OrderedDict((item["id"], item) for item in items).values())
+
         included_languages = {}
         for (
             channel_id,
@@ -189,14 +202,6 @@ def consolidate(self, items, queryset):
         return items
 
 
-class UUIDInFilter(BaseInFilter, UUIDFilter):
-    pass
-
-
-class CharInFilter(BaseInFilter, CharFilter):
-    pass
-
-
 contentnode_filter_fields = [
     "parent",
     "parent__isnull",