rollbar 2.22.1 → 3.4.0

data/lib/rollbar/configuration.rb

@@ -4,71 +4,82 @@ module Rollbar
   class Configuration
     SEND_EXTRA_FRAME_DATA_OPTIONS = [:none, :app, :all].freeze
 
-    attr_accessor :access_token
-    attr_accessor :async_handler
-    attr_accessor :branch
-    attr_reader :before_process
-    attr_accessor :capture_uncaught
-    attr_accessor :code_version
-    attr_accessor :custom_data_method
-    attr_accessor :delayed_job_enabled
-    attr_accessor :default_logger
-    attr_reader :logger_level
-    attr_accessor :disable_monkey_patch
-    attr_accessor :disable_rack_monkey_patch
-    attr_accessor :disable_core_monkey_patch
-    attr_accessor :dj_threshold
-    attr_accessor :enabled
-    attr_accessor :endpoint
-    attr_accessor :environment
-    attr_accessor :exception_level_filters
-    attr_accessor :failover_handlers
-    attr_accessor :filepath
-    attr_accessor :framework
-    attr_accessor :ignored_person_ids
-    attr_accessor :host
-    attr_accessor :locals
-    attr_writer :logger
-    attr_accessor :payload_options
-    attr_accessor :person_method
-    attr_accessor :person_id_method
-    attr_accessor :person_username_method
-    attr_accessor :person_email_method
-    attr_accessor :populate_empty_backtraces
-    attr_accessor :report_dj_data
-    attr_accessor :open_timeout
-    attr_accessor :request_timeout
-    attr_accessor :net_retries
-    attr_accessor :root
-    attr_accessor :js_options
-    attr_accessor :js_enabled
-    attr_accessor :safely
-    attr_accessor :scrub_fields
-    attr_accessor :scrub_user
-    attr_accessor :scrub_password
-    attr_accessor :scrub_whitelist
-    attr_accessor :collect_user_ip
-    attr_accessor :anonymize_user_ip
-    attr_accessor :user_ip_obfuscator_secret
-    attr_accessor :randomize_scrub_length
-    attr_accessor :uncaught_exception_level
-    attr_accessor :scrub_headers
-    attr_accessor :sidekiq_threshold
-    attr_reader :transform
-    attr_accessor :verify_ssl_peer
-    attr_accessor :use_async
-    attr_reader :use_eventmachine
-    attr_accessor :web_base
-    attr_accessor :write_to_file
-    attr_reader :send_extra_frame_data
-    attr_accessor :use_exception_level_filters_default
-    attr_accessor :proxy
-    attr_accessor :raise_on_error
-    attr_accessor :transmit
-    attr_accessor :log_payload
-
-    attr_reader :project_gem_paths
-    attr_accessor :configured_options
+    attr_accessor :access_token,
+                  :anonymize_user_ip,
+                  :async_handler,
+                  :async_json_payload,
+                  :async_skip_report_handler,
+                  :backtrace_cleaner,
+                  :branch,
+                  :capture_uncaught,
+                  :code_version,
+                  :collect_user_ip,
+                  :configured_options,
+                  :custom_data_method,
+                  :default_logger,
+                  :delayed_job_enabled,
+                  :disable_core_monkey_patch,
+                  :disable_monkey_patch,
+                  :disable_rack_monkey_patch,
+                  :dj_threshold,
+                  :enable_error_context,
+                  :enabled,
+                  :endpoint,
+                  :environment,
+                  :exception_level_filters,
+                  :failover_handlers,
+                  :filepath,
+                  :files_processed_duration,
+                  :files_processed_enabled,
+                  :files_processed_size,
+                  :files_with_pid_name_enabled,
+                  :framework,
+                  :ignore_internal_errors,
+                  :ignored_person_ids,
+                  :js_enabled,
+                  :js_options,
+                  :host,
+                  :locals,
+                  :log_payload,
+                  :net_retries,
+                  :open_timeout,
+                  :payload_options,
+                  :person_email_method,
+                  :person_id_method,
+                  :person_method,
+                  :person_username_method,
+                  :populate_empty_backtraces,
+                  :proxy,
+                  :raise_on_error,
+                  :randomize_scrub_length,
+                  :report_dj_data,
+                  :request_timeout,
+                  :root,
+                  :safely,
+                  :scrub_fields,
+                  :scrub_password,
+                  :scrub_user,
+                  :scrub_whitelist,
+                  :transmit,
+                  :uncaught_exception_level,
+                  :user_ip_obfuscator_secret,
+                  :user_ip_rack_env_key,
+                  :scrub_headers,
+                  :sidekiq_threshold,
+                  :sidekiq_use_scoped_block,
+                  :use_async,
+                  :use_exception_level_filters_default,
+                  :use_payload_access_token,
+                  :verify_ssl_peer,
+                  :web_base,
+                  :write_to_file
+    attr_reader :before_process,
+                :logger_level,
+                :project_gem_paths,
+                :send_extra_frame_data,
+                :transform,
+                :use_eventmachine
+    attr_writer :logger # seconds # bytes
 
     alias safely? safely
 
