sentry-raven 2.1.3 → 3.1.2

data/lib/raven/processor/utf8conversion.rb

@@ -1,28 +1,53 @@
 module Raven
   class Processor::UTF8Conversion < Processor
+    # Slightly misnamed - actually just removes any bytes with invalid encoding
+    # Previously, our JSON backend required UTF-8. Since we now use the built-in
+    # JSON, we can use any encoding, but it must be valid anyway so we can do
+    # things like call #match and #slice on strings
+    REPLACE = "".freeze
+
     def process(value)
-      if value.is_a? Array
-        value.map { |v| process v }
-      elsif value.is_a? Hash
-        value.merge(value) { |_, v| process v }
-      elsif value.is_a?(Exception) && !value.message.valid_encoding?
-        clean_exc = value.class.new(clean_invalid_utf8_bytes(value.message))
+      case value
+      when Hash
+        !value.frozen? ? value.merge!(value) { |_, v| process v } : value.merge(value) { |_, v| process v }
+      when Array
+        !value.frozen? ? value.map! { |v| process v } : value.map { |v| process v }
+      when Exception
+        return value if value.message.valid_encoding?
+
+        clean_exc = value.class.new(remove_invalid_bytes(value.message))
         clean_exc.set_backtrace(value.backtrace)
         clean_exc
+      when String
+        # Encoding::BINARY / Encoding::ASCII_8BIT is a special binary encoding.
+        # valid_encoding? will always return true because it contains all codepoints,
+        # so instead we check if it only contains actual ASCII codepoints, and if
+        # not we assume it's actually just UTF8 and scrub accordingly.
+        if value.encoding == Encoding::BINARY && !value.ascii_only?
+          value = value.dup
+          value.force_encoding(Encoding::UTF_8)
+        end
+        return value if value.valid_encoding?
+
+        remove_invalid_bytes(value)
       else
-        clean_invalid_utf8_bytes(value)
+        value
       end
     end
 
     private
 
-    def clean_invalid_utf8_bytes(obj)
-      if obj.respond_to?(:to_utf8)
-        obj.to_utf8
-      elsif obj.respond_to?(:encoding) && obj.is_a?(String)
-        obj.encode('UTF-16', :invalid => :replace, :undef => :replace, :replace => '').encode('UTF-8')
-      else
-        obj
+    # Stolen from RSpec
+    # 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)
+      end
+    else
+      def remove_invalid_bytes(string)
+        string.chars.map do |char|
+          char.valid_encoding? ? char : REPLACE
+        end.join
       end
     end
   end

data/lib/raven/processor.rb

