sentry-raven 3.0.4 → 3.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e0e19bd3b705bd0a2c680d367ea7420941d5df1c5b245317170b9c31fd177006
-  data.tar.gz: f826cbfb501dfd844ff1096b8561ffc8a2e4f589d51d186ce063e4cfcabc65aa
+  metadata.gz: 8c836de333d5f6013b562a5d189b6e775ca61965c7070a111b61d37402d318d1
+  data.tar.gz: b1923aeea7733a7e0d51fdc6e2f49b7dd046b5eaaba1067507229d0cc5262352
 SHA512:
-  metadata.gz: 8f47ca78fad6ebc47e9a76efd32e8009e6b8196256b06edef38dc1081a4eafb57f0f880e69d3e423ef5dffe6f66f2651c6c1fa2ca4002ad1c5be352b541bdfb3
-  data.tar.gz: f6e95e7a313ece5ebfb1af584d2cd11648575a6121a0ff0b807180e396bfb8102b1bc0cc1914d96e26058273193dbf6014c0acd6ded8dbef284cac6d0279ab79
+  metadata.gz: 7ae04b49b38a134386b44e04675f47bbf9742ba1b39f84ac0c51a87b3852380c1b60d91a7a7c67e208a9415c75880559941ac343cb3378a8129259b4aeb63984
+  data.tar.gz: 0fd029cf50d3a54f98906cee4f1c4177282f91030239f093d53e3949bc37a533fd4557f6f932e5c22051416e92ff28a53da7fbc2a9086c83181538f8c81d6c83

data/.craft.yml

@@ -1,14 +1,18 @@
-minVersion: '0.11.0'
+minVersion: '0.13.2'
 github:
     owner: getsentry
-    repo: raven-ruby
+    repo: sentry-ruby
 changelogPolicy: simple
-preReleaseCommand: ruby .scripts/bump-version.sh
-statusProvider: 
-    name: github
+preReleaseCommand: ruby .scripts/bump-version.rb
+releaseBranchPrefix: release-sentry-raven
+statusProvider:
+  name: github
+artifactProvider:
+  name: github
 targets:
     - name: gem
     - name: github
+      tagPrefix: sentry-raven-v
     - name: registry
       type: sdk
       config:

data/.scripts/bump-version.rb

@@ -0,0 +1,5 @@
+file_name = "lib/raven/version.rb"
+
+text = File.read(file_name)
+new_contents = text.gsub(/VERSION = ".*"/, "VERSION = \"#{ARGV[1]}\"")
+File.open(file_name, "w") {|file| file.puts new_contents }

data/CHANGELOG.md

@@ -1,6 +1,150 @@
 # Changelog
 
