airbrake-ruby 4.13.3 → 4.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 63e544ab7354b30c5a8f4e3e73ba22daf9f27a0e3d4804e3bf015f38b34a6314
-  data.tar.gz: f2d238127b26e3fdfdc1b7848f847760993a87d15182ec7266e42d7db753609c
+  metadata.gz: 6b246c5d84c2bc6ff22b535260b416d37bbc2fca17fff01ae3705156ce68a74b
+  data.tar.gz: 743b3190115223bf043cf8ecf7e9b5a8bb32b40206c146967d86489514247d99
 SHA512:
-  metadata.gz: 759ab3e188a8c20f2363e6aabdda6634f278b87cf24a67ecaad3998dde0dfe9de856ad8ca44f6a068b22afc2f8dcd7408ab66be6010ec3090cd2b52eef4434d8
-  data.tar.gz: 845c5c487af401362663273c85d56fb924578332a227ba534ced253d954af17ebdade9c6d5346a8e9640fcb4c8583ad068c8c43d0bc85fa7ec41298aff07c978
+  metadata.gz: c798358c9215c8ba703fd81163378bcd828200a71cc2ad026f9569684ca654ac094d01f38548c2fe5919ad744456c7a42bd58304d961b5c1997b00e4a4df0f8f
+  data.tar.gz: b7ed80303a34c3b0f58b51037063428384b4680273729f88062fd22146fcccfc55989a0f77ddc88a502859d234661a1243853d98fc1abc05f951a703962ec6af

data/lib/airbrake-ruby.rb

@@ -570,6 +570,7 @@ module Airbrake
 
     private
 
+    # rubocop:disable Metrics/AbcSize
     def process_config_options(config)
       if config.blacklist_keys.any?
         blacklist = Airbrake::Filters::KeysBlacklist.new(config.blacklist_keys)
@@ -581,7 +582,6 @@ module Airbrake
         notice_notifier.add_filter(whitelist)
       end
 
-      return if configured?
       return unless config.root_directory
 
       [
@@ -590,9 +590,12 @@ module Airbrake
         Airbrake::Filters::GitRepositoryFilter,
         Airbrake::Filters::GitLastCheckoutFilter,
       ].each do |filter|
+        next if notice_notifier.has_filter?(filter)
+
         notice_notifier.add_filter(filter.new(config.root_directory))
       end
     end
+    # rubocop:enable Metrics/AbcSize
   end
 end
 # rubocop:enable Metrics/ModuleLength

data/lib/airbrake-ruby/filter_chain.rb

@@ -76,7 +76,7 @@ module Airbrake
 
     # @return [String] customized inspect to lessen the amount of clutter
     def inspect
-      @filters.map(&:class).to_s
+      filter_classes.to_s
     end
 
     # @return [String] {#inspect} for PrettyPrint
@@ -91,5 +91,19 @@ module Airbrake
       end
       q.text(']')
     end
+
+    # @param [Class] filter_class
+    # @return [Boolean] true if the current chain has an instance of the given
+    #   class, false otherwise
+    # @since v4.14.0
+    def includes?(filter_class)
+      filter_classes.include?(filter_class)
+    end
+
+    private
+
+    def filter_classes
+      @filters.map(&:class)
+    end
   end
 end

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

@@ -27,6 +27,7 @@ module Airbrake
         @git_path = File.join(root_directory, '.git')
         @weight = 116
         @last_checkout = nil
+        @deploy_username = ENV['AIRBRAKE_DEPLOY_USERNAME']
       end
 
       # @macro call_filter
