airbrake-ruby 4.2.3 → 4.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e44217dd74500dcb6a84f67cd2f3804bc52bf597
-  data.tar.gz: 007ad1edd743e86514894f9535bb550370e26ca0
+  metadata.gz: d616c9badc9da53458a90f76e383ba6f3702c684
+  data.tar.gz: 7f423d7dc6a3d470d3309a6b2443c94166b0e622
 SHA512:
-  metadata.gz: 2305130e3028d248ff60ec68f730d3d6623ee830bba0cb7ab3f3977bc3faaa27cd9976936ed99c0747397291049f89654a89017e96d0ce4f10c9665c59165bab
-  data.tar.gz: 3ca66b9d6ca4790b520414e40fd76fb44e741361404e68213bae35fccb78dbdef3f4c3c8d8ebcc4044b6f3a32be31e2a6a9bc27def63903c22e4713d5f853712
+  metadata.gz: 1833a11f83192a297114346ab89a947fd6d1a9795361cb0337420bbc02d32b3bc16e88a1cfdb736a7ac5669a9cafd473e71668c2a0b7ff1b4d7067f7eadb9be3
+  data.tar.gz: a688273b29302a1c6b831f33f9a76afa2bdad6d399e3defd2f43b737e6e81defbc0ebd7322098a7db9e98111505ebb64cd22912041f051adf2b4eb05bcb7ba81

data/lib/airbrake-ruby.rb

@@ -47,6 +47,8 @@ require 'airbrake-ruby/tdigest'
 require 'airbrake-ruby/query'
 require 'airbrake-ruby/request'
 require 'airbrake-ruby/performance_breakdown'
+require 'airbrake-ruby/benchmark'
+require 'airbrake-ruby/monotonic_time'
 
 # Airbrake is a thin wrapper around instances of the notifier classes (such as
 # notice, performance & deploy notifiers). It creates a way to access them via a
@@ -81,15 +83,15 @@ module Airbrake
   class << self
     # @since v4.2.3
     # @api private
-    attr_accessor :performance_notifier
+    attr_writer :performance_notifier
 
     # @since v4.2.3
     # @api private
-    attr_accessor :notice_notifier
+    attr_writer :notice_notifier
 
     # @since v4.2.3
     # @api private
-    attr_accessor :deploy_notifier
+    attr_writer :deploy_notifier
 
     # Configures the Airbrake notifier.
     #
@@ -99,19 +101,31 @@ module Airbrake
     #     c.project_key = 'fd04e13d806a90f96614ad8e529b2822'
     #   end
     #
-    # @yield [config] The configuration object
+    # @yield [config]
     # @yieldparam config [Airbrake::Config]
     # @return [void]
-    # @raise [Airbrake::Error] when trying to reconfigure already
-    #   existing notifier
-    # @note There's no way to read config values outside of this library
     def configure
       yield config = Airbrake::Config.instance
       Airbrake::Loggable.instance = config.logger
+      process_config_options(config)
+    end
 
-      return if performance_notifier && notice_notifier && deploy_notifier
+    # @since v4.2.3
+    # @api private
+    def performance_notifier
+      @performance_notifier ||= NoticeNotifier.new
+    end
 
-      reset
+    # @since v4.2.3
+    # @api private
+    def notice_notifier
+      @notice_notifier ||= NoticeNotifier.new
+    end
+
+    # @since v4.2.3
+    # @api private
+    def deploy_notifier
+      @deploy_notifier ||= PerformanceNotifier.new
     end
 
     # @return [Boolean] true if the notifier was configured, false otherwise
@@ -459,9 +473,30 @@ module Airbrake
       self.notice_notifier = NoticeNotifier.new
       self.deploy_notifier = DeployNotifier.new
     end
-  end
-end
 
-Airbrake.configure do
-  # Initialize Airbrake with default notifiers.
+    private
+
+    def process_config_options(config)
+      if config.blacklist_keys.any?
+        blacklist = Airbrake::Filters::KeysBlacklist.new(config.blacklist_keys)
+        notice_notifier.add_filter(blacklist)
+      end
+
+      if config.whitelist_keys.any?
+        whitelist = Airbrake::Filters::KeysWhitelist.new(config.whitelist_keys)
+        notice_notifier.add_filter(whitelist)
+      end
+
+      return unless config.root_directory
+
+      [
+        Airbrake::Filters::RootDirectoryFilter,
+        Airbrake::Filters::GitRevisionFilter,
+        Airbrake::Filters::GitRepositoryFilter,
+        Airbrake::Filters::GitLastCheckoutFilter
+      ].each do |filter|
+        notice_notifier.add_filter(filter.new(config.root_directory))
+      end
+    end
+  end
 end

