Pass :include to Serializer

[richmolj]

Using JSONAPI, I never want to load relationships unless they are also include'd. By default:

class PostSerializer < ActiveModel::Serializer
  has_many :comments
end

Does nothing for me but cause an unnecessary DB hit. Instead, by desired behavior would be:

class PostSerializer < ActiveModel::Serializer
  has_many :comments, if: :comments_included?

  def comments_included?
    self.instance_options[:include].include?(:comments)
  end
end

Unfortunately the include option is passed to the adapter, but unavailable on the serializer.

Can we add include to the options passed to the serializer?

[NullVoxPopuli]

so you don't even want the list of comment ids unless comments_included is true?

[richmolj]

Correct. The list of comment IDs is irrelevant to me, and not always feasible.

Imagine a post that has 100,000 comments I'd rather not load (even just IDs), since I already have a link pointing to /posts/1/relationships/comments, which will handle pagination, etc.

[NullVoxPopuli]

this is a good idea / use case. @bf4, @beauby -- do you have any thoughts on this?

[halorium]

+1
I have the same issue / need for this.

[bf4]

Using JSONAPI, I never want to load relationships unless they are also include'd. By default:

The adapter shouldn't be loading the association unless it's included. That would definitely be a bug.

The adapter asks the serializer for the 'included' associations. The bug would be in how the serializer is answering that question. (So, the issue isn't that the serializer needs an include/d option.)

[bf4]

Appears this is a duplicate of #1552

[NullVoxPopuli]

I'd say so.
closing as duplicate. see: #1552

[NullVoxPopuli]

unclosing, cause the other issue is actually a bug report specific to belongs_to. oops.