Skip to content
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.

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

Repeating the same sort attribute with reverse direction overwrites the previous direction for that attribute #1396

Open
3 of 5 tasks
olofheurgren opened this issue Nov 21, 2022 · 0 comments

Comments

@olofheurgren
Copy link

olofheurgren commented Nov 21, 2022

This issue is a (choose one):

  • Problem/bug report.

Checklist before submitting:

  • I've searched for an existing issue.
  • I've asked my question on Gitter and have not received a satisfactory answer.
  • I've included a complete bug report template. This step helps us and allows us to see the bug without trying to reproduce the problem from your description. It helps you because you will frequently detect if it's a problem specific to your project.
  • The feature I'm asking for is compliant with the JSON:API spec.

Description

So, this is a pretty slim edge case. It concerns repetition of an attribute in the sort param, which can yield some arguably weird results that are possibly not compliant with the JSON:API spec recommendations:

Sort fields SHOULD be applied in the order specified.

Scenario

The index of a resource is called with a sort param, where the same attribute occurs more than once with different directions:

GET /foos?sort=bar,baz,-bar

Expected outcome

The records are ordered as specified by all the sort params, with an order of precedence from left to right. Any repetitions of the same attribute can be ignored, since they won't make a difference.

ORDER BY `foos`.`bar` ASC, `foos`.`baz` ASC, `foos`.`bar` DESC

or, equivalently, ignoring the repeated attributes:

ORDER BY `foos`.`bar` ASC, `foos`.`baz` ASC

Actual outcome

Whenever a sort attribute is repeated, its direction overwrites the previous direction of that same attribute.

ORDER BY `foos`.`bar` DESC, `foos`.`baz` ASC

Since ActiveRecord's order uses keyword arguments, calling it with repeated arguments will result in the repeated value overwriting the original value (with a warning). So it could be argued that the present behavior is consistent with how ActiveRecord works.

However, considering sort order in a more general sense or in the context of an SQL query it seems reasonable to me that a repeating value should not overwrite the original value.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant