feat(reporter): customers can now catch every errors thrown by forest (#519)

SteveBunlon · web-flow · commit c040b7351177 · 2021-11-04T17:20:32.000+01:00
diff --git a/app/controllers/forest_liana/actions_controller.rb b/app/controllers/forest_liana/actions_controller.rb
@@ -5,6 +5,7 @@ def get_smart_action_hook_request
       begin
         params[:data][:attributes]
       rescue => error
+        FOREST_REPORTER.report error
         FOREST_LOGGER.error "Smart Action hook request error: #{error}"
         {}
       end
@@ -19,6 +20,7 @@ def get_action(collection_name)
       begin
         collection.actions.find {|action| ActiveSupport::Inflector.parameterize(action.name) == params[:action_name]}
       rescue => error
+        FOREST_REPORTER.report error
         FOREST_LOGGER.error "Smart Action get action retrieval error: #{error}"
         nil
       end
@@ -57,6 +59,7 @@ def handle_result(result, action)
       rescue ForestLiana::Errors::SmartActionInvalidFieldError => invalid_field_error
         FOREST_LOGGER.warn invalid_field_error.message
       rescue ForestLiana::Errors::SmartActionInvalidFieldHookError => invalid_hook_error
+        FOREST_REPORTER.report invalid_hook_error
         FOREST_LOGGER.error invalid_hook_error.message
         return render status: 500, json: { error: invalid_hook_error.message }
       end
diff --git a/app/controllers/forest_liana/associations_controller.rb b/app/controllers/forest_liana/associations_controller.rb
@@ -18,6 +18,7 @@ def index
           format.csv { render_csv(getter, @association.klass) }
         end
       rescue => error
+        FOREST_REPORTER.report error
         FOREST_LOGGER.error "Association Index error: #{error}\n#{format_stacktrace(error)}"
         internal_server_error
       end
@@ -30,6 +31,7 @@ def count
 
         render serializer: nil, json: { count: getter.records_count }
       rescue => error
+        FOREST_REPORTER.report error
         FOREST_LOGGER.error "Association Index Count error: #{error}\n#{format_stacktrace(error)}"
         internal_server_error
       end
@@ -47,6 +49,7 @@ def update
           head :no_content
         end
       rescue => error
+        FOREST_REPORTER.report error
         FOREST_LOGGER.error "Association Update error: #{error}\n#{format_stacktrace(error)}"
         internal_server_error
       end
@@ -59,6 +62,7 @@ def associate
 
         head :no_content
       rescue => error
+        FOREST_REPORTER.report error
         FOREST_LOGGER.error "Association Associate error: #{error}\n#{format_stacktrace(error)}"
         internal_server_error
       end
diff --git a/app/controllers/forest_liana/base_controller.rb b/app/controllers/forest_liana/base_controller.rb
@@ -30,6 +30,7 @@ def reject_unauthorized_ip
         }])
         render(serializer: nil, json: error_data, status: exception.status)
       rescue => exception
+        FOREST_REPORTER.report exception
         FOREST_LOGGER.error(exception)
         FOREST_LOGGER.error(exception.backtrace.join("\n"))
         render(serializer: nil, json: nil, status: :internal_server_error)
diff --git a/app/controllers/forest_liana/resources_controller.rb b/app/controllers/forest_liana/resources_controller.rb
@@ -47,6 +47,7 @@ def index
         }])
         render(serializer: nil, json: error_data, status: error.status)
       rescue => error
+        FOREST_REPORTER.report error
         FOREST_LOGGER.error "Records Index error: #{error}\n#{format_stacktrace(error)}"
         internal_server_error
       end
@@ -79,6 +80,7 @@ def count
         }])
         render(serializer: nil, json: error_data, status: error.status)
       rescue => error
+        FOREST_REPORTER.report error
         FOREST_LOGGER.error "Records Index Count error: #{error}\n#{format_stacktrace(error)}"
         internal_server_error
       end
@@ -96,6 +98,7 @@ def show
       rescue ActiveRecord::RecordNotFound
         render serializer: nil, json: { status: 404 }, status: :not_found
       rescue => error
+        FOREST_REPORTER.report error
         FOREST_LOGGER.error "Record Show error: #{error}\n#{format_stacktrace(error)}"
         internal_server_error
       end
@@ -119,6 +122,7 @@ def create
             creator.record.errors), status: 400
         end
       rescue => error
+        FOREST_REPORTER.report error
         FOREST_LOGGER.error "Record Create error: #{error}\n#{format_stacktrace(error)}"
         internal_server_error
       end
@@ -142,6 +146,7 @@ def update
             updater.record.errors), status: 400
         end
       rescue => error
+        FOREST_REPORTER.report error
         FOREST_LOGGER.error "Record Update error: #{error}\n#{format_stacktrace(error)}"
         internal_server_error
       end
