diff --git a/CHANGELOG.rst b/CHANGELOG.rst index e622973..992b7a6 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -13,6 +13,10 @@ Change Log Unreleased +[1.54.0] - 2024-10-02 +--------------------- +* perf: Added caching to `XBlockSkillsViewSet` list endpoint to improve performance and reduce redundant database queries + [1.53.0] - 2024-08-22 --------------------- * perf: Introduced db_index on the `created` and `is_blacklisted` fields in `XBlockSkillData` model diff --git a/taxonomy/__init__.py b/taxonomy/__init__.py index d450b26..738ee11 100644 --- a/taxonomy/__init__.py +++ b/taxonomy/__init__.py @@ -15,6 +15,6 @@ # 2. MINOR version when you add functionality in a backwards compatible manner, and # 3. PATCH version when you make backwards compatible bug fixes. # More details can be found at https://semver.org/ -__version__ = '1.53.0' +__version__ = '1.54.0' default_app_config = 'taxonomy.apps.TaxonomyConfig' # pylint: disable=invalid-name diff --git a/taxonomy/api/v1/views.py b/taxonomy/api/v1/views.py index fd1db4c..bfc23f3 100644 --- a/taxonomy/api/v1/views.py +++ b/taxonomy/api/v1/views.py @@ -4,6 +4,7 @@ from collections import OrderedDict from django_filters.rest_framework import DjangoFilterBackend +from edx_django_utils.cache import TieredCache, get_cache_key from rest_framework import permissions from rest_framework.filters import OrderingFilter from rest_framework.generics import ListAPIView, RetrieveAPIView @@ -40,6 +41,8 @@ XBlockSkills, ) +from taxonomy.constants import CACHE_TIMEOUT_XBLOCK_SKILLS_SECONDS + class TaxonomyAPIViewSetMixin: """ @@ -320,6 +323,19 @@ def get_queryset(self): ), ).only('id', 'skills', 'usage_key', 'requires_verification', 'auto_processed', 'hash_content') + def list(self, request, *args, **kwargs): + cache_key = get_cache_key(domain='taxonomy', subdomain='xblock_skills', params=request.query_params) + + cached_response = TieredCache.get_cached_response(cache_key) + if cached_response.is_found: + return Response(cached_response.value) + + response = super().list(request, *args, **kwargs) + + TieredCache.set_all_tiers(cache_key, response.data, CACHE_TIMEOUT_XBLOCK_SKILLS_SECONDS) + + return response + class JobPathAPIView(TaxonomyAPIViewSetMixin, RetrieveAPIView): """ diff --git a/taxonomy/constants.py b/taxonomy/constants.py index fe03b0d..74263e6 100644 --- a/taxonomy/constants.py +++ b/taxonomy/constants.py @@ -146,3 +146,5 @@ def get_job_posting_query_filter(jobs=None): JOB_SOURCE_COURSE_SKILL = 'course_skill' JOB_SOURCE_INDUSTRY = 'industry' JOB_SKILLS_URL_NAME = 'job-skills' + +CACHE_TIMEOUT_XBLOCK_SKILLS_SECONDS = 60 * 60