data/lib/airbrake-ruby/benchmark.rb

@@ -0,0 +1,14 @@
+module Airbrake
+  # Benchmark benchmarks Ruby code.
+  #
+  # @since v4.3.0
+  # @api private
+  module Benchmark
+    # Measures monotonic time for the given operation.
+    def self.measure
+      start = MonotonicTime.time_in_ms
+      yield
+      MonotonicTime.time_in_ms - start
+    end
+  end
+end

data/lib/airbrake-ruby/monotonic_time.rb

@@ -0,0 +1,43 @@
+module Airbrake
+  # MonotonicTime is a helper for getting monotonic time suitable for
+  # performance measurements. It guarantees that the time is strictly linearly
+  # increasing (unlike realtime).
+  #
+  # @example
+  #   MonotonicTime.time_in_ms #=> 287138801.144576
+  #
+  # @see http://pubs.opengroup.org/onlinepubs/9699919799/functions/clock_getres.html
+  # @since v4.3.0
+  # @api private
+  module MonotonicTime
+    class << self
+      # @return [Integer] current monotonic time in milliseconds
+      def time_in_ms
+        time_in_nanoseconds / (10.0**6)
+      end
+
+      private
+
+      if defined?(Process::CLOCK_MONOTONIC)
+
+        def time_in_nanoseconds
+          Process.clock_gettime(Process::CLOCK_MONOTONIC, :nanosecond)
+        end
+
+      elsif RUBY_ENGINE == 'jruby'
+
+        def time_in_nanoseconds
+          java.lang.System.nanoTime
+        end
+
+      else
+
+        def time_in_nanoseconds
+          time = Time.now
+          time.to_i * (10**9) + time.nsec
+        end
+
+      end
+    end
+  end
+end

data/lib/airbrake-ruby/notice_notifier.rb

@@ -25,7 +25,10 @@ module Airbrake
       @async_sender = AsyncSender.new
       @sync_sender = SyncSender.new
 
-      add_default_filters
+      DEFAULT_FILTERS.each { |filter| add_filter(filter.new) }
+
+      add_filter(Airbrake::Filters::ContextFilter.new(@context))
+      add_filter(Airbrake::Filters::ExceptionAttributesFilter.new)
     end
 
     # @macro see_public_api_method
@@ -127,35 +130,5 @@ module Airbrake
       return caller_copy if clean_bt.empty?
       clean_bt
     end
-
-    # rubocop:disable Metrics/AbcSize
-    def add_default_filters
-      DEFAULT_FILTERS.each { |f| add_filter(f.new) }
-
-      if (whitelist_keys = @config.whitelist_keys).any?
-        add_filter(Airbrake::Filters::KeysWhitelist.new(whitelist_keys))
-      end
-
-      if (blacklist_keys = @config.blacklist_keys).any?
-        add_filter(Airbrake::Filters::KeysBlacklist.new(blacklist_keys))
-      end
-
-      add_filter(Airbrake::Filters::ContextFilter.new(@context))
-      add_filter(Airbrake::Filters::ExceptionAttributesFilter.new)
-
-      return unless (root_directory = @config.root_directory)
-      [
-        Airbrake::Filters::RootDirectoryFilter,
-        Airbrake::Filters::GitRevisionFilter,
-        Airbrake::Filters::GitRepositoryFilter
-      ].each do |filter|
-        add_filter(filter.new(root_directory))
-      end
-
-      add_filter(
-        Airbrake::Filters::GitLastCheckoutFilter.new(root_directory)
-      )
-    end
-    # rubocop:enable Metrics/AbcSize
   end
 end

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.2.3'.freeze
+  AIRBRAKE_RUBY_VERSION = '4.2.4'.freeze
 end

data/spec/airbrake_spec.rb

@@ -98,6 +98,88 @@ RSpec.describe Airbrake do
         expect(described_class.deploy_notifier).to eql(deploy_notifier)
       end
     end
