JSONAPI-Resources / JSONAPI-Resources/jsonapi-resources

Resource with caching enabled + sort + distinct filter breaks

Offen
#1,272 4 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Vorherrschende Sprache
Ruby
Sterne
2.3k
Forks
546
PR-Merge-Kennzahlen
Keine gemergten PRs in 30 T.

Beschreibung

This issue is a (choose one):

tldr; You can't use distinct on a filter/recordset, plus a sort order, with caching enabled, when using postgres

  • Problem/bug report.
  • Feature request.
  • Request for support. Note: Please try to avoid submitting issues for support requests. Use Gitter instead.

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

Choose one section below and delete the other:

Bug reports:

Setup:

  • Rails 5.2.3
  • Ruby 2.6.3
  • jsonapi-resources 0.9.5 (also tested in 0.10.x)
  • postgres 11.x
  • redis for caching

We have an index endpoint that's hitting a resource with caching enabled, using a query parameter similar to this:

?sort=name&filter[name]=john

I receive an error from postgres below:

E, [2019-07-26T13:46:14.916989 #62203] ERROR -- : Internal Server Error: PG::InvalidColumnReference: ERROR:  for SELECT DISTINCT, ORDER BY expressions must appear in select list
LINE 1: ...WHERE (lower(contacts.name) LIKE 'john') ORDER BY "contacts"...
  • A similar error occurs with Postgres (peeps-uuid fork example linked below)
  • This occurs in both 0.9.5 & 0.10.x
  • This doesn't happen with sqlite3. i know postgres & sqlite3 (and mysql) handle certain things differently, but I don't think this is so much a database issue as it is an issue with how cache-keys are calculated
    • I do get a different error with sqlite3 (wrong number of args w/ mget)
    • Using a memory store instead of redis makes this error go away too (haven't tested outside of this script however)
  • Removing caching, everything works fine (so the query itself is OK)

The root cause, I believe, is in this line because we're only plucking the ID & cached field, but we also need the name (because of the sort/order passed in)

Bug report template:

https://gist.github.com/jaydorsey/b6f290fa2f1b7a002b6e734033373ff7

Fork/branch of peeps-uuid showing the same issue with Postgres:

https://github.com/jaydorsey/peeps-uuids/pull/1

Beitragsleitfaden

Für dieses Repository ist kein Beitragsleitfaden indexiert

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Lies lib/jsonapi/resource.rb um Zeile 1097 herum und prüfe anschließend das verlinkte Bug-Report-Gist sowie die peeps-uuids-Reproduktion. Bestätige die Korrektur, indem du den distinct-Filter mit Sortierung und Redis-Caching gegen PostgreSQL testest und dabei das bestehende Verhalten ohne Cache beibehältst.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
postgresql, rails, redis, ruby
Bereich
backend, databases
Issue-Typ
Bug
Schwierigkeit
3/5
Geschätzter Aufwand
1-2 Tage
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
45/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.