rollbar 2.16.2 → 2.22.1

data/lib/rollbar/middleware/rack.rb

@@ -17,12 +17,15 @@ module Rollbar
 
         Rollbar.scoped(fetch_scope(env)) do
           begin
+            Rollbar.notifier.enable_locals
             response = @app.call(env)
             report_exception_to_rollbar(env, framework_error(env)) if framework_error(env)
             response
           rescue Exception => e
             report_exception_to_rollbar(env, e)
             raise
+          ensure
+            Rollbar.notifier.disable_locals
           end
         end
       end
@@ -41,7 +44,7 @@ module Rollbar
         proc { extract_person_data_from_controller(env) }
       end
 
-      def framework_error(env)
+      def framework_error(_env)
         nil
       end
     end

data/lib/rollbar/middleware/rails/rollbar.rb

@@ -21,6 +21,7 @@ module Rollbar
 
           Rollbar.scoped(scope) do
             begin
+              Rollbar.notifier.enable_locals
               response = @app.call(env)
 
               if (framework_exception = env['action_dispatch.exception'])
@@ -31,6 +32,8 @@ module Rollbar
             rescue Exception => exception
               report_exception_to_rollbar(env, exception)
               raise
+            ensure
+              Rollbar.notifier.disable_locals
             end
           end
         end
@@ -62,7 +65,13 @@ module Rollbar
           block = proc { extract_person_data_from_controller(env) }
           return block unless defined?(ActiveRecord::Base) && ActiveRecord::Base.connected?
 
-          proc { ActiveRecord::Base.connection_pool.with_connection(&block) }
+          proc do
+            begin
+              ActiveRecord::Base.connection_pool.with_connection(&block)
+            rescue ActiveRecord::ConnectionTimeoutError
+              {}
+            end
+          end
         end
 
         def context(request_data)

data/lib/rollbar/notifier.rb

@@ -8,6 +8,7 @@ require 'rollbar/delay/girl_friday'
 require 'rollbar/delay/thread'
 require 'rollbar/logger_proxy'
 require 'rollbar/item'
+require 'rollbar/notifier/trace_with_bindings'
 require 'ostruct'
 
 module Rollbar
@@ -41,21 +42,21 @@ module Rollbar
     # Similar to configure below, but used only internally within the gem
     # to configure it without initializing any of the third party hooks
     def preconfigure
-      yield(configuration)
+      yield(configuration.configured_options)
     end
 
     # Configures the notifier instance
     def configure
       configuration.enabled = true if configuration.enabled.nil?
 
-      yield(configuration)
+      yield(configuration.configured_options)
     end
 
     def reconfigure
       self.configuration = Configuration.new
       configuration.enabled = true
 
-      yield(configuration)
+      yield(configuration.configured_options)
     end
 
     def unconfigure
@@ -95,7 +96,7 @@ module Rollbar
     # @yield Block which exceptions won't be reported.
     def silenced
       yield
-    rescue => e
+    rescue StandardError => e
       e.instance_variable_set(:@_rollbar_do_not_report, true)
       raise
     end
@@ -126,7 +127,7 @@ module Rollbar
     #   Rollbar.log(e, 'This is a description of the exception')
     #
     def log(level, *args)
-      return 'disabled' unless configuration.enabled
+      return 'disabled' unless enabled?
 
       message, exception, extra, context = extract_arguments(args)
       use_exception_level_filters = use_exception_level_filters?(extra)
@@ -134,10 +135,11 @@ module Rollbar
       return 'ignored' if ignored?(exception, use_exception_level_filters)
 
       begin
-        call_before_process(:level => level,
-                            :exception => exception,
-                            :message => message,
-                            :extra => extra)
+        status = call_before_process(:level => level,
+                                     :exception => exception,
+                                     :message => message,
+                                     :extra => extra)
+        return 'ignored' if status == 'ignored'
       rescue Rollbar::Ignore
         return 'ignored'
       end
