fix(api): Eliminate N+1 query for pulls list patch calculation - #1878
Open
sentry[bot] wants to merge 1 commit into
Open
fix(api): Eliminate N+1 query for pulls list patch calculation#1878sentry[bot] wants to merge 1 commit into
sentry[bot] wants to merge 1 commit into
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR addresses an N+1 query issue in the
/api/v2/{service}/{owner_username}/repos/{repo_name}/pulls/endpoint.Problem:
Previously, the
PullSerializer.get_patch()method, aSerializerMethodField, would execute a separate database query viaCommitComparisonService.get_commit_comparison_for_pull(obj)for eachPullobject in the paginated list. This resulted in an N+1 query pattern, where N is the number of pulls returned by the API, leading to inefficient database usage and slower response times.Solution:
To resolve this, the
PullViewSetMixin.get_queryset()method has been enhanced to include two new subquery annotations:commit_comparison_state: Fetches the state of theCommitComparisonfor each pull.commit_comparison_patch_totals: Fetches thepatch_totalsJSON field from theCommitComparisonfor each pull.These annotations ensure that the necessary
CommitComparisondata is loaded in a single, optimized query when the initial queryset is retrieved. ThePullSerializer.get_patch()method was then updated to directly access these pre-annotated fields (obj.commit_comparison_stateandobj.commit_comparison_patch_totals), eliminating the need for individual database lookups and theComparisonReportprocessing for each pull. This significantly reduces the number of database queries and improves the performance of the pulls list API.Legal Boilerplate
Look, I get it. The entity doing business as "Codecov" is owned by Harness, Inc. In 2026 Harness acquired Codecov and as a result Harness is going to need some rights from me in order to utilize my contributions in this PR. So here's the deal: I retain all rights, title and interest in and to my contributions, and by keeping this boilerplate intact I confirm that Harness can use, modify, copy, and redistribute my contributions, under Harness's choice of terms.
Fixes API-ESS