sentry-raven 2.8.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: b2c9069a9b5cfae47df6590266f31063b07347f4
-  data.tar.gz: bacb13812cd83d2e16befab52f47c3cd08f481ec
+SHA256:
+  metadata.gz: 6c812e5ab292c9f9351064bfc75f13bf3f6fff8ea1163a79a0e7da2e5efa9afb
+  data.tar.gz: 2fb7356fa0b26ee6f8a09a8ab023a21dcee132aa75fd3d1d87fd5f528a1c3366
 SHA512:
-  metadata.gz: 94aa454b77018b446f06d1daf50bc97679fc76d45362bf63e1e876fad72882a3363dfe83d0a68b03b04b1e4590b55578e451e42d2badb538b44322ef5b794a06
-  data.tar.gz: e5a2752c30d82bbeeaece755f09a4f4660b58aee9172460968447f40958a6c3ff0fc02b267040c1476097b361a0bc2785b61220acfaff1351e8dff4202010bb3
+  metadata.gz: b406e28322db6c9e96db35d108521f617c484cdef0367a6ea246709356d61b5917795289c3caf1cc7324f3228fba349a8b3f9a2b45aeaef0d01872848540db2a
+  data.tar.gz: f079139a9cf52c7344d28d55eec1fc108c237c76c23df7880122e66851d858bce86da817887d5a83f35c9732c619328178bfdd6f8cb6742c84024f0445710fed

data/.travis.yml

@@ -1,6 +1,5 @@
 language: ruby
 dist: trusty
-sudo: false
 group: beta
 cache: bundler
 
@@ -11,10 +10,11 @@ branches:
   only: [master]
 
 rvm:
-  - 2.2.9
-  - 2.3.6
-  - 2.4.3
-  - 2.5.0
+  - 2.3.8
+  - 2.4.9
+  - 2.5.7
+  - 2.6.5
+  - 2.7.0
 
 env:
   - RAILS_VERSION=4
@@ -33,13 +33,9 @@ before_install:
 
 matrix:
   include:
-    - rvm: 1.9
-      env: RAILS_VERSION=4
-    - rvm: jruby-1.7.27
-      env: JRUBY_OPTS="--dev" RAILS_VERSION=4
-    - rvm: jruby-9.2.0.0
+    - rvm: jruby-9.2.9.0
       env: JRUBY_OPTS="--dev -J-Djruby.launch.inproc=true -J-Xmx1024M" RAILS_VERSION=4
-    - rvm: jruby-9.2.0.0
+    - rvm: jruby-9.2.9.0
       env: JRUBY_OPTS="--dev -J-Djruby.launch.inproc=true -J-Xmx1024M" RAILS_VERSION=5
     - rvm: ruby-head
       env: RAILS_VERSION=0

data/README.md

