airbrake-ruby 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: feeb44b47c5b58cdf1f478065f84640af9102ab9
-  data.tar.gz: 2319d39125a79fb075a3a629fa3dc8c927e95dc2
+  metadata.gz: 28a4924a3ba67bad999146c40bb8b4a18d42c07e
+  data.tar.gz: 08b97f8c2ff47d1e78665df246f71b65fbc401fe
 SHA512:
-  metadata.gz: 78028e33ffe3b0929fc6f5e26b18933d39df58edade9cbf45bd1ca9025d2121201cbf8fa114f9c9ff5614336d2521012d44d9b05dfadb0af08d9710ee40b3bcd
-  data.tar.gz: 14e8924670cac95429572ca814d61421459797059a357a39cf23b18241bf8cb9ff084bbb5b6357441e4f85ae5e11cbff2aa18e24668ec03bc493cb45131dbe8a
+  metadata.gz: ac71aa148439f4cd54a6b6b6c499d0a5e832f58b0e95897dd837a65219cea8a244f700c38f59340f74f1db8ee82cc4b4fead1dfde267d0adb1207c6819c80d29
+  data.tar.gz: 8c6a568e091568b2b3cbb56f1897753bbaa30b5343b9b14055ff815e0fd7244c34036ff6a32f0395d9473573dc2336db414f6703fc49be5bffdbe6f54cade94c

data/lib/airbrake-ruby.rb

@@ -3,7 +3,6 @@ require 'logger'
 require 'json'
 require 'thread'
 require 'set'
-require 'English'
 require 'socket'
 
 require 'airbrake-ruby/version'
@@ -196,6 +195,7 @@ module Airbrake
     # @return [void]
     # @since v5.0.0
     # @see .blacklist_keys
+    # @deprecated Please use {Airbrake::Config#whitelist_keys} instead
     def whitelist_keys(keys, notifier = :default)
       call_notifier(notifier, __method__, keys)
     end
@@ -213,6 +213,7 @@ module Airbrake
     # @return [void]
     # @since v5.0.0
     # @see .whitelist_keys
+    # @deprecated Please use {Airbrake::Config#blacklist_keys} instead
     def blacklist_keys(keys, notifier = :default)
       call_notifier(notifier, __method__, keys)
     end
@@ -291,8 +292,3 @@ module Airbrake
     end
   end
 end
-
-# Notify of unhandled exceptions, if there were any, but ignore SystemExit.
-at_exit do
-  Airbrake.notify_sync($ERROR_INFO) if $ERROR_INFO
-end

data/lib/airbrake-ruby/async_sender.rb

@@ -14,6 +14,7 @@ module Airbrake
       @sender = SyncSender.new(config)
       @closed = false
       @workers = ThreadGroup.new
+      @mutex = Mutex.new
       @pid = nil
     end
 
@@ -37,19 +38,22 @@ module Airbrake
     # @return [void]
     # @raise [Airbrake::Error] when invoked more than one time
     def close
-      if closed?
-        raise Airbrake::Error, 'attempted to close already closed sender'
-      end
+      threads = @mutex.synchronize do
+        if closed?
+          raise Airbrake::Error, 'attempted to close already closed sender'
+        end
 
-      unless @unsent.empty?
-        msg = "#{LOG_LABEL} waiting to send #{@unsent.size} unsent notice(s)..."
-        @config.logger.debug(msg + ' (Ctrl-C to abort)')
-      end
+        unless @unsent.empty?
+          msg = "#{LOG_LABEL} waiting to send #{@unsent.size} unsent notice(s)..."
+          @config.logger.debug(msg + ' (Ctrl-C to abort)')
+        end
 
-      @config.workers.times { @unsent << :stop }
-      @workers.list.each(&:join)
-      @closed = true
+        @config.workers.times { @unsent << :stop }
+        @closed = true
+        @workers.list.dup
+      end
 
+      threads.each(&:join)
       @config.logger.debug("#{LOG_LABEL} closed")
     end
 

data/lib/airbrake-ruby/config.rb

@@ -57,6 +57,18 @@ module Airbrake
     # @return [Integer] The HTTP timeout in seconds.
     attr_accessor :timeout
 
+    ##
+    # @return [Array<String, Symbol, Regexp>] the keys, which should be
+    #   filtered
+    # @since 1.2.0
+    attr_accessor :blacklist_keys
+
+    ##
+    # @return [Array<String, Symbol, Regexp>] the keys, which shouldn't be
+    #   filtered
+    # @since 1.2.0
+    attr_accessor :whitelist_keys
+
     ##
     # @param [Hash{Symbol=>Object}] user_config the hash to be used to build the
     #   config
@@ -76,6 +88,9 @@ module Airbrake
 
       self.timeout = user_config[:timeout]
 
+      self.blacklist_keys = []
+      self.whitelist_keys = []
+
       merge(user_config)
     end
 

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

@@ -30,7 +30,13 @@ module Airbrake
       # @return [Boolean] true if the key matches at least one pattern, false
       #   otherwise
       def should_filter?(key)
-        @patterns.any? { |pattern| key.to_s.match(pattern) }
+        @patterns.any? do |pattern|
+          if pattern.is_a?(Regexp)
+            key.match(pattern)
+          else
+            key.to_s == pattern.to_s
+          end
+        end
       end
     end
   end

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

@@ -9,13 +9,17 @@ module Airbrake
     # @see KeysWhitelist
     # @see KeysBlacklist
     module KeysFilter
+      ##
+      # @return [String] The label to replace real values of filtered payload
+      FILTERED = '[Filtered]'.freeze
+
       ##
       # 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(*patterns)
-        @patterns = patterns.map(&:to_s)
+        @patterns = patterns
       end
 
       ##
@@ -28,6 +32,10 @@ module Airbrake
       def call(notice)
         FILTERABLE_KEYS.each { |key| filter_hash(notice[key]) }
 
+        if notice[:context][:user] && should_filter?(:user)
+          notice[:context][:user] = FILTERED
+        end
+
         return unless notice[:context][:url]
         url = URI(notice[:context][:url])
         return if url.nil? || url.query.nil?
@@ -46,7 +54,7 @@ module Airbrake
       def filter_hash(hash)
         hash.each_key do |key|
           if should_filter?(key)
-            hash[key] = '[Filtered]'.freeze
+            hash[key] = FILTERED
           elsif hash[key].is_a?(Hash)
             filter_hash(hash[key])
           end

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

@@ -30,7 +30,13 @@ module Airbrake
       # @return [Boolean] true if the key doesn't match any pattern, false
       #   otherwise.
       def should_filter?(key)
-        @patterns.none? { |pattern| key.to_s.match(pattern) }
+        @patterns.none? do |pattern|
+          if pattern.is_a?(Regexp)
+            key.match(pattern)
+          else
+            key.to_s == pattern.to_s
+          end
+        end
       end
     end
   end

data/lib/airbrake-ruby/notifier.rb

@@ -7,6 +7,10 @@ module Airbrake
   # @api private
   # @since v5.0.0
   class Notifier
+    ##
+    # @return [String] the label to be prepended to the log output
+    LOG_LABEL = '**Airbrake:'.freeze
+
     ##
     # Creates a new Airbrake notifier with the given config options.
     #
@@ -31,6 +35,15 @@ module Airbrake
       end
 
       @filter_chain = FilterChain.new(@config)
+
+      if @config.blacklist_keys.any?
+        add_filter(Filters::KeysBlacklist.new(*@config.blacklist_keys))
+      end
+
+      if @config.whitelist_keys.any?
+        add_filter(Filters::KeysWhitelist.new(*@config.whitelist_keys))
+      end
+
       @async_sender = AsyncSender.new(@config)
       @sync_sender = SyncSender.new(@config)
     end
@@ -60,13 +73,23 @@ module Airbrake
 
     ##
     # @macro see_public_api_method
+    # @deprecated Please use {Airbrake::Config#whitelist_keys} instead
     def whitelist_keys(keys)
+      @config.logger.warn(
+        "#{LOG_LABEL} Airbrake.whitelist_keys is deprecated. Please use the " \
+        "whitelist_keys option instead (https://goo.gl/sQwpYN)"
+      )
       add_filter(Filters::KeysWhitelist.new(*keys))
     end
 
     ##
     # @macro see_public_api_method
+    # @deprecated Please use {Airbrake::Config#blacklist_keys} instead
     def blacklist_keys(keys)
