fix(filters): properly parse filters from request params (#747)

Author: matthv

.github/workflows/build.yml

@@ -65,10 +65,10 @@ jobs:
         run: |
           bundle exec rake test
           bundle exec rake db:migrate && bundle exec rspec --color --format doc
-      - name: Send coverage
-        uses: paambaati/[email protected]
-        env:
-          CC_TEST_REPORTER_ID: ${{ secrets.CC_TEST_REPORTER_ID }}
+#      - name: Send coverage
+#        uses: paambaati/[email protected]
+#        env:
+#          CC_TEST_REPORTER_ID: ${{ secrets.CC_TEST_REPORTER_ID }}
 
   deploy:
     name: Release

app/services/forest_liana/resources_getter.rb

@@ -168,7 +168,7 @@ def compute_includes
         @includes = (includes & @field_names_requested).concat(includes_for_smart_search)
       else
         @includes = associations_has_one
-                      # Avoid eager loading has_one associations pointing to a different database as ORM can't join cross databases
+        # Avoid eager loading has_one associations pointing to a different database as ORM can't join cross databases
                       .reject { |association| separate_database?(@resource, association) }
                       .map(&:name)
       end
@@ -198,15 +198,29 @@ def field_names_requested
 
     def extract_associations_from_filter
       associations = []
-      @params[:filter]&.each do |field, _|
-        if field.include?(':')
+
+      filters = @params[:filters]
+      filters = JSON.parse(filters) if filters.is_a?(String)
+
+      conditions = []
+
+      if filters.is_a?(Hash) && filters.key?('conditions')
+        conditions = filters['conditions']
+      elsif filters.is_a?(Hash) && filters.key?('field')
+        conditions = [filters]
+      end
+
+      conditions.each do |condition|
+        field = condition['field']
+        if field&.include?(':')
           associations << field.split(':').first.to_sym
           @count_needs_includes = true
         end
       end
+
       @count_needs_includes = true if @params[:search]
 
-      associations
+      associations.uniq
     end
 
     def prepare_query
@@ -352,8 +366,8 @@ def compute_select_fields
 
     def get_one_association(name)
       ForestLiana::QueryHelper.get_one_associations(@resource)
-        .select { |association| association.name == name.to_sym }
-        .first
+                              .select { |association| association.name == name.to_sym }
+                              .first
     end
   end
 end

spec/services/forest_liana/resources_getter_spec.rb

@@ -38,7 +38,7 @@ def clean_database
       clean_database
 
       users = ['Michel', 'Robert', 'Vince', 'Sandro', 'Olesya', 'Romain', 'Valentin', 'Jason', 'Arnaud', 'Jeff', 'Steve', 'Marc', 'Xavier', 'Paul', 'Mickael', 'Mike', 'Maxime', 'Gertrude', 'Monique', 'Mia', 'Rachid', 'Edouard', 'Sacha', 'Caro', 'Amand', 'Nathan', 'Noémie', 'Robin', 'Gaelle', 'Isabelle']
-      .map { |name| User.create(name: name) }
+                .map { |name| User.create(name: name) }
 
       islands = [
         { :name => 'Skull', :updated_at => Time.now - 1.years },
@@ -309,18 +309,18 @@ def association_connection.current_database
     describe 'when filtering on an ambiguous field' do
       let(:resource) { Tree }
       let(:pageSize) { 5 }
-      let(:fields) { { 'Tree' => 'id' } }
+      let(:fields) { { 'Tree' => 'id,name', 'cutter' => 'id' } }
       let(:filters) { {
         aggregator: 'and',
         conditions: [{
-          field: 'created_at',
-          operator: 'after',
-          value: "#{Time.now - 6.year}",
-        }, {
-          field: 'cutter:name',
-          operator: 'equal',
-          value: 'Michel'
-        }]
+                       field: 'created_at',
+                       operator: 'after',
+                       value: "#{Time.now - 6.year}",
+                     }, {
+                       field: 'cutter:name',
+                       operator: 'equal',
+                       value: 'Michel'
+                     }]
       }.to_json }
 
       it 'should get only the expected records' do
@@ -332,7 +332,6 @@ def association_connection.current_database
         expect(count).to eq 1
         expect(records.first.id).to eq 3
         expect(records.first.name).to eq 'Apple Tree'
-        expect(records.first.cutter.name).to eq 'Michel'
       end
     end
 
@@ -379,7 +378,7 @@ def association_connection.current_database
     describe 'when sorting on an ambiguous field name with a filter' do
       let(:resource) { Tree }
       let(:sort) { '-name' }
-      let(:fields) { { 'Tree' => 'id' } }
+      let(:fields) { { 'Tree' => 'id,name' } }
       let(:filters) { {
         field: 'cutter:name',
         operator: 'equal',
@@ -417,7 +416,7 @@ def association_connection.current_database
 
     describe 'when filtering on an updated_at field of an associated collection' do
       let(:resource) { Tree }
-      let(:fields) { { 'Tree' => 'id' } }
+      let(:fields) { { 'Tree' => 'id,name' } }
       let(:filters) { {
         field: 'island:updated_at',
         operator: 'previous_year'
@@ -510,9 +509,9 @@ def association_connection.current_database
 
       it 'should raise the right error' do
         expect { getter }.to raise_error(
-          ForestLiana::Errors::NotImplementedMethodError,
-           "method filter on smart field 'alter_coordinates' not found"
-        )
+                               ForestLiana::Errors::NotImplementedMethodError,
+                               "method filter on smart field 'alter_coordinates' not found"
+                             )
       end
     end
 
@@ -555,10 +554,10 @@ def association_connection.current_database
         let(:filters) { {
           aggregator: 'and',
           conditions: [{
-            field: 'name',
-            operator: 'contains',
-            value: 'a',
-          }]
+                         field: 'name',
+                         operator: 'contains',
+                         value: 'a',
+                       }]
         }.to_json }
 
         it 'should get only the records matching the scope' do
@@ -592,6 +591,64 @@ def association_connection.current_database
         end
       end
 
+      describe '#extract_associations_from_filter' do
+        let(:resource) { Tree }
+
+        before { init_scopes }
+
+        context 'with a single filter as JSON string' do
+          let(:filters) {
+            {
+              field: 'island:updated_at',
+              operator: 'equal',
+              value: '2024-01-01'
+            }.to_json
+          }
+
+          it 'extracts the correct association' do
+            expect(getter.send(:extract_associations_from_filter)).to eq [:island]
+          end
+        end
+
+        context 'with grouped conditions as JSON string' do
+          let(:filters) {
+            {
+              aggregator: 'and',
+              conditions: [
+                { field: 'island:updated_at', operator: 'equal', value: '2024-01-01' },
+                { field: 'owner:name', operator: 'equal', value: 'Michel' },
+                { field: 'id', operator: 'present', value: nil }
+              ]
+            }.to_json
+          }
+
+          it 'extracts all unique associations' do
+            expect(getter.send(:extract_associations_from_filter)).to match_array [:island, :owner]
+          end
+        end
+
+        context 'when filters has no association field' do
+          let(:filters) {
+            {
+              field: 'id',
+              operator: 'equal',
+              value: 1
+            }.to_json
+          }
+
+          it 'returns an empty array' do
+            expect(getter.send(:extract_associations_from_filter)).to eq []
+          end
+        end
+
+        context 'when filters is nil' do
+          let(:filters) { nil }
+
+          it 'returns an empty array' do
+            expect(getter.send(:extract_associations_from_filter)).to eq []
+          end
+        end
+      end
     end
   end
-end
+end