sentry-raven 3.0.4 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e0e19bd3b705bd0a2c680d367ea7420941d5df1c5b245317170b9c31fd177006
-  data.tar.gz: f826cbfb501dfd844ff1096b8561ffc8a2e4f589d51d186ce063e4cfcabc65aa
+  metadata.gz: 41350227e78833d91c3cbff3192b09d7bf3cec1b8560aeabf815ec5f6fcac156
+  data.tar.gz: a40cf7486907f4069c719584c63dcf36a34587702bcfee8a25e0ab5816cdf72f
 SHA512:
-  metadata.gz: 8f47ca78fad6ebc47e9a76efd32e8009e6b8196256b06edef38dc1081a4eafb57f0f880e69d3e423ef5dffe6f66f2651c6c1fa2ca4002ad1c5be352b541bdfb3
-  data.tar.gz: f6e95e7a313ece5ebfb1af584d2cd11648575a6121a0ff0b807180e396bfb8102b1bc0cc1914d96e26058273193dbf6014c0acd6ded8dbef284cac6d0279ab79
+  metadata.gz: 7d0c868e31eb523845681398cb7579022dc6635bf3cc2982ae55cd83f5b0eaf414988b9a7ba6f728d96c43518fd27895fd98a3e0960577c1f06e4bb333be3339
+  data.tar.gz: a9d232ad2858a142d01d52eaa854ca1daa9c7844353487ac2be6c97b9715e41c3c807d93fdd5662e44e5bf0443dffbeb67e0d1ad39d3563e4cf088e433b7be6c

data/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,32 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: bug
+assignees: st0012
+
+---
+
+**Describe the bug**
+
+**To Reproduce**
+
+**Expected behavior**
+
+**Actual behavior**
+
+**Environment**
+ - Ruby Version: 
+ - SDK Version:
+ - Integration Versions (if any):
+  - e.g. Rails 6.0, Sidekiq 6.1.2
+
+**Raven Config**
+
+This is not necessary but could be helpful.
+
+```ruby
+Raven.configure do |config|
+  # the config you're using, without DSN and other sensitive data
+end
+```

data/.github/pull_request_template.md

