JSONAPI-Resources / JSONAPI-Resources/jsonapi-resources

Resource with caching enabled + sort + distinct filter breaks

オープン
#1,272 コメント 4 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

主要言語
Ruby
スター
2.3k
フォーク
546
PR マージ指標
30日以内にマージされた PR はありません

説明

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

コントリビューションガイド

このリポジトリのコントリビューションガイドは索引されていません

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

調査の方向性

lib/jsonapi/resource.rb の1097行付近を読み、その後、リンクされたバグレポートの gist と peeps-uuids の再現手順を確認します。PostgreSQL に対してソートと Redis キャッシュを併用した distinct フィルターを実行し、既存のキャッシュなしの動作を維持したまま修正を確認します。

索引モデルが issue の本文から書いたものです。

評価

技術スタック
postgresql, rails, redis, ruby
領域
backend, databases
issue の種類
バグ
難易度
3/5
見積もり時間
1〜2日
活発さ
停滞
明瞭さ
おおむね明確
初心者へのやさしさ
45/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。