Fixes: #18729 - Reapply model-level ordering on list views (UI and API) to account for annotation #18805
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
…t to reapply model-level ordering
bctiemann
requested review from
a team and
arthanson
and removed request for
a team
arthanson
approved these changes
Mar 5, 2025
bctiemann
added a commit
that referenced
this pull request
Mar 6, 2025
…t to reapply model-level ordering (#18805)
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Fixes: #18729
Adding
.annotateto querysets has the effect of negating theorderingsetting defined on models. Thus when we put annotations/groupings on thequeryseton various list views (for exampleClusterViewSetin the API, orProviderListViewin the UI), i.e. to count related objects to show in columns or fields, the model-level sorting is lost and records are returned in an unpredictable order, leading to repetitions and misses by paginating clients.This change adds a
get_querysetoverride to each of the relevant list view classes, to take the specifiedquerysetand reapply theorderingfields that are defined in the queryset's model class. This occurs centrally and uniformly, thus not requiring many changes throughout the system. It also does not interfere with custom sorting as specified via query params (e.g.&ordering=name).