@@ -76,18 +87,22 @@ module Rollbar
     DEFAULT_WEB_BASE = 'https://rollbar.com'.freeze
 
     def initialize
+      @access_token = nil
       @async_handler = nil
       @before_process = []
+      @branch = nil
       @capture_uncaught = nil
       @code_version = nil
       @custom_data_method = nil
-      @default_logger = lambda { ::Logger.new(STDERR) }
+      @default_logger = lambda { ::Logger.new($stderr) }
       @logger_level = :info
       @delayed_job_enabled = true
       @disable_monkey_patch = false
       @disable_core_monkey_patch = false
       @disable_rack_monkey_patch = false
+      @enable_error_context = true
       @dj_threshold = 0
+      @async_skip_report_handler = nil
       @enabled = nil # set to true when configure is called
       @endpoint = DEFAULT_ENDPOINT
       @environment = nil
@@ -98,7 +113,13 @@ module Rollbar
       }
       @failover_handlers = []
       @framework = 'Plain'
+      @ignore_internal_errors = [
+        'Net::ReadTimeout',
+        'Net::OpenTimeout',
+        'SocketError'
+      ]
       @ignored_person_ids = []
+      @host = nil
       @payload_options = {}
       @person_method = 'current_user'
       @person_id_method = 'id'
@@ -110,6 +131,7 @@ module Rollbar
       @open_timeout = 3
       @request_timeout = 3
       @net_retries = 3
+      @root = nil
       @js_enabled = false
       @js_options = {}
       @locals = {}
@@ -118,18 +140,19 @@ module Rollbar
                        :api_key, :access_token, :accessToken, :session_id]
       @scrub_user = true
       @scrub_password = true
-      @randomize_scrub_length = true
+      @randomize_scrub_length = false
       @scrub_whitelist = []
       @uncaught_exception_level = 'error'
       @scrub_headers = ['Authorization']
       @sidekiq_threshold = 0
+      @sidekiq_use_scoped_block = false
       @safely = false
       @transform = []
       @use_async = false
+      @async_json_payload = false
       @use_eventmachine = false
       @verify_ssl_peer = true
       @web_base = DEFAULT_WEB_BASE
-      @write_to_file = false
       @send_extra_frame_data = :none
       @project_gem_paths = []
       @use_exception_level_filters_default = false
@@ -139,11 +162,22 @@ module Rollbar
       @log_payload = false
       @collect_user_ip = true
       @anonymize_user_ip = false
+      @user_ip_obfuscator_secret = nil
+      @user_ip_rack_env_key = nil
+      @backtrace_cleaner = nil
       @hooks = {
         :on_error_response => nil, # params: response
         :on_report_internal_error => nil # params: exception
       }
 
