[*] Filters - Fix resources display if filtered with associations conditions with the related columns are hidden in the list

Author: arnaudbesnier

CHANGELOG.md

@@ -1,6 +1,8 @@
 # Change Log
 
 ## [Unreleased]
+### Fixed
+- Filters - Fix resources display if filtered with associations conditions with the related columns are hidden in the list. 🛡
 
 ## RELEASE 2.15.4 - 2019-02-26
 ### Fixed

Gemfile

@@ -22,7 +22,7 @@ group :test do
 end
 
 gem 'rails', '4.2.7.1'
-gem 'jsonapi-serializers', '0.14.0'
+gem 'jsonapi-serializers', '1.0.1'
 gem 'rack-cors'
 gem 'arel-helpers'
 gem 'groupdate'

Gemfile.lock

@@ -60,7 +60,7 @@ GEM
     bcrypt (3.1.10)
     builder (3.2.3)
     byebug (8.2.2)
-    concurrent-ruby (1.0.5)
+    concurrent-ruby (1.1.4)
     crass (1.0.3)
     diff-lcs (1.3)
     erubis (2.7.0)
@@ -71,11 +71,11 @@ GEM
     httparty (0.13.7)
       json (~> 1.8)
       multi_xml (>= 0.5.2)
-    i18n (0.9.1)
+    i18n (0.9.5)
       concurrent-ruby (~> 1.0)
     ipaddress (0.8.3)
     json (1.8.6)
-    jsonapi-serializers (0.14.0)
+    jsonapi-serializers (1.0.1)
       activesupport
     jwt (1.5.4)
     loofah (2.1.1)
@@ -85,7 +85,7 @@ GEM
       mini_mime (>= 0.1.1)
     mini_mime (1.0.0)
     mini_portile2 (2.3.0)
-    minitest (5.11.1)
+    minitest (5.11.3)
     multi_xml (0.6.0)
     nokogiri (1.8.1)
       mini_portile2 (~> 2.3.0)
@@ -146,7 +146,7 @@ GEM
     sqlite3 (1.3.11)
     thor (0.20.0)
     thread_safe (0.3.6)
-    tzinfo (1.2.4)
+    tzinfo (1.2.5)
       thread_safe (~> 0.1)
     useragent (0.16.5)
 
@@ -162,7 +162,7 @@ DEPENDENCIES
   groupdate
   httparty (= 0.13.7)
   ipaddress (= 0.8.3)
-  jsonapi-serializers (= 0.14.0)
+  jsonapi-serializers (= 1.0.1)
   jwt
   rack-cors
   rails (= 4.2.7.1)

app/services/forest_liana/resources_getter.rb

@@ -10,6 +10,7 @@ def initialize(resource, params)
       @count_needs_includes = false
       @collection_name = ForestLiana.name_for(@resource)
       @collection = get_collection(@collection_name)
+      @fields_to_serialize = get_fields_to_serialize
       @field_names_requested = field_names_requested
       get_segment()
       compute_includes()
@@ -62,8 +63,16 @@ def compute_includes
       end
     end
 
+    def includes_for_serialization
+      super & @fields_to_serialize.map(&:to_s)
+    end
+
     private
 
+    def get_fields_to_serialize
+      @params[:fields][@collection_name].split(',').map { |name| name.to_sym }
+    end
+
     def get_segment
       if @params[:segment]
         @segment = @collection.segments.find do |segment|
@@ -94,8 +103,7 @@ def field_names_requested
         associations_for_query << @params[:sort].split('.').first.to_sym
       end
 
-      field_names = @params[:fields][@collection_name].split(',').map { |name| name.to_sym }
-      field_names | associations_for_query
+      @fields_to_serialize | associations_for_query
     end
 
     def search_query

spec/requests/resources_spec.rb

@@ -1,23 +1,97 @@
 require 'rails_helper'
 
-describe 'Requesting Tree index', :type => :request  do
-  before do
+describe 'Requesting Tree resources', :type => :request  do
+  before(:each) do
+    user = User.create(name: 'Michel')
+    tree = Tree.create(name: 'Lemon Tree', owner: user, cutter: user)
+  end
+
+  after(:each) do
+    User.destroy_all
+    Tree.destroy_all
+  end
+
+  before(:each) do
     allow(ForestLiana::IpWhitelist).to receive(:retrieve) { true }
     allow(ForestLiana::IpWhitelist).to receive(:is_ip_whitelist_retrieved) { true }
     allow(ForestLiana::IpWhitelist).to receive(:is_ip_valid) { true }
 
     allow_any_instance_of(ForestLiana::PermissionsChecker).to receive(:is_authorized?) { true }
   end
 
