Allow included resources to be filtered when they are related with the 'eager_load_on_include: false' flag set

Author: Truman Shuck

lib/jsonapi/request_parser.rb

@@ -257,7 +257,6 @@ def parse_filters(filters)
         if included_resource_name
           relationship = resource_klass._relationship(included_resource_name || '')
 
-
           unless relationship
             return @errors.concat(Exceptions::FilterNotAllowed.new(filter_method).errors)
           end
@@ -266,7 +265,7 @@ def parse_filters(filters)
             return @errors.concat(Exceptions::FilterNotAllowed.new(filter_method).errors)
           end
 
-          unless @include_directives.model_includes.include?(relationship.name.to_sym)
+          unless @include_directives.include_config(relationship.name.to_sym).present?
             return @errors.concat(Exceptions::FilterNotAllowed.new(filter_method).errors)
           end
 

lib/jsonapi/resource.rb

@@ -741,6 +741,9 @@ def apply_included_resources_filters(records, options = {})
           next memo unless relationship && relationship.is_a?(JSONAPI::Relationship::ToMany)
           filtering_resource = relationship.resource_klass
 
+          # Don't try to merge where clauses when relation isn't already being joined to query.
+          next memo unless config[:include_in_join]
+
           filters = config[:include_filters]
           next memo unless filters
 

test/controllers/controller_test.rb

@@ -509,6 +509,22 @@ def test_show_single_with_includes
     assert_equal 2, json_response['included'].size
   end
 
+  def test_show_with_filtered_includes_when_not_eager_loaded
+    # tags are not eagerly loaded on a post but may still be filtered
+    get :show, params: { id: '1', include: 'tags', filter: { 'tags.name' => ['whiny'] } }
+    assert_response :success
+    assert_equal 1, json_response['included'].size
+  end
+
+  def test_show_with_filtered_includes_when_not_eager_loaded_and_all_filtered_out
+    get :show, params: { id: '1', include: 'tags', filter: { 'tags.name' => ['no-tag-with-this-name'] } }
+    assert_response :success
+    assert json_response['data'].is_a?(Hash)
+    assert_equal 'New post', json_response['data']['attributes']['title']
+    assert_equal 'A body!!!', json_response['data']['attributes']['body']
+    assert_nil json_response['included']
+  end
+
   def test_show_single_with_include_disallowed
     JSONAPI.configuration.allow_include = false
     assert_cacheable_get :show, params: {id: '1', include: 'comments'}

test/fixtures/active_record.rb

@@ -1055,6 +1055,7 @@ class TagResource < JSONAPI::Resource
   attributes :name
 
   has_many :posts
+  filter :name
   # Not including the planets relationship so they don't get output
   #has_many :planets
 end