airbrake-ruby 4.1.0 → 5.0.0

data/spec/performance_notifier_spec.rb

@@ -1,16 +1,22 @@
 RSpec.describe Airbrake::PerformanceNotifier do
   let(:routes) { 'https://api.airbrake.io/api/v5/projects/1/routes-stats' }
   let(:queries) { 'https://api.airbrake.io/api/v5/projects/1/queries-stats' }
+  let(:breakdowns) { 'https://api.airbrake.io/api/v5/projects/1/routes-breakdowns' }
+  let(:queues) { 'https://api.airbrake.io/api/v5/projects/1/queues-stats' }
 
   before do
     stub_request(:put, routes).to_return(status: 200, body: '')
     stub_request(:put, queries).to_return(status: 200, body: '')
+    stub_request(:put, breakdowns).to_return(status: 200, body: '')
+    stub_request(:put, queues).to_return(status: 200, body: '')
 
     Airbrake::Config.instance = Airbrake::Config.new(
       project_id: 1,
       project_key: 'banana',
       performance_stats: true,
-      performance_stats_flush_period: 0
+      performance_stats_flush_period: 0,
+      query_stats: true,
+      job_stats: true,
     )
   end
 
@@ -24,10 +30,11 @@ RSpec.describe Airbrake::PerformanceNotifier do
           func: 'foo',
           file: 'foo.rb',
           line: 123,
-          start_time: Time.new(2018, 1, 1, 0, 49, 0, 0),
-          end_time: Time.new(2018, 1, 1, 0, 50, 0, 0)
-        )
+          timing: 60000,
+          time: Time.new(2018, 1, 1, 0, 49, 0, 0),
+        ),
       )
+      subject.close
 
       expect(
         a_request(:put, queries).with(body: %r|
@@ -43,7 +50,7 @@ RSpec.describe Airbrake::PerformanceNotifier do
             "sum":60000.0,
             "sumsq":3600000000.0,
             "tdigest":"AAAAAkA0AAAAAAAAAAAAAUdqYAAB"
-          }\]}\z|x)
+          }\]}\z|x),
       ).to have_been_made
     end
 
@@ -53,10 +60,11 @@ RSpec.describe Airbrake::PerformanceNotifier do
           method: 'POST',
           route: '/foo',
           status_code: 200,
-          start_time: Time.new(2018, 1, 1, 0, 49, 0, 0),
-          end_time: Time.new(2018, 1, 1, 0, 50, 0, 0)
-        )
+          timing: 60000,
+          time: Time.new(2018, 1, 1, 0, 49, 0, 0),
+        ),
       )
+      subject.close
 
       expect(
         a_request(:put, routes).with(body: %r|
@@ -69,7 +77,89 @@ RSpec.describe Airbrake::PerformanceNotifier do
             "sum":60000.0,
             "sumsq":3600000000.0,
             "tdigest":"AAAAAkA0AAAAAAAAAAAAAUdqYAAB"
-          }\]}\z|x)
+          }\]}\z|x),
+      ).to have_been_made
+    end
+
+    it "sends full performance breakdown" do
+      subject.notify(
+        Airbrake::PerformanceBreakdown.new(
+          method: 'DELETE',
+          route: '/routes-breakdowns',
+          response_type: 'json',
+          timing: 60000,
+          time: Time.new(2018, 1, 1, 0, 49, 0, 0),
+          groups: { db: 131, view: 421 },
+        ),
+      )
+      subject.close
+
+      expect(
+        a_request(:put, breakdowns).with(body: %r|
+          \A{"routes":\[{
+            "method":"DELETE",
+            "route":"/routes-breakdowns",
+            "responseType":"json",
+            "time":"2018-01-01T00:49:00\+00:00",
+            "count":1,
+            "sum":60000.0,
+            "sumsq":3600000000.0,
+            "tdigest":"AAAAAkA0AAAAAAAAAAAAAUdqYAAB",
+            "groups":{
+              "db":{
+                "count":1,
+                "sum":131.0,
+                "sumsq":17161.0,
+                "tdigest":"AAAAAkA0AAAAAAAAAAAAAUMDAAAB"
+              },
+              "view":{
+                "count":1,
+                "sum":421.0,
+                "sumsq":177241.0,
+                "tdigest":"AAAAAkA0AAAAAAAAAAAAAUPSgAAB"
+              }
+            }
+        }\]}\z|x),
+      ).to have_been_made
+    end
+
+    it "sends full queue" do
+      subject.notify(
+        Airbrake::Queue.new(
+          queue: 'emails',
+          error_count: 2,
+          groups: { redis: 131, sql: 421 },
+          timing: 60000,
+          time: Time.new(2018, 1, 1, 0, 49, 0, 0),
+        ),
+      )
+      subject.close
+
+      expect(
+        a_request(:put, queues).with(body: /
+          \A{"queues":\[{
+            "queue":"emails",
+            "errorCount":2,
+            "time":"2018-01-01T00:49:00\+00:00",
+            "count":1,
+            "sum":60000.0,
+            "sumsq":3600000000.0,
+            "tdigest":"AAAAAkA0AAAAAAAAAAAAAUdqYAAB",
+            "groups":{
+              "redis":{
+                "count":1,
+                "sum":131.0,
+                "sumsq":17161.0,
+                "tdigest":"AAAAAkA0AAAAAAAAAAAAAUMDAAAB"
+              },
+              "sql":{
+                "count":1,
+                "sum":421.0,
+                "sumsq":177241.0,
+                "tdigest":"AAAAAkA0AAAAAAAAAAAAAUPSgAAB"
+              }
+            }
+        }\]}\z/x),
       ).to have_been_made
     end
 
