sentry-raven 3.0.2 → 3.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 766dba6870e025b98287e3d2ecf7a2f14aad5c37169e4ffc99bd5c740f30a7eb
-  data.tar.gz: c1b0c1abf8218d480f40e7cd3653b30d4747a5a2c47111a20f269cac219e091c
+  metadata.gz: 80521c1a75c0ad22be530ffd95d497c5faa6def9d88d21dceecf3b7dacecb7a8
+  data.tar.gz: 1c1302782b979b2cf098ef0a90b71d69a65f733af2f95d588b4ae71e0ab67922
 SHA512:
-  metadata.gz: 07ef24c7e92460508209ca9fc1d76d09bd317f7a40d693256f1b44afe9e476f1d6f271db3557b848070c15b7c9277c3cff450ebf3882b206d25419eedbd65327
-  data.tar.gz: ef792fc072cb8c5e2247d868358c413e64dfedddf2f2232c3d81f66a87d700aa22eb3f6f8563b8df83970d20330b029ce8da299a2bd1cf98f458383ba89fa392
+  metadata.gz: 0cd7c853ace426bd428037ea0cf436b781511beded44373fea677a06f58e7a6200f0ddad9d9777fb12468954b344e4035a7a275427a65ff38e6cb618317e7198
+  data.tar.gz: ab5c38a374dc93fffa6baf9b9284795c3790e3db247848a9b39d7aa4902a3045375c24cea5e480cee25758bab96fe6f4c79c2fdae43c1f80ad25f171c443ba1f

data/.craft.yml

@@ -1,4 +1,4 @@
-minVersion: '0.9.0'
+minVersion: '0.11.0'
 github:
     owner: getsentry
     repo: raven-ruby

data/.github/workflows/test.yml

@@ -1,10 +1,9 @@
 name: Test
 
-on: 
+on:
   push:
     branches:
       - master