-  it 'should route /:collection to resource#index' do
-    headers = {
-      'Accept' => 'application/json',
-      'Content-Type' => 'application/json',
-      'Authorization' => 'Bearer eyJhbGciOiJIUzI1NiJ9.eyJleHAiOiIxODQ5ODc4ODYzIiwiZGF0YSI6eyJpZCI6IjM4IiwidHlwZSI6InVzZXJzIiwiZGF0YSI6eyJlbWFpbCI6Im1pY2hhZWwua2Vsc29AdGhhdDcwLnNob3ciLCJmaXJzdF9uYW1lIjoiTWljaGFlbCIsImxhc3RfbmFtZSI6IktlbHNvIiwidGVhbXMiOiJPcGVyYXRpb25zIn0sInJlbGF0aW9uc2hpcHMiOnsicmVuZGVyaW5ncyI6eyJkYXRhIjpbeyJ0eXBlIjoicmVuZGVyaW5ncyIsImlkIjoxNn1dfX19fQ.U4Mxi0tq0Ce7y5FRXP47McNPRPhUx37LznQ5E3mJIp4'
-    }
+  headers = {
+    'Accept' => 'application/json',
+    'Content-Type' => 'application/json',
+    'Authorization' => 'Bearer eyJhbGciOiJIUzI1NiJ9.eyJleHAiOiIxODQ5ODc4ODYzIiwiZGF0YSI6eyJpZCI6IjM4IiwidHlwZSI6InVzZXJzIiwiZGF0YSI6eyJlbWFpbCI6Im1pY2hhZWwua2Vsc29AdGhhdDcwLnNob3ciLCJmaXJzdF9uYW1lIjoiTWljaGFlbCIsImxhc3RfbmFtZSI6IktlbHNvIiwidGVhbXMiOiJPcGVyYXRpb25zIn0sInJlbGF0aW9uc2hpcHMiOnsicmVuZGVyaW5ncyI6eyJkYXRhIjpbeyJ0eXBlIjoicmVuZGVyaW5ncyIsImlkIjoxNn1dfX19fQ.U4Mxi0tq0Ce7y5FRXP47McNPRPhUx37LznQ5E3mJIp4'
+  }
+
+  describe 'index' do
+    describe 'without any filter' do
+      params = {
+        fields: { 'Tree' => 'id,name' },
+        page: { 'number' => '1', 'size' => '10' },
+        searchExtended: '0',
+        sort: '-id',
+        timezone: 'Europe/Paris'
+      }
+
+      it 'should respond 200' do
+        get '/forest/Tree', params, headers
+        expect(response.status).to eq(200)
+      end
+
+      it 'should respond the tree data' do
+        get '/forest/Tree', params, headers
+        expect(JSON.parse(response.body)).to eq({
+          "data" => [{
+            "type" => "Tree",
+            "id" => "1",
+            "attributes" => {
+              "id" => 1,
+              "name" => "Lemon Tree"
+            },
+            "links" => {
+              "self" => "/forest/tree/1"
+            }
+          }],
+          "included" => []
+        })
+      end
+    end
+
+    describe 'with a filter on an association that is not a displayed column' do
+      params = {
+        fields: { 'Tree' => 'id,name' },
+        filterType: 'and',
+        filter: { 'owner:id' => '$present' },
+        page: { 'number' => '1', 'size' => '10' },
+        searchExtended: '0',
+        sort: '-id',
+        timezone: 'Europe/Paris'
+      }
+
+      it 'should respond 200' do
+        get '/forest/Tree', params, headers
+        expect(response.status).to eq(200)
+      end
 
-    get '/forest/Tree', {}, headers
-    expect(response.status).to eq(200)
-    expect(response.body).to eq("{\"data\":[],\"included\":[]}")
+      it 'should respond the tree data' do
+        get '/forest/Tree', params, headers
+        expect(JSON.parse(response.body)).to eq({
+          "data" => [{
+            "type" => "Tree",
+            "id" => "1",
+            "attributes" => {
+              "id" => 1,
+              "name" => "Lemon Tree"
+            },
+            "links" => {
+              "self" => "/forest/tree/1"
+            }
+          }],
+          "included" => []
+        })
+      end
+    end
   end
 end