@@ -79,11 +169,14 @@ RSpec.describe Airbrake::PerformanceNotifier do
           method: 'GET',
           route: '/foo',
           status_code: 200,
-          start_time: Time.new(2018, 1, 1, 0, 0, 20, 0)
-        )
+          timing: 60000,
+          time: Time.new(2018, 1, 1, 0, 0, 20, 0),
+        ),
       )
+      subject.close
+
       expect(
-        a_request(:put, routes).with(body: /"time":"2018-01-01T00:00:00\+00:00"/)
+        a_request(:put, routes).with(body: /"time":"2018-01-01T00:00:00\+00:00"/),
       ).to have_been_made
     end
 
@@ -93,19 +186,21 @@ RSpec.describe Airbrake::PerformanceNotifier do
           method: 'GET',
           route: '/foo',
           status_code: 200,
-          start_time: Time.new(2018, 1, 1, 0, 0, 20, 0)
-        )
+          timing: 213,
+        ),
       )
       subject.notify(
         Airbrake::Request.new(
           method: 'GET',
           route: '/foo',
           status_code: 200,
-          start_time: Time.new(2018, 1, 1, 0, 0, 50, 0)
-        )
+          timing: 123,
+        ),
       )
+      subject.close
+
       expect(
-        a_request(:put, routes).with(body: /"count":2/)
+        a_request(:put, routes).with(body: /"count":2/),
       ).to have_been_made
     end
 
@@ -115,19 +210,21 @@ RSpec.describe Airbrake::PerformanceNotifier do
           method: 'GET',
           route: '/foo',
           status_code: 200,
-          start_time: Time.new(2018, 1, 1, 0, 0, 49, 0),
-          end_time: Time.new(2018, 1, 1, 0, 0, 50, 0)
-        )
+          timing: 1000,
+          time: Time.new(2018, 1, 1, 0, 0, 49, 0),
+        ),
       )
       subject.notify(
         Airbrake::Request.new(
           method: 'GET',
           route: '/foo',
           status_code: 200,
-          start_time: Time.new(2018, 1, 1, 0, 1, 49, 0),
-          end_time: Time.new(2018, 1, 1, 0, 1, 55, 0)
-        )
+          timing: 6000,
+          time: Time.new(2018, 1, 1, 0, 1, 49, 0),
+        ),
       )
+      subject.close
+
       expect(
         a_request(:put, routes).with(
           body: %r|\A
@@ -138,8 +235,8 @@ RSpec.describe Airbrake::PerformanceNotifier do
               {"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
-        )
+          \z|x,
+        ),
       ).to have_been_made
     end
 
@@ -149,19 +246,21 @@ RSpec.describe Airbrake::PerformanceNotifier do
           method: 'GET',
           route: '/foo',
           status_code: 200,