+      @write_to_file = false
+      @filepath = nil
+      @files_with_pid_name_enabled = false
+      @files_processed_enabled = false
+      @files_processed_duration = 60
+      @files_processed_size = 5 * 1000 * 1000
+      @use_payload_access_token = false
+
       @configured_options = ConfiguredOptions.new(self)
     end
 
@@ -186,7 +220,8 @@ module Rollbar
     def use_active_job(options = {})
       require 'rollbar/delay/active_job'
 
-      Rollbar::Delay::ActiveJob.queue_as(options[:queue] || Rollbar::Delay::ActiveJob.default_queue_name)
+      Rollbar::Delay::ActiveJob.queue_as(options[:queue] ||
+      Rollbar::Delay::ActiveJob.default_queue_name)
 
       @use_async      = true
       @async_handler  = Rollbar::Delay::ActiveJob
@@ -226,15 +261,21 @@ module Rollbar
     end
 
     def use_sidekiq=(value)
-      deprecation_message = '#use_sidekiq=(value) has been deprecated in favor of #use_sidekiq(options = {}). Please update your rollbar configuration.'
-      defined?(ActiveSupport) ? ActiveSupport::Deprecation.warn(deprecation_message) : puts(deprecation_message)
+      deprecation_message = '#use_sidekiq=(value) has been deprecated in favor ' \
+        'of #use_sidekiq(options = {}). Please update your rollbar configuration.'
+      if defined?(ActiveSupport)
+        ActiveSupport::Deprecation.warn(deprecation_message)
+      else
+        puts(deprecation_message)
+      end
 
       value.is_a?(Hash) ? use_sidekiq(value) : use_sidekiq
     end
 
-    def use_thread
+    def use_thread(options = {})
       require 'rollbar/delay/thread'
       @use_async = true
+      Rollbar::Delay::Thread.options = options
       @async_handler = Rollbar::Delay::Thread
     end
 
@@ -245,8 +286,13 @@ module Rollbar
     end
 
     def use_sucker_punch=(_value)
-      deprecation_message = '#use_sucker_punch=(value) has been deprecated in favor of #use_sucker_punch. Please update your rollbar configuration.'
-      defined?(ActiveSupport) ? ActiveSupport::Deprecation.warn(deprecation_message) : puts(deprecation_message)
+      deprecation_message = '#use_sucker_punch=(value) has been deprecated in ' \
+        'favor of #use_sucker_punch. Please update your rollbar configuration.'
+      if defined?(ActiveSupport)
+        ActiveSupport::Deprecation.warn(deprecation_message)
+      else
+        puts(deprecation_message)
+      end
 
       use_sucker_punch
     end
@@ -261,7 +307,10 @@ module Rollbar
         found = Gem::Specification.each.select { |spec| name === spec.name }
         puts "[Rollbar] No gems found matching #{name.inspect}" if found.empty?
         found
-      end.flatten.uniq.map(&:gem_dir)
+      end
+      @project_gem_paths.flatten!
+      @project_gem_paths.uniq!
+      @project_gem_paths.map!(&:gem_dir)
     end
 
     def before_process=(*handler)
@@ -274,7 +323,9 @@ module Rollbar
 
     def send_extra_frame_data=(value)
       unless SEND_EXTRA_FRAME_DATA_OPTIONS.include?(value)
-        logger.warning("Wrong 'send_extra_frame_data' value, :none, :app or :full is expected")
+        logger.warning(
+          "Wrong 'send_extra_frame_data' value, :none, :app or :all is expected"
+        )
 
         return
       end
@@ -300,14 +351,14 @@ module Rollbar
     end
 
     def hook(symbol, &block)
-      if @hooks.key?(symbol)
-        if block_given?
-          @hooks[symbol] = block
-        else
-          @hooks[symbol]
-        end
+      unless @hooks.key?(symbol)
+        raise StandardError, "Hook :#{symbol} is not supported by Rollbar SDK."
+      end
+
+      if block_given?
+        @hooks[symbol] = block
       else
