airbrake-ruby 2.2.0 → 2.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 85e069b4c88a953affccceafa0e250aee3c34367
-  data.tar.gz: 349b91844712169716c97ba606cdebf6e200e908
+  metadata.gz: 21223403ddfa03e2f851d2cb5c4a74130e17840f
+  data.tar.gz: ab65e845c6053434813b8bbf0f23edaa80dad44d
 SHA512:
-  metadata.gz: d4fdabb0447a4c8b0ca06a45cb8ce371d35805c191253edec1bda3fd0581f60ae5382efbf7d64b56f5845d9444fcd145c73844c6dba94abbcff5b94aad00de8f
-  data.tar.gz: 4662128a6ad57a91659539296229fe7c0b824a6049abb32f64f9ab883be919a4ced5af56f38a3c768016b4477844eef5db30a600dceca0daa9c9e9822af973ef
+  metadata.gz: e045ca4229249ab1cfc9be1b5d94e72bc633134f4e6fbf34a8a3f16068a042823aa5e5fd09d085220de83313ab22c48bb1ab773549b776dbb64fc6a721356bf1
+  data.tar.gz: 24117e363c96f7cc6673c63cae41ab5306de8ed61bd03c08d6e011fb52cc17d2bf13d8394a797428ef0428ca151e3188995dff733cdb71d8693a22be1de112ce

data/lib/airbrake-ruby/filter_chain.rb

@@ -8,48 +8,55 @@ module Airbrake
   # @since v1.0.0
   class FilterChain
     ##
-    # @return [String] the namespace for filters, which are executed first,
-    #   before any other filters
-    LIB_NAMESPACE = '#<Airbrake::'.freeze
+    # @return [Array<Class>] filters to be executed first
+    DEFAULT_FILTERS = [
+      Airbrake::Filters::SystemExitFilter,
+      Airbrake::Filters::GemRootFilter,
+      Airbrake::Filters::ThreadFilter
+    ].freeze
 
     ##
-    # Filters to be executed last. By this time all permutations on a notice
-    # should be done, so the final step is to blacklist/whitelist keys.
-    # @return [Array<Class>]
-    KEYS_FILTERS = [
-      Airbrake::Filters::KeysBlacklist,
-      Airbrake::Filters::KeysWhitelist
-    ].freeze
+    # @return [Integer]
+    DEFAULT_WEIGHT = 0
 
     ##
     # @param [Airbrake::Config] config
     def initialize(config)
       @filters = []
-      @keys_filters = []
 
-      [Airbrake::Filters::SystemExitFilter,
-       Airbrake::Filters::GemRootFilter,
-       Airbrake::Filters::ThreadFilter].each do |filter|
-        @filters << filter.new
+      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
 
-      root_directory = config.root_directory
-      return unless root_directory
+      if config.blacklist_keys.any?
+        add_filter(
+          Airbrake::Filters::KeysBlacklist.new(
+            config.logger,
+            config.blacklist_keys
+          )
+        )
+      end
 
-      @filters << Airbrake::Filters::RootDirectoryFilter.new(root_directory)
+      return unless (root_directory = config.root_directory)
+      add_filter(Airbrake::Filters::RootDirectoryFilter.new(root_directory))
     end
 
     ##
-    # Adds a filter to the filter chain.
+    # Adds a filter to the filter chain. Sorts filters by weight.
     #
     # @param [#call] filter The filter object (proc, class, module, etc)
     # @return [void]
     def add_filter(filter)
-      return @keys_filters << filter if KEYS_FILTERS.include?(filter.class)
-      return @filters << filter unless filter.to_s.start_with?(LIB_NAMESPACE)
-
-      i = @filters.rindex { |f| f.to_s.start_with?(LIB_NAMESPACE) }
-      @filters.insert(i + 1, filter) if i
+      @filters = (@filters << filter).sort_by do |f|
+        f.respond_to?(:weight) ? f.weight : DEFAULT_WEIGHT
+      end.reverse!
     end
 
     ##
@@ -59,7 +66,7 @@ module Airbrake
     # @param [Airbrake::Notice] notice The notice to be filtered
     # @return [void]
     def refine(notice)
-      (@filters + @keys_filters).each do |filter|
+      @filters.each do |filter|
         break if notice.ignored?
         filter.call(notice)
       end

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