+      @config.logger.warn(
+        "#{LOG_LABEL} Airbrake.blacklist_keys is deprecated. Please use the " \
+        "blacklist_keys option instead (https://goo.gl/jucrFt)"
+      )
       add_filter(Filters::KeysBlacklist.new(*keys))
     end
 

data/lib/airbrake-ruby/sync_sender.rb

@@ -8,18 +8,6 @@ module Airbrake
     # @return [String] body for HTTP requests
     CONTENT_TYPE = 'application/json'.freeze
 
-    ##
-    # @return [Array] the errors to be rescued and logged during an HTTP request
-    HTTP_ERRORS = [
-      Timeout::Error,
-      Net::HTTPBadResponse,
-      Net::HTTPHeaderSyntaxError,
-      Errno::ECONNRESET,
-      Errno::ECONNREFUSED,
-      EOFError,
-      OpenSSL::SSL::SSLError
-    ].freeze
-
     ##
     # @param [Airbrake::Config] config
     def initialize(config)
@@ -39,7 +27,7 @@ module Airbrake
 
       begin
         response = https.request(req)
-      rescue *HTTP_ERRORS => ex
+      rescue => ex
         @config.logger.error("#{LOG_LABEL} HTTP error: #{ex}")
         return
       end

data/lib/airbrake-ruby/version.rb

@@ -3,5 +3,5 @@
 module Airbrake
   ##
   # @return [String] the library version
-  AIRBRAKE_RUBY_VERSION = '1.1.0'.freeze
+  AIRBRAKE_RUBY_VERSION = '1.2.0'.freeze
 end

data/spec/config_spec.rb

@@ -66,6 +66,14 @@ RSpec.describe Airbrake::Config do
       it "doesn't set default timeout" do
         expect(config.timeout).to be_nil
       end
+
+      it "doesn't set default blacklist" do
+        expect(config.blacklist_keys).to be_empty
+      end
+
+      it "doesn't set default whitelist" do
+        expect(config.whitelist_keys).to be_empty
+      end
     end
   end
 end

data/spec/notifier_spec.rb

@@ -495,11 +495,11 @@ RSpec.describe Airbrake::Notifier do
       it "accepts strings" do
         @airbrake.blacklist_keys('bingo')
 
-        @airbrake.notify_sync(ex, bingo: 'bango')
+        @airbrake.notify_sync(ex, bingo: 'bango', bbingoo: 'bbangoo')
 
         expect(
           a_request(:post, endpoint).
-          with(body: /"params":{"bingo":"\[Filtered\]"}/)
+          with(body: /"params":{"bingo":"\[Filtered\]","bbingoo":"bbangoo"}/)
         ).to have_been_made.once
       end
     end
@@ -553,6 +553,17 @@ RSpec.describe Airbrake::Notifier do
         with(body: expected_body)
       ).to have_been_made.once
     end
+
+    it "filters out user" do
+      @airbrake.blacklist_keys('user')
+
+      notice = @airbrake.build_notice(ex)
+      notice[:context][:user] = { id: 1337, name: 'Bingo Bango' }
+
+      @airbrake.notify_sync(notice)
+
+      expect_a_request_with_body(/"user":"\[Filtered\]"/)
+    end
   end
 
   describe "#whitelist_keys" do
@@ -586,13 +597,20 @@ RSpec.describe Airbrake::Notifier do
       it "accepts strings" do
         @airbrake.whitelist_keys('bash')
 
-        @airbrake.notify_sync(ex, bingo: 'bango', bongo: 'bish', bash: 'bosh')
-
-        body = /"params":{"bingo":"\[Filtered\]","bongo":"\[Filtered\]","bash":"bosh"}/
+        @airbrake.notify_sync(
+          ex,
+          bingo: 'bango',
+          bongo: 'bish',
+          bash: 'bosh',
+          bbashh: 'bboshh'
+        )
 
         expect(
           a_request(:post, endpoint).
-          with(body: body)
+          with(
+            body: /"params":{"bingo":"\[Filtered\]","bongo":"\[Filtered\]",
+                   "bash":"bosh","bbashh":"\[Filtered\]"}/x
+          )
         ).to have_been_made.once
       end
     end

data/spec/notifier_spec/options_spec.rb

@@ -1,6 +1,10 @@
 require 'spec_helper'
 
 RSpec.describe Airbrake::Notifier do
