sentry-raven 2.7.4 → 2.12.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 39f754caa8c8dc1d3adf0a5ef6fc1691817c4902
-  data.tar.gz: 1367510ab3abaed41237210d7810626d7bf87fb5
+  metadata.gz: 86dc048eed812d93571e381134d4138c7eadd0f7
+  data.tar.gz: 70b6f8806383b20868acf609aed986160c8f31bb
 SHA512:
-  metadata.gz: 2deb6a18853cd32279e3a4c02a202cf661cb45062700d1efff75284ae7f31955426f774f91d461b9e4e74f13847fb092bf09957abab57cb79a2817e4949be3a3
-  data.tar.gz: 9cc99e456d2485bcd80e92f3d7b4c9f40429d96872d904dcec006804ee4e31b20325366ba263f14872b8b96b4a8e9aaa1f7c1fc53485b96e0a952c9955d28e3e
+  metadata.gz: 20b21e009d1ec5d1757fef8c8ff8e60dd663dfbfc5fc2cd173caed906f9e011ca496480d25076e9198d82855edb4d0b50ae9300cb4ec0f1cb102cb0e98987a05
+  data.tar.gz: 209abfc6bf093fd2640e76db98315673070d20069bfe5b52b5d4df24ff956caac1f3c6e7358be13bbfb3cd25d0a8863f99e328c42353bc78011fd417697fa617

data/.gitignore

@@ -2,7 +2,6 @@ coverage
 pkg
 ruby/
 log/
-docs/_build
 .bundle
 *.gem
 gemfiles/*.lock

data/.gitmodules

@@ -1,3 +0,0 @@
-[submodule "docs/_sentryext"]
-	path = docs/_sentryext
-	url = https://github.com/getsentry/sentry-doc-support

data/.rubocop.yml

@@ -7,7 +7,7 @@ AllCops:
      - 'vendor/**/*'
 
 Metrics/ClassLength:
-  Max: 269
+  Max: 300
   CountComments: false
 
 Metrics/AbcSize:

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.2.10
+  - 2.3.8
+  - 2.4.9
+  - 2.5.7
+  - 2.6.5
 
 env:
   - RAILS_VERSION=4
@@ -37,9 +37,9 @@ matrix:
       env: RAILS_VERSION=4
     - rvm: jruby-1.7.27
       env: JRUBY_OPTS="--dev" RAILS_VERSION=4
-    - rvm: jruby-9.1.17.0
+    - rvm: jruby-9.2.9.0
       env: JRUBY_OPTS="--dev -J-Djruby.launch.inproc=true -J-Xmx1024M" RAILS_VERSION=4
-    - rvm: jruby-9.1.17.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/Gemfile

@@ -4,12 +4,12 @@ gemspec
 
 if ENV["RAILS_VERSION"] && (ENV["RAILS_VERSION"].to_i == 4)
   gem "rails", "< 5"
-  gem "rspec-rails"
+  gem "rspec-rails", "> 3"
 elsif ENV["RAILS_VERSION"] && (ENV["RAILS_VERSION"].to_i == 0)
   # no-op. No Rails.
 else
   gem "rails", "< 6"
-  gem "rspec-rails"
+  gem "rspec-rails", "> 3"
 end
 
 if RUBY_VERSION < '2.0'
@@ -28,9 +28,9 @@ gem "pry-coolline"
 gem "benchmark-ips"
 gem "benchmark-ipsa" if RUBY_VERSION > '2.0'
 gem "ruby-prof", platform: :mri
-gem "rake"
-gem "rubocop", "~> 0.41.1"
-gem "rspec"
+gem "rake", "> 12"
+gem "rubocop", "~> 0.41.1" # Last version that supported 1.9, upgrade to 0.50 after we drop 1.9
+gem "rspec", "> 3"
 gem "capybara" # rspec system tests
 gem "puma" # rspec system tests
 

data/README.md

@@ -1,5 +1,8 @@
 <p align="center">
-  <img src="https://cdn.rawgit.com/getsentry/raven-python/1e525422/docs/_static/logo.png">
+  <a href="https://sentry.io" target="_blank" align="center">
+    <img src="https://sentry-brand.storage.googleapis.com/sentry-logo-black.png" width="280">
+  </a>
+  <br>
 </p>
 
 # Raven-Ruby, the Ruby Client for Sentry
