sentry-raven 3.0.3 → 3.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 80521c1a75c0ad22be530ffd95d497c5faa6def9d88d21dceecf3b7dacecb7a8
-  data.tar.gz: 1c1302782b979b2cf098ef0a90b71d69a65f733af2f95d588b4ae71e0ab67922
+  metadata.gz: e0e19bd3b705bd0a2c680d367ea7420941d5df1c5b245317170b9c31fd177006
+  data.tar.gz: f826cbfb501dfd844ff1096b8561ffc8a2e4f589d51d186ce063e4cfcabc65aa
 SHA512:
-  metadata.gz: 0cd7c853ace426bd428037ea0cf436b781511beded44373fea677a06f58e7a6200f0ddad9d9777fb12468954b344e4035a7a275427a65ff38e6cb618317e7198
-  data.tar.gz: ab5c38a374dc93fffa6baf9b9284795c3790e3db247848a9b39d7aa4902a3045375c24cea5e480cee25758bab96fe6f4c79c2fdae43c1f80ad25f171c443ba1f
+  metadata.gz: 8f47ca78fad6ebc47e9a76efd32e8009e6b8196256b06edef38dc1081a4eafb57f0f880e69d3e423ef5dffe6f66f2651c6c1fa2ca4002ad1c5be352b541bdfb3
+  data.tar.gz: f6e95e7a313ece5ebfb1af584d2cd11648575a6121a0ff0b807180e396bfb8102b1bc0cc1914d96e26058273193dbf6014c0acd6ded8dbef284cac6d0279ab79

data/CHANGELOG.md

@@ -2,6 +2,11 @@
 
 ## Unreleased
 
+## 3.0.4
+
+- fix: Don't log warning messages when it doesn't need to (#1000)
+- fix: Revert "Refactor Raven::Client class" (#1002)
+
 ## 3.0.3
 
 - fix: Ensure Processor::Cookie can run after Processor::RemoveCircularReferences (#996)

data/README.md

@@ -112,19 +112,28 @@ config.transport_failure_callback = lambda { |event|
 
 #### Context
 
-Much of the usefulness of Sentry comes from additional context data with the events. Raven makes this very convenient by providing methods to set thread local context data that is then submitted automatically with all events.
-
-There are three primary methods for providing request context:
+Much of the usefulness of Sentry comes from additional context data with the events. Raven makes this very convenient by providing methods to set thread local context data that is then submitted automatically with all events:
 
 ```ruby
-# bind the logged in user
 Raven.user_context email: 'foo@example.com'
 
-# tag the request with something interesting
-Raven.tags_context interesting: 'yes'
+Raven.tags.merge!(interesting: 'yes')
+
+Raven.extra.merge!(additional_info: 'foo')
+```
+
+You can also use `tags_context` and `extra_context` to provide scoped information:
+
+```ruby
+Raven.tags_context(interesting: 'yes') do
+  # the `interesting: 'yes'` tag will only present in the requests sent inside the block
+  Raven.capture_exception(exception)
+end
 
-# provide a bit of additional context
-Raven.extra_context happiness: 'very'
+Raven.extra_context(additional_info: 'foo') do
+  # same as above, the `additional_info` will only present in this request
+  Raven.capture_exception(exception)
+end
 ```
 
 For more information, see [Context](https://docs.sentry.io/clients/ruby/context/).

data/lib/raven/client.rb

@@ -30,15 +30,18 @@ module Raven
         return
       end
 
+      # Convert to hash
+      event = event.to_hash
+
       unless @state.should_try?
         failed_send(nil, event)
         return
       end
 
-      configuration.logger.info "Sending event #{event.event_id} to Sentry"
+      event_id = event[:event_id] || event['event_id']
+      configuration.logger.info "Sending event #{event_id} to Sentry"
 
-      event_hash = event.to_hash
-      content_type, encoded_data = encode(event_hash)
+      content_type, encoded_data = encode(event)
 
       begin
         transport.send_event(generate_auth_header, encoded_data,
@@ -49,7 +52,7 @@ module Raven
         return
       end
 
-      event_hash
+      event
     end
 
     def transport
@@ -68,8 +71,8 @@ module Raven
 
     private
 
-    def encode(event_hash)
-      hash = @processors.reduce(event_hash) { |a, e| e.process(a) }
+    def encode(event)
+      hash = @processors.reduce(event.to_hash) { |a, e| e.process(a) }
       encoded = JSON.fast_generate(hash)
 
       case configuration.encoding
@@ -80,6 +83,22 @@ 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]) || (event && event['message']) || get_message_from_exception(event) || '<no message value>'
+    end
+
     def generate_auth_header
       now = Time.now.to_i.to_s
       fields = {
@@ -103,12 +122,10 @@ module Raven
       else
         configuration.logger.warn "Not sending event due to previous failure(s)."
       end
-
-      event_message = event&.log_message || '<no message value>'
-      configuration.logger.warn("Failed to submit event: #{event_message}")
+      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.to_hash) if configuration.transport_failure_callback # rubocop:disable Style/SafeNavigation
+      configuration.transport_failure_callback.call(event) if configuration.transport_failure_callback # rubocop:disable Style/SafeNavigation
     end
   end
 

data/lib/raven/configuration.rb

@@ -342,6 +342,10 @@ module Raven
       end
     end
 
+    def enabled_in_current_env?
+      environments.empty? || environments.include?(current_environment)
+    end
+
     private
 
     def detect_project_root
@@ -423,7 +427,7 @@ module Raven
     end
 
     def capture_in_current_environment?
-      return true unless environments.any? && !environments.include?(current_environment)
+      return true if enabled_in_current_env?
 
       @errors << "Not configured to send/capture in environment '#{current_environment}'"
       false

data/lib/raven/event.rb

@@ -136,25 +136,6 @@ module Raven
       JSON.parse(JSON.generate(cleaned_hash))
     end
 
-    def message_from_exception
-      exception = @interfaces[:exception]
-
-      return unless exception
-
-      exception = exception.to_hash
-
-      type = exception.dig(:values, 0, :type)
-      value = exception.dig(:values, 0, :value)
-
-      if type && value
-        "#{type}: #{value}"
-      end
-    end
-
-    def log_message
-      message || message_from_exception
-    end
-
     def add_exception_interface(exc)
       interface(:exception) do |exc_int|
         exceptions = Raven::Utils::ExceptionCauseChain.exception_to_array(exc).reverse

data/lib/raven/instance.rb

@@ -50,6 +50,7 @@ module Raven
 
     # Tell the log that the client is good to go
     def report_status
+      return unless configuration.enabled_in_current_env?
       return if configuration.silence_ready
 
       if configuration.capture_allowed?

data/lib/raven/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Raven
-  VERSION = "3.0.3"
+  VERSION = "3.0.4"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sentry-raven
 version: !ruby/object:Gem::Version
-  version: 3.0.3
+  version: 3.0.4
 platform: ruby
 authors:
 - Sentry Team
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-08-27 00:00:00.000000000 Z
+date: 2020-08-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday