forest_liana 7.0.0.beta.4 → 7.0.0.beta.5

data/spec/services/forest_liana/resources_getter_spec.rb

@@ -6,13 +6,21 @@ module ForestLiana
     let(:sort) { 'id' }
     let(:fields) { }
     let(:filters) { }
+    let(:scopes) { { } }
+    let(:rendering_id) { 13 }
+    let(:user) { { 'id' => '1', 'rendering_id' => rendering_id } }
 
     let(:getter) { described_class.new(resource, {
       page: { size: pageSize, number: pageNumber },
       sort: sort,
       fields: fields,
       filters: filters,
-    })}
+    }, user) }
+
+    def init_scopes
+      ForestLiana::ScopeManager.invalidate_scope_cache(rendering_id)
+      allow(ForestLiana::ScopeManager).to receive(:fetch_scopes).and_return(scopes)
+    end
 
     before(:each) do
       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']
@@ -43,6 +51,7 @@ module ForestLiana
       ].map { |location| Location.create(coordinates: location[:coordinates], island: location[:island]) }
 
       reference = Reference.create()
+      init_scopes
     end
 
     after(:each) do
@@ -355,5 +364,63 @@ module ForestLiana
         )
       end
     end
+
+    describe 'when scopes are defined' do
+      let(:resource) { Island }
+      let(:pageSize) { 15 }
+      let(:fields) { }
+      let(:filters) { }
+      let(:scopes) {
+        {
+          'Island' => {
+            'scope'=> {
+              'filter'=> {
+                'aggregator' => 'and',
+                'conditions' => [
+                  { 'field' => 'name', 'operator' => 'contains', 'value' => 'u' }
+                ]
+              },
+              'dynamicScopesValues' => { }
+            }
+          }
+        }
+      }
+
+      describe 'when there are NO filters already defined' do
+        it 'should get only the records matching the scope' do
+          getter.perform
+          records = getter.records
+          count = getter.count
+
+          expect(records.count).to eq 3
+          expect(count).to eq 3
+          expect(records.first.name).to eq 'Skull'
+          expect(records.second.name).to eq 'Muerta'
+          expect(records.third.name).to eq 'Treasure'
+        end
+      end
+
+      describe 'when there are filters already defined' do
+        let(:filters) { {
+          aggregator: 'and',
+          conditions: [{
+            field: 'name',
+            operator: 'contains',
+            value: 'a',
+          }]
+        }.to_json }
+
+        it 'should get only the records matching the scope' do
+          getter.perform
+          records = getter.records
+          count = getter.count
+
+          expect(records.count).to eq 2
+          expect(count).to eq 2
+          expect(records.first.name).to eq 'Muerta'
+          expect(records.second.name).to eq 'Treasure'
+        end
+      end
+    end
   end
 end

data/spec/services/forest_liana/scope_manager_spec.rb