@@ -162,6 +167,7 @@ def destroy
 
       head :no_content
     rescue => error
+      FOREST_REPORTER.report error
       FOREST_LOGGER.error "Record Destroy error: #{error}\n#{format_stacktrace(error)}"
       internal_server_error
     end
@@ -175,6 +181,7 @@ def destroy_bulk
 
       head :no_content
     rescue => error
+      FOREST_REPORTER.report error
       FOREST_LOGGER.error "Records Destroy error: #{error}\n#{format_stacktrace(error)}"
       internal_server_error
     end
@@ -190,6 +197,7 @@ def find_resource
           render serializer: nil, json: { status: 404 }, status: :not_found
         end
       rescue => error
+        FOREST_REPORTER.report error
         FOREST_LOGGER.error "Find Collection error: #{error}\n#{format_stacktrace(error)}"
         render serializer: nil, json: { status: 404 }, status: :not_found
       end
diff --git a/app/controllers/forest_liana/router.rb b/app/controllers/forest_liana/router.rb
@@ -39,6 +39,7 @@ def call(env)
 
         controller.action(action.to_sym).call(env)
       rescue NoMethodError => exception
+        FOREST_REPORTER.report exception
         FOREST_LOGGER.error "Routing error: #{exception}\n#{exception.backtrace.join("\n\t")}"
         ForestLiana::BaseController.action(:route_not_found).call(env)
       end
diff --git a/app/controllers/forest_liana/scopes_controller.rb b/app/controllers/forest_liana/scopes_controller.rb
@@ -12,6 +12,7 @@ def invalidate_scope_cache
         ForestLiana::ScopeManager.invalidate_scope_cache(rendering_id)
         return render serializer: nil, json: { status: 200 }, status: :ok
       rescue => error
+        FOREST_REPORTER.report error
         FOREST_LOGGER.error "Error during scope cache invalidation: #{error.message}"
         render serializer: nil, json: {status: 500 }, status: :internal_server_error
       end
diff --git a/app/controllers/forest_liana/smart_actions_controller.rb b/app/controllers/forest_liana/smart_actions_controller.rb
@@ -12,6 +12,7 @@ def get_smart_action_request
       begin
         params[:data][:attributes]
       rescue => error
+        FOREST_REPORTER.report error
         FOREST_LOGGER.error "Smart Action execution error: #{error}"
         {}
       end
@@ -47,6 +48,7 @@ def ensure_record_ids_in_scope
         # target records are out of scope
         render serializer: nil, json: { error: 'Smart Action: target record not found' }, status: :bad_request
       rescue => error
+        FOREST_REPORTER.report error
         FOREST_LOGGER.error "Smart Action: #{error}\n#{format_stacktrace(error)}"
         render serializer: nil, json: { error: 'Smart Action: failed to evaluate permissions' }, status: :internal_server_error
       end
@@ -70,6 +72,7 @@ def check_permission_for_smart_route
           render serializer: nil, json: { status: 400 }, status: :bad_request
         end
       rescue => error
+        FOREST_REPORTER.report error
         FOREST_LOGGER.error "Smart Action execution error: #{error}"
         render serializer: nil, json: { status: 400 }, status: :bad_request
       end
@@ -85,6 +88,7 @@ def find_resource(collection_name)
           end
           resource
       rescue => error
+        FOREST_REPORTER.report error
         FOREST_LOGGER.error "Find Collection error: #{error}\n#{format_stacktrace(error)}"
         render serializer: nil, json: { status: 404 }, status: :not_found
       end
diff --git a/app/controllers/forest_liana/stats_controller.rb b/app/controllers/forest_liana/stats_controller.rb
@@ -60,6 +60,7 @@ def get_with_live_query
         render json: { errors: [{ status: 422, detail: error.message }] },
           status: :unprocessable_entity, serializer: nil
       rescue => error
+        FOREST_REPORTER.report error
         FOREST_LOGGER.error "Live Query error: #{error.message}"
         render json: { errors: [{ status: 422, detail: error.message }] },
           status: :unprocessable_entity, serializer: nil
@@ -110,6 +111,7 @@ def check_permission(permission_name)
 
         return head :forbidden unless checker.is_authorized?
       rescue => error
+        FOREST_REPORTER.report error
         FOREST_LOGGER.error "Stats execution error: #{error}"
         render serializer: nil, json: { status: 400 }, status: :bad_request
       end
diff --git a/app/services/forest_liana/intercom_attributes_getter.rb b/app/services/forest_liana/intercom_attributes_getter.rb
@@ -18,6 +18,7 @@ def perform
         @record = user
       rescue Intercom::ResourceNotFound
       rescue Intercom::UnexpectedError => exception
