airbrake-ruby 3.0.0.rc.8 → 3.0.0.rc.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 69c06924329d27b11545cd91cfd49754c866c26c
-  data.tar.gz: 21cdca47905867c45562f9459f190221d43d6632
+  metadata.gz: 5f8f0a23f9d134d54cd586ca311b27cf82d0c3e8
+  data.tar.gz: 06d0f6fbf5b7f7809b0df03806e9991c564eb018
 SHA512:
-  metadata.gz: 4c1ef75e369d21f7c6336cbe10b7dc038d67e73a62f53ae315cdf78b51a372f063f99513132776122edf352f3b695cba579a34505558ca94117528bbb78bd6cd
-  data.tar.gz: 608e533648034f9ee88350a875956d2e800e180b73e4dc6d16e8a3e846c273c0246455c6cd89f1f2f3d9cb3ca355f7c4a233271a88fa0a55693d0ccccbfc0580
+  metadata.gz: c9a326402201a26169bd1c65d36e049ebbfdb5ebf27c314e8dd803e30da89366ac0e8e897cebddf6112fdb751fabc6421e0e4aafea8bf65b5201672aaf731b8c
+  data.tar.gz: 4648f252843e74ad697e519769126acdc3d007ea00316eaf694c7a672c3ffff87272d0e1278e80d7ccd7dca828834104c93e2b179064d462a3c3e3a1652b9f94

data/lib/airbrake-ruby/config.rb

@@ -83,6 +83,12 @@ module Airbrake
     # @since v2.5.0
     attr_accessor :code_hunks
 
+    # @return [Boolean] true if the library should send route stats information
+    #   to Airbrake, false otherwise
+    # @api public
+    # @since v3.0.0
+    attr_accessor :route_stats
+
     # @return [Integer] how many seconds to wait before sending collected route
     #   stats
     # @api public
@@ -91,6 +97,7 @@ module Airbrake
 
     # @param [Hash{Symbol=>Object}] user_config the hash to be used to build the
     #   config
+    # rubocop:disable Metrics/AbcSize
     def initialize(user_config = {})
       @validator = Config::Validator.new(self)
 
@@ -119,10 +126,12 @@ module Airbrake
       )
 
       self.versions = {}
+      self.route_stats = true
       self.route_stats_flush_period = 15
 
       merge(user_config)
     end
+    # rubocop:enable Metrics/AbcSize
 
     # The full URL to the Airbrake Notice API. Based on the +:host+ option.
     # @return [URI] the endpoint address

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

@@ -1,3 +1,5 @@
+require 'date'
+
 module Airbrake
   module Filters
     # Attaches git checkout info to `context`. The info includes:

data/lib/airbrake-ruby/notifier.rb

@@ -101,7 +101,17 @@ module Airbrake
 
     # @macro see_public_api_method
     def notify_request(request_info)
-      @route_sender.notify_request(request_info)
+      promise = Airbrake::Promise.new
+
+      if @config.ignored_environment?
+        return promise.reject("The '#{@config.environment}' environment is ignored")
+      end
+
+      unless @config.route_stats
+        return promise.reject("The Route Stats feature is disabled")
+      end
+
+      @route_sender.notify_request(request_info, promise)
     end
 
     # @return [String] customized inspect to lessen the amount of clutter

data/lib/airbrake-ruby/route_sender.rb

@@ -49,7 +49,7 @@ module Airbrake
     using TDigestBigEndianness
 
     # The key that represents a route.
-    RouteKey = Struct.new(:method, :route, :status_code, :time)
+    RouteKey = Struct.new(:method, :route, :statusCode, :time)
 
     # RouteStat holds data that describes a route's performance.
     RouteStat = Struct.new(:count, :sum, :sumsq, :tdigest) do
@@ -87,14 +87,14 @@ module Airbrake
     end
 
     # @macro see_public_api_method
-    def notify_request(request_info)
+    # @param [Airbrake::Promise] promise
+    def notify_request(request_info, promise = Airbrake::Promise.new)
       route = create_route_key(
         request_info[:method],
         request_info[:route],
         request_info[:status_code],
         utc_truncate_minutes(request_info[:start_time])
       )
-      promise = Airbrake::Promise.new
 
       @mutex.synchronize do
         @routes[route] ||= RouteStat.new

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 = '3.0.0.rc.8'.freeze
+  AIRBRAKE_RUBY_VERSION = '3.0.0.rc.9'.freeze
 end

data/spec/config_spec.rb

@@ -79,6 +79,10 @@ RSpec.describe Airbrake::Config do
         expect(config.whitelist_keys).to be_empty
       end
 
+      it "enables route stats by default" do
+        expect(config.route_stats).to be_truthy
+      end
+
       it "sets the default route_stats_flush_period" do
         expect(config.route_stats_flush_period).to eq(15)
       end

data/spec/filters/git_last_checkout_filter_spec.rb

@@ -32,7 +32,9 @@ RSpec.describe Airbrake::Filters::GitLastCheckoutFilter do
     end
 
     it "attaches last checkouted email" do
-      expect(notice[:context][:lastCheckout][:email]).to match(/\A\w+@\w+\.?\w+?\z/)
+      expect(notice[:context][:lastCheckout][:email]).to(
+        match(/\A\w+[\w.-]*@\w+\.?\w+?\z/)
+      )
     end
 
     it "attaches last checkouted revision" do

data/spec/notifier_spec.rb

@@ -451,18 +451,41 @@ RSpec.describe Airbrake::Notifier do
   end
 
   describe "#notify_request" do
-    it "forwards 'notify_request' to RouteSender" do
-      params = {
+    let(:params) do
+      {
         method: 'GET',
         route: '/foo',
         status_code: 200,
         start_time: Time.new(2018, 1, 1, 0, 20, 0, 0),
         end_time: Time.new(2018, 1, 1, 0, 19, 0, 0)
       }
+    end
+
+    it "forwards 'notify_request' to RouteSender" do
       expect_any_instance_of(Airbrake::RouteSender)
-        .to receive(:notify_request).with(params)
+        .to receive(:notify_request).with(params, instance_of(Airbrake::Promise))
       subject.notify_request(params)
     end
+
+    context "when route stats are disabled" do
+      it "doesn't send route stats" do
+        notifier = described_class.new(user_params.merge(route_stats: false))
+        expect_any_instance_of(Airbrake::RouteSender)
+          .not_to receive(:notify_request)
+        notifier.notify_request(params)
+      end
+    end
+
+    context "when current environment is ignored" do
+      it "doesn't send route stats" do
+        notifier = described_class.new(
+          user_params.merge(environment: 'test', ignore_environments: %w[test])
+        )
+        expect_any_instance_of(Airbrake::RouteSender)
+          .not_to receive(:notify_request)
+        notifier.notify_request(params)
+      end
+    end
   end
 
   describe "#inspect" do

data/spec/route_sender_spec.rb

@@ -73,10 +73,10 @@ RSpec.describe Airbrake::RouteSender do
         a_request(:put, endpoint).with(
           body: %r|\A
             {"routes":\[
-              {"method":"GET","route":"/foo","status_code":200,
+              {"method":"GET","route":"/foo","statusCode":200,
                "time":"2018-01-01T00:00:00\+00:00","count":1,"sum":1000.0,
                "sumsq":1000000.0,"tdigest":"AAAAAkA0AAAAAAAAAAAAAUR6AAAB"},
-              {"method":"GET","route":"/foo","status_code":200,
+              {"method":"GET","route":"/foo","statusCode":200,
                "time":"2018-01-01T00:01:00\+00:00","count":1,"sum":6000.0,
                "sumsq":36000000.0,"tdigest":"AAAAAkA0AAAAAAAAAAAAAUW7gAAB"}\]}
           \z|x
@@ -104,10 +104,10 @@ RSpec.describe Airbrake::RouteSender do
         a_request(:put, endpoint).with(
           body: %r|\A
             {"routes":\[
-              {"method":"GET","route":"/foo","status_code":200,
+              {"method":"GET","route":"/foo","statusCode":200,
                "time":"2018-01-01T00:49:00\+00:00","count":1,"sum":60000.0,
                "sumsq":3600000000.0,"tdigest":"AAAAAkA0AAAAAAAAAAAAAUdqYAAB"},
-              {"method":"POST","route":"/foo","status_code":200,
+              {"method":"POST","route":"/foo","statusCode":200,
                "time":"2018-01-01T00:49:00\+00:00","count":1,"sum":60000.0,
                "sumsq":3600000000.0,"tdigest":"AAAAAkA0AAAAAAAAAAAAAUdqYAAB"}\]}
           \z|x

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: airbrake-ruby
 version: !ruby/object:Gem::Version
-  version: 3.0.0.rc.8
+  version: 3.0.0.rc.9
 platform: ruby
 authors:
 - Airbrake Technologies, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-21 00:00:00.000000000 Z
+date: 2018-12-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tdigest