forest_liana 9.5.7 → 9.6.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ef02f4f1dde4cd777a5716344e1ffe08328870746e34cd4b61fe0494462765f8
-  data.tar.gz: f00356a4fd733f3d08cd317e0f1a74e81ff936c71b6263da013f2f9528e3a5e4
+  metadata.gz: 4ba2b1f8d8557f9d5627817377b70bb733804ab8cba4f8f5c63868261f9e00ad
+  data.tar.gz: 8d493de4d0148d02e826338b6bb2287c1015094333dfe9891de39be17cc7de8b
 SHA512:
-  metadata.gz: c7b5c5c600644678f25cac77cbef4ec5e410a1d324638abf00f897f9c9b1f4683ae1f94f9b11a9a643a803881f9160ebc2b6fdad72cab124a3a09a4e38d06475
-  data.tar.gz: 1c20cb1fb9457418ef6aa7d91bb68d842a9d311b484c95be108b6a1b848b74a022e8370cfa3c56685cdae91c550c6ebbbb5031b2a11e357461addd34d66e705c
+  metadata.gz: 1e136b9bfe6ba3bb94a5c525f04c6db27a88989fa8b2bff0b2a4341266b8ae901c5cac8c53111d4d0e1b443a9b4dfffdb5954f40a72ac31d1a62ff89a8f2a83b
+  data.tar.gz: a8e80f6812a1146af8f3faaa5c20733d3cb731f9a0cd79e63bf93118daa1daadb4e6e5e18d5ae6c54d8f09c4bb567b953af474e63b29ffac365c89424c8fcc92

data/app/serializers/forest_liana/serializer_factory.rb

@@ -127,8 +127,8 @@ module ForestLiana
                   ret[:href] = "/forest/#{ForestLiana.name_for(object.class)}/#{object.id}/relationships/#{attribute_name}"
                 end
               end
-            rescue TypeError, ActiveRecord::StatementInvalid, NoMethodError
-              puts "Cannot load the association #{attribute_name} on #{object.class.name} #{object.id}."
+            rescue TypeError, ActiveRecord::StatementInvalid, NoMethodError => exception
+              FOREST_LOGGER.warn "Cannot load the association #{attribute_name} on #{object.class.name} #{object.id}.\n#{exception&.backtrace&.join("\n\t")}"
             end
           end
 

data/app/services/forest_liana/ability/exceptions/access_denied.rb

@@ -2,12 +2,13 @@ module ForestLiana
   module Ability
     module Exceptions
       class AccessDenied < ForestLiana::Errors::ExpectedError
-        def initialize
+        def initialize (backtrace = nil)
           super(
             403,
             :forbidden,
             'You don\'t have permission to access this resource',
-            'AccessDenied'
+            'AccessDenied',
+            backtrace
           )
         end
       end

data/app/services/forest_liana/ability/exceptions/action_condition_error.rb

@@ -2,12 +2,13 @@ module ForestLiana
   module Ability
     module Exceptions
       class ActionConditionError < ForestLiana::Errors::ExpectedError
-        def initialize
+        def initialize (backtrace = nil)
           super(
             409,
                 :conflict,
                 'The conditions to trigger this action cannot be verified. Please contact an administrator.',
-                'InvalidActionConditionError'
+                'InvalidActionConditionError',
+            backtrace
           )
         end
       end

data/app/services/forest_liana/ability/exceptions/require_approval.rb

@@ -3,13 +3,14 @@ module ForestLiana
     module Exceptions
       class RequireApproval < ForestLiana::Errors::ExpectedError
         attr_reader :data
-        def initialize(data)
+        def initialize(data, backtrace = nil)
           @data = data
           super(
             403,
                 :forbidden,
                 'This action requires to be approved.',
                 'CustomActionRequiresApprovalError',
+            backtrace,
           )
         end
       end

data/app/services/forest_liana/ability/exceptions/trigger_forbidden.rb