-        raise StandardError, 'Hook :' + symbol.to_s + ' is not supported by Rollbar SDK.'
+        @hooks[symbol]
       end
     end
 
@@ -328,7 +379,10 @@ module Rollbar
       return super unless configuration.respond_to?(method)
 
       method_string = method.to_s
-      configured[method_string.chomp('=').to_sym] = args.first if method_string.end_with?('=')
+      if method_string.end_with?('=')
+        configured[method_string.chomp('=').to_sym] =
+          args.first
+      end
 
       configuration.send(method, *args, &block)
     end

data/lib/rollbar/delay/girl_friday.rb

@@ -12,13 +12,9 @@ module Rollbar
 
         def queue
           @queue ||= queue_class.new(nil, :size => 5) do |payload|
-            begin
-              Rollbar.process_from_async_handler(payload)
-            rescue StandardError
-              # According to https://github.com/mperham/girl_friday/wiki#error-handling
-              # we reraise the exception so it can be handled some way
-              raise
-            end
+            Rollbar.process_from_async_handler(payload)
+
+            # Do not rescue. GirlFriday will call the error handler.
           end
         end
       end

data/lib/rollbar/delay/resque.rb

@@ -24,9 +24,8 @@ module Rollbar
 
         def perform(payload)
           Rollbar.process_from_async_handler(payload)
-        rescue StandardError
-          # Raise the exception so Resque can track the errored job
-          raise
+
+          # Do not rescue. Resque will call the error handler.
         end
       end
     end

data/lib/rollbar/delay/shoryuken.rb

@@ -2,9 +2,10 @@ require 'shoryuken'
 
 module Rollbar
   module Delay
-    # Following class allows to send rollbars using Sho-ryu-ken as a background jobs processor.
-    # see the queue_name method which states that your queues needs to be names as "rollbar_ENVIRONMENT".
-    # retry intervals will be used to retry sending the same message again if failed before.
+    # Following class allows to send rollbars using Sho-ryu-ken as a background
+    # jobs processor. See the queue_name method which states that your queues
+    # needs to be names as "rollbar_ENVIRONMENT". Retry intervals will be used
+    # to retry sending the same message again if failed before.
     class Shoryuken
       include ::Shoryuken::Worker
 

data/lib/rollbar/delay/sidekiq.rb

@@ -10,17 +10,17 @@ module Rollbar
       end
 
       def call(payload)
-        raise StandardError, 'Unable to push the job to Sidekiq' if ::Sidekiq::Client.push(@options.merge('args' => [payload])).nil?
+        return unless ::Sidekiq::Client.push(@options.merge('args' => [payload])).nil?
+
+        raise(StandardError, 'Unable to push the job to Sidekiq')
       end
 
       include ::Sidekiq::Worker
 
       def perform(*args)
         Rollbar.process_from_async_handler(*args)
-      rescue StandardError
-        # Raise the exception so Sidekiq can track the errored job
-        # and retry it
-        raise
+
+        # Do not rescue. Sidekiq will call the error handler.
       end
     end
   end

data/lib/rollbar/delay/sucker_punch.rb

@@ -7,8 +7,7 @@ module Rollbar
       include ::SuckerPunch::Job
 
       class << self
-        attr_accessor :perform_proc
-        attr_accessor :ready
+        attr_accessor :perform_proc, :ready
       end
 
       self.ready = false
@@ -33,7 +32,7 @@ module Rollbar
 
       def perform(*args)
         Rollbar.process_from_async_handler(*args)
-      rescue StandardError
+
         # SuckerPunch can configure an exception handler with:
         #
         # SuckerPunch.exception_handler { # do something here }
@@ -41,9 +40,8 @@ module Rollbar
         # This is just passed to Celluloid.exception_handler which will
         # push the reiceved block to an array of handlers, by default empty, [].
         #
