Skip to content

Reduce the number of queries used in tagging API [FC-00036] #157

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.

Sign up for GitHub

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

Merged
pomegranited merged 8 commits into from
Feb 15, 2024
Merged

Reduce the number of queries used in tagging API [FC-00036] #157

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
163ee41
fix: prefetch taxonomy.tag_set to reduce queries
pomegranited Feb 7, 2024
6464f53
fix: copy Django's internal prefetch cache when casting taxonomies
pomegranited Feb 7, 2024
ad7838e
Merge branch 'main' into jill/tagging-less-queries
pomegranited Feb 8, 2024
e36e074
fix: prevents TaxonomyTagsView from running get_queryset twice
pomegranited Feb 8, 2024
5f308ee
fix: annotate taxonomies with their tags_count
pomegranited Feb 8, 2024
77f8282
Merge branch 'main' into jill/tagging-less-queries
pomegranited Feb 15, 2024
dc86603
chore: bumps version
pomegranited Feb 15, 2024
29e644e
fix: overrides _queryset() instead of has_permission
pomegranited Feb 15, 2024
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
6 changes: 6 additions & 0 deletions openedx_tagging/core/tagging/models/base.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -372,6 +372,12 @@ def copy(self, taxonomy: Taxonomy) -> Taxonomy:
self.visible_to_authors = taxonomy.visible_to_authors
self.export_id = taxonomy.export_id
self._taxonomy_class = taxonomy._taxonomy_class # pylint: disable=protected-access

# Copy Django's internal prefetch_related cache to reduce queries required on the casted taxonomy.
if hasattr(taxonomy, '_prefetched_objects_cache'):
# pylint: disable=protected-access,attribute-defined-outside-init
self._prefetched_objects_cache: dict = taxonomy._prefetched_objects_cache

@pomegranited pomegranited Feb 9, 2024

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note: I used code from this blog to make this change. That blog post also copies the caches for one-to-many fields that were cached using select_related, but since Taxonomy doesn't have any one-to-many fields, I omitted that part.

return self

def get_filtered_tags(
Expand Down
2 changes: 1 addition & 1 deletion openedx_tagging/core/tagging/rest_api/v1/views.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -252,7 +252,7 @@ def get_queryset(self) -> models.QuerySet:
query_params.is_valid(raise_exception=True)
enabled = query_params.data.get("enabled", None)

return get_taxonomies(enabled)
return get_taxonomies(enabled).prefetch_related('tag_set')

def perform_create(self, serializer) -> None:
"""
Expand Down
2 changes: 1 addition & 1 deletion tests/openedx_tagging/core/tagging/test_views.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -257,7 +257,7 @@ def test_list_taxonomy_query_count(self):
url = TAXONOMY_LIST_URL

self.client.force_authenticate(user=self.user)
with self.assertNumQueries(5):
with self.assertNumQueries(3):
response = self.client.get(url)

assert response.status_code == 200
Expand Down