Skip to content

Commit 08309ff

Browse files
committed
api: Avoid per-reply parent queries
Load comment parents and projects when archive URLs are exposed, without fetching unused parent message bodies. Signed-off-by: Stephen Finucane <stephen@that.guru> Assisted-by: OpenAI gpt-6.1-sol (via pi)
1 parent 1f2c1b0 commit 08309ff

2 files changed

Lines changed: 57 additions & 4 deletions

File tree

‎patchwork/api/comment.py‎

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@
1111
from rest_framework.serializers import HiddenField
1212
from rest_framework.serializers import SerializerMethodField
1313

14+
from patchwork.api import utils
1415
from patchwork.api.base import BaseHyperlinkedModelSerializer
1516
from patchwork.api.base import NestedHyperlinkedIdentityField
1617
from patchwork.api.base import MultipleFieldLookupMixin
@@ -124,11 +125,16 @@ def get_object(self):
124125

125126
def get_queryset(self):
126127
cover_id = self.kwargs['cover_id']
127-
get_object_or_404(Cover, pk=cover_id)
128+
get_object_or_404(Cover.objects.only('id'), pk=cover_id)
128129

129-
return CoverComment.objects.filter(cover=cover_id).select_related(
130+
queryset = CoverComment.objects.filter(cover=cover_id).select_related(
130131
'submitter'
131132
)
133+
if utils.has_version(self.request, '1.2'):
134+
queryset = queryset.select_related('cover__project').defer(
135+
'cover__content', 'cover__headers'
136+
)
137+
return queryset
132138

133139

134140
class PatchCommentSerializer(BaseCommentListSerializer):
@@ -164,11 +170,16 @@ def get_object(self):
164170

165171
def get_queryset(self):
166172
patch_id = self.kwargs['patch_id']
167-
get_object_or_404(Patch, id=patch_id)
173+
get_object_or_404(Patch.objects.only('id'), id=patch_id)
168174

169-
return PatchComment.objects.filter(patch=patch_id).select_related(
175+
queryset = PatchComment.objects.filter(patch=patch_id).select_related(
170176
'submitter'
171177
)
178+
if utils.has_version(self.request, '1.2'):
179+
queryset = queryset.select_related('patch__project').defer(
180+
'patch__content', 'patch__diff', 'patch__headers'
181+
)
182+
return queryset
172183

173184

174185
class CoverCommentList(CoverCommentMixin, ListAPIView):

‎patchwork/tests/unit/api/test_comment.py‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,27 @@ def test_list(self):
6767
self.assertIn('list_archive_url', resp.data[0])
6868
self.assertIn('addressed', resp.data[0])
6969

70+
def test_list_query_count(self):
71+
self.project.list_archive_url_format = 'https://example.com/{}'
72+
self.project.save()
73+
comments = [create_cover_comment(cover=self.cover) for _ in range(10)]
74+
for version in ('1.1', '1.2', None):
75+
with self.assertNumQueries(3):
76+
response = self.client.get(
77+
self.api_url(self.cover, version=version)
78+
)
79+
self.assertEqual(status.HTTP_200_OK, response.status_code)
80+
self.assertEqual(len(comments), len(response.data))
81+
for comment, data in zip(comments, response.data):
82+
self.assertIn(SAMPLE_CONTENT, data['content'])
83+
if version == '1.1':
84+
self.assertNotIn('list_archive_url', data)
85+
else:
86+
self.assertEqual(
87+
f'https://example.com/{comment.url_msgid}',
88+
data['list_archive_url'],
89+
)
90+
7091
def test_list_version_1_2(self):
7192
"""List cover letter comments using API v1.2."""
7293
create_cover_comment(cover=self.cover)
@@ -299,6 +320,27 @@ def test_list(self):
299320
self.assertIn('list_archive_url', resp.data[0])
300321
self.assertIn('addressed', resp.data[0])
301322

323+
def test_list_query_count(self):
324+
self.project.list_archive_url_format = 'https://example.com/{}'
325+
self.project.save()
326+
comments = [create_patch_comment(patch=self.patch) for _ in range(10)]
327+
for version in ('1.1', '1.2', None):
328+
with self.assertNumQueries(3):
329+
response = self.client.get(
330+
self.api_url(self.patch, version=version)
331+
)
332+
self.assertEqual(status.HTTP_200_OK, response.status_code)
333+
self.assertEqual(len(comments), len(response.data))
334+
for comment, data in zip(comments, response.data):
335+
self.assertIn(SAMPLE_CONTENT, data['content'])
336+
if version == '1.1':
337+
self.assertNotIn('list_archive_url', data)
338+
else:
339+
self.assertEqual(
340+
f'https://example.com/{comment.url_msgid}',
341+
data['list_archive_url'],
342+
)
343+
302344
def test_list_version_1_2(self):
303345
"""List patch comments using API v1.2."""
304346
create_patch_comment(patch=self.patch)

0 commit comments

Comments
 (0)