+
+    context "when blacklist_keys gets configured" do
+      before { allow(Airbrake.notice_notifier).to receive(:add_filter) }
+
+      it "adds blacklist filter" do
+        expect(Airbrake.notice_notifier).to receive(:add_filter)
+          .with(an_instance_of(Airbrake::Filters::KeysBlacklist))
+        described_class.configure { |c| c.blacklist_keys = %w[password] }
+      end
+
+      it "initializes blacklist with specified parameters" do
+        expect(Airbrake::Filters::KeysBlacklist).to receive(:new).with(%w[password])
+        described_class.configure { |c| c.blacklist_keys = %w[password] }
+      end
+    end
+
+    context "when whitelist_keys gets configured" do
+      before { allow(Airbrake.notice_notifier).to receive(:add_filter) }
+
+      it "adds whitelist filter" do
+        expect(Airbrake.notice_notifier).to receive(:add_filter)
+          .with(an_instance_of(Airbrake::Filters::KeysWhitelist))
+        described_class.configure { |c| c.whitelist_keys = %w[banana] }
+      end
+
+      it "initializes whitelist with specified parameters" do
+        expect(Airbrake::Filters::KeysWhitelist).to receive(:new).with(%w[banana])
+        described_class.configure { |c| c.whitelist_keys = %w[banana] }
+      end
+    end
+
+    context "when root_directory gets configured" do
+      before { allow(Airbrake.notice_notifier).to receive(:add_filter) }
+
+      it "adds root directory filter" do
+        expect(Airbrake.notice_notifier).to receive(:add_filter)
+          .with(an_instance_of(Airbrake::Filters::RootDirectoryFilter))
+        described_class.configure { |c| c.root_directory = '/my/path' }
+      end
+
+      it "initializes root directory filter with specified path" do
+        expect(Airbrake::Filters::RootDirectoryFilter)
+          .to receive(:new).with('/my/path')
+        described_class.configure { |c| c.root_directory = '/my/path' }
+      end
+
+      it "adds git revision filter" do
+        expect(Airbrake.notice_notifier).to receive(:add_filter)
+          .with(an_instance_of(Airbrake::Filters::GitRevisionFilter))
+        described_class.configure { |c| c.root_directory = '/my/path' }
+      end
+
+      it "initializes git revision filter with correct root directory" do
+        expect(Airbrake::Filters::GitRevisionFilter)
+          .to receive(:new).with('/my/path')
+        described_class.configure { |c| c.root_directory = '/my/path' }
+      end
+
+      it "adds git repository filter" do
+        expect(Airbrake.notice_notifier).to receive(:add_filter)
+          .with(an_instance_of(Airbrake::Filters::GitRepositoryFilter))
+        described_class.configure { |c| c.root_directory = '/my/path' }
+      end
+
+      it "initializes git repository filter with correct root directory" do
+        expect(Airbrake::Filters::GitRepositoryFilter)
+          .to receive(:new).with('/my/path')
+        described_class.configure { |c| c.root_directory = '/my/path' }
+      end
+
+      it "adds git last checkout filter" do
+        expect(Airbrake.notice_notifier).to receive(:add_filter)
+          .with(an_instance_of(Airbrake::Filters::GitLastCheckoutFilter))
+        described_class.configure { |c| c.root_directory = '/my/path' }
+      end
+
+      it "initializes git last checkout filter with correct root directory" do
+        expect(Airbrake::Filters::GitLastCheckoutFilter)
+          .to receive(:new).with('/my/path')
+        described_class.configure { |c| c.root_directory = '/my/path' }
+      end
+    end
   end
 
   describe "#reset" do

data/spec/benchmark_spec.rb

@@ -0,0 +1,7 @@
+RSpec.describe Airbrake::Benchmark do
+  describe ".measure" do
+    it "returns measured performance time" do
+      expect(subject.measure { '10' * 10 }).to be_kind_of(Numeric)
+    end
+  end
+end

data/spec/monotonic_time_spec.rb

@@ -0,0 +1,12 @@
+RSpec.describe Airbrake::MonotonicTime do
+  describe ".time_in_ms" do
+    it "returns monotonic time in milliseconds" do
+      expect(subject.time_in_ms).to be_a(Float)
+    end
+
+    it "always returns time in the future" do
+      old_time = subject.time_in_ms
+      expect(subject.time_in_ms).to be > old_time
+    end
+  end
+end

data/spec/notice_notifier_spec.rb

@@ -23,62 +23,6 @@ RSpec.describe Airbrake::NoticeNotifier do
           .with(instance_of(Airbrake::Filters::ExceptionAttributesFilter))
         subject
       end
