airbrake-ruby 4.5.1 → 4.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ffbab1be170a9aef318ba4f64637e80a8d272c4a
-  data.tar.gz: c79758680cc22faea98b5d93877a7c46a26949e4
+  metadata.gz: cf81123734caec939f2b487e0ca743ea26659f46
+  data.tar.gz: ba8e315a20b3f59d0863d027010e54311ba15d9d
 SHA512:
-  metadata.gz: 057622e0593896c5acbe522e1e248f37fcbafdf64f7d9cfed980a19bbfa0da07e07e46091d1feaa5a4a42890078f5e4acc99b85cfaea00d7919b3469046f171a
-  data.tar.gz: 859ab7e7f71ce69259481901f289746ac1cb2148a2690c8134db1cab087935d2e2944d2f821c875b7aeed41cfb0226fcb73399ffe247da373d23a7e5ec3993bd
+  metadata.gz: 551704a67996c2064820507d4fb3dd0218df863e7433d77356dd45bc62ecab112508372125a98c8d2f651c2693716e96c86b8e0172ffd265b60de0258d1b7acf
+  data.tar.gz: c32da13a83d385bc91b7cc2f236324ae29918005bac9450076d03fc0b707f49b2474049dac7c13fb78f1b0c848c2a1e95579f3c5f1c2315581c8db7d8c1eb3e0

data/lib/airbrake-ruby/config.rb

@@ -83,18 +83,24 @@ module Airbrake
     # @since v2.5.0
     attr_accessor :code_hunks
 
-    # @return [Boolean] true if the library should send performance stats
-    #   information to Airbrake (routes, SQL queries), false otherwise
+    # @return [Boolean] true if the library should send route performance stats
+    #   to Airbrake, false otherwise
     # @api public
     # @since v3.2.0
     attr_accessor :performance_stats
 
     # @return [Integer] how many seconds to wait before sending collected route
     #   stats
-    # @api public
+    # @api private
     # @since v3.2.0
     attr_accessor :performance_stats_flush_period
 
+    # @return [Boolean] true if the library should send SQL stats to Airbrake,
+    #   false otherwise
+    # @api public
+    # @since v4.6.0
+    attr_accessor :query_stats
+
     class << self
       # @return [Config]
       attr_writer :instance
@@ -132,6 +138,7 @@ module Airbrake
       self.versions = {}
       self.performance_stats = true
       self.performance_stats_flush_period = 15
+      self.query_stats = false
 
       merge(user_config)
     end
@@ -197,6 +204,20 @@ module Airbrake
       check_notify_ability
     end
 
+    # @return [Promise] resolved promise if neither of the performance options
+    #   reject it, false otherwise
+    def check_performance_options(resource)
+      promise = Airbrake::Promise.new
+
+      if !performance_stats
+        promise.reject("The Performance Stats feature is disabled")
+      elsif resource.is_a?(Airbrake::Query) && !query_stats
+        promise.reject("The Query Stats feature is disabled")
+      else
+        promise
+      end
+    end
+
     private
 
     def set_option(option, value)

data/lib/airbrake-ruby/performance_notifier.rb

@@ -25,10 +25,8 @@ module Airbrake
       promise = @config.check_configuration
       return promise if promise.rejected?
 
-      promise = Airbrake::Promise.new
-      unless @config.performance_stats
-        return promise.reject("The Performance Stats feature is disabled")
-      end
+      promise = @config.check_performance_options(resource)
+      return promise if promise.rejected?
 
       @filter_chain.refine(resource)
       return if resource.ignored?

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.5.1'.freeze
+  AIRBRAKE_RUBY_VERSION = '4.6.0'.freeze
 end

data/spec/config_spec.rb

@@ -21,6 +21,7 @@ RSpec.describe Airbrake::Config do
   its(:whitelist_keys) { is_expected.to be_empty }
   its(:performance_stats) { is_expected.to eq(true) }
   its(:performance_stats_flush_period) { is_expected.to eq(15) }
+  its(:query_stats) { is_expected.to eq(false) }
 
   describe "#new" do
     context "when user config is passed" do
@@ -106,4 +107,48 @@ RSpec.describe Airbrake::Config do
       its(:check_configuration) { is_expected.not_to be_rejected }
     end
   end
+
+  describe "#check_performance_options" do
+    it "returns a promise" do
+      resource = Airbrake::Query.new(
+        method: '', route: '', query: '', start_time: Time.now
+      )
+      expect(subject.check_performance_options(resource))
+        .to be_an(Airbrake::Promise)
+    end
+
+    context "when performance stats are disabled" do
+      before { subject.performance_stats = false }
+
+      let(:resource) do
+        Airbrake::Request.new(
+          method: 'GET', route: '/foo', status_code: 200, start_time: Time.new
+        )
+      end
+
+      it "returns a rejected promise" do
+        promise = subject.check_performance_options(resource)
+        expect(promise.value).to eq(
+          'error' => "The Performance Stats feature is disabled"
+        )
+      end
+    end
+
+    context "when query stats are disabled" do
+      before { subject.query_stats = false }
+
+      let(:resource) do
+        Airbrake::Query.new(
+          method: 'GET', route: '/foo', query: '', start_time: Time.new
+        )
+      end
+
+      it "returns a rejected promise" do
+        promise = subject.check_performance_options(resource)
+        expect(promise.value).to eq(
+          'error' => "The Query Stats feature is disabled"
+        )
+      end
+    end
+  end
 end

data/spec/performance_notifier_spec.rb

@@ -12,7 +12,8 @@ RSpec.describe Airbrake::PerformanceNotifier do
       project_id: 1,
       project_key: 'banana',
       performance_stats: true,
-      performance_stats_flush_period: 0
+      performance_stats_flush_period: 0,
+      query_stats: true
     )
   end
 
@@ -284,34 +285,13 @@ RSpec.describe Airbrake::PerformanceNotifier do
       expect(promise.value).to eq('' => nil)
     end
 
-    it "doesn't send route stats when performance stats are disabled" do
-      Airbrake::Config.instance.merge(performance_stats: false)
-
-      promise = subject.notify(
-        Airbrake::Request.new(
-          method: 'GET', route: '/foo', status_code: 200, start_time: Time.new
-        )
+    it "checks performance stat configuration" do
+      request = Airbrake::Request.new(
+        method: 'GET', route: '/foo', status_code: 200, start_time: Time.new
       )
-
-      expect(a_request(:put, routes)).not_to have_been_made
-      expect(promise.value).to eq(
-        'error' => "The Performance Stats feature is disabled"
-      )
-    end
-
-    it "doesn't send route stats when current environment is ignored" do
-      Airbrake::Config.instance.merge(
-        performance_stats: true, environment: 'test', ignore_environments: %w[test]
-      )
-
-      promise = subject.notify(
-        Airbrake::Request.new(
-          method: 'GET', route: '/foo', status_code: 200, start_time: Time.new
-        )
-      )
-
-      expect(a_request(:put, routes)).not_to have_been_made
-      expect(promise.value).to eq('error' => "current environment 'test' is ignored")
+      expect(Airbrake::Config.instance).to receive(:check_performance_options)
+        .with(request).and_return(Airbrake::Promise.new)
+      subject.notify(request)
     end
 
     it "sends environment when it's specified" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: airbrake-ruby
 version: !ruby/object:Gem::Version
-  version: 4.5.1
+  version: 4.6.0
 platform: ruby
 authors:
 - Airbrake Technologies, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-07-29 00:00:00.000000000 Z
+date: 2019-08-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rbtree3