@@ -0,0 +1,232 @@
+module ForestLiana
+  describe ScopeManager do
+    let(:rendering_id) { 13 }
+    let(:user) { { 'id' => '1', 'rendering_id' => rendering_id } }
+    let(:collection_name) { 'Users' }
+    let(:first_collection_scope) {
+      {
+        'scope'=> {
+          'filter'=> {
+            'aggregator' => 'and',
+            'conditions' => [
+              { 'field' => 'description', 'operator' => 'contains', 'value' => 'check' }
+            ]
+          },
+          'dynamicScopesValues' => { }
+        }
+      }
+    }
+    let(:second_collection_scope) {
+      {
+        'scope'=> {
+          'filter'=> {
+            'aggregator' => 'and',
+            'conditions' => [
+              { 'field' => 'description', 'operator' => 'contains', 'value' => 'toto' }
+            ]
+          },
+          'dynamicScopesValues' => { }
+        }
+      }
+    }
+    let(:first_json_scopes) { JSON.generate({ collection_name => first_collection_scope }) }
+    let(:second_json_scopes) { JSON.generate({ collection_name => second_collection_scope }) }
+    let(:first_scopes_api_call_response) { Net::HTTPOK.new({}, 200, first_json_scopes) }
+    let(:second_scopes_api_call_response) { Net::HTTPOK.new({}, 200, second_json_scopes) }
+
+    before do
+      described_class.invalidate_scope_cache(rendering_id)
+      allow(ForestLiana::ForestApiRequester).to receive(:get).and_return(first_scopes_api_call_response, second_scopes_api_call_response)
+      allow(first_scopes_api_call_response).to receive(:body).and_return(first_json_scopes)
+      allow(second_scopes_api_call_response).to receive(:body).and_return(second_json_scopes)
+    end
+
+    describe '#get_scope_for_user' do
+      describe 'with invalid inputs' do
+        it 'should raise an error on missing rendering_id' do
+          expect {
+            described_class.get_scope_for_user({}, collection_name)
+          }.to raise_error 'Missing required rendering_id'
+        end
+
+        it 'should raise an error on missing collection_name' do
+          expect {
+            described_class.get_scope_for_user(user, nil)
+          }.to raise_error 'Missing required collection_name'
+        end
+      end
+
+      describe 'when the backend return an errored response' do
+        let(:first_scopes_api_call_response) { Net::HTTPNotFound.new({}, 404, nil) }
+
+        it 'should raise an error' do
+          expect {
+            described_class.get_scope_for_user(user, collection_name)
+          }.to raise_error 'Unable to fetch scopes'
+        end
+      end
+
+      describe 'when retrieving scopes once with no cached value' do
+        let(:scope) { described_class.get_scope_for_user(user, collection_name) }
+
+        it 'should fetch the relevant scope and return it' do
+          expect(scope).to eq first_collection_scope['scope']['filter']
+          expect(ForestLiana::ForestApiRequester).to have_received(:get).once
+          expect(ForestLiana::ForestApiRequester).to have_received(:get).with('/liana/scopes', query: { 'renderingId' => rendering_id })
+        end
+      end
+
+      describe 'when retrieving scopes twice before the refresh cache delta' do
+        let(:scope_first_fetch) { described_class.get_scope_for_user(user, collection_name) }
+        let(:scope_second_fetch) { described_class.get_scope_for_user(user, collection_name) }
+
+        it 'should return the same value twice and have fetch the scopes from the backend only once' do
+          expect(scope_first_fetch).to eq first_collection_scope['scope']['filter']
+          expect(scope_second_fetch).to eq first_collection_scope['scope']['filter']
+          expect(ForestLiana::ForestApiRequester).to have_received(:get).once.with('/liana/scopes', query: { 'renderingId' => rendering_id })
+        end
+      end
+
+      describe 'when retrieving scopes twice after the refresh cache delta' do
+        let(:scope_first_fetch) { described_class.get_scope_for_user(user, collection_name) }
+        let(:scope_second_fetch) { described_class.get_scope_for_user(user, collection_name) }
+
+        it 'should return same value but trigger a fetch twice' do
+          expect(scope_first_fetch).to eq first_collection_scope['scope']['filter']
+          allow(Time).to receive(:now).and_return(Time.now + 20.minutes)
+          expect(scope_second_fetch).to eq first_collection_scope['scope']['filter']
+          # sleep to wait for the Thread to trigger the call to the `ForestApiRequester`
+          sleep(0.001)
+          expect(ForestLiana::ForestApiRequester).to have_received(:get).twice.with('/liana/scopes', query: { 'renderingId' => rendering_id })
+        end
+      end
+
+      describe 'when retrieving scopes three times after the refresh cache delta' do
+        let(:scope_first_fetch) { described_class.get_scope_for_user(user, collection_name) }
+        let(:scope_second_fetch) { described_class.get_scope_for_user(user, collection_name) }
+        let(:scope_third_fetch) { described_class.get_scope_for_user(user, collection_name) }
+
+        it 'should return a new value on third call and have fetch the scopes from the backend only twice' do
+          expect(scope_first_fetch).to eq first_collection_scope['scope']['filter']
+          allow(Time).to receive(:now).and_return(Time.now + 20.minutes)
+          expect(scope_second_fetch).to eq first_collection_scope['scope']['filter']
+          # sleep to wait for the Thread to update the cache
+          sleep(0.001)
+          expect(scope_third_fetch).to eq second_collection_scope['scope']['filter']
+          expect(ForestLiana::ForestApiRequester).to have_received(:get).twice.with('/liana/scopes', query: { 'renderingId' => rendering_id })
+        end
+      end
+
+      describe 'when scope contains dynamic values' do
+        let(:first_collection_scope) {
+          {
+            'scope' => {
+              'filter'=> {
+                'aggregator' => 'and',
+                'conditions' => [
+                  { 'field' => 'description', 'operator' => 'contains', 'value' => '$currentUser.firstName' }
+                ]
+              },
+              'dynamicScopesValues' => {
+                'users' => { '1' => { '$currentUser.firstName' => 'Valentin' } }
+              }
+            }
+          }
+        }
+        let(:scope_filter) { described_class.get_scope_for_user(user, collection_name) }
+        let(:expected_filter) {
+          {
+            'aggregator' => 'and',
+            'conditions' => [
+              { 'field' => 'description', 'operator' => 'contains', 'value' => 'Valentin' }
+            ]
+          }
+        }
+
+        it 'should replace the dynamic values properly' do
+          expect(scope_filter).to eq expected_filter
+          expect(ForestLiana::ForestApiRequester).to have_received(:get).once
+          expect(ForestLiana::ForestApiRequester).to have_received(:get).with('/liana/scopes', query: { 'renderingId' => rendering_id })
+        end
+      end
+
+      describe 'when target collection has no scopes' do
+        let(:first_collection_scope) { { } }
+        let(:scope_filter) { described_class.get_scope_for_user(user, collection_name) }
+
+        it 'should return nil' do
+          expect(scope_filter).to eq nil
+          expect(ForestLiana::ForestApiRequester).to have_received(:get).once
+          expect(ForestLiana::ForestApiRequester).to have_received(:get).with('/liana/scopes', query: { 'renderingId' => rendering_id })
+        end
+      end
+
+      describe 'when target collection has no scopes' do
+        let(:first_collection_scope) { { } }
+        let(:scope_filter) { described_class.get_scope_for_user(user, collection_name) }
+
+        it 'should return nil' do
+          expect(scope_filter).to eq nil
+          expect(ForestLiana::ForestApiRequester).to have_received(:get).once
+          expect(ForestLiana::ForestApiRequester).to have_received(:get).with('/liana/scopes', query: { 'renderingId' => rendering_id })
+        end
+      end
+
+      describe 'when asking for filters as string' do
+        let(:scope) { described_class.get_scope_for_user(user, collection_name, as_string: true) }
+        let(:expected_filters) { "{\"aggregator\":\"and\",\"conditions\":[{\"field\":\"description\",\"operator\":\"contains\",\"value\":\"check\"}]}" }
+
+        it 'should fetch the relevant scope and return it as a string' do
+          expect(scope).to eq expected_filters
+          expect(ForestLiana::ForestApiRequester).to have_received(:get).once
+          expect(ForestLiana::ForestApiRequester).to have_received(:get).with('/liana/scopes', query: { 'renderingId' => rendering_id })
+        end
+      end
+    end
+
+    describe '#append_scope_for_user' do
+      let(:existing_filter) { "{\"aggregator\":\"and\",\"conditions\":[{\"field\":\"shipping_status\",\"operator\":\"equal\",\"value\":\"Shipped\"}]}" }
+      let(:first_collection_scope_filter_as_string) { "{\"aggregator\":\"and\",\"conditions\":[{\"field\":\"description\",\"operator\":\"contains\",\"value\":\"check\"}]}" }
+
+      describe 'when the target collection has NO scopes defined' do
+        let(:first_collection_scope) { { } }
+
+        describe 'when providing NO existing filters' do
+          let(:existing_filter) { nil }
+          let(:filters) { described_class.append_scope_for_user(existing_filter, user, collection_name) }
+
+          it 'should return nil' do
+            expect(filters).to eq nil
+          end
+        end
+
+        describe 'when providing existing filters' do
+          let(:filters) { described_class.append_scope_for_user(existing_filter, user, collection_name) }
+
+          it 'should return only the exisitng filters' do
+            expect(filters).to eq existing_filter
+          end
+        end
+      end
+
+      describe 'when the target collection has scopes defined' do
+        describe 'when providing NO existing filters' do
+          let(:existing_filter) { nil }
+          let(:filters) { described_class.append_scope_for_user(existing_filter, user, collection_name) }
+
+          it 'should return only the scope filters' do
+            expect(filters).to eq first_collection_scope_filter_as_string
+          end
+        end
+
+        describe 'when providing existing filters' do
+          let(:filters) { described_class.append_scope_for_user(existing_filter, user, collection_name) }
+
+          it 'should return the aggregation between the exisitng filters and the scope filters' do
+            expect(filters).to eq "{\"aggregator\":\"and\",\"conditions\":[#{existing_filter},#{first_collection_scope_filter_as_string}]}"
+          end
+        end
+      end
+    end
+  end
+end