@@ -145,13 +147,19 @@ module Rollbar
       level = lookup_exception_level(level, exception,
                                      use_exception_level_filters)
 
-      begin
-        report(level, message, exception, extra, context)
-      rescue StandardError, SystemStackError => e
-        report_internal_error(e)
+      ret = report_with_rescue(level, message, exception, extra, context)
 
-        'error'
-      end
+      raise(exception) if configuration.raise_on_error && exception
+
+      ret
+    end
+
+    def report_with_rescue(level, message, exception, extra, context)
+      report(level, message, exception, extra, context)
+    rescue StandardError, SystemStackError => e
+      report_internal_error(e)
+
+      'error'
     end
 
     # See log() above
@@ -184,6 +192,11 @@ module Rollbar
       log('critical', *args)
     end
 
+    def enabled?
+      # Require access_token so we don't try to send events when unconfigured.
+      configuration.enabled && configuration.access_token && !configuration.access_token.empty?
+    end
+
     def process_item(item)
       if configuration.write_to_file
         if configuration.use_async
@@ -196,7 +209,7 @@ module Rollbar
       else
         send_item(item)
       end
-    rescue => e
+    rescue StandardError => e
       log_error("[Rollbar] Error processing the item: #{e.class}, #{e.message}. Item: #{item.payload.inspect}")
       raise e
     end
@@ -235,7 +248,7 @@ module Rollbar
       Rollbar.silenced do
         begin
           process_item(item)
-        rescue => e
+        rescue StandardError => e
           report_internal_error(e)
 
           raise
@@ -281,7 +294,7 @@ module Rollbar
                                :configuration => configuration,
                                :logger => logger)
         schedule_item(item)
-      rescue => e
+      rescue StandardError => e
         log_error "[Rollbar] Error sending failsafe : #{e}"
       end
 
@@ -289,12 +302,40 @@ module Rollbar
     end
 
     ## Logging
-    %w(debug info warn error).each do |level|
+    %w[debug info warn error].each do |level|
       define_method(:"log_#{level}") do |message|
         logger.send(level, message)
       end
     end
 
+    def logger
+      @logger ||= LoggerProxy.new(configuration.logger)
+    end
+
+    def trace_with_bindings
+      @trace_with_bindings ||= TraceWithBindings.new
+    end
+
+    def exception_bindings
+      trace_with_bindings.exception_frames
+    end
+
+    def current_bindings
+      trace_with_bindings.frames
+    end
+
+    def enable_locals?
+      configuration.locals[:enabled] && [:app, :all].include?(configuration.send_extra_frame_data)
+    end
+
+    def enable_locals
+      trace_with_bindings.enable if enable_locals?
+    end
+
+    def disable_locals
+      trace_with_bindings.disable if enable_locals?
+    end
+
     private
 
     def use_exception_level_filters?(options)
@@ -317,10 +358,11 @@ module Rollbar
 
       handlers.each do |handler|
         begin
-          handler.call(options)
+          status = handler.call(options)
+          return 'ignored' if status == 'ignored'
         rescue Rollbar::Ignore
           raise
-        rescue => e
+        rescue StandardError => e
           log_error("[Rollbar] Error calling the `before_process` hook: #{e}")
 
           break
@@ -339,14 +381,14 @@ module Rollbar
           message = arg
         elsif arg.is_a?(Exception)
           exception = arg
-        elsif RUBY_PLATFORM == 'java' && arg.is_a?(java.lang.Exception)
+        elsif RUBY_PLATFORM == 'java' && arg.is_a?(java.lang.Throwable)
           exception = arg
         elsif arg.is_a?(Hash)
           extra = arg
-          
+
           context = extra[:custom_data_method_context]
           extra.delete :custom_data_method_context
-          
+
           extra = nil if extra.empty?
         end
       end
@@ -393,39 +435,53 @@ module Rollbar
 
       return 'ignored' if item.ignored?
 
-      schedule_item(item)
+      schedule_item(item) if configuration.transmit
 
+      log_and_return_item_data(item)
+    end
+
+    def log_and_return_item_data(item)
       data = item['data']
       log_instance_link(data)
       Rollbar.last_report = data
+      log_data(data) if configuration.log_payload
 
       data
     end
 
+    def log_data(data)
+      log_info "[Rollbar] Data: #{data}"
+    end
+
     # Reports an internal error in the Rollbar library. This will be reported within the configured
     # Rollbar project. We'll first attempt to provide a report including the exception traceback.
     # If that fails, we'll fall back to a more static failsafe response.
     def report_internal_error(exception)
       log_error '[Rollbar] Reporting internal error encountered while sending data to Rollbar.'
 
+      configuration.execute_hook(:on_report_internal_error, exception)
+
       begin
         item = build_item('error', nil, exception, { :internal => true }, nil)
-      rescue => e
+      rescue StandardError => e
         send_failsafe('build_item in exception_data', e)
+        log_error "[Rollbar] Exception: #{exception}"
         return
       end
 
       begin
         process_item(item)
-      rescue => e
+      rescue StandardError => e
         send_failsafe('error in process_item', e)
+        log_error "[Rollbar] Item: #{item}"
         return
       end
 
       begin
         log_instance_link(item['data'])
-      rescue => e
+      rescue StandardError => e
         send_failsafe('error logging instance link', e)
+        log_error "[Rollbar] Item: #{item}"
         return
       end
     end
@@ -501,19 +557,34 @@ module Rollbar
 
       if uri.scheme == 'https'
         http.use_ssl = true
-        # This is needed to have 1.8.7 passing tests
-        http.ca_file = ENV['ROLLBAR_SSL_CERT_FILE'] if ENV.key?('ROLLBAR_SSL_CERT_FILE')
         http.verify_mode = ssl_verify_mode
       end
 
       request = Net::HTTP::Post.new(uri.request_uri)
 
-      request.body = body
+      request.body = pack_ruby260_bytes(body)
       request.add_field('X-Rollbar-Access-Token', access_token)
 
       handle_net_retries { http.request(request) }
     end
 
