sentry-raven 2.7.1 → 2.7.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 720bbe2b86e0c01584514a17c2f6299bb1313af1
-  data.tar.gz: 0410c196dffd1e8d0617ff1d01335c120b9dfa3c
+SHA256:
+  metadata.gz: 65c91464c7999bd385921487a02e931b3f178412bd22d43ca614c289c6d72c6d
+  data.tar.gz: 789a54b1f5c20db0246ce310a8c7993a9472b8594a7feae8c18843c56ca6963d
 SHA512:
-  metadata.gz: 81eb505ebd43d3946a29ecd8e73ea67349c64907eee5821e1259e36353b6b204c7a42c7b584a4f2e93b1d45ee4a5fddf43c7c1f8315f5e63ff123caad2f73656
-  data.tar.gz: f81baee39e752d97874a88f6c37457325d0ab3baa9a8d3b54a495842bf08095879940854965023cda72397d85ee00e8839b51c6bd7954a0c8668143df57c0c2f
+  metadata.gz: 6f7b6f3d3cb85364b94892c851c8c9dd0ebe17ea21438f596fafe805125275b6acb3e3bc9ba93850c6a0a2d5b1ce5429db37c29604841b4792cc795be50cc870
+  data.tar.gz: 77e29bf73bb328e51844ffb067730511fd130765c798d5611de1c714681d9fa6a88a552560b097a3cc2074387d2a965c381f6f51125fde81ed8b2e7b3f5900bf

data/.gitignore

@@ -11,3 +11,4 @@ Gemfile.lock
 .ruby-version
 .ruby-gemset
 .idea
+*.rdb

data/.rubocop.yml

@@ -7,23 +7,23 @@ AllCops:
      - 'vendor/**/*'
 
 Metrics/ClassLength:
-  Max: 262
+  Max: 268
   CountComments: false
 
 Metrics/AbcSize:
-  Max: 58
+  Max: 30
 
 Metrics/CyclomaticComplexity:
-  Max: 13
+  Max: 12
 
 Metrics/PerceivedComplexity:
-  Max: 13
+  Max: 11
 
 Metrics/LineLength:
   Max: 155
 
 Metrics/MethodLength:
-  Max: 41
+  Max: 30
 
 Style/SignalException:
   Enabled: false

data/.travis.yml

@@ -4,13 +4,17 @@ sudo: false
 group: beta
 cache: bundler
 
+services:
+  - redis-server
+
 branches:
   only: [master]
 
 rvm:
-  - 2.2.8
-  - 2.3.5
-  - 2.4.2
+  - 2.2.9
+  - 2.3.6
+  - 2.4.3
+  - 2.5.0
 
 env:
   - RAILS_VERSION=4
@@ -24,7 +28,8 @@ addons:
 
 before_install:
   - service haveged start
-  - gem install bundler
+  # Pin bundler version due to https://github.com/rubygems/rubygems/issues/2055
+  - gem install bundler -v 1.16.0
 
 matrix:
   include:
@@ -32,9 +37,9 @@ matrix:
       env: RAILS_VERSION=4
     - rvm: jruby-1.7.27
       env: JRUBY_OPTS="--dev" RAILS_VERSION=4
-    - rvm: jruby-9.1.13.0
+    - rvm: jruby-9.1.15.0
       env: JRUBY_OPTS="--dev -J-Djruby.launch.inproc=true -J-Xmx1024M" RAILS_VERSION=4
-    - rvm: jruby-9.1.13.0
+    - rvm: jruby-9.1.15.0
       env: JRUBY_OPTS="--dev -J-Djruby.launch.inproc=true -J-Xmx1024M" RAILS_VERSION=5
     - rvm: ruby-head
       env: RAILS_VERSION=0

data/Gemfile

@@ -17,9 +17,11 @@ if RUBY_VERSION < '2.0'
   gem "nokogiri", "~> 1.6.8"
   gem "rack", "~> 1.6.8"
   gem "sidekiq", "< 3.2"
+  gem "rack-timeout", "0.3.0"
 else
   gem "rack"
   gem "sidekiq"
+  gem "rack-timeout"
 end
 gem "pry"
 gem "pry-coolline"
@@ -29,5 +31,8 @@ gem "ruby-prof", platform: :mri
 gem "rake"
 gem "rubocop", "~> 0.41.1"
 gem "rspec"
+gem "capybara" # rspec system tests
+gem "puma" # rspec system tests
+
 gem "timecop"
 gem "test-unit", platform: :mri if RUBY_VERSION > '2.2'

data/changelog.md

