fix(errors): provide stacktrace with errors (#705)

* fix(errors): provide stacktrace with errors

* chore: remove non related files

* fix: remove useless attr_reader

* test(errors): assert that backtrace is handle properly

* chore(tests): add emtpy space

Author: SteveBunlon

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

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

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

@@ -3,13 +3,14 @@ module Ability
     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

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

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

app/services/forest_liana/ability/permission.rb

@@ -27,8 +27,8 @@ def is_crud_authorized?(action, user, collection)
           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 @@ def is_smart_action_authorized?(user, collection, parameters, endpoint, http_met
           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
 

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

@@ -65,8 +65,8 @@ def match_conditions(condition_name)
             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
 

config/initializers/errors.rb

@@ -44,11 +44,13 @@ def initialize(error, error_description, state)
     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

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