Refactor error tracker handling, move more ENV vars to settings

Author: Kagemaru

app/controllers/application_controller.rb

@@ -13,10 +13,10 @@ class ApplicationController < ActionController::Base
   skip_forgery_protection if: :saml_callback_path? # HACK: https://github.com/heartcombo/devise/issues/5210
 
   # before_action :authenticate
-  before_action :set_sentry_request_context
+  before_action :set_error_tracker_request_context
   before_action :store_employee_location!, if: :storable_location?
   before_action :authenticate_employee!
-  before_action :set_sentry_user_context
+  before_action :set_error_tracker_user_context
   before_action :set_paper_trail_whodunnit
   check_authorization unless: :devise_controller?
 
@@ -71,22 +71,22 @@ def not_found
     raise ActionController::RoutingError, 'Not Found'
   end
 
-  def set_sentry_request_context
-    commit = ENV.fetch('OPENSHIFT_BUILD_COMMIT', nil)
-    Sentry.set_tags(commit: ENV.fetch('OPENSHIFT_BUILD_COMMIT', nil)) if commit && ENV['GLITCHTIP_DSN']
+  def set_error_tracker_request_context
+    commit = Settings.puzzletime.build.commit
+    project = Settings.puzzletime.run.project
+    customer = Settings.puzzletime.run.customer
 
-    if (project = ENV.fetch('OPENSHIFT_BUILD_NAMESPACE', nil))
-      Sentry.set_tags(project: project)
-      Sentry.set_tags(customer: project.split('-')[0])
-    end
+    ErrorTracker.set_tags(commit:) if commit
+    ErrorTracker.set_tags(project:) if project
+    ErrorTracker.set_tags(customer:) if customer
   end
 
-  def set_sentry_user_context
-    return unless ENV['GLITCHTIP_DSN']
-
-    Sentry.set_user(id: current_user.try(:id),
-                    username: current_user.try(:shortname),
-                    email: current_user.email)
+  def set_error_tracker_user_context
+    ErrorTracker.set_user(
+      id: current_user.try(:id),
+      username: current_user.try(:shortname),
+      email: current_user.email
+    )
   end
 
   def saml_callback_path?

app/domain/crm/base.rb

@@ -58,8 +58,5 @@ def sync_additional_order(additional); end
     def restrict_local?
       false
     end
-
-    def sentry? = ENV['GLITCHTIP_DSN'].present?
-    def airbrake? = ENV['RAILS_AIRBRAKE_HOST'].present?
   end
 end

app/domain/crm/highrise.rb

@@ -173,8 +173,8 @@ def notify_sync_error(error, synced_entity, invalid_record = nil)
       parameters = record_to_params(synced_entity, 'synced_entity').tap do |params|
         params.merge!(record_to_params(invalid_record, 'invalid_record')) if invalid_record.present?
       end
-      Airbrake.notify(error, parameters) if airbrake?
-      Sentry.capture_exception(error, extra: parameters) if sentry?
+
+      ErrorTracker.report_exception(error, parameters)
     end
 
     def record_to_params(record, prefix = 'record')

app/domain/crm/odoo.rb

@@ -239,8 +239,7 @@ def notify_sync_error(error, synced_entity, invalid_record = nil)
           #{error.backtrace.join("\n  ")}
       ERROR
 
-      Airbrake.notify(error, parameters) if airbrake?
-      Sentry.capture_exception(error, extra: parameters) if sentry?
+      ErrorTracker.report_exception(error, parameters)
     end
 
     def false_to_nil(hash)

app/domain/error_tracker.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+class ErrorTracker
+  class << self
+    def type
+      Settings.error_tracker.type.to_sym
+    end
+
+    def report_message(message)
+      Sentry.capture_message(message) if sentry_like?
+      Airbrake.notify(message) if airbrake_like?
+    end
+
+    def report_exception(error, payload)
+      Sentry.capture_exception(error, extra: payload) if sentry_like?
+      Airbrake.notify(error, payload) if airbrake_like?
+    end
+
+    def set_tags(**kwargs)
+      Sentry.set_tags(**kwargs) if sentry_like?
+      Airbrake.merge_context(tags: kwargs) if airbrake?
+    end
+
+    def set_extras(**kwargs)
+      Sentry.set_extras(**kwargs) if sentry_like?
+      Airbrake.merge_context(extra: kwargs) if airbrake?
+    end
+
+    def set_user(**kwargs)
+      Sentry.set_user(**kwargs) if sentry_like?
+      Airbrake.merge_context(user: kwargs) if airbrake?
+    end
+
+    def set_contexts(**)
+      Sentry.set_contexts(**) if sentry_like?
+      Airbrake.merge_context(**) if airbrake?
+    end
+
+    def airbrake_like?
+      %i[airbrake errbit].include? type
+    end
+
+    def sentry_like?
+      %i[sentry glitchtip].include? type
+    end
+  end
+end