+    def pack_ruby260_bytes(body)
+      # Ruby 2.6.0 shipped with a bug affecting multi-byte body for Net::HTTP.
+      # Fix (committed one day after 2.6.0p0 shipped) is here:
+      # https://github.com/ruby/ruby/commit/1680a13a926b17661329beec1ded6b32aad16c1b#diff-00a99d8c71daaf5fc60a050da41f7261
+      #
+      # We work around this by repacking the body as single byte chars if needed.
+      if RUBY_VERSION == '2.6.0' && multibyte?(body)
+        body.unpack('C*').pack('C*')
+      else
+        body
+      end
+    end
+
+    def multibyte?(str)
+      str.chars.length != str.bytes.length
+    end
+
     def http_proxy_for_em(uri)
       proxy = http_proxy(uri)
       {
@@ -530,14 +601,15 @@ module Rollbar
     end
 
     def proxy_from_config
-      proxy = configuration.proxy
-      return nil unless proxy
+      proxy_settings = configuration.proxy
+      return nil unless proxy_settings
 
-      px = URI.parse(proxy[:host])
-      px.port = proxy[:port]
-      px.user = proxy[:user]
-      px.password = proxy[:password]
-      px
+      proxy = null_proxy
+      proxy.host = URI.parse(proxy_settings[:host]).host
+      proxy.port = proxy_settings[:port]
+      proxy.user = proxy_settings[:user]
+      proxy.password = proxy_settings[:password]
+      proxy
     end
 
     def proxy_from_env(uri)
@@ -565,7 +637,7 @@ module Rollbar
     end
 
     def skip_retries?
-      Rollbar::LanguageSupport.ruby_18? || Rollbar::LanguageSupport.ruby_19?
+      Rollbar::LanguageSupport.ruby_19?
     end
 
     def handle_response(response)
@@ -574,6 +646,7 @@ module Rollbar
       else
         log_warning "[Rollbar] Got unexpected status code from Rollbar api: #{response.code}"
         log_info "[Rollbar] Response: #{response.body}"
+        configuration.execute_hook(:on_error_response, response)
       end
     end
 
@@ -623,17 +696,17 @@ module Rollbar
 
           exception_info = exception.class.name
           # #to_s and #message defaults to class.to_s. Add message only if add valuable info.
-          exception_info += %(: "#{exception.message}") if exception.message != exception.class.to_s
+          exception_info += %[: "#{exception.message}"] if exception.message != exception.class.to_s
           exception_info += " in #{nearest_frame}" if nearest_frame
 
           body += "#{exception_info}: #{message}"
-        rescue
+        rescue StandardError
           log_error('[Rollbar] Error building failsafe exception message')
         end
       else
         begin
           body += message.to_s
-        rescue
+        rescue StandardError
           log_error('[Rollbar] Error building failsafe message')
         end
       end
@@ -666,7 +739,7 @@ module Rollbar
     def process_async_item(item)
       configuration.async_handler ||= default_async_handler
       configuration.async_handler.call(item.payload)
-    rescue
+    rescue StandardError
       if configuration.failover_handlers.empty?
         log_error '[Rollbar] Async handler failed, and there are no failover handlers configured. See the docs for "failover_handlers"'
         return
@@ -683,7 +756,7 @@ module Rollbar
       failover_handlers.each do |handler|
         begin
           handler.call(item.payload)
-        rescue
+        rescue StandardError
           next unless handler == failover_handlers.last
 
           log_error "[Rollbar] All failover handlers failed while processing item: #{Rollbar::JSON.dump(item.payload)}"
@@ -691,7 +764,7 @@ module Rollbar
       end
     end
 
-    alias_method :log_warning, :log_warn
+    alias log_warning log_warn
 
     def log_instance_link(data)
       return unless data[:uuid]
@@ -699,9 +772,5 @@ module Rollbar
       uuid_url = Util.uuid_rollbar_url(data, configuration)
       log_info "[Rollbar] Details: #{uuid_url} (only available if report was successful)"
     end
-
-    def logger
-      @logger ||= LoggerProxy.new(configuration.logger)
-    end
   end
 end

data/lib/rollbar/notifier/trace_with_bindings.rb

@@ -0,0 +1,65 @@
+module Rollbar
+  class Notifier
+    class TraceWithBindings # :nodoc:
+      attr_reader :frames, :exception_frames
+
+      def initialize
+        reset
+      end
+
+      def reset
+        @frames = []
+        @exception_frames = []
+        @exception_signature = nil
+      end
+
+      def enable
+        reset
+        trace_point.enable if defined?(TracePoint)
+      end
+
+      def disable
+        trace_point.disable if defined?(TracePoint)
+      end
+
+      private
+
+      def exception_signature(trace)
+        # use the exception backtrace to detect reraised exception.
+        trace.raised_exception.backtrace.first
+      end
+
+      def detect_reraise(trace)
+        @exception_signature == exception_signature(trace)
+      end
+
+      def trace_point
+        return unless defined?(TracePoint)
+
+        @trace_point ||= TracePoint.new(:call, :return, :b_call, :b_return, :c_call, :c_return, :raise) do |tp|
+          case tp.event
+          when :call, :b_call, :c_call, :class
+            frames.push frame(tp)
+          when :return, :b_return, :c_return, :end
+            frames.pop
+          when :raise
+            unless detect_reraise(tp) # ignore reraised exceptions
+              @exception_frames = @frames.dup # may be possible to optimize better than #dup
+              @exception_signature = exception_signature(tp)
+            end
+          end
+        end
+      end
+
+      def frame(trace)
+        {
+          :binding => trace.binding,
+          :defined_class => trace.defined_class,
+          :method_id => trace.method_id,
+          :path => trace.path,
+          :lineno => trace.lineno
+        }
+      end
+    end
+  end
+end