-          start_time: Time.new(2018, 1, 1, 0, 49, 0, 0),
-          end_time: Time.new(2018, 1, 1, 0, 50, 0, 0)
-        )
+          timing: 60000,
+          time: Time.new(2018, 1, 1, 0, 49, 0, 0),
+        ),
       )
       subject.notify(
         Airbrake::Request.new(
           method: 'POST',
           route: '/foo',
           status_code: 200,
-          start_time: Time.new(2018, 1, 1, 0, 49, 0, 0),
-          end_time: Time.new(2018, 1, 1, 0, 50, 0, 0)
-        )
+          timing: 60000,
+          time: Time.new(2018, 1, 1, 0, 49, 0, 0),
+        ),
       )
+      subject.close
+
       expect(
         a_request(:put, routes).with(
           body: %r|\A
@@ -172,52 +271,135 @@ RSpec.describe Airbrake::PerformanceNotifier do
               {"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
-        )
+          \z|x,
+        ),
       ).to have_been_made
     end
 
-    it "returns a promise" do
-      promise = subject.notify(
-        Airbrake::Request.new(
-          method: 'GET',
-          route: '/foo',
-          status_code: 200,
-          start_time: Time.new(2018, 1, 1, 0, 49, 0, 0)
-        )
+    it "groups performance breakdowns by route key" do
+      subject.notify(
+        Airbrake::PerformanceBreakdown.new(
+          method: 'DELETE',
+          route: '/routes-breakdowns',
+          response_type: 'json',
+          timing: 2000,
+          time: Time.new(2018, 1, 1, 0, 0, 20, 0),
+          groups: { db: 131, view: 421 },
+        ),
       )
-      expect(promise).to be_an(Airbrake::Promise)
-      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
-        )
+      subject.notify(
+        Airbrake::PerformanceBreakdown.new(
+          method: 'DELETE',
+          route: '/routes-breakdowns',
+          response_type: 'json',
+          timing: 2000,
+          time: Time.new(2018, 1, 1, 0, 0, 30, 0),
+          groups: { db: 55, view: 11 },
+        ),
       )
+      subject.close
 
-      expect(a_request(:put, routes)).not_to have_been_made
-      expect(promise.value).to eq(
-        'error' => "The Performance Stats feature is disabled"
-      )
+      expect(
+        a_request(:put, breakdowns).with(body: %r|
+          \A{"routes":\[{
+            "method":"DELETE",
+            "route":"/routes-breakdowns",
+            "responseType":"json",
+            "time":"2018-01-01T00:00:00\+00:00",
+            "count":2,
+            "sum":4000.0,
+            "sumsq":8000000.0,
+            "tdigest":"AAAAAkA0AAAAAAAAAAAAAUT6AAAC",
+            "groups":{
+              "db":{
+                "count":2,
+                "sum":186.0,
+                "sumsq":20186.0,
+                "tdigest":"AAAAAkA0AAAAAAAAAAAAAkJcAABCmAAAAQE="
+              },
+              "view":{
+                "count":2,
+                "sum":432.0,
+                "sumsq":177362.0,
+                "tdigest":"AAAAAkA0AAAAAAAAAAAAAkEwAABDzQAAAQE="
+              }
+            }
+        }\]}\z|x),
+      ).to have_been_made
     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]
+    it "groups queues by queue key" do
+      subject.notify(
+        Airbrake::Queue.new(
+          queue: 'emails',
+          error_count: 2,
+          groups: { redis: 131, sql: 421 },
+          timing: 60000,
+          time: Time.new(2018, 1, 1, 0, 49, 0, 0),
+        ),
+      )
+      subject.notify(
+        Airbrake::Queue.new(
+          queue: 'emails',
+          error_count: 3,
+          groups: { redis: 131, sql: 421 },
+          timing: 60000,
+          time: Time.new(2018, 1, 1, 0, 49, 0, 0),
+        ),
       )
+      subject.close
 