+  def expect_a_request_with_body(body)
+    expect(a_request(:post, endpoint).with(body: body)).to have_been_made.once
+  end
+
   let(:project_id) { 105138 }
   let(:project_key) { 'fd04e13d806a90f96614ad8e529b2822' }
   let(:localhost) { 'http://localhost:8080' }
@@ -213,5 +217,200 @@ RSpec.describe Airbrake::Notifier do
         include_examples 'sent notice', environment: :development
       end
     end
+
+    describe ":blacklist_keys" do
+      describe "the list of values" do
+        it "accepts regexps" do
+          params = { blacklist_keys: [/\Abin/] }
+          airbrake = described_class.new(airbrake_params.merge(params))
+
+          airbrake.notify_sync(ex, bingo: 'bango')
+
+          expect_a_request_with_body(/"params":{"bingo":"\[Filtered\]"}/)
+        end
+
+        it "accepts symbols" do
+          params = { blacklist_keys: [:bingo] }
+          airbrake = described_class.new(airbrake_params.merge(params))
+
+          airbrake.notify_sync(ex, bingo: 'bango')
+
+          expect_a_request_with_body(/"params":{"bingo":"\[Filtered\]"}/)
+        end
+
+        it "accepts strings" do
+          params = { blacklist_keys: ['bingo'] }
+          airbrake = described_class.new(airbrake_params.merge(params))
+
+          airbrake.notify_sync(ex, bingo: 'bango')
+
+          expect_a_request_with_body(/"params":{"bingo":"\[Filtered\]"}/)
+        end
+      end
+
+      describe "hash values" do
+        context "non-recursive" do
+          it "filters nested hashes" do
+            params = { blacklist_keys: ['bish'] }
+            airbrake = described_class.new(airbrake_params.merge(params))
+
+            airbrake.notify_sync(ex, bongo: { bish: 'bash' })
+
+            expect_a_request_with_body(/"params":{"bongo":{"bish":"\[Filtered\]"}}/)
+          end
+        end
+
+        context "recursive" do
+          it "filters recursive hashes" do
+            params = { blacklist_keys: ['bango'] }
+            airbrake = described_class.new(airbrake_params.merge(params))
+
+            bongo = { bingo: {} }
+            bongo[:bingo][:bango] = bongo
+
+            airbrake.notify_sync(ex, bongo)
+
+            expect_a_request_with_body(/"params":{"bingo":{"bango":"\[Filtered\]"}}/)
+          end
+        end
+      end
+
+      it "filters query parameters correctly" do
+        params = { blacklist_keys: ['bish'] }
+        airbrake = described_class.new(airbrake_params.merge(params))
+
+        notice = airbrake.build_notice(ex)
+        notice[:context][:url] = 'http://localhost:3000/crash?foo=bar&baz=bongo&bish=bash&color=%23FFAAFF'
+
+        airbrake.notify_sync(notice)
+
+        # rubocop:disable Metrics/LineLength
+        expected_body =
+          %r("context":{.*"url":"http://localhost:3000/crash\?foo=bar&baz=bongo&bish=\[Filtered\]&color=%23FFAAFF".*})
+        # rubocop:enable Metrics/LineLength
+
+        expect_a_request_with_body(expected_body)
+      end
+
+      it "filters out user" do
+        params = { blacklist_keys: ['user'] }
+        airbrake = described_class.new(airbrake_params.merge(params))
+
+        notice = airbrake.build_notice(ex)
+        notice[:context][:user] = { id: 1337, name: 'Bingo Bango' }
+
+        airbrake.notify_sync(notice)
+
+        expect_a_request_with_body(/"user":"\[Filtered\]"/)
+      end
+    end
+
+    describe ":whitelist_keys" do
+      describe "the list of values" do
+        it "accepts regexes" do
+          params = { whitelist_keys: [/\Abin/] }
+          airbrake = described_class.new(airbrake_params.merge(params))
+
+          airbrake.notify_sync(ex, bingo: 'bango', bongo: 'bish', bash: 'bosh')
+
+          expect_a_request_with_body(
+            /"params":{"bingo":"bango","bongo":"\[Filtered\]","bash":"\[Filtered\]"}/
+          )
+        end
+
+        it "accepts symbols" do
+          params = { whitelist_keys: [:bongo] }
+          airbrake = described_class.new(airbrake_params.merge(params))
+
+          airbrake.notify_sync(ex, bingo: 'bango', bongo: 'bish', bash: 'bosh')
+
+          expect_a_request_with_body(
+            /"params":{"bingo":"\[Filtered\]","bongo":"bish","bash":"\[Filtered\]"}/
+          )
+        end
+
+        it "accepts strings" do
+          params = { whitelist_keys: ['bash'] }
+          airbrake = described_class.new(airbrake_params.merge(params))
+
+          airbrake.notify_sync(
+            ex,
+            bingo: 'bango',
+            bongo: 'bish',
+            bash: 'bosh',
+            bbashh: 'bboshh'
+          )
+
+          expect_a_request_with_body(
+            /"params":{"bingo":"\[Filtered\]","bongo":"\[Filtered\]",
+                       "bash":"bosh","bbashh":"\[Filtered\]"}/x
+          )
+        end
+      end
+
+      describe "hash values" do
+        context "non-recursive" do
+          it "filters out everything but the provided keys" do
+            params = { whitelist_keys: %w(bongo bish) }
+            airbrake = described_class.new(airbrake_params.merge(params))
+
+            airbrake.notify_sync(ex, bingo: 'bango', bongo: { bish: 'bash' })
+
+            expect_a_request_with_body(
+              /"params":{"bingo":"\[Filtered\]","bongo":{"bish":"bash"}}/
+            )
+          end
+        end
+
+        context "recursive" do
+          it "errors when nested hashes are not filtered" do
+            params = { whitelist_keys: %w(bingo bango) }
+            airbrake = described_class.new(airbrake_params.merge(params))
+
+            bongo = { bingo: {} }
+            bongo[:bingo][:bango] = bongo
+
+            if RUBY_ENGINE == 'jruby'
+              # JRuby might raise two different exceptions, which represent the
+              # same thing. One is a Java exception, the other is a Ruby
+              # exception. It's probably a JRuby bug:
+              # https://github.com/jruby/jruby/issues/1903
+              begin
+                expect do
+                  airbrake.notify_sync(ex, bongo)
+                end.to raise_error(SystemStackError)
+              rescue RSpec::Expectations::ExpectationNotMetError
+                expect do
+                  airbrake.notify_sync(ex, bongo)
+                end.to raise_error(java.lang.StackOverflowError)
+              end
+            else
+              expect do
+                airbrake.notify_sync(ex, bongo)
+              end.to raise_error(SystemStackError)
+            end
+          end
+        end
+      end
+
+      describe "context/url" do
+        it "filters query parameters correctly" do
+          params = { whitelist_keys: %w(bish) }
+          airbrake = described_class.new(airbrake_params.merge(params))
+
+          notice = airbrake.build_notice(ex)
+          notice[:context][:url] = 'http://localhost:3000/crash?foo=bar&baz=bongo&bish=bash'
+
+          airbrake.notify_sync(notice)
+
+          # rubocop:disable Metrics/LineLength
+          expected_body =
+            %r("context":{.*"url":"http://localhost:3000/crash\?foo=\[Filtered\]&baz=\[Filtered\]&bish=bash".*})
+          # rubocop:enable Metrics/LineLength
+
+          expect_a_request_with_body(expected_body)
+        end
+      end
+    end
   end
 end

data/spec/sync_sender_spec.rb

@@ -10,4 +10,18 @@ RSpec.describe Airbrake::SyncSender do
       expect(https.read_timeout).to eq(10)
     end
   end
+
+  describe "#send" do
+    it "catches exceptions raised when sending" do
+      stdout = StringIO.new
+      config = Airbrake::Config.new(logger: Logger.new(stdout))
+      sender = described_class.new config
+      notice = Airbrake::Notice.new(config, AirbrakeTestError.new)
+      https = double("foo")
+      allow(sender).to receive(:build_https).and_return(https)
+      allow(https).to receive(:request).and_raise(StandardError.new('foo'))
+      expect(sender.send(notice)).to be_nil
+      expect(stdout.string).to match(/ERROR -- : .+ HTTP error: foo/)
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: airbrake-ruby
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Airbrake Technologies, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-26 00:00:00.000000000 Z
+date: 2016-03-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -160,3 +160,4 @@ test_files:
 - spec/payload_truncator_spec.rb
 - spec/spec_helper.rb
 - spec/sync_sender_spec.rb
+has_rdoc: