airbrake-ruby 2.2.3 → 2.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 03b38987d8ca77dcd6c8302246192bd1a9184854
-  data.tar.gz: 93f4e52998430af6c6bcce0bca5e1b6dae3202ae
+  metadata.gz: 076ef6e377b4e2fbc3a5cce600393a13390da43c
+  data.tar.gz: 8b31cc49491997971856b5c2d1480c00881f5058
 SHA512:
-  metadata.gz: 9f2ae08f59cb532ca0313d7d16eebab0ea9e54c5796048c57fc6418d2c7b18d37744450651f4743d4147b7288aba6f25ae0d8db88d0135104a50d35444d59be1
-  data.tar.gz: 0a327f231fea3629de145c84570c17f48a5f0e9c37050ed0a3f53ab8cea9d59d83c17c03066c4e025051d6f0870b9b0e5591345e1d76f554a42744b0a55949b0
+  metadata.gz: b65105fb50ef5098b1bbfa489387e48f785fcdd8ba25dc7ac306c817385719b8fb9af684b11c447a98740dcc1a2cee17fc65376bc6934150f7f26e268c8ea88d
+  data.tar.gz: 8ef30b2ef9aa0a652de4c9ef1a3a0a9f8b7d60018f9441bae0e7ebe16c79fe0a793290b666132b4adf447bfcdfc4ec9c6610459471f02d9ec0d1cd5b0cabc1ad

data/lib/airbrake-ruby.rb

@@ -15,8 +15,7 @@ require 'airbrake-ruby/response'
 require 'airbrake-ruby/nested_exception'
 require 'airbrake-ruby/notice'
 require 'airbrake-ruby/backtrace'
-require 'airbrake-ruby/payload_truncator'
-require 'airbrake-ruby/filters'
+require 'airbrake-ruby/truncator'
 require 'airbrake-ruby/filters/keys_filter'
 require 'airbrake-ruby/filters/keys_whitelist'
 require 'airbrake-ruby/filters/keys_blacklist'

data/lib/airbrake-ruby/filter_chain.rb

@@ -19,33 +19,9 @@ module Airbrake
     # @return [Integer]
     DEFAULT_WEIGHT = 0
 
-    ##
-    # @param [Airbrake::Config] config
-    def initialize(config)
+    def initialize
       @filters = []
-
       DEFAULT_FILTERS.each { |f| add_filter(f.new) }
-
-      if config.whitelist_keys.any?
-        add_filter(
-          Airbrake::Filters::KeysWhitelist.new(
-            config.logger,
-            config.whitelist_keys
-          )
-        )
-      end
-
-      if config.blacklist_keys.any?
-        add_filter(
-          Airbrake::Filters::KeysBlacklist.new(
-            config.logger,
-            config.blacklist_keys
-          )
-        )
-      end
-
-      return unless (root_directory = config.root_directory)
-      add_filter(Airbrake::Filters::RootDirectoryFilter.new(root_directory))
     end
 
     ##

data/lib/airbrake-ruby/filters/keys_filter.rb

@@ -18,6 +18,11 @@ module Airbrake
       #   which can compared with payload keys
       VALID_PATTERN_CLASSES = [String, Symbol, Regexp].freeze
 
+      ##
+      # @return [Array<Symbol>] parts of a Notice's payload that can be modified
+      #   by blacklist/whitelist filters
+      FILTERABLE_KEYS = %i[environment session params].freeze
+
       ##
       # @return [Integer]
       attr_reader :weight

data/lib/airbrake-ruby/filters/thread_filter.rb

@@ -9,13 +9,16 @@ module Airbrake
       attr_reader :weight
 
       ##
-      # @return [Array<Symbol>] the list of ignored fiber variables
-      IGNORED_FIBER_VARIABLES = [
-        # https://github.com/airbrake/airbrake-ruby/issues/204
-        :__recursive_key__,
-
-        # https://github.com/rails/rails/issues/28996
-        :__rspec
+      # @return [Array<Class>] the list of classes that can be safely converted
+      #   to JSON
+      SAFE_CLASSES = [
+        NilClass,
+        TrueClass,
+        FalseClass,
+        String,
+        Symbol,
+        Regexp,
+        Numeric
       ].freeze
 
       def initialize
@@ -48,16 +51,13 @@ module Airbrake
 
       def thread_variables(th)
         th.thread_variables.map.with_object({}) do |var, h|
-          next if (value = th.thread_variable_get(var)).is_a?(IO)
-          h[var] = value
+          h[var] = sanitize_value(th.thread_variable_get(var))
         end
       end
 
       def fiber_variables(th)
         th.keys.map.with_object({}) do |key, h|
-          next if IGNORED_FIBER_VARIABLES.any? { |v| v == key }
-          next if (value = th[key]).is_a?(IO)
-          h[key] = value
+          h[key] = sanitize_value(th[key])
         end
       end
 
@@ -68,6 +68,19 @@ module Airbrake
 
         thread_info[:safe_level] = th.safe_level unless Airbrake::JRUBY
       end
+
+      def sanitize_value(value)
+        return value if SAFE_CLASSES.any? { |klass| value.is_a?(klass) }
+
+        case value
+        when Array
+          value = value.map { |elem| sanitize_value(elem) }
+        when Hash
+          Hash[value.map { |k, v| [k, sanitize_value(v)] }]
+        else
+          value.to_s
+        end
+      end
     end
   end
 end

data/lib/airbrake-ruby/notice.rb

@@ -4,7 +4,6 @@ module Airbrake
   # Airbrake or ignored completely.
   #
   # @since v1.0.0
-  # rubocop:disable Metrics/ClassLength
   class Notice
     ##
     # @return [Hash{Symbol=>String}] the information about the notifier library
@@ -44,13 +43,12 @@ module Airbrake
 
     # @return [Array<Symbol>] the list of keys that can be be overwritten with
     #   {Airbrake::Notice#[]=}
-    WRITABLE_KEYS = %i[
-      notifier
-      context
-      environment
-      session
-      params
-    ].freeze
+    WRITABLE_KEYS = %i[notifier context environment session params].freeze
+
+    ##
+    # @return [Array<Symbol>] parts of a Notice's payload that can be modified
+    #   by the truncator
+    TRUNCATABLE_KEYS = %i[errors environment session params].freeze
 
     ##
     # @return [String] the name of the host machine
@@ -77,10 +75,9 @@ module Airbrake
         params: params
       }
       @stash = {}
+      @truncator = Airbrake::Truncator.new(PAYLOAD_MAX_SIZE)
 
       extract_custom_attributes(exception)
-
-      @truncator = PayloadTruncator.new(PAYLOAD_MAX_SIZE, @config.logger)
     end
 
     ##
@@ -99,7 +96,7 @@ module Airbrake
           return json if json && json.bytesize <= MAX_NOTICE_SIZE
         end
 
-        break if truncate_payload.zero?
+        break if truncate == 0
       end
     end
 
@@ -184,17 +181,11 @@ module Airbrake
       raise Airbrake::Error, "Got #{value.class} value, wanted a Hash"
     end
 
-    def truncate_payload
-      @payload[:errors].each do |error|
-        @truncator.truncate_error(error)
-      end
-
-      Filters::FILTERABLE_KEYS.each do |key|
-        @truncator.truncate_object(@payload[key])
-      end
+    def truncate
+      TRUNCATABLE_KEYS.each { |key| @truncator.truncate_object(self[key]) }
 
       new_max_size = @truncator.reduce_max_size
-      if new_max_size.zero?
+      if new_max_size == 0
         @config.logger.error(
           "#{LOG_LABEL} truncation failed. File an issue at " \
           "https://github.com/airbrake/airbrake-ruby " \
@@ -229,5 +220,4 @@ module Airbrake
       end
     end
   end
-  # rubocop:enable Metrics/ClassLength
 end

data/lib/airbrake-ruby/notifier.rb

@@ -33,7 +33,8 @@ module Airbrake
         raise Airbrake::Error, @config.validation_error_message
       end
 
-      @filter_chain = FilterChain.new(@config)
+      @filter_chain = FilterChain.new
+      add_default_filters
 
       @async_sender = AsyncSender.new(@config)
       @sync_sender = SyncSender.new(@config)
@@ -145,6 +146,25 @@ module Airbrake
       return caller_copy if clean_bt.empty?
       clean_bt
     end
+
+    def add_default_filters
+      if (whitelist_keys = @config.whitelist_keys).any?
+        @filter_chain.add_filter(
+          Airbrake::Filters::KeysWhitelist.new(@config.logger, whitelist_keys)
+        )
+      end
+
+      if (blacklist_keys = @config.blacklist_keys).any?
+        @filter_chain.add_filter(
+          Airbrake::Filters::KeysBlacklist.new(@config.logger, blacklist_keys)
+        )
+      end
+
+      return unless (root_directory = @config.root_directory)
+      @filter_chain.add_filter(
+        Airbrake::Filters::RootDirectoryFilter.new(root_directory)
+      )
+    end
   end
 
   ##
@@ -153,13 +173,13 @@ module Airbrake
   #
   # @since 2.1.0
   class NilNotifier
-    def notify(_exception, _params = {}); end
+    def notify(_exception, _params = {}, &block); end
 
-    def notify_sync(_exception, _params); end
+    def notify_sync(_exception, _params = {}, &block); end
 
     def add_filter(_filter = nil, &_block); end
 
-    def build_notice(_exception, _params); end
+    def build_notice(_exception, _params = {}); end
 
     def close; end
 

data/lib/airbrake-ruby/{payload_truncator.rb → truncator.rb}

@@ -5,7 +5,7 @@ module Airbrake
   #
   # @api private
   # @since v1.0.0
-  class PayloadTruncator
+  class Truncator
     ##
     # @return [Hash] the options for +String#encode+
     ENCODING_OPTIONS = { invalid: :replace, undef: :replace }.freeze
@@ -17,29 +17,8 @@ module Airbrake
 
     ##
     # @param [Integer] max_size maximum size of hashes, arrays and strings
-    # @param [Logger] logger the logger object
-    def initialize(max_size, logger)
+    def initialize(max_size)
       @max_size = max_size
-      @logger = logger
-    end
-
-    ##
-    # Truncates errors (not exceptions) to fit the limit.
-    #
-    # @param [Hash] error
-    # @option error [Symbol] :message
-    # @option error [Array<String>] :backtrace
-    # @return [void]
-    def truncate_error(error)
-      if error[:message].length > @max_size
-        error[:message] = truncate_string(error[:message])
-        @logger.info("#{LOG_LABEL} truncated the message of #{error[:type]}")
-      end
-
-      return if (dropped_frames = error[:backtrace].size - @max_size) < 0
-
-      error[:backtrace] = error[:backtrace].slice(0, @max_size)
-      @logger.info("#{LOG_LABEL} dropped #{dropped_frames} frame(s) from #{error[:type]}")
     end
 
     ##
@@ -49,26 +28,29 @@ module Airbrake
     # @param [Hash,Array] object The object to truncate
     # @param [Hash] seen The hash that helps to detect recursion
     # @return [void]
+    # @note This method is public to simplify testing. You probably want to use
+    #   {truncate_notice} instead
     def truncate_object(object, seen = {})
       return seen[object] if seen[object]
 
       seen[object] = '[Circular]'.freeze
-      truncated = if object.is_a?(Hash)
-                    truncate_hash(object, seen)
-                  elsif object.is_a?(Array)
-                    truncate_array(object, seen)
-                  elsif object.is_a?(Set)
-                    truncate_set(object, seen)
-                  else
-                    raise Airbrake::Error,
-                          "cannot truncate object: #{object} (#{object.class})"
-                  end
+      truncated =
+        if object.is_a?(Hash)
+          truncate_hash(object, seen)
+        elsif object.is_a?(Array)
+          truncate_array(object, seen)
+        elsif object.is_a?(Set)
+          truncate_set(object, seen)
+        else
+          raise Airbrake::Error,
+                "cannot truncate object: #{object} (#{object.class})"
+        end
       seen[object] = truncated
     end
 
     ##
     # Reduces maximum allowed size of the truncated object.
-    # @return [void]
+    # @return [Integer] current +max_size+ value
     def reduce_max_size
       @max_size /= 2
     end
@@ -84,11 +66,12 @@ module Airbrake
       when Numeric, TrueClass, FalseClass, Symbol, NilClass
         val
       else
-        stringified_val = begin
-                            val.to_json
-                          rescue *Notice::JSON_EXCEPTIONS
-                            val.to_s
-                          end
+        stringified_val =
+          begin
+            val.to_json
+          rescue *Notice::JSON_EXCEPTIONS
+            val.to_s
+          end
         truncate_string(stringified_val)
       end
     end

data/lib/airbrake-ruby/version.rb

@@ -4,5 +4,5 @@
 module Airbrake
   ##
   # @return [String] the library version
-  AIRBRAKE_RUBY_VERSION = '2.2.3'.freeze
+  AIRBRAKE_RUBY_VERSION = '2.2.4'.freeze
 end

data/spec/filter_chain_spec.rb

@@ -1,222 +1,46 @@
 require 'spec_helper'
 
 RSpec.describe Airbrake::FilterChain do
-  before do
-    @chain = described_class.new(config)
+  let(:notice) do
+    Airbrake::Notice.new(Airbrake::Config.new, AirbrakeTestError.new)
   end
 
-  let(:config) { Airbrake::Config.new }
-
   describe "#refine" do
-    describe "execution order" do
-      let(:notice) do
-        Airbrake::Notice.new(config, AirbrakeTestError.new)
-      end
-
-      it "executes keys filters last" do
-        notice[:params] = { bingo: 'bango' }
-        config.blacklist_keys = [:bingo]
-        @chain = described_class.new(config)
-
-        @chain.add_filter(
-          proc do |notice|
-            expect(notice[:params][:bingo]).to eq('bango')
-          end
-        )
-
-        @chain.refine(notice)
-        expect(notice[:params][:bingo]).to eq('[Filtered]')
-      end
-
-      describe "filter weight" do
-        let(:filter) do
-          Class.new do
-            attr_reader :weight
+    let(:filter) do
+      Class.new do
+        attr_reader :weight
 
-            def initialize(weight)
-              @weight = weight
-            end
-
-            def call(notice)
-              notice[:params][:bingo] << @weight
-            end
-          end
+        def initialize(weight)
+          @weight = weight
         end
 
-        it "executes filters from heaviest to lightest" do
-          notice[:params][:bingo] = []
-
-          (0...3).reverse_each do |i|
-            @chain.add_filter(filter.new(i))
-          end
-          @chain.refine(notice)
-
-          expect(notice[:params][:bingo]).to eq([2, 1, 0])
-        end
-
-        it "stops execution once a notice was ignored" do
-          f2 = filter.new(2)
-          expect(f2).to receive(:call)
-
-          f1 = proc { |notice| notice.ignore! }
-
-          f0 = filter.new(-1)
-          expect(f0).not_to receive(:call)
-
-          [f2, f1, f0].each { |f| @chain.add_filter(f) }
-
-          @chain.refine(notice)
+        def call(notice)
+          notice[:params][:bingo] << @weight
         end
       end
     end
 
-    describe "default backtrace filters" do
-      let(:ex) { AirbrakeTestError.new.tap { |e| e.set_backtrace(backtrace) } }
-      let(:notice) { Airbrake::Notice.new(config, ex) }
-
-      before do
-        Gem.path << '/my/gem/root' << '/my/other/gem/root'
-        @chain.refine(notice)
-        @bt = notice[:errors].first[:backtrace].map { |frame| frame[:file] }
-      end
-
-      shared_examples 'root directories' do |root_directory, bt, expected_bt|
-        let(:backtrace) { bt }
-
-        before do
-          config = Airbrake::Config.new(root_directory: root_directory)
-          chain = described_class.new(config)
-          chain.refine(notice)
-          @bt = notice[:errors].first[:backtrace].map { |frame| frame[:file] }
-        end
-
-        it "filters it out" do
-          expect(@bt).to eq(expected_bt)
-        end
-      end
-
-      # rubocop:disable Metrics/LineLength
-      context "gem root" do
-        bt = [
-          "/home/kyrylo/code/airbrake/ruby/spec/spec_helper.rb:23:in `<top (required)>'",
-          "/my/gem/root/gems/rspec-core-3.3.2/lib/rspec/core/configuration.rb:1327:in `load'",
-          "/opt/rubies/ruby-2.2.2/lib/ruby/2.2.0/rubygems/core_ext/kernel_require.rb:54:in `require'",
-          "/my/other/gem/root/gems/rspec-core-3.3.2/exe/rspec:4:in `<main>'"
-        ]
+    it "executes filters from heaviest to lightest" do
+      notice[:params][:bingo] = []
 
-        expected_bt = [
-          "/home/kyrylo/code/airbrake/ruby/spec/spec_helper.rb",
-          "[GEM_ROOT]/gems/rspec-core-3.3.2/lib/rspec/core/configuration.rb",
-          "/opt/rubies/ruby-2.2.2/lib/ruby/2.2.0/rubygems/core_ext/kernel_require.rb",
-          "[GEM_ROOT]/gems/rspec-core-3.3.2/exe/rspec"
-        ]
+      (0...3).reverse_each { |i| subject.add_filter(filter.new(i)) }
+      subject.refine(notice)
 
-        include_examples 'root directories', nil, bt, expected_bt
-      end
-
-      context "root directory" do
-        context "when normal string path" do
-          bt = [
-            "/home/kyrylo/code/airbrake/ruby/spec/spec_helper.rb:23:in `<top (required)>'",
-            "/var/www/project/gems/rspec-core-3.3.2/lib/rspec/core/configuration.rb:1327:in `load'",
-            "/opt/rubies/ruby-2.2.2/lib/ruby/2.2.0/rubygems/core_ext/kernel_require.rb:54:in `require'",
-            "/var/www/project/gems/rspec-core-3.3.2/exe/rspec:4:in `<main>'"
-          ]
-
-          expected_bt = [
-            "/home/kyrylo/code/airbrake/ruby/spec/spec_helper.rb",
-            "[PROJECT_ROOT]/gems/rspec-core-3.3.2/lib/rspec/core/configuration.rb",
-            "/opt/rubies/ruby-2.2.2/lib/ruby/2.2.0/rubygems/core_ext/kernel_require.rb",
-            "[PROJECT_ROOT]/gems/rspec-core-3.3.2/exe/rspec"
-          ]
-
-          include_examples 'root directories', '/var/www/project', bt, expected_bt
-        end
-
-        context "when equals to a part of filename" do
-          bt = [
-            "/home/kyrylo/code/airbrake/ruby/spec/spec_helper.rb:23:in `<top (required)>'",
-            "/var/www/gems/gems/rspec-core-3.3.2/lib/rspec/core/configuration.rb:1327:in `load'",
-            "/opt/rubies/ruby-2.2.2/lib/ruby/2.2.0/rubygems/core_ext/kernel_require.rb:54:in `require'",
-            "/var/www/gems/gems/rspec-core-3.3.2/exe/rspec:4:in `<main>'"
-          ]
-
-          expected_bt = [
-            "/home/kyrylo/code/airbrake/ruby/spec/spec_helper.rb",
-            "[PROJECT_ROOT]/gems/rspec-core-3.3.2/lib/rspec/core/configuration.rb",
-            "/opt/rubies/ruby-2.2.2/lib/ruby/2.2.0/rubygems/core_ext/kernel_require.rb",
-            "[PROJECT_ROOT]/gems/rspec-core-3.3.2/exe/rspec"
-          ]
-
-          include_examples 'root directories', '/var/www/gems', bt, expected_bt
-        end
-
-        context "when normal pathname path" do
-          bt = [
-            "/home/kyrylo/code/airbrake/ruby/spec/spec_helper.rb:23:in `<top (required)>'",
-            "/var/www/project/gems/rspec-core-3.3.2/lib/rspec/core/configuration.rb:1327:in `load'",
-            "/opt/rubies/ruby-2.2.2/lib/ruby/2.2.0/rubygems/core_ext/kernel_require.rb:54:in `require'",
-            "/var/www/project/gems/rspec-core-3.3.2/exe/rspec:4:in `<main>'"
-          ]
-
-          expected_bt = [
-            "/home/kyrylo/code/airbrake/ruby/spec/spec_helper.rb",
-            "[PROJECT_ROOT]/gems/rspec-core-3.3.2/lib/rspec/core/configuration.rb",
-            "/opt/rubies/ruby-2.2.2/lib/ruby/2.2.0/rubygems/core_ext/kernel_require.rb",
-            "[PROJECT_ROOT]/gems/rspec-core-3.3.2/exe/rspec"
-          ]
-
-          include_examples 'root directories',
-                           Pathname.new('/var/www/project'), bt, expected_bt
-        end
-      end
-      # rubocop:enable Metrics/LineLength
+      expect(notice[:params][:bingo]).to eq([2, 1, 0])
     end
 
-    describe "default ignore filters" do
-      context "system exit filter" do
-        it "marks SystemExit exceptions as ignored" do
-          notice = Airbrake::Notice.new(config, SystemExit.new)
-          expect { @chain.refine(notice) }.
-            to(change { notice.ignored? }.from(false).to(true))
-        end
-      end
-
-      context "gem root filter" do
-        let(:ex) do
-          AirbrakeTestError.new.tap do |error|
-            error.set_backtrace(['(unparseable/frame.rb:23)'])
-          end
-        end
-
-        it "does not filter file if it is nil" do
-          config.logger = Logger.new('/dev/null')
-          notice = Airbrake::Notice.new(config, ex)
+    it "stops execution once a notice was ignored" do
+      f2 = filter.new(2)
+      expect(f2).to receive(:call)
 
-          expect(notice[:errors].first[:file]).to be_nil
-          expect { @chain.refine(notice) }.
-            not_to(change { notice[:errors].first[:file] })
-        end
-      end
+      f1 = proc { |notice| notice.ignore! }
 
-      context "root directory filter" do
-        let(:ex) do
-          AirbrakeTestError.new.tap do |error|
-            error.set_backtrace(['(unparseable/frame.rb:23)'])
-          end
-        end
+      f0 = filter.new(-1)
+      expect(f0).not_to receive(:call)
 
-        it "does not filter file if it is nil" do
-          config.logger = Logger.new('/dev/null')
-          config.root_directory = '/bingo/bango'
-          notice = Airbrake::Notice.new(config, ex)
-          filter_chain = described_class.new(config)
+      [f2, f1, f0].each { |f| subject.add_filter(f) }
 
-          expect(notice[:errors].first[:file]).to be_nil
-          expect { filter_chain.refine(notice) }.
-            not_to(change { notice[:errors].first[:file] })
-        end
-      end
+      subject.refine(notice)
     end
   end
 end