@@ -0,0 +1,16 @@
+Thanks for your Pull Request 🎉 
+
+**Please keep these instructions in mind so we can review it more efficiently:**
+
+- Add the references of all the related issues/PRs in the description
+- Whether it's a new feature or a bug fix, make sure they're covered by new test cases
+- If this PR contains any refactoring work, please give it its own commit(s)
+
+
+**Other Notes**
+- We squash all commits before merging
+- We generally review new PRs within a week
+- If you have any question, you can ask for feedback in our [discord community](https://discord.gg/Ww9hbqr) first
+
+## Description
+Describe your changes:

data/.github/workflows/test.yml

@@ -43,6 +43,11 @@ jobs:
         bundler: 1
         ruby-version: ${{ matrix.ruby_version }}
 
+    - name: Start Redis
+      uses: supercharge/redis-github-action@1.1.0
+      with:
+        redis-version: 5
+
     - name: Build with Rails ${{ matrix.rails_version }}
       env:
         RAILS_VERSION: ${{ matrix.rails_version }}

data/.gitignore

@@ -1,5 +1,6 @@
 coverage
 pkg
+tmp
 ruby/
 log/
 .bundle

data/.rubocop.yml

@@ -7,7 +7,7 @@ AllCops:
      - 'vendor/**/*'
 
 Metrics/ClassLength:
-  Max: 300
+  Max: 350
   CountComments: false
 
 Metrics/AbcSize:
@@ -23,7 +23,7 @@ Metrics/PerceivedComplexity:
   Max: 11
 
 Metrics/MethodLength:
-  Max: 30
+  Max: 40
 
 Style/SymbolArray:
   Enabled: false
@@ -55,6 +55,9 @@ Style/CommentedKeyword:
 Style/RescueModifier:
   Enabled: false
 
+Style/RegexpLiteral:
+  Enabled: false
+
 Style/StringLiterals:
   Enabled: false
 
@@ -75,7 +78,7 @@ Style/NumericLiterals:
     - 'spec/raven/processors/sanitizedata_processor_spec.rb'
 
 Style/HashSyntax:
-  EnforcedStyle: hash_rockets
+  Enabled: false
 
 Style/IfUnlessModifier:
   Enabled: false

data/CHANGELOG.md

@@ -1,6 +1,123 @@
 # Changelog
 
-## Unreleased
+## 3.1.0
+
+**Feature**
+
+- Exclude all 4xx Rails errors ([#1004](https://github.com/getsentry/raven-ruby/pull/1004))
+
+    See the full list [here](https://github.com/getsentry/raven-ruby/blob/master/lib/raven/configuration.rb#L198-L219)
+
+- Add some error context in `transport_failure_callback` ([#1003](https://github.com/getsentry/raven-ruby/pull/1003))
+
+    Before:
+
+    ```ruby
+    config.transport_failure_callback = lambda { |event|
+      AdminMailer.email_admins("Oh god, it's on fire!", event).deliver_later
+    }
+    ```
+
+    After:
+
+    ```ruby
+    config.transport_failure_callback = lambda { |event, error|
+      AdminMailer.email_admins("Oh god, it's on fire because #{error.message}!", event).deliver_later
+    }
+    ```
+
+- Support cleaning up exception backtrace with customized backtrace_cleaner ([#1011](https://github.com/getsentry/raven-ruby/pull/1011))
+
+    The new config `backtrace_cleanup_callback` takes a lambda/proc object (default is `nil`) and will be called with exception's backtrace
+
+    ```ruby
+    Raven.configure do |config|
+      config.backtrace_cleanup_callback = lambda do |backtrace|
+        Rails.backtrace_cleaner.clean(backtrace)
+      end
+    end
+    ```
+
+    And with the Rails integration, it'll automatically use a customized `Raven::Rails::BacktraceCleaner` to clean up exception's backtrace. It's basically Rails 6's [backtrace cleaner](https://github.com/rails/rails/blob/master/railties/lib/rails/backtrace_cleaner.rb) but without silencers. 
+    
+    The main reason to add this cleaner is to remove template methods from the trace, e.g.
+
+    ```
+    app/views/welcome/view_error.html.erb in _app_views_welcome_view_error_html_erb__2807287320172182514_65600 at line 1
+    ```
+
+    will become
+
+    ```
+    app/views/welcome/view_error.html.erb at line 1
+    ```
+
+    This can help Sentry group issues more accurately. See [#957](https://github.com/getsentry/raven-ruby/issues/957) for more information about this.
+    
+    If you don't want this change, you can disable it with:
+
+    ```ruby
+    Raven.configure do |config|
+      config.backtrace_cleanup_callback = nil
+    end
+    ```
+
+
+- Make dsn value accessable from config ([#1012](https://github.com/getsentry/raven-ruby/pull/1012))
+
+    You can now access the dsn value via `Raven.configuration.dsn`
+    
+**Deprecation**
+
+- Deprecate dasherized filenames ([#1006](https://github.com/getsentry/raven-ruby/pull/1006))
+
+    If you're using 
+    
+    ```ruby
+    gem 'sentry-raven', require: 'sentry-raven-without-integrations'
+    # or 
+    require "sentry-raven-without-integrations"
+    ```
+    
+    you will start seeing deprecation warnings. Please change them into
+    
+    ```ruby
+    gem 'sentry-raven', require: 'sentry_raven_without_integrations'
+    # or 
+    require "sentry_raven_without_integrations"
+    ```
+    
+- Unify breadcrumb loggers activation ([#1016](https://github.com/getsentry/raven-ruby/pull/1016))
+
+    Currently, we activate our breadcrumb loggers differently:
+
+    ```ruby
+    require "raven/breadcrumbs/sentry_logger"
+    Raven.configuration.rails_activesupport_breadcrumbs = true
+    ```
+
+    It's not a nice user interface, so this PR adds a new configuration
+    option `breadcrumbs_logger` to improve this:
+
+    ```ruby
+    Raven.configuration.breadcrumbs_logger = :sentry_logger
+    Raven.configuration.breadcrumbs_logger = :active_support_logger
+    Raven.configuration.breadcrumbs_logger = [:sentry_logger, :active_support_logger]
+    ```
+
+    Please migrate to the new activation apporach, otherwise you'll see depraction warnings. And old ones will be dropped in version 4.0.
+    
+**Refactor**
+
+- Accept non-string message in Event.from_exception ([#1005](https://github.com/getsentry/raven-ruby/pull/1005))
+- Refactor event initialization ([#1010](https://github.com/getsentry/raven-ruby/pull/1010))
+- Refactor sidekiq integration ([#1019](https://github.com/getsentry/raven-ruby/pull/1019))
+
+**Fix**
+
+- Replace sys_command usages in context.rb ([#1017](https://github.com/getsentry/raven-ruby/pull/1017))
+- Fix merge error from rack-timeout raven_context on old releases ([#1007](https://github.com/getsentry/raven-ruby/pull/1007))
+- Return value of `rescue_with_handler` when intercepting ActiveJob exceptions ([#1027](https://github.com/getsentry/raven-ruby/pull/1027))
 
 ## 3.0.4
 

data/CONTRIBUTING.md

@@ -0,0 +1,71 @@
+<p align="center">
+  <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>
+
+# Contributing
+
+You can contribute this project in the following ways:
+
+- File a [bug report] or propose a feature
+- Open a PR for bug fixes or implementing requested features
+- Give feedback to opened issues/pull requests
+- Test the latest version - `gem 'sentry-raven', github: 'getsentry/raven-ruby'`
+- Contribute documentation in the [document repo]
+
+
+And if you have any questions, please feel free to reach out on [Discord].
+
+
+[bug report]: https://github.com/getsentry/raven-ruby/issues/new?template=bug_report.md
+[document repo]: https://github.com/getsentry/sentry-docs
+[Discord]: https://discord.gg/Ww9hbqr
+
+## How To Contribute
+
+### Running Tests
+
+#### RAILS_VERSION
+
+Because this SDK supports multiple versions of Rails, or even without Rails, you might want to run your test against different versions of Rails.
+
+You can do this by changing the `RAILS_VERSION` environment variable:
+
+
+```
+$ echo RAILS_VERSION=6.0
+$ bundle update # this is necessary if you're switching between Rails versions
+$ bundle exec rake
+```
+
+If not specified, it runs tests against `Rails 5.2`. 
+
+And if you don't want to run the Rails related test cases, you can use `RAILS_VERSION=0`
+
+```
+$ RAILS_VERSION=0 bundle exec rake # runs without Rails related test cases
+```
+
+### Testing Your Change Against Example Rails Apps
+
+We have a few example apps for different Rails versions under the `/examples` folder. You can use them to perform an end-to-end testing on your changes (just remember to change the DSN to your project's).
+
+At this moment, we recommend testing against the [Rails 6 example](https://github.com/getsentry/raven-ruby/tree/master/examples/rails-6.0) first. Please read its readme to see what kind of testing you can perform with it.
+
+
+## Making a release
+
+Install and use `craft`: https://github.com/getsentry/craft
+
+Make sure the `CHANGELOG.md` is update and latest `master` contains all changes.
+
+Run:
+
+```bash
+craft prepare x.x.x
+```
+
+Where `x.x.x` stands for the version you want to release.
+Afterwards reach out to an employee of Sentry, they will cut a release by running the `publish` process of `craft`.

data/README.md

@@ -105,8 +105,8 @@ end
 If Raven fails to send an event to Sentry for any reason (either the Sentry server has returned a 4XX or 5XX response), this Proc or lambda will be called.
 
 ```ruby
-config.transport_failure_callback = lambda { |event|
-  AdminMailer.email_admins("Oh god, it's on fire!", event).deliver_later
+config.transport_failure_callback = lambda { |event, error|
+  AdminMailer.email_admins("Oh god, it's on fire because #{error.message}!", event).deliver_later
 }
 ```
 

data/lib/raven/backtrace.rb

@@ -94,6 +94,8 @@ module Raven
     def self.parse(backtrace, opts = {})
       ruby_lines = backtrace.is_a?(Array) ? backtrace : backtrace.split(/\n\s*/)
 
+      ruby_lines = opts[:configuration].backtrace_cleanup_callback.call(ruby_lines) if opts[:configuration]&.backtrace_cleanup_callback
+
       filters = opts[:filters] || []
       filtered_lines = ruby_lines.to_a.map do |line|
         filters.reduce(line) do |nested_line, proc|

data/lib/raven/base.rb

@@ -1,4 +1,5 @@
 require 'raven/version'
+require "raven/helpers/deprecation_helper"
 require 'raven/core_ext/object/deep_dup'
 require 'raven/backtrace'
 require 'raven/breadcrumbs'

data/lib/raven/breadcrumbs/active_support_logger.rb

@@ -0,0 +1,25 @@
+module Raven
+  module Breadcrumbs
+    module ActiveSupportLogger
+      class << self
+        def add(name, started, _finished, _unique_id, data)
+          Raven.breadcrumbs.record do |crumb|
+            crumb.data = data
+            crumb.category = name
+            crumb.timestamp = started.to_i
+          end
+        end
+
+        def inject
+          @subscriber = ::ActiveSupport::Notifications.subscribe(/.*/) do |name, started, finished, unique_id, data|
+            add(name, started, finished, unique_id, data)
+          end
+        end
+
+        def detach
+          ::ActiveSupport::Notifications.unsubscribe(@subscriber)
+        end
+      end
+    end
+  end
+end

data/lib/raven/breadcrumbs/logger.rb

@@ -1,93 +1,3 @@
-require 'logger'
+DeprecationHelper.deprecate_old_breadcrumbs_configuration(:sentry_logger)
 
-module Raven
-  module BreadcrumbLogger
-    LEVELS = {
-      ::Logger::DEBUG => 'debug',
-      ::Logger::INFO => 'info',
-      ::Logger::WARN => 'warn',
-      ::Logger::ERROR => 'error',
-      ::Logger::FATAL => 'fatal'
-    }.freeze
-
-    EXC_FORMAT = /^([a-zA-Z0-9]+)\:\s(.*)$/.freeze
-
-    def self.parse_exception(message)
-      lines = message.split(/\n\s*/)
-      # TODO: wat
-      return nil unless lines.length > 2
-
-      match = lines[0].match(EXC_FORMAT)
-      return nil unless match
-
-      _, type, value = match.to_a
-      [type, value]
-    end
-
-    def add(*args)
-      add_breadcrumb(*args)
-      super
-    end
-
-    def add_breadcrumb(severity, message = nil, progname = nil)
-      message = progname if message.nil? # see Ruby's Logger docs for why
-      return if ignored_logger?(progname)
-      return if message.nil? || message == ""
-
-      # some loggers will add leading/trailing space as they (incorrectly, mind you)
-      # think of logging as a shortcut to std{out,err}
-      message = message.to_s.strip
-
-      last_crumb = Raven.breadcrumbs.peek
-      # try to avoid dupes from logger broadcasts
-      if last_crumb.nil? || last_crumb.message != message
-        error = Raven::BreadcrumbLogger.parse_exception(message)
-        # TODO(dcramer): we need to filter out the "currently captured error"
-        if error
-          Raven.breadcrumbs.record do |crumb|
-            crumb.level = Raven::BreadcrumbLogger::LEVELS.fetch(severity, nil)
-            crumb.category = progname || 'error'
-            crumb.type = 'error'
-            crumb.data = {
-              :type => error[0],
-              :value => error[1]
-            }
-          end
-        else
-          Raven.breadcrumbs.record do |crumb|
-            crumb.level = Raven::BreadcrumbLogger::LEVELS.fetch(severity, nil)
-            crumb.category = progname || 'logger'
-            crumb.message = message
-          end
-        end
-      end
-    end
-
-    private
-
-    def ignored_logger?(progname)
-      progname == "sentry" ||
-        Raven.configuration.exclude_loggers.include?(progname)
-    end
-  end
-  module OldBreadcrumbLogger
-    def self.included(base)
-      base.class_eval do
-        include Raven::BreadcrumbLogger
-        alias_method :add_without_raven, :add
-        alias_method :add, :add_with_raven
-      end
-    end
-
-    def add_with_raven(*args)
-      add_breadcrumb(*args)
-      add_without_raven(*args)
-    end
-  end
-end
-
-Raven.safely_prepend(
-  "BreadcrumbLogger",
-  :from => Raven,
-  :to => ::Logger
-)
+require "raven/breadcrumbs/sentry_logger"

data/lib/raven/breadcrumbs/sentry_logger.rb

@@ -0,0 +1,73 @@
+require 'logger'
+
+module Raven
+  module Breadcrumbs
+    module SentryLogger
+      LEVELS = {
+        ::Logger::DEBUG => 'debug',
+        ::Logger::INFO => 'info',
+        ::Logger::WARN => 'warn',
+        ::Logger::ERROR => 'error',
+        ::Logger::FATAL => 'fatal'
+      }.freeze
+
+      def add(*args)
+        add_breadcrumb(*args)
+        super
+      end
+
+      def add_breadcrumb(severity, message = nil, progname = nil)
+        message = progname if message.nil? # see Ruby's Logger docs for why
+        return if ignored_logger?(progname)
+        return if message.nil? || message == ""
+
+        # some loggers will add leading/trailing space as they (incorrectly, mind you)
+        # think of logging as a shortcut to std{out,err}
+        message = message.to_s.strip
+
+        last_crumb = Raven.breadcrumbs.peek
+        # try to avoid dupes from logger broadcasts
+        if last_crumb.nil? || last_crumb.message != message
+          Raven.breadcrumbs.record do |crumb|
+            crumb.level = Raven::Breadcrumbs::SentryLogger::LEVELS.fetch(severity, nil)
+            crumb.category = progname || 'logger'
+            crumb.message = message
+            crumb.type =
+              if severity >= 3
+                "error"
+              else
+                crumb.level
+              end
+          end
+        end
+      end
+
+      private
+
+      def ignored_logger?(progname)
+        progname == "sentry" ||
+          Raven.configuration.exclude_loggers.include?(progname)
+      end
+    end
+    module OldBreadcrumbsSentryLogger
+      def self.included(base)
+        base.class_eval do
+          include Raven::Breadcrumbs::SentryLogger
+          alias_method :add_without_raven, :add
+          alias_method :add, :add_with_raven
+        end
+      end
+
+      def add_with_raven(*args)
+        add_breadcrumb(*args)
+        add_without_raven(*args)
+      end
+    end
+  end
+end
+
+Raven.safely_prepend(
+  "Breadcrumbs::SentryLogger",
+  :from => Raven,
+  :to => ::Logger
+)

data/lib/raven/cli.rb

@@ -1,6 +1,6 @@
 module Raven
   class CLI
-    def self.test(dsn = nil, silent = false, config = nil) # rubocop:disable all
+    def self.test(dsn = nil, silent = false, config = nil)
       config ||= Raven.configuration
 
       config.logger = if silent

data/lib/raven/client.rb

@@ -125,7 +125,7 @@ module Raven
       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) if configuration.transport_failure_callback # rubocop:disable Style/SafeNavigation
+      configuration.transport_failure_callback.call(event, e) if configuration.transport_failure_callback # rubocop:disable Style/SafeNavigation
     end
   end
 

data/lib/raven/configuration.rb

@@ -12,6 +12,11 @@ module Raven
     attr_reader :async
     alias async? async
 
+    # An array of breadcrumbs loggers to be used. Available options are:
+    # - :sentry_logger
+    # - :active_support_logger
+    attr_reader :breadcrumbs_logger
+
     # Number of lines of code context to capture, or nil for none
     attr_accessor :context_lines
 
@@ -83,7 +88,7 @@ module Raven
     attr_accessor :public_key
 
     # Turns on ActiveSupport breadcrumbs integration
-    attr_accessor :rails_activesupport_breadcrumbs
+    attr_reader :rails_activesupport_breadcrumbs
 
     # Rails catches exceptions in the ActionDispatch::ShowExceptions or
     # ActionDispatch::DebugExceptions middlewares, depending on the environment.
@@ -118,6 +123,19 @@ module Raven
     # Otherwise, can be one of "http", "https", or "dummy"
     attr_accessor :scheme
 
+    # a proc/lambda that takes an array of stack traces
+    # it'll be used to silence (reduce) backtrace of the exception
+    #
+    # for example:
+    #
+    # ```ruby
+    # Raven.configuration.backtrace_cleanup_callback = lambda do |backtrace|
+    #   Rails.backtrace_cleaner.clean(backtrace)
+    # end
+    # ```
+    #
+    attr_accessor :backtrace_cleanup_callback
+
     # Secret key for authentication with the Sentry server
     # If you provide a DSN, this will be set automatically.
     #
@@ -172,16 +190,32 @@ module Raven
     # Errors object - an Array that contains error messages. See #
     attr_reader :errors
 
+    # the dsn value, whether it's set via `config.dsn=` or `ENV["SENTRY_DSN"]`
+    attr_reader :dsn
+
+    # Most of these errors generate 4XX responses. In general, Sentry clients
+    # only automatically report 5xx responses.
     IGNORE_DEFAULT = [
       'AbstractController::ActionNotFound',
+      'ActionController::BadRequest',
       'ActionController::InvalidAuthenticityToken',
+      'ActionController::InvalidCrossOriginRequest',
+      'ActionController::MethodNotAllowed',
+      'ActionController::NotImplemented',
+      'ActionController::ParameterMissing',
       'ActionController::RoutingError',
       'ActionController::UnknownAction',
+      'ActionController::UnknownFormat',
+      'ActionController::UnknownHttpMethod',
+      'ActionDispatch::Http::Parameters::ParseError',
+      'ActionView::MissingTemplate',
+      'ActiveJob::DeserializationError', # Can cause infinite loops
       'ActiveRecord::RecordNotFound',
       'CGI::Session::CookieStore::TamperedWithCookie',
       'Mongoid::Errors::DocumentNotFound',
-      'Sinatra::NotFound',
-      'ActiveJob::DeserializationError'
+      'Rack::QueryParser::InvalidParameterError',
+      'Rack::QueryParser::ParameterTypeError',
+      'Sinatra::NotFound'
     ].freeze
 
     # Note the order - we have to remove circular references and bad characters
@@ -201,8 +235,11 @@ module Raven
     LOG_PREFIX = "** [Raven] ".freeze
     MODULE_SEPARATOR = "::".freeze
 
+    AVAILABLE_BREADCRUMBS_LOGGERS = [:sentry_logger, :active_support_logger].freeze
+
     def initialize
       self.async = false
+      self.breadcrumbs_logger = []
       self.context_lines = 3
       self.current_environment = current_environment_from_env
       self.encoding = 'gzip'
@@ -215,7 +252,8 @@ module Raven
       self.open_timeout = 1
       self.processors = DEFAULT_PROCESSORS.dup
       self.project_root = detect_project_root
-      self.rails_activesupport_breadcrumbs = false
+      @rails_activesupport_breadcrumbs = false
+
       self.rails_report_rescued_exceptions = true
       self.release = detect_release
       self.sample_rate = 1.0
@@ -237,6 +275,8 @@ module Raven
     def server=(value)
       return if value.nil?
 
+      @dsn = value
+
       uri = URI.parse(value)
       uri_path = uri.path.split('/')
 
@@ -273,6 +313,23 @@ module Raven
       @async = value
     end
 
+    def breadcrumbs_logger=(logger)
+      loggers =
+        if logger.is_a?(Array)
+          logger
+        else
+          unless AVAILABLE_BREADCRUMBS_LOGGERS.include?(logger)
+            raise Raven::Error, "Unsupported breadcrumbs logger. Supported loggers: #{AVAILABLE_BREADCRUMBS_LOGGERS}"
+          end
+
+          Array(logger)
+        end
+
+      require "raven/breadcrumbs/sentry_logger" if loggers.include?(:sentry_logger)
+
+      @breadcrumbs_logger = logger
+    end
+
     def transport_failure_callback=(value)
       unless value == false || value.respond_to?(:call)
         raise(ArgumentError, "transport_failure_callback must be callable (or false to disable)")
@@ -329,6 +386,11 @@ module Raven
       Backtrace::Line.instance_variable_set(:@in_app_pattern, nil) # blow away cache
     end
 
+    def rails_activesupport_breadcrumbs=(val)
+      DeprecationHelper.deprecate_old_breadcrumbs_configuration(:active_support_logger)
+      @rails_activesupport_breadcrumbs = val
+    end
+
     def exception_class_allowed?(exc)
       if exc.is_a?(Raven::Error)
         # Try to prevent error reporting loops

data/lib/raven/context.rb

@@ -1,4 +1,5 @@
 require 'rbconfig'
+require 'etc'
 
 module Raven
   class Context
@@ -24,18 +25,22 @@ module Raven
 
     class << self
       def os_context
-        @os_context ||= {
-          :name => Raven.sys_command("uname -s") || RbConfig::CONFIG["host_os"],
-          :version => Raven.sys_command("uname -v"),
-          :build => Raven.sys_command("uname -r"),
-          :kernel_version => Raven.sys_command("uname -a") || Raven.sys_command("ver") # windows
-        }
+        @os_context ||=
+          begin
+            uname = Etc.uname
+            {
+              name: uname[:sysname] || RbConfig::CONFIG["host_os"],
+              version: uname[:version],
+              build: uname[:release],
+              kernel_version: uname[:version]
+            }
+          end
       end
 
       def runtime_context
         @runtime_context ||= {
-          :name => RbConfig::CONFIG["ruby_install_name"],
-          :version => Raven.sys_command("ruby -v")
+          name: RbConfig::CONFIG["ruby_install_name"],
+          version: RUBY_DESCRIPTION || Raven.sys_command("ruby -v")
         }
       end
     end

data/lib/raven/event.rb

@@ -8,6 +8,7 @@ module Raven
     # See Sentry server default limits at
     # https://github.com/getsentry/sentry/blob/master/src/sentry/conf/server.py
     MAX_MESSAGE_SIZE_IN_BYTES = 1024 * 8
+    REQUIRED_OPTION_KEYS = [:configuration, :context, :breadcrumbs].freeze
 
     SDK = { "name" => "raven-ruby", "version" => Raven::VERSION }.freeze
 
@@ -19,7 +20,7 @@ module Raven
 
     attr_reader :level, :timestamp, :time_spent
 
-    def initialize(init = {})
+    def initialize(options)
       # Set some simple default values
       self.id            = SecureRandom.uuid.delete("-")
       self.timestamp     = Time.now.utc
@@ -36,11 +37,17 @@ module Raven
       self.runtime       = {} # TODO: contexts
       self.tags          = {} # TODO: contexts
 
-      copy_initial_state
+      unless REQUIRED_OPTION_KEYS.all? { |key| options.key?(key) }
+        raise "you much provide configuration, context, and breadcrumbs when initializing a Raven::Event"
+      end
+
+      self.configuration = options[:configuration]
+      self.context       = options[:context]
+      self.breadcrumbs   = options[:breadcrumbs]
 
       # Allow attributes to be set on the event at initialization
       yield self if block_given?
-      init.each_pair { |key, val| public_send("#{key}=", val) unless val.nil? }
+      options.each_pair { |key, val| public_send("#{key}=", val) unless val.nil? }
 
       set_core_attributes_from_configuration
       set_core_attributes_from_context
@@ -56,8 +63,7 @@ module Raven
                           end
       options = Raven::Utils::DeepMergeHash.deep_merge(exception_context, options)
 
-      configuration = options[:configuration] || Raven.configuration
-      return unless configuration.exception_class_allowed?(exc)
+      return unless options[:configuration].exception_class_allowed?(exc)
 
       new(options) do |evt|
         evt.add_exception_interface(exc)
@@ -81,7 +87,17 @@ module Raven
     end
 
     def message=(args)
-      message, params = *args
+      if args.is_a?(Array)
+        message, params = args[0], args[0..-1]
+      else
+        message = args
+      end
+
+      unless message.is_a?(String)
+        configuration.logger.debug("You're passing a non-string message")
+        message = message.to_s
+      end
+
       interface(:message) do |int|
         int.message = message.byteslice(0...MAX_MESSAGE_SIZE_IN_BYTES) # Messages limited to 10kb
         int.params = params
@@ -159,7 +175,7 @@ module Raven
     end
 
     def stacktrace_interface_from(backtrace)
-      Backtrace.parse(backtrace).lines.reverse.each_with_object([]) do |line, memo|
+      Backtrace.parse(backtrace, { configuration: configuration }).lines.reverse.each_with_object([]) do |line, memo|
         frame = StacktraceInterface::Frame.new
         frame.abs_path = line.file if line.file
         frame.function = line.method if line.method
@@ -186,12 +202,6 @@ 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

data/lib/raven/helpers/deprecation_helper.rb

@@ -0,0 +1,17 @@
+module DeprecationHelper
+  def self.deprecate_dasherized_filename(correct_filename)
+    warn "[Deprecation Warning] Dasherized filename \"#{correct_filename.gsub('_', '-')}\" is deprecated and will be removed in 4.0; use \"#{correct_filename}\" instead" # rubocop:disable Style/LineLength
+  end
+
+  def self.deprecate_old_breadcrumbs_configuration(logger)
+    deprecated_usage =
+      if logger == :sentry_logger
+        "require \"raven/breadcrumbs/logger\""
+      else
+        "Raven.configuration.rails_activesupport_breadcrumbs = true"
+      end
+    recommended_usage = "Raven.configuration.breadcrumbs_logger = :#{logger}"
+
+    warn "[Deprecation Warning] The way you enable breadcrumbs logger (#{deprecated_usage}) is deprecated and will be removed in 4.0; use '#{recommended_usage}' instead" # rubocop:disable Style/LineLength
+  end
+end

data/lib/raven/instance.rb

@@ -77,7 +77,7 @@ module Raven
     # Send an event to the configured Sentry server
     #
     # @example
-    #   evt = Raven::Event.new(:message => "An error")
+    #   evt = Raven::Event.new(:message => "An errore)
     #   Raven.send_event(evt)
     def send_event(event, hint = nil)
       client.send_event(event, hint)
@@ -114,6 +114,8 @@ module Raven
       options = options.deep_dup
       options[:configuration] = configuration
       options[:context] = context
+      options[:breadcrumbs] = breadcrumbs
+
       if evt = Event.send("from_" + message_or_exc, obj, options)
         yield evt if block_given?
         if configuration.async?

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

@@ -10,7 +10,11 @@ module RackTimeoutExtensions
     # 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)
+    if defined?(env)
+      { :fingerprint => ["{{ default }}", env["REQUEST_URI"]] }
+    else
+      {}
+    end
   end
 end
 

data/lib/raven/integrations/rails.rb

@@ -5,6 +5,7 @@ module Raven
     require 'raven/integrations/rails/overrides/streaming_reporter'
     require 'raven/integrations/rails/controller_methods'
     require 'raven/integrations/rails/controller_transaction'
+    require 'raven/integrations/rails/backtrace_cleaner'
     require 'raven/integrations/rack'
 
     initializer "raven.use_rack_middleware" do |app|
@@ -37,12 +38,20 @@ module Raven
 
     config.before_initialize do
       Raven.configuration.logger = ::Rails.logger
+
+      backtrace_cleaner = Raven::Rails::BacktraceCleaner.new
+
+      Raven.configuration.backtrace_cleanup_callback = lambda do |backtrace|
+        backtrace_cleaner.clean(backtrace)
+      end
     end
 
     config.after_initialize do
-      if Raven.configuration.rails_activesupport_breadcrumbs
-        require 'raven/breadcrumbs/activesupport'
-        Raven::ActiveSupportBreadcrumbs.inject
+      if Raven.configuration.breadcrumbs_logger.include?(:active_support_logger) ||
+         Raven.configuration.rails_activesupport_breadcrumbs
+
+        require 'raven/breadcrumbs/active_support_logger'
+        Raven::Breadcrumbs::ActiveSupportLogger.inject
       end
 
       if Raven.configuration.rails_report_rescued_exceptions

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

@@ -21,7 +21,8 @@ module Raven
       def capture_and_reraise_with_sentry(job, block)
         block.call
       rescue Exception => e # rubocop:disable Lint/RescueException
-        return if rescue_with_handler(e)
+        rescue_handler_result = rescue_with_handler(e)
+        return rescue_handler_result if rescue_handler_result
 
         Raven.capture_exception(e, :extra => raven_context(job))
         raise e

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

@@ -0,0 +1,29 @@
+require "active_support/backtrace_cleaner"
+require "active_support/core_ext/string/access"
+
+module Raven
+  class Rails
+    class BacktraceCleaner < ActiveSupport::BacktraceCleaner
+      APP_DIRS_PATTERN = /\A(?:\.\/)?(?:app|config|lib|test|\(\w*\))/.freeze
+      RENDER_TEMPLATE_PATTERN = /:in `.*_\w+_{2,3}\d+_\d+'/.freeze
+
+      def initialize
+        super
+        # we don't want any default silencers because they're too aggressive
+        remove_silencers!
+
+        @root = "#{Raven.configuration.project_root}/"
+        add_filter do |line|
+          line.start_with?(@root) ? line.from(@root.size) : line
+        end
+        add_filter do |line|
+          if line =~ RENDER_TEMPLATE_PATTERN
+            line.sub(RENDER_TEMPLATE_PATTERN, "")
+          else
+            line
+          end
+        end
+      end
+    end
+  end
+end

data/lib/raven/integrations/sidekiq.rb

@@ -1,87 +1,13 @@
 require 'time'
 require 'sidekiq'
-
-module Raven
-  class SidekiqCleanupMiddleware
-    def call(_worker, job, queue)
-      Raven.context.transaction.push "Sidekiq/#{job['class']}"
-      Raven.extra_context(:sidekiq => job.merge("queue" => queue))
-      yield
-      Context.clear!
-      BreadcrumbBuffer.clear!
-    end
-  end
-
-  class SidekiqErrorHandler
-    ACTIVEJOB_RESERVED_PREFIX = "_aj_".freeze
-    HAS_GLOBALID = const_defined?('GlobalID')
-
-    def call(ex, context)
-      context = filter_context(context)
-      Raven.context.transaction.push transaction_from_context(context)
-      Raven.capture_exception(
-        ex,
-        :message => ex.message,
-        :extra => { :sidekiq => context }
-      )
-      Context.clear!
-      BreadcrumbBuffer.clear!
-    end
-
-    private
-
-    # 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
-
-    def filter_context_hash(key, value)
-      (key = key[3..-1]) if key [0..3] == ACTIVEJOB_RESERVED_PREFIX
-      [key, filter_context(value)]
-    end
-
-    # this will change in the future:
-    # https://github.com/mperham/sidekiq/pull/3161
-    def transaction_from_context(context)
-      classname = (context["wrapped"] || context["class"] ||
-                    (context[:job] && (context[:job]["wrapped"] || context[:job]["class"]))
-                  )
-      if classname
-        "Sidekiq/#{classname}"
-      elsif context[:event]
-        "Sidekiq/#{context[:event]}"
-      else
-        "Sidekiq"
-      end
-    end
-
-    def format_globalid(context)
-      if HAS_GLOBALID && context.is_a?(GlobalID)
-        context.to_s
-      else
-        context
-      end
-    end
-  end
-end
+require 'raven/integrations/sidekiq/cleanup_middleware'
+require 'raven/integrations/sidekiq/error_handler'
 
 if Sidekiq::VERSION > '3'
   Sidekiq.configure_server do |config|
-    config.error_handlers << Raven::SidekiqErrorHandler.new
+    config.error_handlers << Raven::Sidekiq::ErrorHandler.new
     config.server_middleware do |chain|
-      chain.add Raven::SidekiqCleanupMiddleware
+      chain.add Raven::Sidekiq::CleanupMiddleware
     end
   end
 end

data/lib/raven/integrations/sidekiq/cleanup_middleware.rb

@@ -0,0 +1,13 @@
+module Raven
+  module Sidekiq
+    class CleanupMiddleware
+      def call(_worker, job, queue)
+        Raven.context.transaction.push "Sidekiq/#{job['class']}"
+        Raven.extra_context(:sidekiq => job.merge("queue" => queue))
+        yield
+        Context.clear!
+        BreadcrumbBuffer.clear!
+      end
+    end
+  end
+end

data/lib/raven/integrations/sidekiq/context_filter.rb

@@ -0,0 +1,42 @@
+module Raven
+  module Sidekiq
+    module ContextFilter
+      class << self
+        ACTIVEJOB_RESERVED_PREFIX = "_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[3..-1]) if key [0..3] == ACTIVEJOB_RESERVED_PREFIX
+          [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/integrations/sidekiq/error_handler.rb

@@ -0,0 +1,38 @@
+require 'raven/integrations/sidekiq/context_filter'
+
+module Raven
+  module Sidekiq
+    class ErrorHandler
+      SIDEKIQ_NAME = "Sidekiq".freeze
+
+      def call(ex, context)
+        context = ContextFilter.filter_context(context)
+        Raven.context.transaction.push transaction_from_context(context)
+        Raven.capture_exception(
+          ex,
+          :message => ex.message,
+          :extra => { :sidekiq => context }
+        )
+        Context.clear!
+        BreadcrumbBuffer.clear!
+      end
+
+      private
+
+      # this will change in the future:
+      # https://github.com/mperham/sidekiq/pull/3161
+      def transaction_from_context(context)
+        classname = (context["wrapped"] || context["class"] ||
+                      (context[:job] && (context[:job]["wrapped"] || context[:job]["class"]))
+                    )
+        if classname
+          "#{SIDEKIQ_NAME}/#{classname}"
+        elsif context[:event]
+          "#{SIDEKIQ_NAME}/#{context[:event]}"
+        else
+          SIDEKIQ_NAME
+        end
+      end
+    end
+  end
+end

data/lib/raven/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Raven
-  VERSION = "3.0.4"
+  VERSION = "3.1.0"
 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'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sentry-raven
 version: !ruby/object:Gem::Version
-  version: 3.0.4
+  version: 3.1.0
 platform: ruby
 authors:
 - Sentry Team
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-08-28 00:00:00.000000000 Z
+date: 2020-09-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -34,6 +34,8 @@ extra_rdoc_files:
 - LICENSE
 files:
 - ".craft.yml"
+- ".github/ISSUE_TEMPLATE/bug_report.md"
+- ".github/pull_request_template.md"
 - ".github/workflows/test.yml"
 - ".github/workflows/zeus_upload.yml"
 - ".gitignore"
@@ -42,7 +44,7 @@ files:
 - ".rubocop.yml"
 - ".scripts/bump-version.sh"
 - CHANGELOG.md
-- CONTRIUTING.md
+- CONTRIBUTING.md
 - Gemfile
 - LICENSE
 - README.md
@@ -52,8 +54,9 @@ files:
 - 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
@@ -61,12 +64,14 @@ files:
 - 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
@@ -74,6 +79,9 @@ files:
 - 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/context_filter.rb
+- lib/raven/integrations/sidekiq/error_handler.rb
 - lib/raven/integrations/tasks.rb
 - lib/raven/interface.rb
 - lib/raven/interfaces/exception.rb
@@ -101,6 +109,7 @@ files:
 - 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:

data/CONTRIUTING.md

@@ -1,26 +0,0 @@
-<p align="center">
-  <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>
-
-# Contributing
-
-We welcome suggested improvements and bug fixes in the form of pull requests. The guide below will help you get started, but if you have further questions, please feel free to reach out on [Discord](https://discord.gg/Ww9hbqr).
-
-
-## Making a release
-
-Install and use `craft`: https://github.com/getsentry/craft
-
-Make sure the `CHANGELOG.md` is update and latest `master` contains all changes.
-
-Run:
-
-```bash
-craft prepare x.x.x
-```
-
-Where `x.x.x` stands for the version you want to release.
-Afterwards reach out to an employee of Sentry, they will cut a release by running the `publish` process of `craft`.

data/lib/raven/breadcrumbs/activesupport.rb

@@ -1,19 +0,0 @@
-module Raven
-  module ActiveSupportBreadcrumbs
-    class << self
-      def add(name, started, _finished, _unique_id, data)
-        Raven.breadcrumbs.record do |crumb|
-          crumb.data = data
-          crumb.category = name
-          crumb.timestamp = started.to_i
-        end
-      end
-
-      def inject
-        ActiveSupport::Notifications.subscribe(/.*/) do |name, started, finished, unique_id, data|
-          add(name, started, finished, unique_id, data)
-        end
-      end
-    end
-  end
-end