sentry-raven 2.1.3 → 3.1.2

data/lib/raven/cli.rb

@@ -1,60 +1,48 @@
 module Raven
   class CLI
-    def self.test(dsn = nil, silent = false) # rubocop:disable all
-      if silent
-        Raven.configuration.logger = ::Logger.new(nil)
-      else
-        logger = ::Logger.new(STDOUT)
-        logger.level = ::Logger::ERROR
-        logger.formatter = proc do |_severity, _datetime, _progname, msg|
-          "-> #{msg}\n"
-        end
-
-        Raven.configuration.logger = logger
-      end
-
-      Raven.configuration.timeout = 5
-      Raven.configuration.dsn = dsn if dsn
+    def self.test(dsn = nil, silent = false, config = nil)
+      config ||= Raven.configuration
+
+      config.logger = if silent
+                        ::Logger.new(nil)
+                      else
+                        logger = ::Logger.new(STDOUT)
+                        logger.formatter = proc do |_severity, _datetime, _progname, msg|
+                          "-> #{msg}\n"
+                        end
+                        logger
+                      end
+
+      config.timeout = 5
+      config.dsn = dsn if dsn
 
       # wipe out env settings to ensure we send the event
-      unless Raven.configuration.capture_allowed?
-        env_name = Raven.configuration.environments.pop || 'production'
-        Raven.logger.debug "Setting environment to #{env_name}"
-        Raven.configuration.current_environment = env_name
+      unless config.capture_allowed?
+        env_name = config.environments.last || 'production'
+        config.current_environment = env_name
       end
 
-      Raven.configuration.verify!
+      instance = Raven::Instance.new(nil, config)
 
-      Raven.logger.debug "Sending a test event:"
-      Raven.logger.debug ""
+      instance.logger.debug "Sending a test event:"
+      instance.logger.debug ""
 
       begin
         1 / 0
-      rescue ZeroDivisionError => exception
-        evt = Raven.capture_exception(exception)
+      rescue ZeroDivisionError => e
+        evt = instance.capture_exception(e)
       end
 
-      if evt && !(evt.is_a? Thread)
-        if evt.is_a? Hash
-          Raven.logger.debug "-> event ID: #{evt[:event_id]}"
-        else
-          Raven.logger.debug "-> event ID: #{evt.id}"
-        end
-      elsif evt # async configuration
-        if evt.value.is_a? Hash
-          Raven.logger.debug "-> event ID: #{evt.value[:event_id]}"
-        else
-          Raven.logger.debug "-> event ID: #{evt.value.id}"
-        end
+      if evt
+        instance.logger.debug "-> event ID: #{evt.id}"
+        instance.logger.debug ""
+        instance.logger.debug "Done!"
+        evt
       else
-        Raven.logger.debug ""
-        Raven.logger.debug "An error occurred while attempting to send the event."
-        exit 1
+        instance.logger.debug ""
+        instance.logger.debug "An error occurred while attempting to send the event."
+        false
       end
-
-      Raven.logger.debug ""
-      Raven.logger.debug "Done!"
-      true
     end
   end
 end

data/lib/raven/client.rb

@@ -1,17 +1,17 @@
 # frozen_string_literal: true
+
 require 'base64'
 require 'json'
 require 'zlib'
 
-require 'raven/version'
-require 'raven/transports/http'
+require "raven/transports"
 
 module Raven
   # Encodes events and sends them to the Sentry server.
   class Client
-    PROTOCOL_VERSION = '5'.freeze
-    USER_AGENT = "raven-ruby/#{Raven::VERSION}".freeze
-    CONTENT_TYPE = 'application/json'.freeze
+    PROTOCOL_VERSION = '5'
+    USER_AGENT = "raven-ruby/#{Raven::VERSION}"
+    CONTENT_TYPE = 'application/json'
 
     attr_accessor :configuration
 
@@ -21,9 +21,15 @@ module Raven
       @state = ClientState.new
     end
 
-    def send_event(event)
+    def send_event(event, hint = nil)
       return false unless configuration.sending_allowed?(event)
 
+      event = configuration.before_send.call(event, hint) if configuration.before_send
+      if event.nil?
+        configuration.logger.info "Discarded event because before_send returned nil"
+        return
+      end
+
       # Convert to hash
       event = event.to_hash
 
@@ -32,7 +38,8 @@ module Raven
         return
       end
 
-      Raven.logger.debug "Sending event #{event[:event_id]} to Sentry"
+      event_id = event[:event_id] || event['event_id']
+      configuration.logger.info "Sending event #{event_id} to Sentry"
 
       content_type, encoded_data = encode(event)
 
@@ -53,6 +60,8 @@ module Raven
         case configuration.scheme
         when 'http', 'https'
           Transports::HTTP.new(configuration)
+        when 'stdout'
+          Transports::Stdout.new(configuration)
         when 'dummy'
           Transports::Dummy.new(configuration)
         else
@@ -64,7 +73,7 @@ module Raven
 
     def encode(event)
       hash = @processors.reduce(event.to_hash) { |a, e| e.process(a) }
-      encoded = JSON.generate(hash)
+      encoded = JSON.fast_generate(hash)
 
       case configuration.encoding
       when 'gzip'
@@ -74,8 +83,20 @@ module Raven
       end
     end
 
+    def get_message_from_exception(event)
+      (
+        event &&
+        event[:exception] &&
+        event[:exception][:values] &&
+        event[:exception][:values][0] &&
+        event[:exception][:values][0][:type] &&
+        event[:exception][:values][0][:value] &&
+        "#{event[:exception][:values][0][:type]}: #{event[:exception][:values][0][:value]}"
+      )
+    end
+
     def get_log_message(event)
-      (event && event[:message]) || '<no message value>'
+      (event && event[:message]) || (event && event['message']) || get_message_from_exception(event) || '<no message value>'
     end
 
     def generate_auth_header
@@ -84,9 +105,9 @@ module Raven
         'sentry_version' => PROTOCOL_VERSION,
         'sentry_client' => USER_AGENT,
         'sentry_timestamp' => now,
-        'sentry_key' => configuration.public_key,
-        'sentry_secret' => configuration.secret_key
+        'sentry_key' => configuration.public_key
       }
+      fields['sentry_secret'] = configuration.secret_key unless configuration.secret_key.nil?
       'Sentry ' + fields.map { |key, value| "#{key}=#{value}" }.join(', ')
     end
 
@@ -95,15 +116,16 @@ module Raven
     end
 
     def failed_send(e, event)
-      @state.failure
       if e # exception was raised
-        Raven.logger.error "Unable to record event with remote Sentry server (#{e.class} - #{e.message})"
-        e.backtrace[0..10].each { |line| Raven.logger.error(line) }
+        @state.failure
+        configuration.logger.warn "Unable to record event with remote Sentry server (#{e.class} - #{e.message}):\n#{e.backtrace[0..10].join("\n")}"
       else
-        Raven.logger.error "Not sending event due to previous failure(s)."
+        configuration.logger.warn "Not sending event due to previous failure(s)."
       end
-      Raven.logger.error("Failed to submit event: #{get_log_message(event)}")
-      configuration.transport_failure_callback.call(event) if configuration.transport_failure_callback
+      configuration.logger.warn("Failed to submit event: #{get_log_message(event)}")
+
+      # configuration.transport_failure_callback can be false & nil
+      configuration.transport_failure_callback.call(event, e) if configuration.transport_failure_callback # rubocop:disable Style/SafeNavigation
     end
   end