data/spec/services/forest_liana/value_stat_getter_spec.rb

@@ -0,0 +1,96 @@
+module ForestLiana
+  describe ValueStatGetter do
+    let(:rendering_id) { 13 }
+    let(:user) { { 'id' => '1', 'rendering_id' => rendering_id } }
+
+    before(:each) do
+      ForestLiana::ScopeManager.invalidate_scope_cache(rendering_id)
+      allow(ForestLiana::ScopeManager).to receive(:fetch_scopes).and_return(scopes)
+
+      island = Island.create!(name: 'Númenor')
+      king = User.create!(title: :king, name: 'Aragorn')
+      villager = User.create!(title: :villager)
+      Tree.create!(name: 'Tree n1', age: 1, island: island, owner: king)
+      Tree.create!(name: 'Tree n2', age: 3, island: island, created_at: 3.day.ago, owner: villager)
+      Tree.create!(name: 'Tree n3', age: 4, island: island, owner: king, cutter: villager)
+    end
+
+    let(:params) {
+      {
+        type: "Value",
+        collection: collection,
+        timezone: "Europe/Paris",
+        aggregate: "Count",
+        filters: filters
+      }
+    }
+
+    subject { ValueStatGetter.new(model, params, user) }
+
+    describe 'with empty scopes' do
+      let(:scopes) { { } }
+
+      describe 'with a simple filter matching no entries' do
+        let(:model) { User }
+        let(:collection) { 'users' }
+        let(:filters) { { field: 'name', operator: 'in', value: ['Merry', 'Pippin'] }.to_json }
+
+        it 'should have a countCurrent of 0' do
+          subject.perform
+          expect(subject.record.value[:countCurrent]).to eq 0
+        end
+      end
+
+      describe 'with a filter on a belongs_to string field' do
+        let(:model) { Tree }
+        let(:collection) { 'trees' }
+        let(:filters) { { field: 'owner:name', operator: 'equal', value: 'Aragorn' }.to_json }
+
+        it 'should have a countCurrent of 2' do
+          subject.perform
+          expect(subject.record.value[:countCurrent]).to eq 2
+        end
+      end
+
+      describe 'with a filter on a belongs_to enum field' do
+        let(:model) { Tree }
+        let(:collection) { 'trees' }
+        let(:filters) { { field: 'owner:title', operator: 'equal', value: 'villager' }.to_json }
+
+        it 'should have a countCurrent of 1' do
+          subject.perform
+          expect(subject.record.value[:countCurrent]).to eq 1
+        end
+      end
+    end
+
+    describe 'with scopes' do
+      let(:scopes) {
+        {
+          'User' => {
+            'scope'=> {
+              'filter'=> {
+                'aggregator' => 'and',
+                'conditions' => [
+                  { 'field' => 'title', 'operator' => 'not_equal', 'value' => 'villager' }
+                ]
+              },
+              'dynamicScopesValues' => { }
+            }
+          }
+        }
+      }
+
+      describe 'with a filter on a belongs_to enum field' do
+        let(:model) { User }
+        let(:collection) { 'users' }
+        let(:filters) { { field: 'title', operator: 'equal', value: 'villager' }.to_json }
+
+        it 'should have a countCurrent of 0' do
+          subject.perform
+          expect(subject.record.value[:countCurrent]).to eq 0
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: forest_liana
 version: !ruby/object:Gem::Version
