JSONAPI-Resources / JSONAPI-Resources/jsonapi-resources

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

Aperta
#1,396 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Lingua principale
Ruby
Stelle
2.3k
Fork
546
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Descrizione

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.

Guida per i contributori

Nessuna guida per i contributori indicizzata per questo repository

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Inizia riproducendo GET /foos?sort=bar,baz,-bar e verifica come l'ordinamento dell'indice delle risorse viene passato al metodo order di ActiveRecord. Conferma che venga mantenuta la prima direzione per un attributo ripetuto, quindi verifica il comportamento ORDER BY generato rispetto alla precedenza prevista descritta nell'issue.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
rails, ruby, sql
Ambito
api, backend, databases
Tipo di issue
Bug
Difficoltà
3/5
Tempo stimato
1-2 giorni
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
35/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.