-
-      context "when user config has some whitelist keys" do
-        before { Airbrake::Config.instance.merge(whitelist_keys: %w[foo]) }
-
-        it "appends the whitelist filter" do
-          expect_any_instance_of(Airbrake::FilterChain).to receive(:add_filter)
-            .with(instance_of(Airbrake::Filters::KeysWhitelist))
-          subject
-        end
-      end
-
-      context "when user config doesn't have any whitelist keys" do
-        it "doesn't append the whitelist filter" do
-          expect_any_instance_of(Airbrake::FilterChain).not_to receive(:add_filter)
-            .with(instance_of(Airbrake::Filters::KeysWhitelist))
-          subject
-        end
-      end
-
-      context "when user config has some blacklist keys" do
-        before { Airbrake::Config.instance.merge(blacklist_keys: %w[bar]) }
-
-        it "appends the blacklist filter" do
-          expect_any_instance_of(Airbrake::FilterChain).to receive(:add_filter)
-            .with(instance_of(Airbrake::Filters::KeysBlacklist))
-          subject
-        end
-      end
-
-      context "when user config doesn't have any blacklist keys" do
-        it "doesn't append the blacklist filter" do
-          expect_any_instance_of(Airbrake::FilterChain).not_to receive(:add_filter)
-            .with(instance_of(Airbrake::Filters::KeysBlacklist))
-          subject
-        end
-      end
-
-      context "when user config specifies a root directory" do
-        before { Airbrake::Config.instance.merge(root_directory: '/foo') }
-
-        it "appends the root directory filter" do
-          expect_any_instance_of(Airbrake::FilterChain).to receive(:add_filter)
-            .with(instance_of(Airbrake::Filters::RootDirectoryFilter))
-          subject
-        end
-      end
-
-      context "when user config doesn't specify a root directory" do
-        it "doesn't append the root directory filter" do
-          expect_any_instance_of(Airbrake::Config).to receive(:root_directory)
-            .and_return(nil)
-          expect_any_instance_of(Airbrake::FilterChain).not_to receive(:add_filter)
-            .with(instance_of(Airbrake::Filters::RootDirectoryFilter))
-          subject
-        end
-      end
     end
   end
 

data/spec/notice_notifier_spec/options_spec.rb

@@ -63,7 +63,9 @@ RSpec.describe Airbrake::NoticeNotifier do
 
     describe ":root_directory" do
       before do
-        Airbrake::Config.instance.merge(root_directory: '/home/kyrylo/code')
+        subject.add_filter(
+          Airbrake::Filters::RootDirectoryFilter.new('/home/kyrylo/code')
+        )
       end
 
       it "filters out frames" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: airbrake-ruby
 version: !ruby/object:Gem::Version
-  version: 4.2.3
+  version: 4.2.4
 platform: ruby
 authors:
 - Airbrake Technologies, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-08 00:00:00.000000000 Z
+date: 2019-04-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rbtree3
@@ -41,6 +41,7 @@ files:
 - lib/airbrake-ruby.rb
 - lib/airbrake-ruby/async_sender.rb
 - lib/airbrake-ruby/backtrace.rb
+- lib/airbrake-ruby/benchmark.rb
 - lib/airbrake-ruby/code_hunk.rb
 - lib/airbrake-ruby/config.rb
 - lib/airbrake-ruby/config/validator.rb
@@ -65,6 +66,7 @@ files:
 - lib/airbrake-ruby/ignorable.rb
 - lib/airbrake-ruby/inspectable.rb
 - lib/airbrake-ruby/loggable.rb
+- lib/airbrake-ruby/monotonic_time.rb
 - lib/airbrake-ruby/nested_exception.rb
 - lib/airbrake-ruby/notice.rb
 - lib/airbrake-ruby/notice_notifier.rb
@@ -83,6 +85,7 @@ files:
 - spec/airbrake_spec.rb
 - spec/async_sender_spec.rb
 - spec/backtrace_spec.rb
+- spec/benchmark_spec.rb
 - spec/code_hunk_spec.rb
 - spec/config/validator_spec.rb
 - spec/config_spec.rb
@@ -111,6 +114,7 @@ files:
 - spec/helpers.rb
 - spec/ignorable_spec.rb
 - spec/inspectable_spec.rb
+- spec/monotonic_time_spec.rb
 - spec/nested_exception_spec.rb
 - spec/notice_notifier_spec.rb
 - spec/notice_notifier_spec/options_spec.rb
@@ -150,6 +154,7 @@ specification_version: 4
 summary: Ruby notifier for https://airbrake.io
 test_files:
 - spec/truncator_spec.rb
+- spec/benchmark_spec.rb
 - spec/helpers.rb
 - spec/filters/exception_attributes_filter_spec.rb
 - spec/filters/root_directory_filter_spec.rb
@@ -191,5 +196,6 @@ test_files:
 - spec/fixtures/project_root/code.rb
 - spec/fixtures/project_root/short_file.rb
 - spec/fixtures/project_root/vendor/bundle/ignored_file.rb
+- spec/monotonic_time_spec.rb
 - spec/inspectable_spec.rb
 - spec/notice_notifier_spec/options_spec.rb