Custom filters sometimes work incorrectly for nested routes
まだ誰も着手していません。
評価
- 難易度
- 4/5
- 見積もり時間
- 3〜5日
- 初心者へのやさしさ
- 35/100
調査の方向性
組み込みの title フィルターとカスタム _title フィルターの両方を使って、ネストされた /authors/:id/books リクエストを再現し、次に、ネストされたルートでカスタムフィルターの apply ラムダがどのようにレコードを受け取るかを追跡します。生成された ActiveRecord の join 条件を比較し、意図された動作に応じて回帰テストを追加するか、テーブル名の要件を文書化します。
索引モデルが issue の本文から書いたものです。
説明
This issue is a (choose one):
- 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
Bug reports:
Gem version 0.10.5.
EDIT: After submitting this, I realized that this might not be considered a bug so much as a limitation due to how ActiveRecord joins work. It might be a good idea, however, to include a caveat in the documentation that table name must be specified in filters so as not to break join queries.
When using a custom filter (i.e. one defined with an apply lambda) on a nested route (/foos/:id/bars), the filter is applied on the parent model (Foo) instead of the child model (Bar), when the child model's table name is not specified in the filter query.
Example:
class AuthorResource < JSONAPI::Resource
has_many :books
end
class BookResource < JSONAPI::Resource
has_one :author
attributes :title
filter :title
filter :_title, apply: ->(records, value, _options){
records.where(title: value)
}
end
Rails returns the expected response for http://localhost:3000/authors/1/books?filter[title]=book1:
{"data":[
{"id":"1",
"type":"books",
"links":{
"self":"http://localhost:3000/books/1"
},
"attributes":{
"title":"book1"
},
"relationships":{
"author":{
"links":{
"self":"http://localhost:3000/books/1/relationships/author",
"related":"http://localhost:3000/books/1/author"}}}}]}
But not for http://localhost:3000/authors/1/books?filter[_title]=book1
{"errors":[
{"title":"Internal Server Error",
"detail":"Internal Server Error",
"code":"500",
"status":"500",
"meta":{
"exception":"SQLite3::SQLException: no such column: authors.title",
"backtrace":[...],
"application_backtrace":[]}}]}
So, with filter[title], the filter is applied on Book, whereas with filter[_title], it is is instead applied on Author, in this case causing the error SQLite3::SQLException: no such column: authors.title, since the Author model does not have the attribute title.
filter[_title] does work, however, if we instead define it as:
filter :_title, apply: ->(records, value, _options){
records.where(books: {title: value})
}
So I suppose applying the two versions of _title on records results in something like:
Author.joins(:books).where(title: 'book1')
and
Author.joins(:books).where(books: {title: 'book1'})
respectively, where the first one does not work as intended.
- 主要言語
- Ruby
- スター
- 2.3k
- フォーク
- 546
- PR マージ指標
- 30日以内にマージされた PR はありません
コントリビューションガイド
このリポジトリのコントリビューションガイドは索引されていません
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
JSONAPI-Resources/jsonapi-resources のほかの issue
-
難易度 1/5 1時間未満 初心者へのやさしさ 85/100
-
難易度 3/5 1〜2日 初心者へのやさしさ 50/100
JSONAPI-Resources/jsonapi-resources#1488 · コメント 1 件 ·
-
難易度 4/5 3〜5日 初心者へのやさしさ 42/100
JSONAPI-Resources/jsonapi-resources#1479 · コメント 2 件 ·
-
難易度 4/5 3〜5日 初心者へのやさしさ 30/100
JSONAPI-Resources/jsonapi-resources#1477 · コメント 3 件 · リアクション 1 件 ·
-
難易度 3/5 1〜2日 初心者へのやさしさ 45/100
JSONAPI-Resources/jsonapi-resources の issue をすべて見る
似ている issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 70/100
-
bug
難易度 1/5 1時間未満 初心者へのやさしさ 90/100
riscv/riscv-unified-db#2626 ·
-
Component: GLib
難易度 2/5 1〜3時間 初心者へのやさしさ 70/100
-
ds-drift
難易度 2/5 1〜3時間 初心者へのやさしさ 70/100
we-promise/sure#3693 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
simp/pupmod-simp-simp#395 ·