@@ -2,12 +2,13 @@ module ForestLiana
   module Ability
     module Exceptions
       class TriggerForbidden < ForestLiana::Errors::ExpectedError
-        def initialize
+        def initialize(backtrace = nil)
           super(
             403,
                 :forbidden,
                 'You don\'t have the permission to trigger this action',
-                'CustomActionTriggerForbiddenError'
+                'CustomActionTriggerForbiddenError',
+            backtrace,
           )
         end
       end

data/app/services/forest_liana/ability/exceptions/unknown_collection.rb

@@ -2,12 +2,13 @@ module ForestLiana
   module Ability
     module Exceptions
       class UnknownCollection < ForestLiana::Errors::ExpectedError
-        def initialize(collection_name)
+        def initialize(collection_name, backtrace = nil)
           super(
             409,
             :conflict,
             "The collection #{collection_name} doesn't exist",
-            'collection not found'
+            'collection not found',
+            backtrace
           )
         end
       end

data/app/services/forest_liana/ability/permission/smart_action_checker.rb

@@ -65,8 +65,8 @@ module ForestLiana
             end
 
             records.select(@collection.table_name + '.id').count == attributes[:ids].count
-          rescue
-            raise ForestLiana::Ability::Exceptions::ActionConditionError.new
+          rescue => exception
+            raise ForestLiana::Ability::Exceptions::ActionConditionError.new(exception.backtrace)
           end
         end
 

data/app/services/forest_liana/ability/permission.rb

@@ -27,8 +27,8 @@ module ForestLiana
           is_allowed
         rescue ForestLiana::Errors::ExpectedError => exception
           raise exception
-        rescue
-          raise ForestLiana::Ability::Exceptions::UnknownCollection.new(collection_name)
+        rescue => exception
+          raise ForestLiana::Ability::Exceptions::UnknownCollection.new(collection_name, exception.backtrace)
         end
       end
 
@@ -45,8 +45,8 @@ module ForestLiana
           smart_action_approval.can_execute?
         rescue ForestLiana::Errors::ExpectedError => exception
           raise exception
-        rescue
-          raise ForestLiana::Ability::Exceptions::UnknownCollection.new(collection_name)
+        rescue => exception
+          raise ForestLiana::Ability::Exceptions::UnknownCollection.new(collection_name, exception.backtrace)
         end
       end
 

data/app/services/forest_liana/forest_api_requester.rb

@@ -10,7 +10,10 @@ module ForestLiana
           query: query,
         }).response
       rescue
-        raise "Cannot reach Forest API at #{forest_api_url}#{route}, it seems to be down right now."
+        message = "Cannot reach Forest API at #{forest_api_url}#{route}, it seems to be down right now."
+        FOREST_LOGGER.error message
+        FOREST_REPORTER.report message
+        raise
       end
     end
 
@@ -29,7 +32,10 @@ module ForestLiana
           body: body.to_json,
         }).response
       rescue
-        raise "Cannot reach Forest API at #{post_route}, it seems to be down right now."
+        message = "Cannot reach Forest API at #{post_route}, it seems to be down right now."
+        FOREST_LOGGER.error message
+        FOREST_REPORTER.report message
+        raise
       end
     end
 

data/config/initializers/errors.rb

@@ -44,11 +44,13 @@ module ForestLiana
     class ExpectedError < StandardError
       attr_reader :error_code, :status, :message, :name
 
-      def initialize(error_code, status, message, name = nil)
+      def initialize(error_code, status, message, name = nil, backtrace = nil)
         @error_code = error_code
         @status = status
         @message = message
         @name = name
+
+        set_backtrace(backtrace) unless backtrace.nil?
       end
 
       def display_error

data/lib/forest_liana/collection.rb

@@ -80,8 +80,16 @@ module ForestLiana::Collection
 
       field = opts.merge({
         field: name,
-        is_filterable: !!opts[:is_filterable],
-        is_sortable: !!opts[:is_sortable],
+        is_filterable: if opts.has_key?(:is_filterable)
+                        !!opts[:is_filterable]
+                      else
+                        !!opts[:polymorphic_key]
+                      end,
+        is_sortable: if opts.has_key?(:is_sortable)
+                      !!opts[:is_sortable]
+                    else
+                      !!opts[:polymorphic_key]
+                    end
       })
 
       add_field(field)