@@ -7,9 +10,10 @@
 [![Gem Version](https://img.shields.io/gem/v/sentry-raven.svg)](https://rubygems.org/gems/sentry-raven)
 [![Build Status](https://img.shields.io/travis/getsentry/raven-ruby/master.svg)](https://travis-ci.org/getsentry/raven-ruby)
 [![Gem](https://img.shields.io/gem/dt/sentry-raven.svg)](https://rubygems.org/gems/sentry-raven/)
+[![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.
 
@@ -31,12 +35,12 @@ Raven will capture and send exceptions to the Sentry server whenever its DSN is
 
 ```bash
 # Set your SENTRY_DSN environment variable.
-export SENTRY_DSN=http://public:secret@example.com/project-id
+export SENTRY_DSN=http://public@example.com/project-id
 ```
 ```ruby
 # Or you can configure the client in the code (not recommended - keep your DSN secret!)
 Raven.configure do |config|
-  config.dsn = 'http://public:secret@example.com/project-id'
+  config.dsn = 'http://public@example.com/project-id'
 end
 ```
 
@@ -126,7 +130,7 @@ For more information, see [Context](https://docs.sentry.io/clients/ruby/context/
 
 ## More Information
 
-* [Documentation](https://docs.getsentry.com/hosted/clients/ruby/)
+* [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,3 +1,62 @@
+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 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

@@ -18,9 +18,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
 
@@ -50,6 +56,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
@@ -71,8 +79,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]) || get_message_from_exception(event) || '<no message value>'
     end
 
     def generate_auth_header
@@ -92,13 +112,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
 
@@ -156,6 +160,15 @@ module Raven
     # E.g. lambda { |event| Thread.new { MyJobProcessor.send_email(event) } }
     attr_reader :transport_failure_callback
 
+    # Optional Proc, called before sending an event to the server/
+    # E.g.: lambda { |event, hint| event }
+    # E.g.: lambda { |event, hint| nil }
+    # E.g.: lambda { |event, hint|
+    #   event[:message] = 'a'
+    #   event
+    # }
+    attr_reader :before_send
+
     # Errors object - an Array that contains error messages. See #
     attr_reader :errors
 
@@ -182,6 +195,9 @@ module Raven
       Raven::Processor::HTTPHeaders
     ].freeze
 
+    HEROKU_DYNO_METADATA_MESSAGE = "You are running on Heroku but haven't enabled Dyno Metadata. For Sentry's "\
+    "release detection to work correctly, please run `heroku labs:enable runtime-dyno-metadata`".freeze
+
     LOG_PREFIX = "** [Raven] ".freeze
     MODULE_SEPARATOR = "::".freeze
 
@@ -193,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
@@ -214,6 +231,7 @@ module Raven
       self.tags = {}
       self.timeout = 2
       self.transport_failure_callback = false
+      self.before_send = false
     end
 
     def server=(value)
@@ -266,6 +284,13 @@ module Raven
       @should_capture = value
     end
 
+    def before_send=(value)
+      unless value == false || value.respond_to?(:call)
+        raise ArgumentError, "before_send must be callable (or false to disable)"
+      end
+      @before_send = value
+    end
+
     # Allows config options to be read like a hash
     #
     # @param [Symbol] option Key for a given attribute
@@ -322,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
@@ -352,7 +388,7 @@ module Raven
     def detect_release_from_heroku
       return unless running_on_heroku?
       return if ENV['CI']
-      logger.warn(heroku_dyno_metadata_message) && return unless ENV['HEROKU_SLUG_COMMIT']
+      logger.warn(HEROKU_DYNO_METADATA_MESSAGE) && return unless ENV['HEROKU_SLUG_COMMIT']
 
       ENV['HEROKU_SLUG_COMMIT']
     end
@@ -361,11 +397,6 @@ module Raven
       File.directory?("/etc/heroku")
     end
 
-    def heroku_dyno_metadata_message
-      "You are running on Heroku but haven't enabled Dyno Metadata. For Sentry's "\
-      "release detection to work correctly, please run `heroku labs:enable runtime-dyno-metadata`"
-    end
-
     def detect_release_from_capistrano
       revision_file = File.join(project_root, 'REVISION')
       revision_log = File.join(project_root, '..', 'revisions.log')
@@ -381,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}'"
@@ -423,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|
@@ -237,20 +234,6 @@ module Raven
       ].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
-    end
-
     def list_gem_specs
       # Older versions of Rubygems don't support iterating over all specs
       Hash[Gem::Specification.map { |spec| [spec.name, spec.version.to_s] }] if Gem::Specification.respond_to?(:map)

data/lib/raven/instance.rb

@@ -77,8 +77,8 @@ module Raven
     # @example
     #   evt = Raven::Event.new(:message => "An error")
     #   Raven.send_event(evt)
-    def send_event(event)
-      client.send_event(event)
+    def send_event(event, hint = nil)
+      client.send_event(event, hint)
     end
 
     # Capture and process any exceptions from the given block.
@@ -120,10 +120,10 @@ module Raven
             configuration.async.call(evt.to_json_compatible)
           rescue => ex
             logger.error("async event sending failed: #{ex.message}")
-            send_event(evt)
+            send_event(evt, make_hint(obj))
           end
         else
-          send_event(evt)
+          send_event(evt, make_hint(obj))
         end
         Thread.current["sentry_#{object_id}_last_event_id".to_sym] = evt.id
         evt
@@ -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)
@@ -217,5 +225,9 @@ module Raven
         end
       end
     end
+
+    def make_hint(obj)
+      obj.is_a?(String) ? { :exception => nil, :message => obj } : { :exception => obj, :message => nil }
+    end
   end
 end

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/transports/stdout.rb

@@ -0,0 +1,20 @@
+module Raven
+  module Transports
+    class Stdout < Transport
+      attr_accessor :events
+
+      def initialize(*)
+        super
+      end
+
+      def send_event(_auth_header, data, _options = {})
+        unless configuration.sending_allowed?
+          logger.debug("Event not sent: #{configuration.error_messages}")
+        end
+
+        $stdout.puts data
+        $stdout.flush
+      end
+    end
+  end
+end

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.7.4" # rubocop:disable Style/MutableConstant
+  VERSION = "2.12.3" # rubocop:disable Style/MutableConstant
 end

data/sentry-raven.gemspec

@@ -5,14 +5,13 @@ 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.has_rdoc = true
   gem.extra_rdoc_files = ["README.md", "LICENSE"]
   gem.files = `git ls-files | grep -Ev '^(spec|benchmarks|examples)'`.split("\n")
   gem.bindir = "exe"