sentry-raven 2.1.3 → 3.1.2

data/Gemfile

@@ -0,0 +1,37 @@
+source "https://rubygems.org/"
+
+gemspec
+
+rails_version = ENV["RAILS_VERSION"]
+rails_version = "5.2" if rails_version.nil?
+
+if rails_version.to_f != 0
+  gem "rails", "~> #{rails_version}"
+  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"
+gem "benchmark-ipsa"
+gem "benchmark-memory"
+gem "ruby-prof", platform: :mri
+gem "rake", "> 12"
+gem "rubocop", "~> 0.81.0"
+gem "rspec", "~> 3.9.0"
+gem "capybara", "~> 3.15.0" # rspec system tests
+gem "puma" # rspec system tests
+
+gem "timecop"
+gem "test-unit"
+gem "simplecov"
+gem "codecov", "<= 0.2.12"

data/Makefile

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

data/README.md

@@ -1,13 +1,44 @@
-# Raven-Ruby
+<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>
+
+# 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://img.shields.io/travis/getsentry/raven-ruby/master.svg)](https://travis-ci.org/getsentry/raven-ruby)
+![Build Status](https://github.com/getsentry/raven-ruby/workflows/Test/badge.svg)
+[![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)
+
+
+[Documentation](https://docs.sentry.io/clients/ruby/) | [Bug Tracker](https://github.com/getsentry/raven-ruby/issues) | [Forum](https://forum.sentry.io/) | IRC: irc.freenode.net, #sentry
+
+The official Ruby-language client and integration layer for the [Sentry](https://github.com/getsentry/sentry) error reporting API.
 
-A client and integration layer for the [Sentry](https://github.com/getsentry/sentry) error reporting API.
 
 ## Requirements
 
-We test on Ruby 1.9, 2.2 and 2.3 at the latest patchlevel/teeny version. Our Rails integration works with Rails 4.2+. JRuby support is experimental - check TravisCI to see if the build is passing or failing.
+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.
 
 ## Getting Started
 
@@ -17,30 +48,30 @@ We test on Ruby 1.9, 2.2 and 2.3 at the latest patchlevel/teeny version. Our Rai
 gem "sentry-raven"
 ```
 
-### Raven only runs when SENTRY_DSN is set
+### Raven only runs when Sentry DSN is set
 
 Raven will capture and send exceptions to the Sentry server whenever its DSN is set. This makes environment-based configuration easy - if you don't want to send errors in a certain environment, just don't set the DSN in that environment!
 
 ```bash
 # Set your SENTRY_DSN environment variable.
-export SENTRY_DSN=http://public:secret@example.com/project-id
+export SENTRY_DSN=http://public@example.com/project-id
 ```
 ```ruby
-# Or you can configure the client in the code (not recommended - keep your DSN secret!)
+# Or you can configure the client in the code.
 Raven.configure do |config|
-  config.dsn = 'http://public:secret@example.com/project-id'
+  config.dsn = 'http://public@example.com/project-id'
 end
 ```
 
-### Raven doesn't report some kinds of data by default.
+### Raven doesn't report some kinds of data by default
 
-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 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.getsentry.com/hosted/clients/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/)
 
-### Call
+### Usage
 
-If you use Rails, you're already done - no more configuration required! Check [Integrations](https://docs.getsentry.com/hosted/clients/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:
 
@@ -57,10 +88,77 @@ rescue ZeroDivisionError => exception
 end
 ```
 
+### More configuration
+
+You're all set - but there's a few more settings you may want to know about too!
+
+#### async
+
+When an error or message occurs, the notification is immediately sent to Sentry. Raven can be configured to send asynchronously:
+
+```ruby
+config.async = lambda { |event|
+  Thread.new { Raven.send_event(event) }
+}
+```
+
+Using a thread to send events will be adequate for truly parallel Ruby platforms such as JRuby, though the benefit on MRI/CRuby will be limited. If the async callback raises an exception, Raven will attempt to send synchronously.
+
+Note that the naive example implementation has a major drawback - it can create an infinite number of threads. We recommend creating a background job, using your background job processor, that will send Sentry notifications in the background.
+
+```ruby
+config.async = lambda { |event| SentryJob.perform_later(event) }
+
+class SentryJob < ActiveJob::Base
+  queue_as :default
+
+  def perform(event)
+    Raven.send_event(event)
+  end
+end
+```
+
+#### transport_failure_callback
+
+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, error|
+  AdminMailer.email_admins("Oh god, it's on fire because #{error.message}!", event).deliver_later
+}
+```
+
+#### Context
+
+Much of the usefulness of Sentry comes from additional context data with the events. Raven makes this very convenient by providing methods to set thread local context data that is then submitted automatically with all events:
+
+```ruby
+Raven.user_context email: 'foo@example.com'
+
+Raven.tags_context interesting: 'yes'
+
+Raven.extra_context additional_info: 'foo'
+```
+
+You can also use `tags_context` and `extra_context` to provide scoped information:
+
+```ruby
+Raven.tags_context(interesting: 'yes') do
+  # the `interesting: 'yes'` tag will only present in the requests sent inside the block
+  Raven.capture_exception(exception)
+end
+
+Raven.extra_context(additional_info: 'foo') do
+  # same as above, the `additional_info` will only present in this request
+  Raven.capture_exception(exception)
+end
+```
+
+For more information, see [Context](https://docs.sentry.io/platforms/ruby/enriching-events/context/).
+
 ## More Information
 
-* [Documentation](https://docs.getsentry.com/hosted/clients/ruby/)
-* [Bug Tracker](https://github.com/getsentry/raven-ruby/issues>)
-* [Code](https://github.com/getsentry/raven-ruby>)
-* [Mailing List](https://groups.google.com/group/getsentry>)
-* [IRC](irc://irc.freenode.net/sentry>)  (irc.freenode.net, #sentry)
+* [Documentation](https://docs.sentry.io/clients/ruby/)
+* [Bug Tracker](https://github.com/getsentry/raven-ruby/issues)
+* [Forum](https://forum.sentry.io/)
+- [Discord](https://discord.gg/ez5KZN7)

data/Rakefile

@@ -0,0 +1,30 @@
+require 'rake'
+require 'raven'
+require 'rubygems/package_task'
+require 'bundler/gem_tasks'
+
+gemspec = Gem::Specification.load(Dir['*.gemspec'].first)
+
+Gem::PackageTask.new(gemspec).define
+
+begin
+  require 'rubygems'
+  require 'rspec/core/rake_task'
+
+  require 'rubocop/rake_task'
+  RuboCop::RakeTask.new(:rubocop) do |task|
+    task.patterns = ['lib/**/*.rb','spec/**/*.rb',]
+    task.options << '--display-cop-names'
+  end
+
+  RSpec::Core::RakeTask.new(:spec) do |spec|
+    spec.pattern = 'spec/**/*_spec.rb'
+  end
+
+rescue LoadError
+  task :spec do
+    abort "Rspec is not available. bundle install to run unit tests"
+  end
+end
+
+task :default => [:rubocop, :spec]

data/exe/raven

@@ -0,0 +1,32 @@
+#!/usr/bin/env ruby
+
+require "raven"
+require "raven/cli"
+require "optparse"
+
+parser = OptionParser.new do |opt|
+  opt.banner = "Usage: raven COMMAND [OPTIONS]"
+  opt.separator  ""
+  opt.separator  "Commands"
+  opt.separator  "     test: send a test event"
+  opt.separator  ""
+  opt.separator  "Options"
+
+  opt.on("-h", "--help", "help") do
+    puts parser
+  end
+end
+
+parser.parse!
+
+case ARGV[0]
+when "test"
+  dsn = ARGV[1] if ARGV.length > 1
+  if !dsn
+    puts "Usage: raven test <dsn>"
+  else
+    Raven::CLI.test(dsn)
+  end
+else
+  puts parser
+end

data/lib/raven/backtrace.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 ## Inspired by Rails' and Airbrake's backtrace parsers.
 
 module Raven
@@ -5,11 +7,16 @@ module Raven
   class Backtrace
     # Handles backtrace parsing line by line
     class Line
-      # regexp (optionnally allowing leading X: for windows support)
-      RUBY_INPUT_FORMAT = /^((?:[a-zA-Z]:)?[^:]+|<.*>):(\d+)(?::in `([^']+)')?$/
+      RB_EXTENSION = ".rb"
+      # regexp (optional leading X: on windows, or JRuby9000 class-prefix)
+      RUBY_INPUT_FORMAT = /
+        ^ \s* (?: [a-zA-Z]: | uri:classloader: )? ([^:]+ | <.*>):
+        (\d+)
+        (?: :in \s `([^']+)')?$
+      /x.freeze
 
       # org.jruby.runtime.callsite.CachingCallSite.call(CachingCallSite.java:170)
-      JAVA_INPUT_FORMAT = /^(.+)\.([^\.]+)\(([^\:]+)\:(\d+)\)$/
+      JAVA_INPUT_FORMAT = /^(.+)\.([^\.]+)\(([^\:]+)\:(\d+)\)$/.freeze
 
       # The file portion of the line (such as app/models/user.rb)
       attr_reader :file
@@ -30,6 +37,7 @@ module Raven
         ruby_match = unparsed_line.match(RUBY_INPUT_FORMAT)
         if ruby_match
           _, file, number, method = ruby_match.to_a
+          file.sub!(/\.class$/, RB_EXTENSION)
           module_name = nil
         else
           java_match = unparsed_line.match(JAVA_INPUT_FORMAT)
@@ -68,7 +76,7 @@ module Raven
 
       def self.in_app_pattern
         @in_app_pattern ||= begin
-          project_root = Raven.configuration.project_root && Raven.configuration.project_root.to_s
+          project_root = Raven.configuration.project_root&.to_s
           Regexp.new("^(#{project_root}/)?#{Raven.configuration.app_dirs_pattern || APP_DIRS_PATTERN}")
         end
       end
@@ -78,7 +86,7 @@ module Raven
       attr_writer :file, :number, :method, :module_name
     end
 
-    APP_DIRS_PATTERN = /(bin|exe|app|config|lib|test)/
+    APP_DIRS_PATTERN = /(bin|exe|app|config|lib|test)/.freeze
 
     # holder for an Array of Backtrace::Line instances
     attr_reader :lines
@@ -86,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|
@@ -105,7 +115,7 @@ module Raven
     end
 
     def inspect
-      "<Backtrace: " + lines.map(&inspect).join(", ") + ">"
+      "<Backtrace: " + lines.map(&:inspect).join(", ") + ">"
     end
 
     def to_s

data/lib/raven/base.rb

@@ -1,4 +1,6 @@
 require 'raven/version'
+require "raven/helpers/deprecation_helper"
+require 'raven/core_ext/object/deep_dup'
 require 'raven/backtrace'
 require 'raven/breadcrumbs'
 require 'raven/processor'
@@ -12,14 +14,19 @@ require 'raven/configuration'
 require 'raven/context'
 require 'raven/client'
 require 'raven/event'
+require 'raven/linecache'
 require 'raven/logger'
 require 'raven/interfaces/message'
 require 'raven/interfaces/exception'
 require 'raven/interfaces/single_exception'
 require 'raven/interfaces/stack_trace'
 require 'raven/interfaces/http'
+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'
 
 require 'forwardable'
@@ -28,6 +35,9 @@ require 'English'
 module Raven
   AVAILABLE_INTEGRATIONS = %w(delayed_job railties sidekiq rack rack-timeout rake).freeze
 
+  class Error < StandardError
+  end
+
   class << self
     extend Forwardable
 
@@ -78,12 +88,13 @@ module Raven
 
     def load_integration(integration)
       require "raven/integrations/#{integration}"
-    rescue Exception => error
-      logger.warn "Unable to load raven/integrations/#{integration}: #{error}"
+    rescue Exception => e
+      logger.warn "Unable to load raven/integrations/#{integration}: #{e}"
     end
 
     def safely_prepend(module_name, opts = {})
       return if opts[:to].nil? || opts[:from].nil?
+
       if opts[:to].respond_to?(:prepend, true)
         opts[:to].send(:prepend, opts[:from].const_get(module_name))
       else
@@ -92,8 +103,10 @@ module Raven
     end
 
     def sys_command(command)
-      result = `#{command}` rescue nil
-      result.strip if result != "" && result
+      result = `#{command} 2>&1` rescue nil
+      return if result.nil? || result.empty? || ($CHILD_STATUS && $CHILD_STATUS.exitstatus != 0)
+
+      result.strip
     end
   end
 end

data/lib/raven/breadcrumbs/{activesupport.rb → active_support_logger.rb}

@@ -1,6 +1,7 @@
 module Raven
-  module ActiveSupportBreadcrumbs
-    class << self
+  module Breadcrumbs
+    module ActiveSupportLogger
+      class << self
         def add(name, started, _finished, _unique_id, data)
           Raven.breadcrumbs.record do |crumb|
             crumb.data = data
@@ -10,10 +11,15 @@ module Raven
         end
 
         def inject
-          ActiveSupport::Notifications.subscribe(/.*/) do |name, started, finished, unique_id, data|
+          @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(.*)$/
-
-    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.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/breadcrumbs.rb

@@ -28,6 +28,8 @@ module Raven
   class BreadcrumbBuffer
     include Enumerable
 
+    attr_accessor :buffer
+
     def self.current
       Thread.current[:sentry_breadcrumbs] ||= new
     end
@@ -62,7 +64,7 @@ module Raven
     end
 
     def empty?
-      !members.any?
+      members.none?
     end
 
     def to_hash