@@ -59,7 +60,7 @@ module Airbrake
 
         author = parts[2..-4]
         @last_checkout = {
-          username: author[0..1].join(' '),
+          username: @deploy_username || author[0..1].join(' '),
           email: parts[-3][1..-2],
           revision: parts[1],
           time: timestamp(parts[-2].to_i),

data/lib/airbrake-ruby/notice_notifier.rb

@@ -82,6 +82,12 @@ module Airbrake
       @context.merge!(context)
     end
 
+    # @return [Boolean]
+    # @since v4.14.0
+    def has_filter?(filter_class) # rubocop:disable Naming/PredicateName
+      @filter_chain.includes?(filter_class)
+    end
+
     private
 
     def convert_to_exception(ex)

data/lib/airbrake-ruby/version.rb

@@ -2,5 +2,5 @@
 # More information: http://semver.org/
 module Airbrake
   # @return [String] the library version
-  AIRBRAKE_RUBY_VERSION = '4.13.3'.freeze
+  AIRBRAKE_RUBY_VERSION = '4.14.0'.freeze
 end

data/spec/airbrake_spec.rb

@@ -85,6 +85,18 @@ RSpec.describe Airbrake do
         expect(described_class.notice_notifier).not_to receive(:add_filter)
         10.times { described_class.configure {} }
       end
+
+      it "appends some default filters" do
+        allow(described_class.notice_notifier).to receive(:add_filter)
+        expect(described_class.notice_notifier).to receive(:add_filter).with(
+          an_instance_of(Airbrake::Filters::RootDirectoryFilter),
+        )
+
+        described_class.configure do |c|
+          c.project_id = 1
+          c.project_key = '2'
+        end
+      end
     end
 
     context "when blacklist_keys gets configured" do

data/spec/filter_chain_spec.rb

@@ -89,4 +89,31 @@ RSpec.describe Airbrake::FilterChain do
       expect(subject.inspect).to eq('[Proc]')
     end
   end
+
+  describe "#includes?" do
+    context "when a custom filter class is included in the filter chain" do
+      it "returns true" do
+        klass = Class.new {}
+
+        subject.add_filter(klass.new)
+        expect(subject.includes?(klass)).to eq(true)
+      end
+    end
+
+    context "when Proc filter class is included in the filter chain" do
+      it "returns true" do
+        subject.add_filter(proc {})
+        expect(subject.includes?(Proc)).to eq(true)
+      end
+    end
+
+    context "when filter class is NOT included in the filter chain" do
+      it "returns false" do
+        klass = Class.new {}
+
+        subject.add_filter(proc {})
+        expect(subject.includes?(klass)).to eq(false)
+      end
+    end
+  end
 end

data/spec/filters/git_last_checkout_filter_spec.rb

@@ -21,24 +21,41 @@ RSpec.describe Airbrake::Filters::GitLastCheckoutFilter do
   end
 
   context "when .git directory exists" do
-    before { subject.call(notice) }
+    context "when AIRBRAKE_DEPLOY_USERNAME env variable is set" do
+      before { ENV['AIRBRAKE_DEPLOY_USERNAME'] = 'deployer' }
 
-    it "attaches last checkouted username" do
-      expect(notice[:context][:lastCheckout][:username]).not_to be_empty
+      it "attaches username from the environment" do
+        subject.call(notice)
+        expect(notice[:context][:lastCheckout][:username]).to eq('deployer')
+      end
+    end
+
+    context "when AIRBRAKE_DEPLOY_USERNAME env variable is NOT set" do
+      before { ENV['AIRBRAKE_DEPLOY_USERNAME'] = nil }
+
+      it "attaches last checkouted username" do
+        subject.call(notice)
+        username = notice[:context][:lastCheckout][:username]
+        expect(username).not_to be_empty
+        expect(username).not_to be_nil
+      end
     end
 
     it "attaches last checkouted email" do
+      subject.call(notice)
       expect(notice[:context][:lastCheckout][:email]).to(
         match(/\A\w+[\w.-]*@\w+\.?\w+?\z/),
       )
     end
 
     it "attaches last checkouted revision" do
+      subject.call(notice)
       expect(notice[:context][:lastCheckout][:revision]).not_to be_empty
       expect(notice[:context][:lastCheckout][:revision].size).to eq(40)
     end
 
     it "attaches last checkouted time" do
+      subject.call(notice)
       expect(notice[:context][:lastCheckout][:time]).not_to be_empty
       expect(notice[:context][:lastCheckout][:time].size).to eq(25)
     end

data/spec/performance_notifier_spec.rb

@@ -389,7 +389,7 @@ RSpec.describe Airbrake::PerformanceNotifier do
       subject.close
 
       expect(promise).to be_an(Airbrake::Promise)
-      expect(promise.value).to eq('' => nil)
+      expect(promise.value).to eq('' => '')
     end
 
     it "checks performance stat configuration" do
@@ -601,7 +601,7 @@ RSpec.describe Airbrake::PerformanceNotifier do
           body: %r|\A{"queries":\[{"method":"POST","route":"/foo"|,
         ),
       ).to have_been_made
-      expect(retval).to eq('' => nil)
+      expect(retval).to eq('' => '')
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: airbrake-ruby
 version: !ruby/object:Gem::Version
-  version: 4.13.3
+  version: 4.14.0
 platform: ruby
 authors:
 - Airbrake Technologies, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-02 00:00:00.000000000 Z
+date: 2020-04-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rbtree3
@@ -161,8 +161,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6.2
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Ruby notifier for https://airbrake.io