-        # We reraise the exception here casue it's safe and users could have defined
-        # their own exception handler for SuckerPunch
-        raise
+
+        # Do not rescue. SuckerPunch will call the error handler.
       end
     end
   end

data/lib/rollbar/delay/thread.rb

@@ -9,7 +9,10 @@ module Rollbar
       Error        = Class.new(StandardError)
       TimeoutError = Class.new(Error)
 
+      DEFAULT_PRIORITY = 1
+
       class << self
+        attr_writer :options
         attr_reader :reaper
 
         def call(payload)
@@ -20,6 +23,10 @@ module Rollbar
           thread
         end
 
+        def options
+          @options || {}
+        end
+
         private
 
         def threads
@@ -55,15 +62,23 @@ module Rollbar
                 reaper.join
               end
             rescue Timeout::Error
-              raise TimeoutError, "unable to reap all threads within #{EXIT_TIMEOUT} seconds"
+              raise TimeoutError,
+                    "unable to reap all threads within #{EXIT_TIMEOUT} seconds"
             end
           end
         end
-      end # class << self
+      end
+
+      def priority
+        self.class.options[:priority] || DEFAULT_PRIORITY
+      end
 
       def call(payload)
+        priority = self.priority
+
         ::Thread.new do
           begin
+            ::Thread.current.priority = priority
             Rollbar.process_from_async_handler(payload)
           rescue StandardError
             # Here we swallow the exception:

data/lib/rollbar/deploy.rb

@@ -1,3 +1,5 @@
+require 'json'
+
 module Rollbar
   # Deploy Tracking API wrapper module
   module Deploy
@@ -28,9 +30,7 @@ module Rollbar
       return {} unless access_token && !access_token.empty?
 
       uri = ::URI.parse(
-        ::Rollbar::Deploy::ENDPOINT +
-        deploy_id.to_s +
-        '?access_token=' + access_token
+        "#{::Rollbar::Deploy::ENDPOINT}#{deploy_id}?access_token=#{access_token}"
       )
 
       request = ::Net::HTTP::Patch.new(uri.request_uri)
@@ -72,17 +72,18 @@ module Rollbar
 
       def request_result(uri, request)
         {
-          :request_info => uri.inspect + ': ' + request.body,
+          :request_info => "#{uri.inspect}: #{request.body}",
           :request => request
         }
       end
 
       def response_result(response)
+        code = response.code
+        message = response.message
+        body = response.body.delete("\n")
         {
           :response => response,
-          :response_info => response.code + '; ' +
-            response.message + '; ' +
-            response.body.delete("\n")
+          :response_info => "#{code}; #{message}; #{body}"
         }.merge(::JSON.parse(response.body, :symbolize_names => true))
       end
     end

data/lib/rollbar/encoding/encoder.rb

@@ -1,9 +1,10 @@
 module Rollbar
   module Encoding
     class Encoder
-      ALL_ENCODINGS = [::Encoding::UTF_8, ::Encoding::ISO_8859_1, ::Encoding::ASCII_8BIT, ::Encoding::US_ASCII].freeze
-      ASCII_ENCODINGS = [::Encoding::US_ASCII, ::Encoding::ASCII_8BIT, ::Encoding::ISO_8859_1].freeze
-      ENCODING_OPTIONS = { :invalid => :replace, :undef => :replace, :replace => '' }.freeze
+      ALL_ENCODINGS = [::Encoding::UTF_8, ::Encoding::ISO_8859_1, ::Encoding::ASCII_8BIT,
+                       ::Encoding::US_ASCII].freeze
+      ASCII_ENCODINGS = [::Encoding::US_ASCII, ::Encoding::ASCII_8BIT,
+                         ::Encoding::ISO_8859_1].freeze
       UTF8 = 'UTF-8'.freeze
       BINARY = 'binary'.freeze
 
@@ -21,10 +22,19 @@ module Rollbar
         encoded_value = if encoding == ::Encoding::UTF_8 && value.valid_encoding?
                           value
                         else
