Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove the channel labels from the non-public ContentNode API #12985

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 12 additions & 1 deletion kolibri/core/content/api.py
Original file line number Diff line number Diff line change
Expand Up @@ -826,6 +826,8 @@ class OptionalPagination(ValuesViewsetCursorPagination):


class OptionalContentNodePagination(OptionalPagination):
use_deprecated_channels_labels = False

def paginate_queryset(self, queryset, request, view=None):
# Record the queryset for use in returning available filters
self.queryset = queryset
Expand All @@ -839,7 +841,12 @@ def get_paginated_response(self, data):
[
("more", self.get_more()),
("results", data),
("labels", get_available_metadata_labels(self.queryset)),
(
"labels",
get_available_metadata_labels(
self.queryset, self.use_deprecated_channels_labels
),
),
]
)
)
Expand All @@ -864,6 +871,10 @@ def get_paginated_response_schema(self, schema):
}


class PublicContentNodePagination(OptionalContentNodePagination):
use_deprecated_channels_labels = True


@method_decorator(remote_metadata_cache, name="dispatch")
class ContentNodeViewset(InternalContentNodeMixin, RemoteMixin, ReadOnlyValuesViewset):
pagination_class = OptionalContentNodePagination
Expand Down
17 changes: 17 additions & 0 deletions kolibri/core/content/test/test_content_app.py
Original file line number Diff line number Diff line change
Expand Up @@ -392,6 +392,23 @@ def test_contentnode_list(self):
self.assertEqual(len(response.data), expected_output)
self._assert_nodes(response.data, nodes)

def test_contentnode_channel_metadata_label_absent_in_internal_api(self):
response = self._get(
reverse("kolibri:core:contentnode-list"), data={"max_results": 5}
)
self.assertEqual(response.status_code, 200)
if not self.baseurl:
self.assertNotIn("channels", response.data.get("labels"))
else:
self.assertIn("channels", response.data.get("labels"))

def test_contentnode_channel_metadata_label_present_in_public_api(self):
response = self._get(
reverse("kolibri:core:publiccontentnode-list"), data={"max_results": 5}
)
self.assertEqual(response.status_code, 200)
self.assertIn("channels", response.data.get("labels"))

def test_contentnode_etag(self):
root = content.ContentNode.objects.get(title="root")
nodes = root.get_descendants(include_self=True).filter(available=True)
Expand Down
10 changes: 7 additions & 3 deletions kolibri/core/content/utils/search.py
Original file line number Diff line number Diff line change
Expand Up @@ -105,14 +105,17 @@ def template(self):
)


def get_available_metadata_labels(base_queryset): # noqa: C901
def get_available_metadata_labels( # noqa: C901
base_queryset, use_deprecated_channels_labels=False
):
from kolibri.core.device.models import ContentCacheKey

content_cache_key = ContentCacheKey.get_cache_key()
try:
cache_key = "search-labels:{}:{}".format(
cache_key = "search-labels:{}:{}:{}".format(
content_cache_key,
hashlib.md5(str(base_queryset.query).encode("utf8")).hexdigest(),
"with-channels" if use_deprecated_channels_labels else "no-channels",
)
except EmptyResultSet:
return empty_labels
Expand All @@ -137,7 +140,8 @@ def get_available_metadata_labels(base_queryset): # noqa: C901
if bit_value is not None and bit_value & value["bits"]:
output[value["field_name"]].append(value["label"])
output["languages"] = _get_available_languages(base_queryset)
output["channels"] = _get_available_channels(base_queryset)
if use_deprecated_channels_labels:
output["channels"] = _get_available_channels(base_queryset)
cache.set(cache_key, output, timeout=None)
return cache.get(cache_key)

Expand Down
4 changes: 2 additions & 2 deletions kolibri/core/public/api.py
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
from kolibri.core.content.api import BaseContentNodeMixin
from kolibri.core.content.api import BaseContentNodeTreeViewset
from kolibri.core.content.api import metadata_cache
from kolibri.core.content.api import OptionalContentNodePagination
from kolibri.core.content.api import PublicContentNodePagination
from kolibri.core.content.models import ChannelMetadata
from kolibri.core.content.models import ContentNode
from kolibri.core.content.models import LocalFile
Expand Down Expand Up @@ -137,7 +137,7 @@ def get_queryset(self):

@method_decorator(public_metadata_cache, name="dispatch")
class PublicContentNodeViewSet(BaseContentNodeMixin, ReadOnlyValuesViewset):
pagination_class = OptionalContentNodePagination
pagination_class = PublicContentNodePagination


@method_decorator(public_metadata_cache, name="dispatch")
Expand Down
Loading