-  version: 7.0.0.beta.4
+  version: 7.0.0.beta.5
 platform: ruby
 authors:
 - Sandro Munda
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-07-06 00:00:00.000000000 Z
+date: 2021-07-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -218,6 +218,7 @@ files:
 - app/controllers/forest_liana/mixpanel_controller.rb
 - app/controllers/forest_liana/resources_controller.rb
 - app/controllers/forest_liana/router.rb
+- app/controllers/forest_liana/scopes_controller.rb
 - app/controllers/forest_liana/smart_actions_controller.rb
 - app/controllers/forest_liana/stats_controller.rb
 - app/controllers/forest_liana/stripe_controller.rb
@@ -280,7 +281,7 @@ files:
 - app/services/forest_liana/resources_getter.rb
 - app/services/forest_liana/schema_adapter.rb
 - app/services/forest_liana/schema_utils.rb
-- app/services/forest_liana/scope_validator.rb
+- app/services/forest_liana/scope_manager.rb
 - app/services/forest_liana/search_query_builder.rb
 - app/services/forest_liana/smart_action_field_validator.rb
 - app/services/forest_liana/stat_getter.rb
@@ -324,6 +325,7 @@ files:
 - spec/dummy/app/assets/stylesheets/application.css
 - spec/dummy/app/config/routes.rb
 - spec/dummy/app/controllers/application_controller.rb