-                          force_encoding(value).encode(*encoding_args(value))
+                          force_encoding(value).encode(
+                            *encoding_args(value),
+                            # Ruby 2.7 requires this to look like keyword args,
+                            # and Ruby 1.9.3 doesn't understand keyword args, so
+                            # don't use hash rockets here and both will be happy.
+                            invalid: :replace, undef: :replace, replace: '' # rubocop:disable Style/HashSyntax
+                          )
                         end
 
         object.is_a?(Symbol) ? encoded_value.to_sym : encoded_value
+      rescue StandardError => e
+        # If encoding fails for any reason, replace the string with a diagnostic error.
+        "error encoding string: #{e.class}: #{e.message}"
       end
 
       private
@@ -32,7 +42,9 @@ module Rollbar
       def force_encoding(value)
         return value if value.frozen?
 
-        value.force_encoding(detect_encoding(value)) if value.encoding == ::Encoding::UTF_8
+        if value.encoding == ::Encoding::UTF_8
+          value.force_encoding(detect_encoding(value))
+        end
 
         value
       end
@@ -54,7 +66,6 @@ module Rollbar
       def encoding_args(value)
         args = [UTF8]
         args << BINARY if ASCII_ENCODINGS.include?(value.encoding)
-        args << ENCODING_OPTIONS
 
         args
       end

data/lib/rollbar/encoding.rb

@@ -5,13 +5,8 @@ module Rollbar
     end
 
     def self.setup
-      if String.instance_methods.include?(:encode)
-        require 'rollbar/encoding/encoder'
-        self.encoding_class = Rollbar::Encoding::Encoder
-      else
-        require 'rollbar/encoding/legacy_encoder'
-        self.encoding_class = Rollbar::Encoding::LegacyEncoder
-      end
+      require 'rollbar/encoding/encoder'
+      self.encoding_class = Rollbar::Encoding::Encoder
     end
 
     def self.encode(object)

data/lib/rollbar/exception_reporter.rb

@@ -7,16 +7,23 @@ module Rollbar
 
       exception_data = exception_data(exception)
 
-      if exception_data.is_a?(Hash)
+      case exception_data
+      when Hash
         env['rollbar.exception_uuid'] = exception_data[:uuid]
-        Rollbar.log_debug "[Rollbar] Exception uuid saved in env: #{exception_data[:uuid]}"
-      elsif exception_data == 'disabled'
-        Rollbar.log_debug '[Rollbar] Exception not reported because Rollbar is disabled'
-      elsif exception_data == 'ignored'
+        Rollbar.log_debug(
+          "[Rollbar] Exception uuid saved in env: #{exception_data[:uuid]}"
+        )
+      when 'disabled'
+        Rollbar.log_debug(
+          '[Rollbar] Exception not reported because Rollbar is disabled'
+        )
+      when 'ignored'
         Rollbar.log_debug '[Rollbar] Exception not reported because it was ignored'
       end
     rescue StandardError => e
-      Rollbar.log_warning "[Rollbar] Exception while reporting exception to Rollbar: #{e.message}"
+      Rollbar.log_warning(
+        "[Rollbar] Exception while reporting exception to Rollbar: #{e.message}"
+      )
     end
 
     def capture_uncaught?
@@ -24,12 +31,14 @@ module Rollbar
     end
 
     def log_exception_message(exception)
-      exception_message = exception.respond_to?(:message) ? exception.message : 'No Exception Message'
+      exception_message = exception.message if exception.respond_to?(:message)
+      exception_message ||= 'No Exception Message'
       Rollbar.log_debug "[Rollbar] Reporting exception: #{exception_message}"
     end
 
     def exception_data(exception)
-      Rollbar.log(Rollbar.configuration.uncaught_exception_level, exception, :use_exception_level_filters => true)
+      Rollbar.log(Rollbar.configuration.uncaught_exception_level, exception,
+                  :use_exception_level_filters => true)
     end
   end
 end