+        FOREST_REPORTER.report exception
         FOREST_LOGGER.error "Cannot retrieve the Intercom attributes: #{exception.message}"
       end
     end
diff --git a/app/services/forest_liana/intercom_conversation_getter.rb b/app/services/forest_liana/intercom_conversation_getter.rb
@@ -14,6 +14,7 @@ def perform
       rescue Intercom::ResourceNotFound
         @record = nil
       rescue Intercom::UnexpectedError => exception
+        FOREST_REPORTER.report exception
         FOREST_LOGGER.error "Cannot retrieve the Intercom conversation: #{exception.message}"
         @record = nil
       end
diff --git a/app/services/forest_liana/intercom_conversations_getter.rb b/app/services/forest_liana/intercom_conversations_getter.rb
@@ -31,6 +31,7 @@ def perform
       rescue Intercom::ResourceNotFound
         @records = []
       rescue Intercom::UnexpectedError => exception
+        FOREST_REPORTER.report exception
         FOREST_LOGGER.error "Cannot retrieve the Intercom conversations: #{exception.message}"
         @records = []
       end
diff --git a/app/services/forest_liana/ip_whitelist.rb b/app/services/forest_liana/ip_whitelist.rb
@@ -21,6 +21,7 @@ def self.retrieve
           false
         end
       rescue => exception
+        FOREST_REPORTER.report exception
         FOREST_LOGGER.error 'Cannot retrieve the IP Whitelist from the Forest server.'
         FOREST_LOGGER.error 'Which was caused by:'
         ForestLiana::Errors::ExceptionHelper.recursively_print(exception, margin: ' ', is_error: true)
diff --git a/app/services/forest_liana/permissions_getter.rb b/app/services/forest_liana/permissions_getter.rb
@@ -47,6 +47,7 @@ def get_permissions_for_rendering(rendering_id, rendering_specific_only: false)
             raise "Forest API returned an #{ForestLiana::Errors::HTTPErrorHelper.format(response)}"
           end
         rescue => exception
+          FOREST_REPORTER.report exception
           FOREST_LOGGER.error 'Cannot retrieve the permissions from the Forest server.'
           FOREST_LOGGER.error 'Which was caused by:'
           ForestLiana::Errors::ExceptionHelper.recursively_print(exception, margin: ' ', is_error: true)
diff --git a/app/services/forest_liana/resources_getter.rb b/app/services/forest_liana/resources_getter.rb
@@ -179,6 +179,7 @@ def prepare_query
           )
         rescue => error
           error_message = "Live Query Segment: #{error.message}"
+          FOREST_REPORTER.report error
           FOREST_LOGGER.error(error_message)
           raise ForestLiana::Errors::LiveQueryError.new(error_message)
         end
diff --git a/app/services/forest_liana/schema_adapter.rb b/app/services/forest_liana/schema_adapter.rb
@@ -261,6 +261,7 @@ def add_associations
           FOREST_LOGGER.warn "The association \"#{association.name.to_s}\" " \
             "does not seem to exist for model \"#{@model.name}\"."
         rescue => exception
+          FOREST_REPORTER.report exception
           FOREST_LOGGER.error "An error occured trying to add " \
             "\"#{association.name.to_s}\" association:\n#{exception}"
         end
diff --git a/app/services/forest_liana/search_query_builder.rb b/app/services/forest_liana/search_query_builder.rb
@@ -31,6 +31,7 @@ def perform(resource)
             begin
               @records = field[:search].call(@records, @search)
             rescue => exception
+              FOREST_REPORTER.report exception
               FOREST_LOGGER.error "Cannot search properly on Smart Field:\n" \
                 "#{exception}"
             end
diff --git a/app/services/forest_liana/stripe_invoices_getter.rb b/app/services/forest_liana/stripe_invoices_getter.rb
@@ -50,6 +50,7 @@ def perform
           d
         end
       rescue ::Stripe::InvalidRequestError => error
+        FOREST_REPORTER.report error
         FOREST_LOGGER.error "Stripe error: #{error.message}"
         @records = []
       end
diff --git a/app/services/forest_liana/stripe_payments_getter.rb b/app/services/forest_liana/stripe_payments_getter.rb
@@ -48,6 +48,7 @@ def perform
           d
         end
       rescue ::Stripe::InvalidRequestError => error
+        FOREST_REPORTER.report error
         FOREST_LOGGER.error "Stripe error: #{error.message}"
         @records = []
       end
diff --git a/app/services/forest_liana/stripe_sources_getter.rb b/app/services/forest_liana/stripe_sources_getter.rb
@@ -46,6 +46,7 @@ def fetch_bank_accounts(customer, params)
           d
         end
       rescue ::Stripe::InvalidRequestError => error
+        FOREST_REPORTER.report error
         FOREST_LOGGER.error "Stripe error: #{error.message}"
         @records = []
       end