@@ -1,3 +1,12 @@
+2.7.2
+-----
+
+* BUGFIX: GlobalIDs are now displayed correctly in Sidekiq contexts [@louim, #798]
+* BUGFIX: If git is not installed, fail silently during release detection [@nateberkopec]
+* BUGFIX: We do not support rack-timeout <= 0.2, fix errors when incompat version present [@nateberkopec]
+* BUGFIX: Put cookies in the correct spot of event [@nateberkopec, #812]
+* BUGFIX: Exception context is deep_merged [@janklimo, #782]
+
 2.7.1
 -----
 

data/docs/context.rst

@@ -130,9 +130,9 @@ element of the array) will be used as the ``transaction`` for any events:
 
 .. sourcecode:: ruby
 
-    Raven.context.transactions.push "User Import"
+    Raven.context.transaction.push "User Import"
     # import some users
-    Raven.context.transactions.pop
+    Raven.context.transaction.pop
 
 Transactions may also be overridden/set explicitly during event creation:
 

data/docs/integrations/rails.rst

@@ -3,7 +3,7 @@ Ruby on Rails
 
 In Rails, all uncaught exceptions will be automatically reported.
 
-We support Rails 3 and newer.
+We support Rails 4 and newer.
 
 Installation
 ------------

data/lib/raven/configuration.rb

@@ -130,7 +130,7 @@ module Raven
     # Note that the object passed into the block will be a String (messages) or
     # an exception.
     # e.g. lambda { |exc_or_msg| exc_or_msg.some_attr == false }
-    attr_accessor :should_capture
+    attr_reader :should_capture
 
     # Silences ready message when true.
     attr_accessor :silence_ready
@@ -186,7 +186,7 @@ module Raven
     def initialize
       self.async = false
       self.context_lines = 3
-      self.current_environment = ENV['SENTRY_CURRENT_ENV'] || ENV['RAILS_ENV'] || ENV['RACK_ENV'] || 'default'
+      self.current_environment = current_environment_from_env
       self.encoding = 'gzip'
       self.environments = []
       self.exclude_loggers = []
@@ -196,7 +196,6 @@ module Raven
       self.open_timeout = 1
       self.processors = DEFAULT_PROCESSORS.dup
       self.project_root = detect_project_root
-      self.proxy = nil
       self.rails_activesupport_breadcrumbs = false
       self.rails_report_rescued_exceptions = true
       self.release = detect_release
@@ -206,8 +205,8 @@ module Raven
       self.sanitize_fields_excluded = []
       self.sanitize_http_headers = []
       self.send_modules = true
-      self.server = ENV['SENTRY_DSN'] if ENV['SENTRY_DSN']
-      self.server_name = heroku_dyno_name || resolve_hostname
+      self.server = ENV['SENTRY_DSN']
+      self.server_name = server_name_from_env
       self.should_capture = false
       self.ssl_verification = true
       self.tags = {}
@@ -216,6 +215,7 @@ module Raven
     end
 
     def server=(value)
+      return if value.nil?
       uri = URI.parse(value)
       uri_path = uri.path.split('/')
 
@@ -296,22 +296,6 @@ module Raven
       Backtrace::Line.instance_variable_set(:@in_app_pattern, nil) # blow away cache
     end
 
-    def detect_release
-      detect_release_from_git ||
-        detect_release_from_capistrano ||
-        detect_release_from_heroku
-    rescue => ex
-      logger.error "Error detecting release: #{ex.message}"
-    end
-
-    def detect_project_root
-      if defined? Rails.root # we are in a Rails application
-        Rails.root.to_s
-      else
-        Dir.pwd
-      end
-    end
-
     def exception_class_allowed?(exc)
       if exc.is_a?(Raven::Error)
         # Try to prevent error reporting loops
@@ -327,6 +311,22 @@ module Raven
 
     private
 
+    def detect_project_root
+      if defined? Rails.root # we are in a Rails application
+        Rails.root.to_s
+      else
+        Dir.pwd
+      end
+    end
+
+    def detect_release
+      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 }
     end
@@ -375,7 +375,7 @@ module Raven
     end
 
     def detect_release_from_git
-      `git rev-parse --short HEAD`.strip if File.directory?(".git") rescue nil
+      Raven.sys_command("git rev-parse --short HEAD") if File.directory?(".git")
     end
 
     def capture_in_current_environment?
@@ -402,11 +402,6 @@ module Raven
       false
     end
 
-    def heroku_dyno_name
-      return unless running_on_heroku?
-      ENV['DYNO']
-    end
-
     def sample_allowed?
       return true if sample_rate == 1.0
       if Random::DEFAULT.rand >= sample_rate
@@ -423,5 +418,17 @@ module Raven
       Socket.gethostname ||
         Socket.gethostbyname(hostname).first rescue server_name
     end
+
+    def current_environment_from_env
+      ENV['SENTRY_CURRENT_ENV'] || ENV['RAILS_ENV'] || ENV['RACK_ENV'] || 'default'
+    end
+
+    def server_name_from_env
+      if running_on_heroku?
+        ENV['DYNO']
+      else
+        resolve_hostname
+      end
+    end
   end
 end

data/lib/raven/event.rb

@@ -10,23 +10,24 @@ module Raven
 
     SDK = { "name" => "raven-ruby", "version" => Raven::VERSION }.freeze
 
-    attr_accessor :id, :timestamp, :time_spent, :level, :logger,
-                  :transaction, :server_name, :release, :modules, :extra, :tags,
-                  :context, :configuration, :checksum, :fingerprint, :environment,
-                  :server_os, :runtime, :breadcrumbs, :user, :backtrace, :platform,
-                  :sdk
+    attr_accessor :id, :logger, :transaction, :server_name, :release, :modules,
+                  :extra, :tags, :context, :configuration, :checksum,
+                  :fingerprint, :environment, :server_os, :runtime,
+                  :breadcrumbs, :user, :backtrace, :platform, :sdk
     alias event_id id
 
+    attr_reader :level, :timestamp, :time_spent
+
     def initialize(init = {})
-      self.configuration = Raven.configuration
-      self.breadcrumbs   = Raven.breadcrumbs
-      self.context       = Raven.context
+      # Set some simple default values
       self.id            = SecureRandom.uuid.delete("-")
       self.timestamp     = Time.now.utc
       self.level         = :error
       self.logger        = :ruby
       self.platform      = :ruby
       self.sdk           = SDK
+
+      # Set some attributes with empty hashes to allow merging
       @interfaces        = {}
       self.user          = {} # TODO: contexts
       self.extra         = {} # TODO: contexts
@@ -34,27 +35,14 @@ module Raven
       self.runtime       = {} # TODO: contexts
       self.tags          = {} # TODO: contexts
 
-      yield self if block_given?
+      copy_initial_state
 
+      # Allow attributes to be set on the event at initialization
+      yield self if block_given?
       init.each_pair { |key, val| public_send("#{key}=", val) }
 
-      self.transaction ||= context.transaction.last
-      self.server_name ||= configuration.server_name
-      self.release     ||= configuration.release
-      self.modules       = list_gem_specs if configuration.send_modules
-      self.environment ||= configuration.current_environment
-
-      if !self[:http] && context.rack_env
-        interface :http do |int|
-          int.from_rack(context.rack_env)
-        end
-
-        context.user[:ip_address] = calculate_real_ip_from_rack
-      end
-
-      self.user = context.user.merge(user) # TODO: contexts
-      self.extra = context.extra.merge(extra) # TODO: contexts
-      self.tags = configuration.tags.merge(context.tags).merge(tags) # TODO: contexts
+      set_core_attributes_from_configuration
+      set_core_attributes_from_context
     end
 
     def self.from_exception(exc, options = {}, &block)
@@ -199,6 +187,38 @@ module Raven
 
     private
 
+    def copy_initial_state
+      self.configuration = Raven.configuration
+      self.breadcrumbs   = Raven.breadcrumbs
+      self.context       = Raven.context
+    end
+
+    def set_core_attributes_from_configuration
+      self.server_name ||= configuration.server_name
+      self.release     ||= configuration.release
+      self.modules       = list_gem_specs if configuration.send_modules
+      self.environment ||= configuration.current_environment
+    end
+
+    def set_core_attributes_from_context
+      self.transaction ||= context.transaction.last
+
+      # If this is a Rack event, merge Rack context
+      add_rack_context if !self[:http] && context.rack_env
+
+      # Merge contexts
+      self.user = context.user.merge(user) # TODO: contexts
+      self.extra = context.extra.merge(extra) # TODO: contexts
+      self.tags = configuration.tags.merge(context.tags).merge!(tags) # TODO: contexts
+    end
+
+    def add_rack_context
+      interface :http do |int|
+        int.from_rack(context.rack_env)
+      end
+      context.user[:ip_address] = calculate_real_ip_from_rack
+    end
+
     # When behind a proxy (or if the user is using a proxy), we can't use
     # REMOTE_ADDR to determine the Event IP, and must use other headers instead.
     def calculate_real_ip_from_rack

data/lib/raven/instance.rb

@@ -158,7 +158,7 @@ module Raven
     #   end
     def annotate_exception(exc, options = {})
       notes = (exc.instance_variable_defined?(:@__raven_context) && exc.instance_variable_get(:@__raven_context)) || {}
-      notes.merge!(options)
+      Raven::Utils::DeepMergeHash.deep_merge!(notes, options)
       exc.instance_variable_set(:@__raven_context, notes)
       exc
     end

data/lib/raven/integrations/rack-timeout.rb

@@ -7,9 +7,13 @@ require "rack/timeout/base" unless defined?(Rack::Timeout)
 # that will distinguish exceptions in the way you desire.
 module RackTimeoutExtensions
   def raven_context
-    { :fingerprint => ["{{ default }}", env["REQUEST_URI"]] }
+    # Only rack-timeout 0.3.0+ provides the request environment, but we can't
+    # gate this based on a gem version constant because rack-timeout does
+    # not provide one.
+    { :fingerprint => ["{{ default }}", env["REQUEST_URI"]] } if defined?(env)
   end
 end
 
-Rack::Timeout::Error.include RackTimeoutExtensions
-Rack::Timeout::RequestTimeoutException.include RackTimeoutExtensions
+# Include is private in Ruby 1.9
+Rack::Timeout::Error.__send__(:include, RackTimeoutExtensions)
+Rack::Timeout::RequestTimeoutException.__send__(:include, RackTimeoutExtensions)

data/lib/raven/integrations/rack.rb

@@ -74,9 +74,10 @@ module Raven
       self.method = req.request_method
       self.query_string = req.query_string
       self.data = read_data_from(req)
+      self.cookies = req.cookies
 
       self.headers = format_headers_for_sentry(env_hash)
-      self.env = format_env_for_sentry(env_hash)
+      self.env     = format_env_for_sentry(env_hash)
     end
 
     private
@@ -108,6 +109,7 @@ module Raven
           # if the request has legitimately sent a Version header themselves.
           # See: https://github.com/rack/rack/blob/028438f/lib/rack/handler/cgi.rb#L29
           next if key == 'HTTP_VERSION' && value == env_hash['SERVER_PROTOCOL']
+          next if key == 'HTTP_COOKIE' # Cookies don't go here, they go somewhere else
 
           next unless key.start_with?('HTTP_') || %w(CONTENT_TYPE CONTENT_LENGTH).include?(key)
           # Rack stores headers as HTTP_WHAT_EVER, we need What-Ever

data/lib/raven/integrations/sidekiq.rb

@@ -14,6 +14,7 @@ module Raven
 
   class SidekiqErrorHandler
     ACTIVEJOB_RESERVED_PREFIX = "_aj_".freeze
+    HAS_GLOBALID = const_defined?('GlobalID')
 
     def call(ex, context)
       context = filter_context(context)
@@ -42,7 +43,7 @@ module Raven
       when Hash
         Hash[context.map { |key, value| filter_context_hash(key, value) }]
       else
-        context
+        format_globalid(context)
       end
     end
 
@@ -65,6 +66,14 @@ module Raven
         "Sidekiq"
       end
     end
+
+    def format_globalid(context)
+      if HAS_GLOBALID && context.is_a?(GlobalID)
+        context.to_s
+      else
+        context
+      end
+    end
   end
 end
 

data/lib/raven/transports/http.rb

@@ -39,26 +39,27 @@ module Raven
       def set_conn
         configuration.logger.debug "Raven HTTP Transport connecting to #{configuration.server}"
 
-        ssl_configuration = configuration.ssl || {}
-        ssl_configuration[:verify] = configuration.ssl_verification
-        ssl_configuration[:ca_file] = configuration.ssl_ca_file
-
-        conn = Faraday.new(
-          :url => configuration[:server],
-          :ssl => ssl_configuration
-        ) do |builder|
+        Faraday.new(configuration.server, :ssl => ssl_configuration) do |builder|
           configuration.faraday_builder.call(builder) if configuration.faraday_builder
           builder.response :raise_error
+          builder.options.merge! faraday_opts
+          builder.headers[:user_agent] = "sentry-ruby/#{Raven::VERSION}"
           builder.adapter(*adapter)
         end
+      end
 
-        conn.headers[:user_agent] = "sentry-ruby/#{Raven::VERSION}"
-
-        conn.options[:proxy] = configuration.proxy if configuration.proxy
-        conn.options[:timeout] = configuration.timeout if configuration.timeout
-        conn.options[:open_timeout] = configuration.open_timeout if configuration.open_timeout
+      # TODO: deprecate and replace where possible w/Faraday Builder
+      def faraday_opts
+        [:proxy, :timeout, :open_timeout].each_with_object({}) do |opt, memo|
+          memo[opt] = configuration.public_send(opt) if configuration.public_send(opt)
+        end
+      end
 
-        conn
+      def ssl_configuration
+        (configuration.ssl || {}).merge(
+          :verify => configuration.ssl_verification,
+          :ca_file => configuration.ssl_ca_file
+        )
       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.1" # rubocop:disable Style/MutableConstant
+  VERSION = "2.7.2" # rubocop:disable Style/MutableConstant
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sentry-raven
 version: !ruby/object:Gem::Version
-  version: 2.7.1
+  version: 2.7.2
 platform: ruby
 authors:
 - Sentry Team
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-10-11 00:00:00.000000000 Z
+date: 2018-02-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -136,7 +136,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.7.3
 signing_key: 
 specification_version: 4
 summary: A gem that provides a client interface for the Sentry error logger