@@ -7,6 +7,14 @@ module Airbrake
       # @return [String]
       GEM_ROOT_LABEL = '[GEM_ROOT]'.freeze
 
+      ##
+      # @return [Integer]
+      attr_reader :weight
+
+      def initialize
+        @weight = 120
+      end
+
       def call(notice)
         return unless defined?(Gem)
 

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

@@ -26,6 +26,11 @@ module Airbrake
     class KeysBlacklist
       include KeysFilter
 
+      def initialize(*)
+        super
+        @weight = -110
+      end
+
       ##
       # @return [Boolean] true if the key matches at least one pattern, false
       #   otherwise

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

@@ -18,12 +18,16 @@ module Airbrake
       #   which can compared with payload keys
       VALID_PATTERN_CLASSES = [String, Symbol, Regexp].freeze
 
+      ##
+      # @return [Integer]
+      attr_reader :weight
+
       ##
       # Creates a new KeysBlacklist or KeysWhitelist filter that uses the given
       # +patterns+ for filtering a notice's payload.
       #
       # @param [Array<String,Regexp,Symbol>] patterns
-      def initialize(logger, *patterns)
+      def initialize(logger, patterns)
         @logger = logger
         @patterns = patterns
         @valid_patterns = false

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

@@ -26,6 +26,11 @@ module Airbrake
     class KeysWhitelist
       include KeysFilter
 
+      def initialize(*)
+        super
+        @weight = -100
+      end
+
       ##
       # @return [Boolean] true if the key doesn't match any pattern, false
       #   otherwise.

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

@@ -7,8 +7,13 @@ module Airbrake
       # @return [String]
       PROJECT_ROOT_LABEL = '[PROJECT_ROOT]'.freeze
 
+      ##
+      # @return [Integer]
+      attr_reader :weight
+
       def initialize(root_directory)
         @root_directory = root_directory
+        @weight = 100
       end
 
       def call(notice)

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

@@ -7,6 +7,14 @@ module Airbrake
       # @return [String]
       SYSTEM_EXIT_TYPE = 'SystemExit'.freeze
 
+      ##
+      # @return [Integer]
+      attr_reader :weight
+
+      def initialize
+        @weight = 130
+      end
+
       def call(notice)
         return if notice[:errors].none? { |error| error[:type] == SYSTEM_EXIT_TYPE }
         notice.ignore!

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

@@ -4,6 +4,14 @@ module Airbrake
     # Attaches thread & fiber local variables along with general thread
     # information.
     class ThreadFilter
+      ##
+      # @return [Integer]
+      attr_reader :weight
+
+      def initialize
+        @weight = 110
+      end
+
       def call(notice)
         th = Thread.current
         thread_info = {}
@@ -30,12 +38,17 @@ module Airbrake
 
       def thread_variables(th)
         th.thread_variables.map.with_object({}) do |var, h|
-          h[var] = th.thread_variable_get(var).inspect
+          next if (value = th.thread_variable_get(var)).is_a?(IO)
+          h[var] = value
         end
       end
 
       def fiber_variables(th)
-        th.keys.map.with_object({}) { |key, h| h[key] = th[key].inspect }
+        th.keys.map.with_object({}) do |key, h|
+          next if key == :__recursive_key__
+          next if (value = th[key]).is_a?(IO)
+          h[key] = value
+        end
       end
 
       def add_thread_info(th, thread_info)

data/lib/airbrake-ruby/notifier.rb

@@ -35,8 +35,6 @@ module Airbrake
 
       @filter_chain = FilterChain.new(@config)
 
-      add_filters_for_config_keys
-
       @async_sender = AsyncSender.new(@config)
       @sync_sender = SyncSender.new(@config)
     end
@@ -147,16 +145,6 @@ module Airbrake
       return caller_copy if clean_bt.empty?
       clean_bt
     end
-
-    def add_filters_for_config_keys
-      if @config.blacklist_keys.any?
-        add_filter(Filters::KeysBlacklist.new(@config.logger, *@config.blacklist_keys))
-      end
-
-      return if @config.whitelist_keys.none?
-
-      add_filter(Filters::KeysWhitelist.new(@config.logger, *@config.whitelist_keys))
-    end
   end
 
   ##

data/lib/airbrake-ruby/version.rb

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

data/spec/filter_chain_spec.rb