-      - release/**
   pull_request:
 jobs:
   test:
@@ -47,31 +46,42 @@ jobs:
     - name: Build with Rails ${{ matrix.rails_version }}
       env:
         RAILS_VERSION: ${{ matrix.rails_version }}
-      run: | 
+      run: |
         bundle install --jobs 4 --retry 3
         bundle exec rake
 
-  job_zeus:
-    name: Zeus
-    runs-on: ubuntu-latest
+  compare_allocation:
+    name: Compare memory allocation with ${{ matrix.ruby_version }} and rails ${{ matrix.rails_version }}
+    runs-on: ${{ matrix.os }}
+    needs: test
+    env:
+      RAILS_VERSION: ${{ matrix.rails_version }}
+    strategy:
+      matrix:
+        rails_version: [5.2, 6.0]
+        ruby_version: [2.6, 2.7]
+        os: [ubuntu-latest]
     steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-node@v1
-      - name: Set up Ruby
-        uses: ruby/setup-ruby@v1
-        with:
-          ruby-version: 2.6 # Not needed with a .ruby-version file
-      - run: bundle install
-      - name: Install Zeus
-        run: |
-          yarn global add @zeus-ci/cli
-          echo "::add-path::$(yarn global bin)"
-      - name: Upload to Zeus
-        env:
-          ZEUS_API_TOKEN: ${{ secrets.ZEUS_API_TOKEN }}
-          ZEUS_HOOK_BASE: ${{ secrets.ZEUS_HOOK_BASE }}
-        run: |
-          zeus job update -b $GITHUB_RUN_ID -j $GITHUB_RUN_NUMBER -r $GITHUB_SHA
-          gem build sentry-raven.gemspec
-          zeus upload -b $GITHUB_RUN_ID -j $GITHUB_RUN_NUMBER -t "application/tar+gem" ./*.gem
-          zeus job update --status=passed -b $GITHUB_RUN_ID -j $GITHUB_RUN_NUMBER -r $GITHUB_SHA
+    - name: Set up Ruby ${{ matrix.ruby_version }}
+      uses: ruby/setup-ruby@v1
+      with:
+        bundler: 1
+        ruby-version: ${{ matrix.ruby_version }}
+
+    - uses: actions/checkout@v2
+      with:
+        ref: master
+
+    - name: Build and run allocation report on master
+      run: |
+        bundle install --jobs 4 --retry 3
+        bundle exec ruby benchmarks/allocation_comparison.rb
+
+    - uses: actions/checkout@v1
+
+    - name: Rebuild on the branch
+      run: |
+        bundle install --jobs 4 --retry 3
+    - name: Run allocation report on the branch
+      run: |
+        bundle exec ruby benchmarks/allocation_comparison.rb

data/.github/workflows/zeus_upload.yml

@@ -0,0 +1,32 @@
+name: Zeus Upload
+
+on:
+  push:
+    branches:
+      - release/**
+
+jobs:
+  zeus_upload:
+    name: Zeus
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v1
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 2.6 # Not needed with a .ruby-version file
+      - run: bundle install
+      - name: Install Zeus
+        run: |
+          yarn global add @zeus-ci/cli
+          echo "::add-path::$(yarn global bin)"
+      - name: Upload to Zeus
+        env:
+          ZEUS_API_TOKEN: ${{ secrets.ZEUS_API_TOKEN }}
+          ZEUS_HOOK_BASE: ${{ secrets.ZEUS_HOOK_BASE }}
+        run: |
+          zeus job update -b $GITHUB_RUN_ID -j $GITHUB_RUN_NUMBER -r $GITHUB_SHA
+          gem build sentry-raven.gemspec
+          zeus upload -b $GITHUB_RUN_ID -j $GITHUB_RUN_NUMBER -t "application/tar+gem" ./*.gem
+          zeus job update --status=passed -b $GITHUB_RUN_ID -j $GITHUB_RUN_NUMBER -r $GITHUB_SHA

data/{changelog.md → CHANGELOG.md}

@@ -2,17 +2,25 @@
 
 ## Unreleased
 
+## 3.0.3
+
+- fix: Ensure Processor::Cookie can run after Processor::RemoveCircularReferences (#996)
+- fix: Avoid mutating user passed in options (#994)
+- fix: Fix/Refactor Raven::Cli (#989)
+- ref: Refactor Raven::Client class (#995)
+  - It adds `Event#message_from_exception` and `Event#log_message` interfaces
+
 ## 3.0.2
 
-* fix: Add gem target for craft
+- fix: Add gem target for craft
 
 ## 3.0.1
 
-* fix: Improve SanitizeData processor (#984)
-* fix: Masking cookies as key/pair instead of a single string (#983)
-* fix: Transports classes' requiring issue (#986)
-* fix: Frozen string issues (#977)
-* feat: Officially support Rails 6 (#982)
+- fix: Improve SanitizeData processor (#984)
+- fix: Masking cookies as key/pair instead of a single string (#983)
+- fix: Transports classes' requiring issue (#986)
+- fix: Frozen string issues (#977)
+- feat: Officially support Rails 6 (#982)
 
 3.0.0
 ----
@@ -499,7 +507,7 @@ OTHER CHANGES:
 0.12.0
 ------
 
-- You can now give additional fields to the SanitizeData processor. Values matched are replaced by the string mask (*********). Full documentation (and how to use with Rails config.filter_parameters) [here](https://docs.getsentry.com/hosted/clients/ruby/config/). [jamescway, #232]
+- You can now give additional fields to the SanitizeData processor. Values matched are replaced by the string mask (*********). Full documentation (and how to use with Rails config.filter_parameters) [here](https://docs.sentry.io/platforms/ruby/config/). [jamescway, #232]
 - An additional processor has been added, though it isn't turned on by default: RemoveStacktrace. Use it to remove stacktraces from exception reports. [nateberkopec, #233]
 - Dependency on `uuidtools` has been removed. [nateberkopec, #231]
 

data/CONTRIUTING.md

@@ -0,0 +1,26 @@
+<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/Gemfile

@@ -2,9 +2,10 @@ source "https://rubygems.org/"
 
 gemspec
 
-rails_version = ENV["RAILS_VERSION"].to_f
+rails_version = ENV["RAILS_VERSION"]
+rails_version = "5.2" if rails_version.nil?
 
-if rails_version != 0
+if rails_version.to_f != 0
   gem "rails", "~> #{rails_version}"
   gem "rspec-rails", "~> 4.0"
 end
@@ -16,7 +17,9 @@ gem "rack-timeout"
 
 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"

data/README.md

@@ -30,7 +30,7 @@ We test on Ruby 2.3, 2.4, 2.5, 2.6 and 2.7 at the latest patchlevel/teeny versio
 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!
 
@@ -39,7 +39,7 @@ Raven will capture and send exceptions to the Sentry server whenever its DSN is
 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@example.com/project-id'
 end
@@ -49,11 +49,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.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/config/)
 
 ### 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/integrations/) for more details on other gems Sentry integrates with automatically.
 
 Otherwise, Raven supports two methods of capturing exceptions:
 

data/lib/raven/base.rb

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

data/lib/raven/cli.rb

@@ -18,7 +18,7 @@ module Raven
 
       # wipe out env settings to ensure we send the event
       unless config.capture_allowed?
-        env_name = config.environments.pop || 'production'
+        env_name = config.environments.last || 'production'
         config.current_environment = env_name
       end
 
@@ -33,27 +33,16 @@ module Raven
         evt = instance.capture_exception(e)
       end
 
-      if evt && !(evt.is_a? Thread)
-        if evt.is_a? Hash
-          instance.logger.debug "-> event ID: #{evt[:event_id]}"
-        else
-          instance.logger.debug "-> event ID: #{evt.id}"
-        end
-      elsif evt # async configuration
-        if evt.value.is_a? Hash
-          instance.logger.debug "-> event ID: #{evt.value[:event_id]}"
-        else
-          instance.logger.debug "-> event ID: #{evt.value.id}"
-        end
+      if evt
+        instance.logger.debug "-> event ID: #{evt.id}"
+        instance.logger.debug ""
+        instance.logger.debug "Done!"
+        evt
       else
         instance.logger.debug ""
         instance.logger.debug "An error occurred while attempting to send the event."
-        exit 1
+        false
       end
-
-      instance.logger.debug ""
-      instance.logger.debug "Done!"
-      evt
     end
   end
 end

data/lib/raven/client.rb

@@ -30,18 +30,15 @@ module Raven
         return
       end
 
-      # Convert to hash
-      event = event.to_hash
-
       unless @state.should_try?
         failed_send(nil, event)
         return
       end
 
-      event_id = event[:event_id] || event['event_id']
-      configuration.logger.info "Sending event #{event_id} to Sentry"
+      configuration.logger.info "Sending event #{event.event_id} to Sentry"
 
-      content_type, encoded_data = encode(event)
+      event_hash = event.to_hash
+      content_type, encoded_data = encode(event_hash)
 
       begin
         transport.send_event(generate_auth_header, encoded_data,
@@ -52,7 +49,7 @@ module Raven
         return
       end
 
-      event
+      event_hash
     end
 
     def transport
@@ -71,8 +68,8 @@ module Raven
 
     private
 
-    def encode(event)
-      hash = @processors.reduce(event.to_hash) { |a, e| e.process(a) }
+    def encode(event_hash)
+      hash = @processors.reduce(event_hash) { |a, e| e.process(a) }
       encoded = JSON.fast_generate(hash)
 
       case configuration.encoding
@@ -83,22 +80,6 @@ module Raven
       end
     end
 
-    def get_message_from_exception(event)
-      (
-        event &&
-        event[:exception] &&
-        event[:exception][:values] &&
-        event[:exception][:values][0] &&
-        event[:exception][:values][0][:type] &&
-        event[:exception][:values][0][:value] &&
-        "#{event[:exception][:values][0][:type]}: #{event[:exception][:values][0][:value]}"
-      )
-    end
-
-    def get_log_message(event)
-      (event && event[:message]) || (event && event['message']) || get_message_from_exception(event) || '<no message value>'
-    end
-
     def generate_auth_header
       now = Time.now.to_i.to_s
       fields = {
@@ -122,10 +103,12 @@ module Raven
       else
         configuration.logger.warn "Not sending event due to previous failure(s)."
       end
-      configuration.logger.warn("Failed to submit event: #{get_log_message(event)}")
+
+      event_message = event&.log_message || '<no message value>'
+      configuration.logger.warn("Failed to submit event: #{event_message}")
 
       # 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.to_hash) if configuration.transport_failure_callback # rubocop:disable Style/SafeNavigation
     end
   end
 

data/lib/raven/core_ext/object/deep_dup.rb

@@ -0,0 +1,57 @@
+require 'raven/core_ext/object/duplicable'
+
+#########################################
+#  This file was copied from Rails 5.2  #
+#########################################
+
+class Object
+  # Returns a deep copy of object if it's duplicable. If it's
+  # not duplicable, returns +self+.
+  #
+  #   object = Object.new
+  #   dup    = object.deep_dup
+  #   dup.instance_variable_set(:@a, 1)
+  #
+  #   object.instance_variable_defined?(:@a) # => false
+  #   dup.instance_variable_defined?(:@a)    # => true
+  def deep_dup
+    duplicable? ? dup : self
+  end
+end
+
+class Array
+  # Returns a deep copy of array.
+  #
+  #   array = [1, [2, 3]]
+  #   dup   = array.deep_dup
+  #   dup[1][2] = 4
+  #
+  #   array[1][2] # => nil
+  #   dup[1][2]   # => 4
+  def deep_dup
+    map(&:deep_dup)
+  end
+end
+
+class Hash
+  # Returns a deep copy of hash.
+  #
+  #   hash = { a: { b: 'b' } }
+  #   dup  = hash.deep_dup
+  #   dup[:a][:c] = 'c'
+  #
+  #   hash[:a][:c] # => nil
+  #   dup[:a][:c]  # => "c"
+  def deep_dup
+    hash = dup
+    each_pair do |key, value|
+      if key.frozen? && ::String === key
+        hash[key] = value.deep_dup
+      else
+        hash.delete(key)
+        hash[key.deep_dup] = value.deep_dup
+      end
+    end
+    hash
+  end
+end

data/lib/raven/core_ext/object/duplicable.rb

@@ -0,0 +1,153 @@
+# frozen_string_literal: true
+
+#########################################
+#  This file was copied from Rails 5.2  #
+#########################################
+
+#--
+# Most objects are cloneable, but not all. For example you can't dup methods:
+#
+#   method(:puts).dup # => TypeError: allocator undefined for Method
+#
+# Classes may signal their instances are not duplicable removing +dup+/+clone+
+# or raising exceptions from them. So, to dup an arbitrary object you normally
+# use an optimistic approach and are ready to catch an exception, say:
+#
+#   arbitrary_object.dup rescue object
+#
+# Rails dups objects in a few critical spots where they are not that arbitrary.
+# That rescue is very expensive (like 40 times slower than a predicate), and it
+# is often triggered.
+#
+# That's why we hardcode the following cases and check duplicable? instead of
+# using that rescue idiom.
+#++
+class Object
+  # Can you safely dup this object?
+  #
+  # False for method objects;
+  # true otherwise.
+  def duplicable?
+    true
+  end
+end
+
+class NilClass
+  begin
+    nil.dup
+  rescue TypeError
+    # +nil+ is not duplicable:
+    #
+    #   nil.duplicable? # => false
+    #   nil.dup         # => TypeError: can't dup NilClass
+    def duplicable?
+      false
+    end
+  end
+end
+
+class FalseClass
+  begin
+    false.dup
+  rescue TypeError
+    # +false+ is not duplicable:
+    #
+    #   false.duplicable? # => false
+    #   false.dup         # => TypeError: can't dup FalseClass
+    def duplicable?
+      false
+    end
+  end
+end
+
+class TrueClass
+  begin
+    true.dup
+  rescue TypeError
+    # +true+ is not duplicable:
+    #
+    #   true.duplicable? # => false
+    #   true.dup         # => TypeError: can't dup TrueClass
+    def duplicable?
+      false
+    end
+  end
+end
+
+class Symbol
+  begin
+    :symbol.dup # Ruby 2.4.x.
+    "symbol_from_string".to_sym.dup # Some symbols can't `dup` in Ruby 2.4.0.
+  rescue TypeError
+    # Symbols are not duplicable:
+    #
+    #   :my_symbol.duplicable? # => false
+    #   :my_symbol.dup         # => TypeError: can't dup Symbol
+    def duplicable?
+      false
+    end
+  end
+end
+
+class Numeric
+  begin
+    1.dup
+  rescue TypeError
+    # Numbers are not duplicable:
+    #
+    #  3.duplicable? # => false
+    #  3.dup         # => TypeError: can't dup Integer
+    def duplicable?
+      false
+    end
+  end
+end
+
+require "bigdecimal"
+class BigDecimal
+  # BigDecimals are duplicable:
+  #
+  #   BigDecimal("1.2").duplicable? # => true
+  #   BigDecimal("1.2").dup         # => #<BigDecimal:...,'0.12E1',18(18)>
+  def duplicable?
+    true
+  end
+end
+
+class Method
+  # Methods are not duplicable:
+  #
+  #  method(:puts).duplicable? # => false
+  #  method(:puts).dup         # => TypeError: allocator undefined for Method
+  def duplicable?
+    false
+  end
+end
+
+class Complex
+  begin
+    Complex(1).dup
+  rescue TypeError
+    # Complexes are not duplicable:
+    #
+    #   Complex(1).duplicable? # => false
+    #   Complex(1).dup         # => TypeError: can't copy Complex
+    def duplicable?
+      false
+    end
+  end
+end
+
+class Rational
+  begin
+    Rational(1).dup
+  rescue TypeError
+    # Rationals are not duplicable:
+    #
+    #   Rational(1).duplicable? # => false
+    #   Rational(1).dup         # => TypeError: can't copy Rational
+    def duplicable?
+      false
+    end
+  end
+end

data/lib/raven/event.rb

@@ -136,6 +136,25 @@ module Raven
       JSON.parse(JSON.generate(cleaned_hash))
     end
 
+    def message_from_exception
+      exception = @interfaces[:exception]
+
+      return unless exception
+
+      exception = exception.to_hash
+
+      type = exception.dig(:values, 0, :type)
+      value = exception.dig(:values, 0, :value)
+
+      if type && value
+        "#{type}: #{value}"
+      end
+    end
+
+    def log_message
+      message || message_from_exception
+    end
+
     def add_exception_interface(exc)
       interface(:exception) do |exc_int|
         exceptions = Raven::Utils::ExceptionCauseChain.exception_to_array(exc).reverse

data/lib/raven/instance.rb

@@ -110,6 +110,7 @@ module Raven
       end
 
       message_or_exc = obj.is_a?(String) ? "message" : "exception"
+      options = options.deep_dup
       options[:configuration] = configuration
       options[:context] = context
       if evt = Event.send("from_" + message_or_exc, obj, options)

data/lib/raven/processor/cookies.rb

@@ -30,7 +30,7 @@ module Raven
     end
 
     def generate_masked_cookies(cookies)
-      cookies.merge(cookies) { STRING_MASK }
+      cookies.merge(cookies) { STRING_MASK } if cookies.respond_to?(:merge)
     end
   end
 end

data/lib/raven/processor/removecircularreferences.rb

@@ -1,7 +1,8 @@
 module Raven
   class Processor::RemoveCircularReferences < Processor
+    ELISION_STRING = "(...)".freeze
     def process(value, visited = [])
-      return "(...)" if visited.include?(value.__id__)
+      return ELISION_STRING if visited.include?(value.__id__)
 
       visited << value.__id__ if value.is_a?(Array) || value.is_a?(Hash)
 

data/lib/raven/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Raven
-  VERSION = "3.0.2"
+  VERSION = "3.0.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sentry-raven
 version: !ruby/object:Gem::Version
-  version: 3.0.2
+  version: 3.0.3
 platform: ruby
 authors:
 - Sentry Team
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-08-20 00:00:00.000000000 Z
+date: 2020-08-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -35,16 +35,18 @@ extra_rdoc_files:
 files:
 - ".craft.yml"
 - ".github/workflows/test.yml"
+- ".github/workflows/zeus_upload.yml"
 - ".gitignore"
 - ".gitmodules"
 - ".rspec"
 - ".rubocop.yml"
 - ".scripts/bump-version.sh"
+- CHANGELOG.md
+- CONTRIUTING.md
 - Gemfile
 - LICENSE
 - README.md
 - Rakefile
-- changelog.md
 - exe/raven
 - lib/raven.rb
 - lib/raven/backtrace.rb
@@ -56,6 +58,8 @@ files:
 - lib/raven/client.rb
 - lib/raven/configuration.rb
 - lib/raven/context.rb
+- lib/raven/core_ext/object/deep_dup.rb
+- lib/raven/core_ext/object/duplicable.rb
 - lib/raven/event.rb
 - lib/raven/instance.rb
 - lib/raven/integrations/delayed_job.rb