data/lib/forest_liana/version.rb

@@ -1,3 +1,3 @@
 module ForestLiana
-  VERSION = "9.5.7"
+  VERSION = "9.6.3"
 end

data/spec/config/initializers/errors_spec.rb

@@ -0,0 +1,34 @@
+module ForestLiana
+  describe Errors do
+    describe 'ExpectedError' do
+      describe 'when initializing' do
+        describe 'when backtrace is added' do
+          it 'should add the backtrace to the errors if passed' do
+            err = nil
+
+            begin
+              raise "This is an exception"
+            rescue => error
+              err = ForestLiana::Errors::ExpectedError.new(300, 300, error.message, nil, error.backtrace )
+            end
+
+            expect(err.backtrace).to be_truthy
+          end
+        end
+        describe 'when backtrace is not added' do
+          it 'should not break nor add any backtrace' do
+            err = nil
+
+            begin
+              raise "This is an exception"
+            rescue => error
+              err = ForestLiana::Errors::ExpectedError.new(300, 300, error.message, nil)
+            end
+
+            expect(err.backtrace).to be_falsy
+          end
+        end
+      end
+    end
+  end
+end

data/spec/dummy/lib/forest_liana/collections/address.rb

@@ -0,0 +1,17 @@
+class Forest::Address
+    include ForestLiana::Collection
+
+    collection :Address
+
+    field :addressable_type, type: 'String', polymorphic_key: true, is_filterable: false do
+      object.addressable_type
+    end
+
+    field :addressable_id, type: 'String', polymorphic_key: true do
+      object.addressable_type
+    end
+
+    field :address_type, type: 'String' do
+      'delivery'
+    end
+end

data/spec/lib/forest_liana/collection_spec.rb

@@ -0,0 +1,51 @@
+module ForestLiana
+  describe Collection do
+    before do
+      allow(ForestLiana).to receive(:env_secret).and_return(nil)
+    end
+
+    let(:collection) { ForestLiana.apimap.select { |collection| collection.name == 'Address' }.first }
+
+    describe 'field' do
+      it 'add simple smart field' do
+        field = collection.fields.select { |field| field[:field] == :address_type }.first
+
+        expect(field).not_to be_nil
+        expect(field).to eq(
+          {
+            type: "String",
+            is_read_only: true,
+            is_required: false,
+            default_value: nil,
+            integration: nil,
+            reference: nil,
+            inverse_of: nil,
+            relationships: nil,
+            widget: nil,
+            validations: [],
+            is_virtual: true,
+            field: :address_type,
+            is_filterable: false,
+            is_sortable: false
+          }
+        )
+      end
+
+      it 'add polymorphic smart field with default values' do
+        field = collection.fields.select { |field| field[:field] == :addressable_id }.first
+
+        expect(field).not_to be_nil
+        expect(field[:is_filterable]).to eq(true)
+        expect(field[:is_sortable]).to eq(true)
+      end
+
+      it 'add polymorphic smart field with is_filterable option set to false' do
+        field = collection.fields.select { |field| field[:field] == :addressable_type }.first
+
+        expect(field).not_to be_nil
+        expect(field[:is_filterable]).to eq(false)
+        expect(field[:is_sortable]).to eq(true)
+      end
+    end
+  end
+end

data/spec/services/forest_liana/forest_api_requester_spec.rb