@@ -13,13 +13,13 @@
 [![SemVer](https://api.dependabot.com/badges/compatibility_score?dependency-name=sentry-raven&package-manager=bundler&version-scheme=semver)](https://dependabot.com/compatibility-score.html?dependency-name=sentry-raven&package-manager=bundler&version-scheme=semver)
 
 
-[Documentation](https://docs.getsentry.com/hosted/clients/ruby/) | [Bug Tracker](https://github.com/getsentry/raven-ruby/issues) | [Forum](https://forum.sentry.io/) | IRC: irc.freenode.net, #sentry
+[Documentation](https://docs.sentry.io/clients/ruby/) | [Bug Tracker](https://github.com/getsentry/raven-ruby/issues) | [Forum](https://forum.sentry.io/) | IRC: irc.freenode.net, #sentry
 
 The official Ruby-language client and integration layer for the [Sentry](https://github.com/getsentry/sentry) error reporting API.
 
 ## Requirements
 
-We test on Ruby 1.9, 2.2, 2.3, and 2.4 at the latest patchlevel/teeny version. We also support JRuby 1.7 and 9.0. Our Rails integration works with Rails 4.2+ (including Rails 5).
+We test on Ruby 2.3, 2.4, 2.5, 2.6 and 2.7 at the latest patchlevel/teeny version. We also support JRuby 9.0. Our Rails integration works with Rails 4.2+ (including Rails 5).
 
 ## Getting Started
 
@@ -133,4 +133,4 @@ For more information, see [Context](https://docs.sentry.io/clients/ruby/context/
 * [Documentation](https://docs.sentry.io/clients/ruby/)
 * [Bug Tracker](https://github.com/getsentry/raven-ruby/issues)
 * [Forum](https://forum.sentry.io/)
-* [IRC](irc://irc.freenode.net/sentry>)  (irc.freenode.net, #sentry)
+- [Discord](https://discord.gg/ez5KZN7)

data/changelog.md

@@ -1,7 +1,77 @@
+3.0.0
+----
+
+* SDK now requires Ruby >= 2.3
+* REF: Retain any literal "HTTP-" in header names [@elliterate, #950]
+* REF: Delete JSON spec for recursive hashes [@ksylvest, #952]
+* FEAT: Bump faraday version to latest [@ksylvest, #946] 
+
+2.13.0
+----
+
+* FIX: Sanitize event data before they are sent to async job. [@edariedl, #895]
+* FIX: Serialization MongoDB ObjectId to JSON problem with gem delayed_job_mongoid conjunction. [@eagleas, #935]
+* FEAT: Skip ActiveJob integration if there is a better one [@fsateler, #909]
+* FIX: Bugs with send_event in asynchronous mode (#940) [@cstyles, #940]
+
+2.12.3
+----
+
+* FIX: crash when Process.wait is used [@asBrettisay, #895]
+
+2.12.2
+----
+
+* FIX: return tags/extra for [@rivayama, #931]
+
+2.12.1
+----
+
+* FIX: undefined method `[]' for nil:NilClass [@HazAT, #932]
+
+2.12.0
+----
+
+* FIX: Remove duplicate message when exception is emitted
+* FIX: Frozen string bug in utf8conversation
+* FEATURE: Allow block on tags_context and extra_context
+
+2.11.3
+----
+
+* FIX: infinite backoff under pressure [@Bonias, #886]
+
+2.11.2
+----
+
+* REF: Warn on 4xx error [@iloveitaly, #862]
+
+2.11.1
+----
+
+* FIX: Call `to_s` on breadcrumb message [@halkeye, #914]
+
+2.11.0
+----
+
+* FEATURE: Prepend the transaction around_action so libraries with controllers can alter the value. [@drcapulet, #887]
+
+2.10.0
+-----
+
+* FEATURE: Added support for `SENTRY_ENVIRONMENT` [@mtsmfm, #910]
+* FEATURE: Added support for `SENTRY_RELEASE` [@coorasse, #911]
+
+2.9.0
+-----
+
+* FEATURE: Added `config.inspect_exception_causes_for_exclusion`. Determines if the exception cause should be inspected for `config.excluded_exceptions` option. [@effron, #872]
+
+
 2.8.0
 -----
 
-* FEATURE: Added `config.before_send`. Provide a lambda or proc to this config setting, which will be `call`ed when before sending an event to Sentry. Receives `event` and `hint` as parameter. `hint` is a has {:exception => ex | nil, :message => message | nil}. [@hazat, #847]
+* FEATURE: Added `config.before_send`. Provide a lambda or proc to this config setting, which will be `call`ed before sending an event to Sentry. Receives `event` and `hint` as parameters. `hint` is a hash `{:exception => ex | nil, :message => message | nil}`. [@hazat, #882]
 
 2.7.4
 -----

data/lib/raven/base.rb

@@ -23,6 +23,7 @@ require 'raven/transports'
 require 'raven/transports/http'
 require 'raven/utils/deep_merge'
 require 'raven/utils/real_ip'
+require 'raven/utils/exception_cause_chain'
 require 'raven/instance'
 
 require 'forwardable'
@@ -99,7 +100,7 @@ module Raven
 
     def sys_command(command)
       result = `#{command} 2>&1` rescue nil
-      return if result.nil? || result.empty? || $CHILD_STATUS.exitstatus != 0
+      return if result.nil? || result.empty? || ($CHILD_STATUS && $CHILD_STATUS.exitstatus != 0)
       result.strip
     end
   end

data/lib/raven/breadcrumbs/logger.rb

@@ -36,7 +36,7 @@ module Raven
 
       # some loggers will add leading/trailing space as they (incorrectly, mind you)
       # think of logging as a shortcut to std{out,err}
-      message = message.strip
+      message = message.to_s.strip
 
       last_crumb = Raven.breadcrumbs.peek
       # try to avoid dupes from logger broadcasts

data/lib/raven/client.rb

@@ -35,7 +35,8 @@ module Raven
         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"
 
       content_type, encoded_data = encode(event)
 
@@ -79,8 +80,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
@@ -100,13 +113,13 @@ module Raven
     end
 
     def failed_send(e, event)
-      @state.failure
       if e # exception was raised
-        configuration.logger.error "Unable to record event with remote Sentry server (#{e.class} - #{e.message}):\n#{e.backtrace[0..10].join("\n")}"
+        @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
-        configuration.logger.error "Not sending event due to previous failure(s)."
+        configuration.logger.warn "Not sending event due to previous failure(s)."
       end
-      configuration.logger.error("Failed to submit event: #{get_log_message(event)}")
+      configuration.logger.warn("Failed to submit event: #{get_log_message(event)}")
       configuration.transport_failure_callback.call(event) if configuration.transport_failure_callback
     end
   end

data/lib/raven/configuration.rb

@@ -31,6 +31,10 @@ module Raven
     # You should probably append to this rather than overwrite it.
     attr_accessor :excluded_exceptions
 
+    # Boolean to check nested exceptions when deciding if to exclude. Defaults to false
+    attr_accessor :inspect_exception_causes_for_exclusion
+    alias inspect_exception_causes_for_exclusion? inspect_exception_causes_for_exclusion
+
     # DSN component - set automatically if DSN provided
     attr_accessor :host
 
@@ -205,6 +209,7 @@ module Raven
       self.environments = []
       self.exclude_loggers = []
       self.excluded_exceptions = IGNORE_DEFAULT.dup
+      self.inspect_exception_causes_for_exclusion = false
       self.linecache = ::Raven::LineCache.new
       self.logger = ::Raven::Logger.new(STDOUT)
       self.open_timeout = 1
@@ -342,21 +347,32 @@ module Raven
     end
 
     def detect_release
-      detect_release_from_git ||
+      detect_release_from_env ||
+        detect_release_from_git ||
         detect_release_from_capistrano ||
         detect_release_from_heroku
     rescue => ex
       logger.error "Error detecting release: #{ex.message}"
     end
 
-    def excluded_exception?(exc)
-      excluded_exceptions.any? { |x| get_exception_class(x) === exc }
+    def excluded_exception?(incoming_exception)
+      excluded_exceptions.any? do |excluded_exception|
+        matches_exception?(get_exception_class(excluded_exception), incoming_exception)
+      end
     end
 
     def get_exception_class(x)
       x.is_a?(Module) ? x : qualified_const_get(x)
     end
 
+    def matches_exception?(excluded_exception_class, incoming_exception)
+      if inspect_exception_causes_for_exclusion?
+        Raven::Utils::ExceptionCauseChain.exception_to_array(incoming_exception).any? { |cause| excluded_exception_class === cause }
+      else
+        excluded_exception_class === incoming_exception
+      end
+    end
+
     # In Ruby <2.0 const_get can't lookup "SomeModule::SomeClass" in one go
     def qualified_const_get(x)
       x = x.to_s
@@ -396,6 +412,10 @@ module Raven
       Raven.sys_command("git rev-parse --short HEAD") if File.directory?(".git")
     end
 
+    def detect_release_from_env
+      ENV['SENTRY_RELEASE']
+    end
+
     def capture_in_current_environment?
       return true unless environments.any? && !environments.include?(current_environment)
       @errors << "Not configured to send/capture in environment '#{current_environment}'"
@@ -438,7 +458,7 @@ module Raven
     end
 
     def current_environment_from_env
-      ENV['SENTRY_CURRENT_ENV'] || ENV['RAILS_ENV'] || ENV['RACK_ENV'] || 'default'
+      ENV['SENTRY_CURRENT_ENV'] || ENV['SENTRY_ENVIRONMENT'] || ENV['RAILS_ENV'] || ENV['RACK_ENV'] || 'default'
     end
 
     def server_name_from_env

data/lib/raven/event.rb

@@ -59,10 +59,7 @@ module Raven
       return unless configuration.exception_class_allowed?(exc)
 
       new(options) do |evt|
-        evt.message = "#{exc.class}: #{exc.message}"
-
         evt.add_exception_interface(exc)
-
         yield evt if block
       end
     end
@@ -139,7 +136,7 @@ module Raven
 
     def add_exception_interface(exc)
       interface(:exception) do |exc_int|
-        exceptions = exception_chain_to_array(exc)
+        exceptions = Raven::Utils::ExceptionCauseChain.exception_to_array(exc).reverse
         backtraces = Set.new
         exc_int.values = exceptions.map do |e|
           SingleExceptionInterface.new do |int|
@@ -231,24 +228,7 @@ module Raven
     end
 
     def async_json_processors
-      [
-        Raven::Processor::RemoveCircularReferences,
-        Raven::Processor::UTF8Conversion
-      ].map { |v| v.new(self) }
-    end
-
-    def exception_chain_to_array(exc)
-      if exc.respond_to?(:cause) && exc.cause
-        exceptions = [exc]
-        while exc.cause
-          exc = exc.cause
-          break if exceptions.any? { |e| e.object_id == exc.object_id }
-          exceptions << exc
-        end
-        exceptions.reverse!
-      else
-        [exc]
-      end
+      configuration.processors.map { |v| v.new(self) }
     end
 
     def list_gem_specs

data/lib/raven/instance.rb

@@ -183,6 +183,10 @@ module Raven
     #   Raven.tags_context('my_custom_tag' => 'tag_value')
     def tags_context(options = nil)
       context.tags.merge!(options || {})
+      yield if block_given?
+      context.tags
+    ensure
+      context.tags.delete_if { |k, _| options.keys.include? k } if block_given?
     end
 
     # Bind extra context. Merges with existing context (if any).
@@ -194,6 +198,10 @@ module Raven
     #   Raven.extra_context('my_custom_data' => 'value')
     def extra_context(options = nil)
       context.extra.merge!(options || {})
+      yield if block_given?
+      context.extra
+    ensure
+      context.extra.delete_if { |k, _| options.keys.include? k } if block_given?
     end
 
     def rack_context(env)

data/lib/raven/integrations/delayed_job.rb

@@ -13,7 +13,7 @@ module Delayed
             # Log error to Sentry
             extra = {
               :delayed_job => {
-                :id          => job.id,
+                :id          => job.id.to_s,
                 :priority    => job.priority,
                 :attempts    => job.attempts,
                 :run_at      => job.run_at,
@@ -36,7 +36,7 @@ module Delayed
                                       :logger  => 'delayed_job',
                                       :tags    => {
                                         :delayed_job_queue => job.queue,
-                                        :delayed_job_id => job.id
+                                        :delayed_job_id => job.id.to_s
                                       },
                                       :extra => extra)
 

data/lib/raven/integrations/rack.rb

@@ -113,7 +113,7 @@ module Raven
 
           next unless key.start_with?('HTTP_') || %w(CONTENT_TYPE CONTENT_LENGTH).include?(key)
           # Rack stores headers as HTTP_WHAT_EVER, we need What-Ever
-          key = key.gsub("HTTP_", "")
+          key = key.sub(/^HTTP_/, "")
           key = key.split('_').map(&:capitalize).join('-')
           memo[key] = value
         rescue StandardError => e

data/lib/raven/integrations/rails/active_job.rb

@@ -9,7 +9,11 @@ module Raven
       def self.included(base)
         base.class_eval do
           around_perform do |job, block|
-            capture_and_reraise_with_sentry(job, block)
+            if already_supported_by_specific_integration?(job)
+              block.call
+            else
+              capture_and_reraise_with_sentry(job, block)
+            end
           end
         end
       end
@@ -18,9 +22,7 @@ module Raven
         block.call
       rescue Exception => exception # rubocop:disable Lint/RescueException
         return if rescue_with_handler(exception)
-        unless already_supported_by_specific_integration?(job)
-          Raven.capture_exception(exception, :extra => raven_context(job))
-        end
+        Raven.capture_exception(exception, :extra => raven_context(job))
         raise exception
       ensure
         Context.clear!

data/lib/raven/integrations/rails/controller_transaction.rb

@@ -2,7 +2,7 @@ module Raven
   class Rails
     module ControllerTransaction
       def self.included(base)
-        base.around_action do |controller, block|
+        base.prepend_around_action do |controller, block|
           Raven.context.transaction.push "#{controller.class}##{controller.action_name}"
           block.call
           Raven.context.transaction.pop

data/lib/raven/processor/utf8conversion.rb

@@ -39,7 +39,7 @@ module Raven
     # https://github.com/rspec/rspec-support/blob/f0af3fd74a94ff7bb700f6ba06dbdc67bba17fbf/lib/rspec/support/encoded_string.rb#L120-L139
     if String.method_defined?(:scrub) # 2.1+
       def remove_invalid_bytes(string)
-        string.scrub!(REPLACE)
+        string.scrub(REPLACE)
       end
     else
       def remove_invalid_bytes(string)

data/lib/raven/utils/exception_cause_chain.rb

@@ -0,0 +1,19 @@
+module Raven
+  module Utils
+    module ExceptionCauseChain
+      def self.exception_to_array(exception)
+        if exception.respond_to?(:cause) && exception.cause
+          exceptions = [exception]
+          while exception.cause
+            exception = exception.cause
+            break if exceptions.any? { |e| e.object_id == exception.object_id }
+            exceptions << exception
+          end
+          exceptions
+        else
+          [exception]
+        end
+      end
+    end
+  end
+end

data/lib/raven/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 module Raven
   # Freezing this constant breaks in 1.9.x
-  VERSION = "2.8.0" # rubocop:disable Style/MutableConstant
+  VERSION = "3.0.0" # rubocop:disable Style/MutableConstant
 end

data/sentry-raven.gemspec

@@ -5,17 +5,17 @@ Gem::Specification.new do |gem|
   gem.name = "sentry-raven"
   gem.authors = ["Sentry Team"]
   gem.description = gem.summary = "A gem that provides a client interface for the Sentry error logger"
-  gem.email = "getsentry@googlegroups.com"
+  gem.email = "accounts@sentry.io"
   gem.license = 'Apache-2.0'
   gem.homepage = "https://github.com/getsentry/raven-ruby"
 
   gem.version = Raven::VERSION
   gem.platform = Gem::Platform::RUBY
-  gem.required_ruby_version = '>= 1.9.0'
+  gem.required_ruby_version = '>= 2.3'
   gem.extra_rdoc_files = ["README.md", "LICENSE"]
   gem.files = `git ls-files | grep -Ev '^(spec|benchmarks|examples)'`.split("\n")
   gem.bindir = "exe"
   gem.executables = "raven"
 
-  gem.add_dependency "faraday", ">= 0.7.6", "< 1.0"
+  gem.add_dependency "faraday", ">= 1.0"
 end

metadata

@@ -1,23 +1,20 @@
 --- !ruby/object:Gem::Specification
 name: sentry-raven
 version: !ruby/object:Gem::Version
-  version: 2.8.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Sentry Team
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-01-09 00:00:00.000000000 Z
+date: 2020-03-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.7.6
-    - - "<"
       - !ruby/object:Gem::Version
         version: '1.0'
   type: :runtime
@@ -25,13 +22,10 @@ dependencies:
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.7.6
-    - - "<"
       - !ruby/object:Gem::Version
         version: '1.0'
 description: A gem that provides a client interface for the Sentry error logger
-email: getsentry@googlegroups.com
+email: accounts@sentry.io
 executables:
 - raven
 extensions: []
@@ -96,6 +90,7 @@ files:
 - lib/raven/transports/http.rb
 - lib/raven/transports/stdout.rb
 - lib/raven/utils/deep_merge.rb
+- lib/raven/utils/exception_cause_chain.rb
 - lib/raven/utils/real_ip.rb
 - lib/raven/version.rb
 - lib/sentry-raven-without-integrations.rb
@@ -113,15 +108,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.9.0
+      version: '2.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.2.3
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: A gem that provides a client interface for the Sentry error logger