@@ -13,37 +13,10 @@ RSpec.describe Airbrake::FilterChain do
         Airbrake::Notice.new(config, AirbrakeTestError.new)
       end
 
-      it "executes filters starting from the oldest" do
-        nums = []
-
-        3.times do |i|
-          @chain.add_filter(proc { nums << i })
-        end
-
-        @chain.refine(notice)
-
-        expect(nums).to eq([0, 1, 2])
-      end
-
-      it "stops execution once a notice was ignored" do
-        nums = []
-
-        5.times do |i|
-          @chain.add_filter(proc do |notice|
-                              nums << i
-                              notice.ignore! if i == 2
-                            end)
-        end
-
-        @chain.refine(notice)
-
-        expect(nums).to eq([0, 1, 2])
-      end
-
       it "executes keys filters last" do
         notice[:params] = { bingo: 'bango' }
-        blacklist = Airbrake::Filters::KeysBlacklist.new(config.logger, :bingo)
-        @chain.add_filter(blacklist)
+        config.blacklist_keys = [:bingo]
+        @chain = described_class.new(config)
 
         @chain.add_filter(
           proc do |notice|
@@ -55,20 +28,45 @@ RSpec.describe Airbrake::FilterChain do
         expect(notice[:params][:bingo]).to eq('[Filtered]')
       end
 
-      it "executes library filters before user ones" do
-        nums = []
+      describe "filter weight" do
+        let(:filter) do
+          Class.new do
+            attr_reader :weight
 
-        @chain.add_filter(proc { nums << 2 })
+            def initialize(weight)
+              @weight = weight
+            end
 
-        priority_filter = proc { nums << 1 }
-        def priority_filter.to_s
-          '#<Airbrake::'
+            def call(notice)
+              notice[:params][:bingo] << @weight
+            end
+          end
         end
-        @chain.add_filter(priority_filter)
 
-        @chain.refine(notice)
+        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! }
 
-        expect(nums).to eq([1, 2])
+          f0 = filter.new(-1)
+          expect(f0).not_to receive(:call)
+
+          [f2, f1, f0].each { |f| @chain.add_filter(f) }
+
+          @chain.refine(notice)
+        end
       end
     end
 

data/spec/filters/thread_filter_spec.rb

@@ -11,7 +11,7 @@ RSpec.describe Airbrake::Filters::ThreadFilter do
     subject.call(notice)
     th.thread_variable_set(:bingo, nil)
 
-    expect(notice[:params][:thread][:thread_variables][:bingo]).to eq(':bango')
+    expect(notice[:params][:thread][:thread_variables][:bingo]).to eq(:bango)
   end
 
   it "appends fiber variables" do
@@ -19,7 +19,7 @@ RSpec.describe Airbrake::Filters::ThreadFilter do
     subject.call(notice)
     th[:bingo] = nil
 
-    expect(notice[:params][:thread][:fiber_variables][:bingo]).to eq(':bango')
+    expect(notice[:params][:thread][:fiber_variables][:bingo]).to eq(:bango)
   end
 
   it "appends name", skip: !Thread.current.respond_to?(:name) do
@@ -49,4 +49,32 @@ RSpec.describe Airbrake::Filters::ThreadFilter do
     subject.call(notice)
     expect(notice[:params][:thread][:safe_level]).to eq(0)
   end
+
+  context "when an IO-like object is stored" do
+    let(:io_obj) do
+      Class.new(IO) do
+        def initialize; end
+      end.new
+    end
+
+    before do
+      expect(io_obj).to be_is_a(IO)
+    end
+
+    it "doesn't append the IO object to thread variables" do
+      th.thread_variable_set(:io, io_obj)
+      subject.call(notice)
+      th.thread_variable_set(:io, nil)
+
+      expect(notice[:params][:thread][:thread_variables][:io]).to be_nil
+    end
+
+    it "doesn't append the IO object to thread variables" do
+      th[:io] = io_obj
+      subject.call(notice)
+      th[:io] = nil
+
+      expect(notice[:params][:thread][:fiber_variables][:io]).to be_nil
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: airbrake-ruby
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.2.1
 platform: ruby
 authors:
 - Airbrake Technologies, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-01 00:00:00.000000000 Z
+date: 2017-05-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -168,7 +168,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.2.5
 signing_key: 
 specification_version: 4
 summary: Ruby notifier for https://airbrake.io