+      expect(
+        a_request(:put, queues).with(body: /
+          \A{"queues":\[{
+            "queue":"emails",
+            "errorCount":5,
+            "time":"2018-01-01T00:49:00\+00:00",
+            "count":2,
+            "sum":120000.0,
+            "sumsq":7200000000.0,
+            "tdigest":"AAAAAkA0AAAAAAAAAAAAAUdqYAAC",
+            "groups":{
+              "redis":{
+                "count":2,
+                "sum":262.0,
+                "sumsq":34322.0,
+                "tdigest":"AAAAAkA0AAAAAAAAAAAAAUMDAAAC"
+              },
+              "sql":{
+                "count":2,
+                "sum":842.0,
+                "sumsq":354482.0,
+                "tdigest":"AAAAAkA0AAAAAAAAAAAAAUPSgAAC"
+              }
+            }
+        }\]}\z/x),
+      ).to have_been_made
+    end
+
+    it "returns a promise" do
       promise = subject.notify(
         Airbrake::Request.new(
-          method: 'GET', route: '/foo', status_code: 200, start_time: Time.new
-        )
+          method: 'GET',
+          route: '/foo',
+          status_code: 200,
+          timing: 123,
+        ),
       )
+      subject.close
+
+      expect(promise).to be_an(Airbrake::Promise)
+      expect(promise.value).to eq('' => '')
+    end
 
-      expect(a_request(:put, routes)).not_to have_been_made
-      expect(promise.value).to eq('error' => "current environment 'test' is ignored")
+    it "checks performance stat configuration" do
+      request = Airbrake::Request.new(
+        method: 'GET', route: '/foo', status_code: 200, timing: 123,
+      )
+      expect(Airbrake::Config.instance).to receive(:check_performance_options)
+        .with(request).and_return(Airbrake::Promise.new)
+      subject.notify(request)
+      subject.close
     end
 
     it "sends environment when it's specified" do
@@ -228,13 +410,15 @@ RSpec.describe Airbrake::PerformanceNotifier do
           method: 'POST',
           route: '/foo',
           status_code: 200,
-          start_time: Time.new
-        )
+          timing: 123,
+        ),
       )
+      subject.close
+
       expect(
         a_request(:put, routes).with(
-          body: /\A{"routes":\[.+\],"environment":"test"}\z/x
-        )
+          body: /\A{"routes":\[.+\],"environment":"test"}\z/x,
+        ),
       ).to have_been_made
     end
 
@@ -255,7 +439,7 @@ RSpec.describe Airbrake::PerformanceNotifier do
           project_id: 1,
           project_key: 'banana',
           performance_stats: true,
-          performance_stats_flush_period: flush_period
+          performance_stats_flush_period: flush_period,
         )
 
         subject.notify(
@@ -263,8 +447,8 @@ RSpec.describe Airbrake::PerformanceNotifier do
             method: 'GET',
             route: '/foo',
             status_code: 200,
-            start_time: Time.new(2018, 1, 1, 0, 49, 0, 0)
-          )
+            timing: 123,
+          ),
         )
 
         subject.notify(
@@ -272,8 +456,8 @@ RSpec.describe Airbrake::PerformanceNotifier do
             method: 'POST',
             route: '/foo',
             query: 'SELECT * FROM things',
-            start_time: Time.new(2018, 1, 1, 0, 49, 0, 0)
-          )
+            timing: 123,
+          ),
         )
 
         sleep(flush_period + 0.5)
@@ -292,9 +476,11 @@ RSpec.describe Airbrake::PerformanceNotifier do
             method: 'GET',
             route: '/foo',
             status_code: 200,
-            start_time: Time.new(2018, 1, 1, 0, 49, 0, 0)
-          )
+            timing: 1,
+          ),
         )
+        subject.close
+
         expect(a_request(:put, routes)).not_to have_been_made
       end
 
@@ -304,11 +490,29 @@ RSpec.describe Airbrake::PerformanceNotifier do
             method: 'POST',
             route: '/foo',
             query: 'SELECT * FROM things',
-            start_time: Time.new(2018, 1, 1, 0, 49, 0, 0)
-          )
+            timing: 1,
+          ),
         )
+        subject.close
+
         expect(a_request(:put, queries)).not_to have_been_made
       end
+
+      it "returns a rejected promise" do
+        promise = subject.notify(
+          Airbrake::Query.new(
+            method: 'POST',
+            route: '/foo',
+            query: 'SELECT * FROM things',
+            timing: 1,
+          ),
+        )
+        subject.close
+
+        expect(promise.value).to eq(
+          'error' => 'Airbrake::Query was ignored by a filter',
+        )
+      end
     end
 
     context "when a filter that modifies payload was defined" do