@@ -0,0 +1,44 @@
+module ForestLiana
+  describe ForestApiRequester do
+    describe 'when an error occurs' do
+      before do
+        allow(HTTParty).to receive(:get).and_raise(StandardError, 'Custom error message')
+        allow(HTTParty).to receive(:post).and_raise(StandardError, 'Custom error message')
+      end
+
+      describe 'Get' do
+        it 'should keep the original error and raise it with backtrace' do
+          err = nil
+
+          begin
+            ForestApiRequester.get('/incorrect_url')
+          rescue => error
+            err = error
+          end
+
+          expect(error)
+            .to be_instance_of(StandardError)
+            .and have_attributes(:message => 'Custom error message')
+            .and have_attributes(:backtrace => be_truthy)
+        end
+      end
+
+      describe 'Post' do
+        it 'should keep the original error and raise it with backtrace' do
+          err = nil
+
+          begin
+            ForestApiRequester.post('/incorrect_url')
+          rescue => error
+            err = error
+          end
+
+          expect(error)
+            .to be_instance_of(StandardError)
+            .and have_attributes(:message => 'Custom error message')
+            .and have_attributes(:backtrace => be_truthy)
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: forest_liana
 version: !ruby/object:Gem::Version
-  version: 9.5.7
+  version: 9.6.3
 platform: ruby
 authors:
 - Sandro Munda
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-12-10 00:00:00.000000000 Z
+date: 2024-12-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -329,6 +329,7 @@ files:
 - lib/tasks/clear_oidc_data.rake
 - lib/tasks/display_apimap.rake
 - lib/tasks/send_apimap.rake
+- spec/config/initializers/errors_spec.rb
 - spec/config/initializers/logger_spec.rb
 - spec/dummy/README.rdoc
 - spec/dummy/Rakefile
@@ -395,6 +396,7 @@ files:
 - spec/dummy/db/migrate/20220727114930_add_columns_to_products.rb
 - spec/dummy/db/migrate/20231117084236_create_addresses.rb
 - spec/dummy/db/schema.rb
+- spec/dummy/lib/forest_liana/collections/address.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
@@ -403,6 +405,7 @@ files:
 - spec/helpers/forest_liana/query_helper_spec.rb
 - spec/helpers/forest_liana/schema_helper_spec.rb
 - spec/lib/forest_liana/bootstrapper_spec.rb
+- spec/lib/forest_liana/collection_spec.rb
 - spec/lib/forest_liana/schema_file_updater_spec.rb
 - spec/rails_helper.rb
 - spec/requests/actions_controller_spec.rb
@@ -418,6 +421,7 @@ files:
 - spec/services/forest_liana/ability/permission_spec.rb
 - spec/services/forest_liana/apimap_sorter_spec.rb
 - spec/services/forest_liana/filters_parser_spec.rb
+- spec/services/forest_liana/forest_api_requester_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
@@ -630,6 +634,7 @@ test_files:
 - test/services/forest_liana/operator_date_interval_parser_test.rb
 - test/services/forest_liana/schema_adapter_test.rb
 - test/test_helper.rb
+- spec/config/initializers/errors_spec.rb
 - spec/config/initializers/logger_spec.rb
 - spec/dummy/README.rdoc
 - spec/dummy/Rakefile
@@ -696,6 +701,7 @@ test_files:
 - spec/dummy/db/migrate/20220727114930_add_columns_to_products.rb
 - spec/dummy/db/migrate/20231117084236_create_addresses.rb
 - spec/dummy/db/schema.rb
+- spec/dummy/lib/forest_liana/collections/address.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
@@ -704,6 +710,7 @@ test_files:
 - spec/helpers/forest_liana/query_helper_spec.rb
 - spec/helpers/forest_liana/schema_helper_spec.rb
 - spec/lib/forest_liana/bootstrapper_spec.rb
+- spec/lib/forest_liana/collection_spec.rb
 - spec/lib/forest_liana/schema_file_updater_spec.rb
 - spec/rails_helper.rb
 - spec/requests/actions_controller_spec.rb
@@ -719,6 +726,7 @@ test_files:
 - spec/services/forest_liana/ability/permission_spec.rb
 - spec/services/forest_liana/apimap_sorter_spec.rb
 - spec/services/forest_liana/filters_parser_spec.rb
+- spec/services/forest_liana/forest_api_requester_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