@@ -4,7 +4,7 @@ module Raven
     INT_MASK = 0
     REGEX_SPECIAL_CHARACTERS = %w(. $ ^ { [ ( | ) * + ?).freeze
 
-    def initialize(client)
+    def initialize(client = nil)
       @client = client
     end
 

data/lib/raven/transports/http.rb

@@ -1,8 +1,5 @@
 require 'faraday'
 
-require 'raven/transports'
-require 'raven/error'
-
 module Raven
   module Transports
     class HTTP < Transport
@@ -15,6 +12,11 @@ module Raven
       end
 
       def send_event(auth_header, data, options = {})
+        unless configuration.sending_allowed?
+          configuration.logger.debug("Event not sent: #{configuration.error_messages}")
+          return
+        end
+
         project_id = configuration[:project_id]
         path = configuration[:path] + "/"
 
@@ -23,36 +25,42 @@ module Raven
           req.headers['X-Sentry-Auth'] = auth_header
           req.body = data
         end
-      rescue Faraday::ClientError => ex
-        raise Raven::Error, ex.message
+      rescue Faraday::Error => e
+        error_info = e.message
+        if e.response && e.response[:headers]['x-sentry-error']
+          error_info += " Error in headers is: #{e.response[:headers]['x-sentry-error']}"
+        end
+        raise Raven::Error, error_info
       end
 
       private
 
       def set_conn
-        verify_configuration
-
-        Raven.logger.debug "Raven HTTP Transport connecting to #{configuration.server}"
+        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
+        proxy = configuration.public_send(:proxy)
 
-        conn = Faraday.new(
-          :url => configuration[:server],
-          :ssl => ssl_configuration
-        ) do |builder|
+        Faraday.new(configuration.server, :ssl => ssl_configuration, :proxy => proxy) do |builder|
+          configuration.faraday_builder&.call(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
+        [: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/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/transports.rb

@@ -1,5 +1,3 @@
-require 'raven/error'
-
 module Raven
   module Transports
     class Transport
@@ -12,12 +10,10 @@ module Raven
       def send_event # (auth_header, data, options = {})
         raise NotImplementedError, 'Abstract method not implemented'
       end
-
-      protected
-
-      def verify_configuration
-        configuration.verify!
-      end
     end
   end
 end
+
+require "raven/transports/dummy"
+require "raven/transports/http"
+require "raven/transports/stdout"

data/lib/raven/utils/context_filter.rb

@@ -0,0 +1,42 @@
+module Raven
+  module Utils
+    module ContextFilter
+      class << self
+        ACTIVEJOB_RESERVED_PREFIX_REGEX = /^_aj_/.freeze
+        HAS_GLOBALID = const_defined?('GlobalID')
+
+        # Once an ActiveJob is queued, ActiveRecord references get serialized into
+        # some internal reserved keys, such as _aj_globalid.
+        #
+        # The problem is, if this job in turn gets queued back into ActiveJob with
+        # these magic reserved keys, ActiveJob will throw up and error. We want to
+        # capture these and mutate the keys so we can sanely report it.
+        def filter_context(context)
+          case context
+          when Array
+            context.map { |arg| filter_context(arg) }
+          when Hash
+            Hash[context.map { |key, value| filter_context_hash(key, value) }]
+          else
+            format_globalid(context)
+          end
+        end
+
+        private
+
+        def filter_context_hash(key, value)
+          key = key.to_s.sub(ACTIVEJOB_RESERVED_PREFIX_REGEX, "") if key.match(ACTIVEJOB_RESERVED_PREFIX_REGEX)
+          [key, filter_context(value)]
+        end
+
+        def format_globalid(context)
+          if HAS_GLOBALID && context.is_a?(GlobalID)
+            context.to_s
+          else
+            context
+          end
+        end
+      end
+    end
+  end
+end

data/lib/raven/utils/deep_merge.rb

@@ -7,21 +7,15 @@ module Raven
       end
 
       def self.deep_merge!(hash, other_hash, &block)
-        other_hash.each_pair do |current_key, other_value|
-          this_value = hash[current_key]
-
-          hash[current_key] = if this_value.is_a?(Hash) && other_value.is_a?(Hash)
-            this_value.deep_merge(other_value, &block)
+        hash.merge!(other_hash) do |key, this_val, other_val|
+          if this_val.is_a?(Hash) && other_val.is_a?(Hash)
+            deep_merge(this_val, other_val, &block)
+          elsif block_given?
+            block.call(key, this_val, other_val)
           else
-            if block_given? && key?(current_key)
-              block.call(current_key, this_value, other_value)
-            else
-              other_value
-            end
+            other_val
           end
         end
-
-        hash
       end
     end
   end

data/lib/raven/utils/exception_cause_chain.rb

@@ -0,0 +1,20 @@
+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/utils/real_ip.rb

@@ -13,7 +13,7 @@ module Raven
         "fc00::/7",       # private IPv6 range fc00::/7
         "10.0.0.0/8",     # private IPv4 range 10.x.x.x
         "172.16.0.0/12",  # private IPv4 range 172.16.0.0 .. 172.31.255.255
-        "192.168.0.0/16", # private IPv4 range 192.168.x.x
+        "192.168.0.0/16" # private IPv4 range 192.168.x.x
       ].map { |proxy| IPAddr.new(proxy) }
 
       attr_accessor :ip, :ip_addresses

data/lib/raven/utils/request_id.rb

@@ -0,0 +1,16 @@
+module Raven
+  module Utils
+    module RequestId
+      REQUEST_ID_HEADERS = %w(action_dispatch.request_id HTTP_X_REQUEST_ID).freeze
+
+      # Request ID based on ActionDispatch::RequestId
+      def self.read_from(env_hash)
+        REQUEST_ID_HEADERS.each do |key|
+          request_id = env_hash[key]
+          return request_id if request_id
+        end
+        nil
+      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.1.3" # rubocop:disable Style/MutableConstant
+  VERSION = "3.1.2"
 end

data/lib/sentry-raven-without-integrations.rb

@@ -1 +1,6 @@
-require 'raven/base'
+require "raven/helpers/deprecation_helper"
+
+filename = "sentry_raven_without_integrations"
+DeprecationHelper.deprecate_dasherized_filename(filename)
+
+require filename

data/lib/sentry_raven_without_integrations.rb

@@ -0,0 +1 @@
+require 'raven/base'

data/sentry-raven.gemspec

@@ -0,0 +1,28 @@
+$LOAD_PATH.unshift File.expand_path('../lib', __FILE__)
+require 'raven/version'
+
+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 = "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 = '>= 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", ">= 1.0"
+
+  gem.post_install_message = <<~EOS
+    `sentry-raven` is deprecated! Please migrate to `sentry-ruby`
+
+    See https://docs.sentry.io/platforms/ruby/migration for the migration guide.
+
+  EOS
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sentry-raven
 version: !ruby/object:Gem::Version
-  version: 2.1.3
+  version: 3.1.2
 platform: ruby
 authors:
 - Sentry Team
 autorequire: 
-bindir: bin
+bindir: exe
 cert_chain: []
-date: 2016-11-16 00:00:00.000000000 Z
+date: 2021-03-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -16,138 +16,63 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.7.6
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: 0.10.x
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.7.6
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: 0.10.x
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.41.1
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.41.1
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rspec-rails
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: timecop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: test-unit
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
 description: A gem that provides a client interface for the Sentry error logger
-email: getsentry@googlegroups.com
-executables: []
+email: accounts@sentry.io
+executables:
+- raven
 extensions: []
 extra_rdoc_files:
 - README.md
 - LICENSE
 files:
+- ".craft.yml"
+- ".scripts/bump-version.rb"
+- CHANGELOG.md
+- Gemfile
 - LICENSE
+- Makefile
 - README.md
+- Rakefile
+- exe/raven
 - lib/raven.rb
 - lib/raven/backtrace.rb
 - lib/raven/base.rb
 - lib/raven/breadcrumbs.rb
-- lib/raven/breadcrumbs/activesupport.rb
+- lib/raven/breadcrumbs/active_support_logger.rb
 - lib/raven/breadcrumbs/logger.rb
+- lib/raven/breadcrumbs/sentry_logger.rb
 - lib/raven/cli.rb
 - lib/raven/client.rb
 - lib/raven/configuration.rb
 - lib/raven/context.rb
-- lib/raven/error.rb
+- lib/raven/core_ext/object/deep_dup.rb
+- lib/raven/core_ext/object/duplicable.rb
 - lib/raven/event.rb
+- lib/raven/helpers/deprecation_helper.rb
 - lib/raven/instance.rb
 - lib/raven/integrations/delayed_job.rb
 - lib/raven/integrations/rack-timeout.rb
 - lib/raven/integrations/rack.rb
 - lib/raven/integrations/rails.rb
 - lib/raven/integrations/rails/active_job.rb
+- lib/raven/integrations/rails/backtrace_cleaner.rb
 - lib/raven/integrations/rails/controller_methods.rb
+- lib/raven/integrations/rails/controller_transaction.rb
 - lib/raven/integrations/rails/overrides/debug_exceptions_catcher.rb
 - lib/raven/integrations/rails/overrides/streaming_reporter.rb
 - lib/raven/integrations/railties.rb
 - lib/raven/integrations/rake.rb
 - lib/raven/integrations/sidekiq.rb
+- lib/raven/integrations/sidekiq/cleanup_middleware.rb
+- lib/raven/integrations/sidekiq/error_handler.rb
 - lib/raven/integrations/tasks.rb
 - lib/raven/interface.rb
 - lib/raven/interfaces/exception.rb
@@ -168,16 +93,26 @@ files:
 - lib/raven/transports.rb
 - lib/raven/transports/dummy.rb
 - lib/raven/transports/http.rb
+- lib/raven/transports/stdout.rb
+- lib/raven/utils/context_filter.rb
 - lib/raven/utils/deep_merge.rb
+- lib/raven/utils/exception_cause_chain.rb
 - lib/raven/utils/real_ip.rb
+- lib/raven/utils/request_id.rb
 - lib/raven/version.rb
 - lib/sentry-raven-without-integrations.rb
 - lib/sentry-raven.rb
+- lib/sentry_raven_without_integrations.rb
+- sentry-raven.gemspec
 homepage: https://github.com/getsentry/raven-ruby
 licenses:
 - Apache-2.0
 metadata: {}
-post_install_message: 
+post_install_message: |+
+  `sentry-raven` is deprecated! Please migrate to `sentry-ruby`
+
+  See https://docs.sentry.io/platforms/ruby/migration for the migration guide.
+
 rdoc_options: []
 require_paths:
 - lib
@@ -185,15 +120,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.6.8
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: A gem that provides a client interface for the Sentry error logger

data/lib/raven/error.rb

@@ -1,4 +0,0 @@
-module Raven
-  class Error < StandardError
-  end
-end