+- spec/dummy/app/controllers/forest/islands_controller.rb
 - spec/dummy/app/helpers/application_helper.rb
 - spec/dummy/app/models/island.rb
 - spec/dummy/app/models/location.rb
@@ -366,6 +368,7 @@ files:
 - spec/dummy/db/migrate/20210511141752_create_owners.rb
 - spec/dummy/db/migrate/20210526084712_create_products.rb
 - spec/dummy/db/schema.rb
+- spec/dummy/lib/forest_liana/collections/island.rb
 - spec/dummy/lib/forest_liana/collections/location.rb
 - spec/dummy/lib/forest_liana/collections/user.rb
 - spec/helpers/forest_liana/query_helper_spec.rb
@@ -379,6 +382,7 @@ files:
 - spec/requests/stats_spec.rb
 - spec/services/forest_liana/apimap_sorter_spec.rb
 - spec/services/forest_liana/filters_parser_spec.rb
+- spec/services/forest_liana/has_many_getter_spec.rb
 - spec/services/forest_liana/ip_whitelist_checker_spec.rb
 - spec/services/forest_liana/line_stat_getter_spec.rb
 - spec/services/forest_liana/permissions_checker_acl_disabled_spec.rb
@@ -386,9 +390,13 @@ files:
 - spec/services/forest_liana/permissions_checker_live_queries_spec.rb
 - spec/services/forest_liana/permissions_formatter_spec.rb
 - spec/services/forest_liana/permissions_getter_spec.rb
+- spec/services/forest_liana/pie_stat_getter_spec.rb
+- spec/services/forest_liana/resource_updater_spec.rb
 - spec/services/forest_liana/resources_getter_spec.rb
 - spec/services/forest_liana/schema_adapter_spec.rb
+- spec/services/forest_liana/scope_manager_spec.rb
 - spec/services/forest_liana/smart_action_field_validator_spec.rb