diff --git a/app/services/forest_liana/stripe_subscriptions_getter.rb b/app/services/forest_liana/stripe_subscriptions_getter.rb
@@ -43,6 +43,7 @@ def perform
           d
         end
       rescue ::Stripe::InvalidRequestError => error
+        FOREST_REPORTER.report error
         FOREST_LOGGER.error "Stripe error: #{error.message}"
         @records = []
       end
diff --git a/config/initializers/logger.rb b/config/initializers/logger.rb
@@ -18,12 +18,19 @@ def log
             displayed_message = "[#{datetime.to_s(:db)}] Forest 🌳🌳🌳  " \
                   "#{message}\n"
                 "\e[#{logger_colors[severity.to_sym]}m#{displayed_message}\033[0m"
-            end
+          end
           logger
         end
       end
     end
   end
+
+  class Reporter
+    def self.report (error)
+      ForestLiana.reporter.report error if ForestLiana.reporter
+    end
+  end
 end
 
 FOREST_LOGGER = ForestLiana::Logger.log
+FOREST_REPORTER = ForestLiana::Reporter
diff --git a/lib/forest_liana.rb b/lib/forest_liana.rb
@@ -28,6 +28,7 @@ module UserSpace
   mattr_accessor :names_overriden
   mattr_accessor :meta
   mattr_accessor :logger
+  mattr_accessor :reporter
   # TODO: Remove once lianas prior to 2.0.0 are not supported anymore.
   mattr_accessor :names_old_overriden
 
@@ -40,6 +41,7 @@ module UserSpace
   self.names_overriden = {}
   self.meta = {}
   self.logger = nil
+  self.reporter = nil
 
   @config_dir = 'lib/forest_liana/**/*.rb'
 
diff --git a/lib/forest_liana/bootstrapper.rb b/lib/forest_liana/bootstrapper.rb
@@ -82,7 +82,8 @@ def generate_apimap
             @collections_sent = content['collections']
             @meta_sent = content['meta']
             generate_action_hooks
-          rescue JSON::JSONError
+          rescue JSON::JSONError => error
+            FOREST_REPORTER.report error
             FOREST_LOGGER.error "The content of .forestadmin-schema.json file is not a correct JSON."
             FOREST_LOGGER.error "The schema cannot be synchronized with Forest Admin servers."
           end
@@ -122,6 +123,7 @@ def fetch_model(model)
           end
         end
       rescue => exception
+        FOREST_REPORTER.report exception
         FOREST_LOGGER.error "Cannot fetch properly model #{model.name}:\n" \
           "#{exception}"
       end
diff --git a/lib/forest_liana/collection.rb b/lib/forest_liana/collection.rb
@@ -91,6 +91,7 @@ def field(name, opts, &block)
               begin
                 object.instance_eval(&block)
               rescue => exception
+                FOREST_REPORTER.report exception
                 FOREST_LOGGER.error "Cannot retrieve the " + name.to_s + " value because of an " \
                   "internal error in the getter implementation: " + exception.message
                 nil
diff --git a/lib/forest_liana/engine.rb b/lib/forest_liana/engine.rb
@@ -37,6 +37,7 @@ def configure_forest_cors
         end
         nil
       rescue => exception
+        FOREST_REPORTER.report exception
         exception
       end
     end
@@ -51,6 +52,7 @@ def database_available?
         ActiveRecord::Base.connection_pool.with_connection { |connection| connection.active? }
       rescue => error
         database_available = false
+        FOREST_REPORTER.report error
         FOREST_LOGGER.error "No Apimap sent to Forest servers, it seems that the database is not accessible:\n#{error}"
       end
       database_available
@@ -75,6 +77,7 @@ def eager_load_active_record_descendants app
 
     config.after_initialize do |app|
       if error
+        FOREST_REPORTER.report error
         FOREST_LOGGER.error "Impossible to set the whitelisted Forest " \
           "domains for CORS constraint:\n#{error}"
       end
diff --git a/lib/forest_liana/schema_file_updater.rb b/lib/forest_liana/schema_file_updater.rb
@@ -102,6 +102,7 @@ def initialize filename, collections, meta
           rescue ForestLiana::Errors::SmartActionInvalidFieldError => invalid_field_error
             FOREST_LOGGER.warn invalid_field_error.message
           rescue ForestLiana::Errors::SmartActionInvalidFieldHookError => invalid_hook_error
+            FOREST_REPORTER.report invalid_hook_error
             FOREST_LOGGER.error invalid_hook_error.message
           end
           action['fields'] = action['fields'].map { |field| field.slice(*KEYS_ACTION_FIELD) }
diff --git a/spec/config/initializers/logger_spec.rb b/spec/config/initializers/logger_spec.rb