app/domain/invoicing/small_invoice/client_sync.rb

@@ -33,19 +33,11 @@ def notify_sync_error(error, client = nil)
           parameters = client.present? ? record_to_params(client) : {}
           parameters[:code] = error.code if error.respond_to?(:code)
           parameters[:data] = error.data if error.respond_to?(:data)
-          Airbrake.notify(error, parameters) if airbrake?
-          Sentry.capture_exception(error, extra: parameters) if sentry?
-        end
-
-        private
 
-        def airbrake?
-          ENV['RAILS_AIRBRAKE_HOST'].present?
+          ErrorTracker.report_exception(error, parameters)
         end
 
-        def sentry?
-          ENV['GLITCHTIP_DSN'].present?
-        end
+        private
 
         def record_to_params(record, prefix = 'client')
           {

app/domain/invoicing/small_invoice/invoice_sync.rb

@@ -48,16 +48,8 @@ def notify_sync_error(error, invoice)
           parameters = record_to_params(invoice)
           parameters[:code] = error.code if error.respond_to?(:code)
           parameters[:data] = error.data if error.respond_to?(:data)
-          Airbrake.notify(error, parameters) if airbrake?
-          Sentry.capture_exception(error, extra: parameters) if sentry?
-        end
-
-        def airbrake?
-          ENV['RAILS_AIRBRAKE_HOST'].present?
-        end
 
-        def sentry?
-          ENV['GLITCHTIP_DSN'].present?
+          ErrorTracker.report_exception(error, parameters)
         end
 
         def record_to_params(record, prefix = 'invoice')

app/jobs/application_job.rb

@@ -10,25 +10,13 @@ class ApplicationJob < ActiveJob::Base
     payload = { cgi_data: ENV.to_hash }
     payload[:code] = error.code if error.respond_to?(:code)
     payload[:data] = error.data if error.respond_to?(:data)
-    Airbrake.notify(error, payload) if airbrake?
-    Sentry.capture_exception(error, extra: payload) if sentry?
+
+    ErrorTracker.report_exception(error, payload)
   end
 
   # Called once by active job before perform_now, after delayed job callbacks
   def deserialize(job_data)
     super
-    init_sentry_job_context(job_data) if sentry?
-  end
-
-  def airbrake?
-    ENV['RAILS_AIRBRAKE_HOST'].present?
-  end
-
-  def sentry?
-    ENV['GLITCHTIP_DSN'].present?
-  end
-
-  def init_sentry_job_context(job_data)
-    Sentry.set_extras(active_job: job_data)
+    ErrorTracker.set_extras(active_job: job_data)
   end
 end

config/initializers/errbit.rb

@@ -5,17 +5,20 @@
 #  or later. See the COPYING file at the top-level directory or at
 #  https://github.com/puzzle/puzzletime.
 
-if ENV['RAILS_AIRBRAKE_HOST'] && ENV['RAILS_AIRBRAKE_API_KEY']
+require 'error_tracker'
+
+if ErrorTracker.airbrake_like?
   require 'airbrake'
+
   Airbrake.configure do |config|
     config.environment = Rails.env
     config.ignore_environments = %i[development test]
     # if no host is given, ignore all environments
-    config.ignore_environments << :production if ENV['RAILS_AIRBRAKE_HOST'].blank?
+    config.ignore_environments << :production if Settings.error_tracker.airbrake.host.blank?
 
     config.project_id     = 1 # required, but any positive integer works
-    config.project_key    = ENV['RAILS_AIRBRAKE_API_KEY']
-    config.host           = ENV['RAILS_AIRBRAKE_HOST']
+    config.project_key    = Settings.error_tracker.airbrake.api_key
+    config.host           = Settings.error_tracker.airbrake.host
     config.blacklist_keys << 'pwd'
     config.blacklist_keys << 'RAILS_DB_PASSWORD'
     config.blacklist_keys << 'RAILS_AIRBRAKE_API_KEY'

config/initializers/sentry.rb

@@ -5,9 +5,11 @@
 #  or later. See the COPYING file at the top-level directory or at
 #  https://github.com/puzzle/puzzletime.
 
-if ENV['GLITCHTIP_DSN']
+require 'error_tracker'
+
+if ErrorTracker.sentry_like?
   Sentry.init do |config|
-    config.dsn = ENV['GLITCHTIP_DSN']
+    config.dsn = Settings.error_tracker.sentry.dsn
 
     # Additionally exclude the following exceptions:
     # config.excluded_exceptions += []
@@ -25,11 +27,7 @@
     # defaults to development
     # config.environment = Rails.env
 
-    config.release = if (commit = ENV.fetch('OPENSHIFT_BUILD_COMMIT', nil))
-                       "#{Puzzletime.version}_#{commit}"
-                     else
-                       Puzzletime.version
-                     end
+    config.release = Settings.puzzletime.run.full_versioon
 
     config.before_send = lambda do |event, _hint|
       # filter out parameters filtered by Rails