-## Unreleased
+## 3.1.2
+
+- Fix Delayed::Plugins::Raven when job raises exception [#1057](https://github.com/getsentry/sentry-ruby/pull/1057)
+- Merge hash instead of replacing the original value in user_context [#1064](https://github.com/getsentry/sentry-ruby/pull/1064)
+- Don't exclude ActionView::MissingTemplate error by default [#1092](https://github.com/getsentry/sentry-ruby/pull/1092)
+- Fix typo: much -> must for Raven::Event [#1106](https://github.com/getsentry/sentry-ruby/pull/1106)
+- Fix undefined local variable or method logger [#1143](https://github.com/getsentry/sentry-ruby/pull/1143)
+  - Fixes [#1110](https://github.com/getsentry/sentry-ruby/issues/1110)
+- fix format headers for sentry-raven [#1198](https://github.com/getsentry/sentry-ruby/pull/1198)
+- Print deprecation message after sentry-raven is installed [#1206](https://github.com/getsentry/sentry-ruby/pull/1206)
+
+## 3.1.1
+
+**Feature**
+
+- Add request id to headers if exists ([#1033](https://github.com/getsentry/sentry-ruby/pull/1033))
+
+- Allow blocks on user_context ([#1023](https://github.com/getsentry/sentry-ruby/pull/1023))
+
+- Enable configurable rack environment recorded parameters ([#860](https://github.com/getsentry/sentry-ruby/pull/860))
+
+- Remove ActiveJob keys for both Sidekiq and DelayedJob ([#898](https://github.com/getsentry/sentry-ruby/pull/898))
+
+**Fix**
+
+- Remove circular dependency in transport/http.rb ([#1035](https://github.com/getsentry/sentry-ruby/pull/1035))
+
+## 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/Gemfile

@@ -10,11 +10,15 @@ if rails_version.to_f != 0
   gem "rspec-rails", "~> 4.0"
 end
 
+gem "delayed_job"
 gem "sidekiq"
 
 gem "rack"
 gem "rack-timeout"
 
+# TODO: Remove this if https://github.com/jruby/jruby/issues/6547 is addressed
+gem "i18n", "<= 1.8.7"
+
 gem "pry"
 gem "benchmark-ips"
 gem "benchmark_driver"
@@ -30,4 +34,4 @@ gem "puma" # rspec system tests
 gem "timecop"
 gem "test-unit"
 gem "simplecov"
-gem "codecov"
+gem "codecov", "<= 0.2.12"

data/Makefile

@@ -0,0 +1,3 @@
+build:
+	bundle install
+	gem build sentry-raven.gemspec

data/README.md

@@ -7,9 +7,26 @@
 
 # Raven-Ruby, the Ruby Client for Sentry
 
+### 🚧 Migrating To The New SDK 🚧
+
+We've released our new Ruby SDK, [sentry-ruby](https://github.com/getsentry/sentry-ruby/tree/master/sentry-ruby). Here are the benefits of migrating to it:
+
+- **Unified Interfaces With Other SDKs:** The design of `sentry-raven` is outdated compared with our modern Sentry SDKs. If you also use other Sentry SDKs, such as Sentry's JavaScript SDK for your frontend application, you'll notice that their interfaces are quite different from the one provided for `sentry-raven`. The new `sentry-ruby` SDK provides a more consistent user experience across all different platforms.
+
+- **Performance Monitoring:** The Sentry Ruby SDK includes [performance monitoring](https://docs.sentry.io/product/performance/), which you can enable if you haven't already as ([discussed here](https://docs.sentry.io/platforms/ruby/performance/)).
+
+- **Future Support:** `sentry-raven` has entered maintenance mode, which means it won't receive any new feature supports or aggressive bug fixes.
+
+- **Better Extensibility:** Unlike `sentry-raven`, `sentry-ruby` is built with extensibility in mind and will allow the community to build extensions for different integrations/features.
+
+If you're interested in the migration, please also read our [migration guide](https://docs.sentry.io/platforms/ruby/migration/) for more information.
+
+---
+
+
 [![Gem Version](https://img.shields.io/gem/v/sentry-raven.svg)](https://rubygems.org/gems/sentry-raven)
 ![Build Status](https://github.com/getsentry/raven-ruby/workflows/Test/badge.svg)
-[![Coverage Status](https://img.shields.io/codecov/c/github/getsentry/raven-ruby/master?logo=codecov)](https://codecov.io/gh/getsentry/raven-ruby/branch/master)
+[![Coverage Status](https://img.shields.io/codecov/c/github/getsentry/sentry-ruby/master?logo=codecov)](https://codecov.io/gh/getsentry/sentry-ruby/branch/master)
 [![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)
 
@@ -18,6 +35,7 @@
 
 The official Ruby-language client and integration layer for the [Sentry](https://github.com/getsentry/sentry) error reporting API.
 
+
 ## Requirements
 
 We test on Ruby 2.3, 2.4, 2.5, 2.6 and 2.7 at the latest patchlevel/teeny version. We also support JRuby 9.0. Our Rails integration works with Rails 4.2+, including Rails 5 and Rails 6.
@@ -49,11 +67,11 @@ end
 
 **Raven ignores some exceptions by default** - most of these are related to 404s or controller actions not being found. [For a complete list, see the `IGNORE_DEFAULT` constant](https://github.com/getsentry/raven-ruby/blob/master/lib/raven/configuration.rb).
 
-Raven doesn't report POST data or cookies by default. In addition, it will attempt to remove any obviously sensitive data, such as credit card or Social Security numbers. For more information about how Sentry processes your data, [check out the documentation on the `processors` config setting.](https://docs.sentry.io/platforms/ruby/config/)
+Raven doesn't report POST data or cookies by default. In addition, it will attempt to remove any obviously sensitive data, such as credit card or Social Security numbers. For more information about how Sentry processes your data, [check out the documentation on the `processors` config setting.](https://docs.sentry.io/platforms/ruby/configuration/options/)
 
 ### Usage
 
-**If you use Rails, you're already done - no more configuration required!** Check [Integrations](https://docs.sentry.io/platforms/ruby/integrations/) for more details on other gems Sentry integrates with automatically.
+**If you use Rails, you're already done - no more configuration required!** Check [Integrations](https://docs.sentry.io/platforms/ruby/configuration/integrations/) for more details on other gems Sentry integrates with automatically.
 
 Otherwise, Raven supports two methods of capturing exceptions:
 
@@ -105,8 +123,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
 }
 ```
 
@@ -117,9 +135,9 @@ Much of the usefulness of Sentry comes from additional context data with the eve
 ```ruby
 Raven.user_context email: 'foo@example.com'
 
-Raven.tags.merge!(interesting: 'yes')
+Raven.tags_context interesting: 'yes'
 
-Raven.extra.merge!(additional_info: 'foo')
+Raven.extra_context additional_info: 'foo'
 ```
 
 You can also use `tags_context` and `extra_context` to provide scoped information:
@@ -136,7 +154,7 @@ Raven.extra_context(additional_info: 'foo') do
 end
 ```
 
-For more information, see [Context](https://docs.sentry.io/clients/ruby/context/).
+For more information, see [Context](https://docs.sentry.io/platforms/ruby/enriching-events/context/).
 
 ## More Information
 

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'
@@ -24,6 +25,7 @@ require 'raven/transports'
 require 'raven/transports/http'
 require 'raven/utils/deep_merge'
 require 'raven/utils/real_ip'
+require 'raven/utils/request_id'
 require 'raven/utils/exception_cause_chain'
 require 'raven/instance'
 

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"