+- spec/services/forest_liana/value_stat_getter_spec.rb
 - spec/spec_helper.rb
 - test/dummy/README.rdoc
 - test/dummy/Rakefile
@@ -474,13 +482,8 @@ files:
 - test/fixtures/tree.yml
 - test/forest_liana_test.rb
 - test/routing/route_test.rb
-- test/services/forest_liana/has_many_getter_test.rb
 - test/services/forest_liana/operator_date_interval_parser_test.rb
-- test/services/forest_liana/pie_stat_getter_test.rb
-- test/services/forest_liana/resource_updater_test.rb
 - test/services/forest_liana/schema_adapter_test.rb
-- test/services/forest_liana/scope_validator_test.rb
-- test/services/forest_liana/value_stat_getter_test.rb
 - test/test_helper.rb
 homepage: https://github.com/ForestAdmin/forest-rails
 licenses:
@@ -509,12 +512,7 @@ test_files:
 - test/routing/route_test.rb
 - test/forest_liana_test.rb
 - test/services/forest_liana/schema_adapter_test.rb
-- test/services/forest_liana/resource_updater_test.rb
-- test/services/forest_liana/scope_validator_test.rb
 - test/services/forest_liana/operator_date_interval_parser_test.rb
-- test/services/forest_liana/value_stat_getter_test.rb
-- test/services/forest_liana/has_many_getter_test.rb
-- test/services/forest_liana/pie_stat_getter_test.rb
 - test/fixtures/string_field.yml
 - test/fixtures/reference.yml
 - test/fixtures/has_one_field.yml
@@ -600,17 +598,22 @@ test_files:
 - test/test_helper.rb
 - spec/helpers/forest_liana/schema_helper_spec.rb
 - spec/helpers/forest_liana/query_helper_spec.rb
+- spec/services/forest_liana/scope_manager_spec.rb
+- spec/services/forest_liana/resource_updater_spec.rb
+- spec/services/forest_liana/pie_stat_getter_spec.rb
 - spec/services/forest_liana/permissions_checker_live_queries_spec.rb
 - spec/services/forest_liana/ip_whitelist_checker_spec.rb
 - spec/services/forest_liana/line_stat_getter_spec.rb
 - spec/services/forest_liana/schema_adapter_spec.rb
 - spec/services/forest_liana/resources_getter_spec.rb
 - spec/services/forest_liana/smart_action_field_validator_spec.rb
+- spec/services/forest_liana/has_many_getter_spec.rb
 - spec/services/forest_liana/apimap_sorter_spec.rb
 - spec/services/forest_liana/filters_parser_spec.rb
 - spec/services/forest_liana/permissions_checker_acl_enabled_spec.rb
 - spec/services/forest_liana/permissions_formatter_spec.rb
 - spec/services/forest_liana/permissions_getter_spec.rb
+- spec/services/forest_liana/value_stat_getter_spec.rb
 - spec/services/forest_liana/permissions_checker_acl_disabled_spec.rb
 - spec/spec_helper.rb
 - spec/config/initializers/logger_spec.rb
@@ -652,6 +655,7 @@ test_files:
 - spec/dummy/config/initializers/forest_liana.rb
 - spec/dummy/config/routes.rb
 - spec/dummy/lib/forest_liana/collections/location.rb
+- spec/dummy/lib/forest_liana/collections/island.rb
 - spec/dummy/lib/forest_liana/collections/user.rb
 - spec/dummy/app/models/location.rb
 - spec/dummy/app/models/island.rb
@@ -667,6 +671,7 @@ test_files:
 - spec/dummy/app/assets/stylesheets/application.css
 - spec/dummy/app/assets/config/manifest.js
 - spec/dummy/app/controllers/application_controller.rb
+- spec/dummy/app/controllers/forest/islands_controller.rb
 - spec/dummy/bin/setup
 - spec/dummy/bin/bundle
 - spec/dummy/bin/rake