@@ -324,24 +528,93 @@ RSpec.describe Airbrake::PerformanceNotifier do
             method: 'POST',
             route: '/foo',
             query: 'SELECT * FROM things',
-            start_time: Time.new(2018, 1, 1, 0, 49, 0, 0)
-          )
+            timing: 123,
+          ),
         )
+        subject.close
+
         expect(
           a_request(:put, queries).with(
-            body: /\A{"queries":\[{"method":"POST","route":"\[Filtered\]"/
-          )
+            body: /\A{"queries":\[{"method":"POST","route":"\[Filtered\]"/,
+          ),
         ).to have_been_made
       end
     end
+
+    context "when provided :timing is zero" do
+      it "doesn't notify" do
+        queue = Airbrake::Queue.new(queue: 'bananas', error_count: 0, timing: 0)
+        subject.notify(queue)
+        subject.close
+
+        expect(a_request(:put, queues)).not_to have_been_made
+      end
+
+      it "returns a rejected promise" do
+        queue = Airbrake::Queue.new(queue: 'bananas', error_count: 0, timing: 0)
+        promise = subject.notify(queue)
+        subject.close
+
+        expect(promise.value).to eq('error' => ':timing cannot be zero')
+      end
+    end
+  end
+
+  describe "#notify_sync" do
+    it "notifies synchronously" do
+      retval = subject.notify_sync(
+        Airbrake::Query.new(
+          method: 'POST',
+          route: '/foo',
+          query: 'SELECT * FROM things',
+          timing: 123,
+        ),
+      )
+
+      expect(
+        a_request(:put, queries).with(
+          body: %r|\A{"queries":\[{"method":"POST","route":"/foo"|,
+        ),
+      ).to have_been_made
+      expect(retval).to eq('' => '')
+    end
+  end
+
+  describe "#close" do
+    before do
+      Airbrake::Config.instance.merge(performance_stats_flush_period: 0.1)
+    end
+
+    after do
+      Airbrake::Config.instance.merge(performance_stats_flush_period: 0)
+    end
+
+    it "kills the background thread" do
+      expect_any_instance_of(Thread).to receive(:kill).and_call_original
+      subject.notify(
+        Airbrake::Query.new(
+          method: 'POST',
+          route: '/foo',
+          query: 'SELECT * FROM things',
+          timing: 123,
+        ),
+      )
+      subject.close
+    end
+
+    it "logs the exit message" do
+      allow(Airbrake::Loggable.instance).to receive(:debug)
+      expect(Airbrake::Loggable.instance).to receive(:debug).with(
+        /performance notifier closed/,
+      )
+      subject.close
+    end
   end
 
   describe "#delete_filter" do
     let(:filter) do
       Class.new do
-        def call(resource)
-          resource.ignore!
-        end
+        def call(resource); end
       end
     end
 
@@ -354,9 +627,11 @@ RSpec.describe Airbrake::PerformanceNotifier do
           method: 'POST',
           route: '/foo',
           status_code: 200,
-          start_time: Time.new(2018, 1, 1, 0, 49, 0, 0)
-        )
+          timing: 123,
+        ),
       )
+      subject.close
+
       expect(a_request(:put, routes)).to have_been_made
     end
   end

data/spec/query_spec.rb

@@ -0,0 +1,11 @@
+RSpec.describe Airbrake::Query do
+  describe "#stash" do
+    subject do
+      described_class.new(
+        method: 'GET', route: '/', query: '',
+      )
+    end
+
+    it { is_expected.to respond_to(:stash) }
+  end
+end

data/spec/queue_spec.rb

@@ -0,0 +1,18 @@
+RSpec.describe Airbrake::Queue do
+  subject { described_class.new(queue: 'bananas', error_count: 0) }
+
+  describe "#ignore" do
+    it { is_expected.to respond_to(:ignore!) }
+  end
+
+  describe "#stash" do
+    it { is_expected.to respond_to(:stash) }
+  end
+
+  describe "#route" do
+    it "always returns an empty route" do
+      queue = described_class.new(queue: 'a', error_count: 0)
+      expect(queue.route).to be_empty
+    end
+  end
+end