Inconsistency in rating sort & filter query parameters #9190
Comments
This is somewhat confusing if someone ends up comparing the 2 fields values yes, but this was done on purpose... 15 years ago. The idea is to solve the classic issue with ratings sort of something with a single 5 star rating being ranked before a super popular 4.9 one. To combat this problem, we use a bayesian rating to weigh the rating (See https://web.archive.org/web/20060423210706/http://www.thebroth.com/blog/118/bayesian-rating). Only sorting is affected though, for filtering and displaying purposes we use the actual average, mostly out of concern that some users would do the math themselves and be confused that it's not a straight average. We could revisit all of that, but that is a product decision to make, not an engineering call. |
- Ensure "sort=ratings" is supported, preferred - Ensure "sort=rating" is still supported, for backwards compatibility - Update existing tests using "sort=rating" to use the new preferred parameter See https://github.com/mozilla/addons-server/issues/20763
Mention only the preferred sort=ratings parameter. See https://github.com/mozilla/addons-server/issues/20763
Mention sort=ratings parameter being preferred. Mention sort=rating parameter being still supported for backwards-compatibility but deprecated. See https://github.com/mozilla/addons-server/issues/20763
* Add sort=ratings sorting param for consistency See https://github.com/mozilla/addons-server/issues/20763 * Add test_sort_ratings search filters test - Ensure "sort=ratings" is supported, preferred - Ensure "sort=rating" is still supported, for backwards compatibility - Update existing tests using "sort=rating" to use the new preferred parameter See https://github.com/mozilla/addons-server/issues/20763 * Update addons search endpoint ratings sort documentation Mention sort=ratings parameter being preferred. Mention sort=rating parameter being still supported for backwards-compatibility but deprecated. See https://github.com/mozilla/addons-server/issues/20763 * Update v5 API changelog for Addons search endpoint sort=ratings param renaming
|
Old Jira Ticket: https://mozilla-hub.atlassian.net/browse/ADDSRV-377 |
KevinMind
added
repository:addons-server
Describe the problem and steps to reproduce it:
On the
/api/v5/addons/searchAPI endpoint, one can filter & sort add-ons by rating.For example, a query used for searching add-ons with an average rating of 4 and sorting the results by rating would like this:
/api/v5/addons/search/?ratings__gte=4&sort=ratingWhat happened?
The query parameters for filtering & sorting add-ons by ratings aren't named consistently which can be confusing & error-prone, especially since, in the endpoint documentation, sort parameters & threshold style filter parameters are presented next to each other.
View docs screenshot
What did you expect to happen?
The ratings related object property & sort/filter query parameters should be named consistently.
Anything else we should know?
ratingsbeing the property actually returned in the addon details object, it might be preferable to:sort=ratingsquery parameter.sort=ratingquery parameter as an alias.sort=ratingsquery parameter for consistency / DX.Additionally, glancing at src/olympa/search/filters.py, it appears the filtering & sorting logic currently do not leverage the same ratings field: the
ratingsfilter relies on theratings.averagefield, whereas theratingsort relies onbayesian_rating, which might or might not be intentional, may lead to odd behavior.┆Issue is synchronized with this Jira Task
The text was updated successfully, but these errors were encountered: