airbrake-ruby 3.1.0 → 3.2.0

data/spec/time_truncate_spec.rb

@@ -0,0 +1,13 @@
+RSpec.describe Airbrake::TimeTruncate do
+  describe "#utc_truncate_minutes" do
+    it "truncates time to the floor minute and returns an RFC3339 timestamp" do
+      time = Time.new(2018, 1, 1, 0, 0, 20, 0)
+      expect(subject.utc_truncate_minutes(time)).to eq('2018-01-01T00:00:00+00:00')
+    end
+
+    it "converts time with zone to UTC" do
+      time = Time.new(2018, 1, 1, 0, 0, 20, '-05:00')
+      expect(subject.utc_truncate_minutes(time)).to eq('2018-01-01T05:00:00+00:00')
+    end
+  end
+end

data/spec/truncator_spec.rb

@@ -1,5 +1,3 @@
-require 'spec_helper'
-
 RSpec.describe Airbrake::Truncator do
   def multiply_by_2_max_len(chr)
     chr * 2 * max_len

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: airbrake-ruby
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 3.2.0
 platform: ruby
 authors:
 - Airbrake Technologies, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-01-23 00:00:00.000000000 Z
+date: 2019-02-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: tdigest
+  name: rbtree3
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.1
+        version: 0.5.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.1
+        version: 0.5.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -134,6 +134,7 @@ files:
 - lib/airbrake-ruby/code_hunk.rb
 - lib/airbrake-ruby/config.rb
 - lib/airbrake-ruby/config/validator.rb
+- lib/airbrake-ruby/deploy_notifier.rb
 - lib/airbrake-ruby/file_cache.rb
 - lib/airbrake-ruby/filter_chain.rb
 - lib/airbrake-ruby/filters/context_filter.rb
@@ -147,15 +148,21 @@ files:
 - lib/airbrake-ruby/filters/keys_filter.rb
 - lib/airbrake-ruby/filters/keys_whitelist.rb
 - lib/airbrake-ruby/filters/root_directory_filter.rb
+- lib/airbrake-ruby/filters/sql_filter.rb
 - lib/airbrake-ruby/filters/system_exit_filter.rb
 - lib/airbrake-ruby/filters/thread_filter.rb
+- lib/airbrake-ruby/hash_keyable.rb
+- lib/airbrake-ruby/ignorable.rb
 - lib/airbrake-ruby/nested_exception.rb
 - lib/airbrake-ruby/notice.rb
-- lib/airbrake-ruby/notifier.rb
+- lib/airbrake-ruby/notice_notifier.rb
+- lib/airbrake-ruby/performance_notifier.rb
 - lib/airbrake-ruby/promise.rb
 - lib/airbrake-ruby/response.rb
-- lib/airbrake-ruby/route_sender.rb
+- lib/airbrake-ruby/stat.rb
 - lib/airbrake-ruby/sync_sender.rb
+- lib/airbrake-ruby/tdigest.rb
+- lib/airbrake-ruby/time_truncate.rb
 - lib/airbrake-ruby/truncator.rb
 - lib/airbrake-ruby/version.rb
 - spec/airbrake_spec.rb
@@ -164,6 +171,7 @@ files:
 - spec/code_hunk_spec.rb
 - spec/config/validator_spec.rb
 - spec/config_spec.rb
+- spec/deploy_notifier_spec.rb
 - spec/file_cache.rb
 - spec/filter_chain_spec.rb
 - spec/filters/context_filter_spec.rb
@@ -176,6 +184,7 @@ files:
 - spec/filters/keys_blacklist_spec.rb
 - spec/filters/keys_whitelist_spec.rb
 - spec/filters/root_directory_filter_spec.rb
+- spec/filters/sql_filter_spec.rb
 - spec/filters/system_exit_filter_spec.rb
 - spec/filters/thread_filter_spec.rb
 - spec/fixtures/notroot.txt
@@ -185,15 +194,19 @@ files:
 - spec/fixtures/project_root/short_file.rb
 - spec/fixtures/project_root/vendor/bundle/ignored_file.rb
 - spec/helpers.rb
+- spec/ignorable_spec.rb
 - spec/nested_exception_spec.rb
+- spec/notice_notifier_spec.rb
+- spec/notice_notifier_spec/options_spec.rb
 - spec/notice_spec.rb
-- spec/notifier_spec.rb
-- spec/notifier_spec/options_spec.rb
+- spec/performance_notifier_spec.rb
 - spec/promise_spec.rb
 - spec/response_spec.rb
-- spec/route_sender_spec.rb
 - spec/spec_helper.rb
+- spec/stat_spec.rb
 - spec/sync_sender_spec.rb
+- spec/tdigest_spec.rb
+- spec/time_truncate_spec.rb
 - spec/truncator_spec.rb
 homepage: https://airbrake.io
 licenses:
@@ -220,11 +233,11 @@ signing_key:
 specification_version: 4
 summary: Ruby notifier for https://airbrake.io
 test_files:
-- spec/route_sender_spec.rb
 - spec/truncator_spec.rb
 - spec/helpers.rb
 - spec/filters/exception_attributes_filter_spec.rb
 - spec/filters/root_directory_filter_spec.rb
+- spec/filters/sql_filter_spec.rb
 - spec/filters/keys_whitelist_spec.rb
 - spec/filters/system_exit_filter_spec.rb
 - spec/filters/thread_filter_spec.rb
@@ -238,13 +251,19 @@ test_files:
 - spec/spec_helper.rb
 - spec/notice_spec.rb
 - spec/config_spec.rb
+- spec/tdigest_spec.rb
 - spec/async_sender_spec.rb
+- spec/stat_spec.rb
 - spec/backtrace_spec.rb
+- spec/notice_notifier_spec.rb
+- spec/time_truncate_spec.rb
 - spec/promise_spec.rb
 - spec/config/validator_spec.rb
 - spec/sync_sender_spec.rb
+- spec/ignorable_spec.rb
+- spec/deploy_notifier_spec.rb
+- spec/performance_notifier_spec.rb
 - spec/airbrake_spec.rb
-- spec/notifier_spec.rb
 - spec/nested_exception_spec.rb
 - spec/filter_chain_spec.rb
 - spec/response_spec.rb
@@ -256,4 +275,4 @@ 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/notifier_spec/options_spec.rb
+- spec/notice_notifier_spec/options_spec.rb

data/lib/airbrake-ruby/route_sender.rb

@@ -1,175 +0,0 @@
-require 'tdigest'
-require 'base64'
-
-module Airbrake
-  # RouteSender aggregates information about requests and periodically sends
-  # collected data to Airbrake.
-  # @since v3.0.0
-  class RouteSender
-    # Monkey-patch https://github.com/castle/tdigest to pack with Big Endian
-    # (instead of Little Endian) since our backend wants it.
-    #
-    # @see https://github.com/castle/tdigest/blob/master/lib/tdigest/tdigest.rb
-    # @since v3.0.0
-    # @api private
-    module TDigestBigEndianness
-      refine TDigest::TDigest do
-        # rubocop:disable Metrics/AbcSize
-        def as_small_bytes
-          size = @centroids.size
-          output = [self.class::SMALL_ENCODING, compression, size]
-          x = 0
-          # delta encoding allows saving 4-bytes floats
-          mean_arr = @centroids.map do |_, c|
-            val = c.mean - x
-            x = c.mean
-            val
-          end
-          output += mean_arr
-          # Variable length encoding of numbers
-          c_arr = @centroids.each_with_object([]) do |(_, c), arr|
-            k = 0
-            n = c.n
-            while n < 0 || n > 0x7f
-              b = 0x80 | (0x7f & n)
-              arr << b
-              n = n >> 7
-              k += 1
-              raise 'Unreasonable large number' if k > 6
-            end
-            arr << n
-          end
-          output += c_arr
-          output.pack("NGNg#{size}C#{size}")
-        end
-        # rubocop:enable Metrics/AbcSize
-      end
-    end
-
-    using TDigestBigEndianness
-
-    # The key that represents a route.
-    RouteKey = Struct.new(:method, :route, :statusCode, :time)
-
-    # RouteStat holds data that describes a route's performance.
-    RouteStat = Struct.new(:count, :sum, :sumsq, :tdigest) do
-      # @param [Integer] count The number of requests
-      # @param [Float] sum The sum of request duration in milliseconds
-      # @param [Float] sumsq The squared sum of request duration in milliseconds
-      # @param [TDigest::TDigest] tdigest By default, the compression is 20
-      def initialize(
-        count: 0, sum: 0.0, sumsq: 0.0, tdigest: TDigest::TDigest.new(0.05)
-      )
-        super(count, sum, sumsq, tdigest)
-      end
-
-      # @return [Hash{String=>Object}] the route stat as a hash with compressed
-      #   and serialized as binary base64 tdigest
-      def to_h
-        tdigest.compress!
-        {
-          'count' => count,
-          'sum' => sum,
-          'sumsq' => sumsq,
-          'tdigest' => Base64.strict_encode64(tdigest.as_small_bytes)
-        }
-      end
-    end
-
-    # @param [Airbrake::Config] config
-    def initialize(config)
-      @config = config
-      @flush_period = config.route_stats_flush_period
-      @sender = SyncSender.new(config, :put)
-      @routes = {}
-      @thread = nil
-      @mutex = Mutex.new
-    end
-
-    # @macro see_public_api_method
-    # @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])
-      )
-
-      @mutex.synchronize do
-        @routes[route] ||= RouteStat.new
-        increment_stats(request_info, @routes[route])
-
-        if @flush_period > 0
-          schedule_flush(promise)
-        else
-          send(@routes, promise)
-        end
-      end
-
-      promise
-    end
-
-    private
-
-    def create_route_key(method, route, status_code, tm)
-      # rubocop:disable Style/DateTime
-      time = DateTime.new(
-        tm.year, tm.month, tm.day, tm.hour, tm.min, 0, tm.zone || 0
-      )
-      # rubocop:enable Style/DateTime
-      RouteKey.new(method, route, status_code, time.rfc3339)
-    end
-
-    def increment_stats(request_info, stat)
-      stat.count += 1
-
-      end_time = request_info[:end_time] || Time.new
-      ms = (end_time - request_info[:start_time]) * 1000
-
-      stat.sum += ms
-      stat.sumsq += ms * ms
-
-      stat.tdigest.push(ms)
-    end
-
-    def schedule_flush(promise)
-      @thread ||= Thread.new do
-        sleep(@flush_period)
-
-        routes = nil
-        @mutex.synchronize do
-          routes = @routes
-          @routes = {}
-          @thread = nil
-        end
-
-        send(routes, promise)
-      end
-
-      # Setting a name is needed to test the timer.
-      # Ruby <=2.2 doesn't support Thread#name, so we have this check.
-      @thread.name = 'route-stat-thread' if @thread.respond_to?(:name)
-    end
-
-    def send(routes, promise)
-      if routes.none?
-        raise "#{self.class.name}##{__method__}: routes cannot be empty. Race?"
-      end
-
-      @config.logger.debug("#{LOG_LABEL} RouteStats#send: #{routes}")
-
-      @sender.send(
-        { routes: routes.map { |k, v| k.to_h.merge(v.to_h) } },
-        promise,
-        URI.join(@config.host, "api/v5/projects/#{@config.project_id}/routes-stats")
-      )
-    end
-
-    def utc_truncate_minutes(time)
-      time_array = time.to_a
-      time_array[0] = 0
-      Time.utc(*time_array)
-    end
-  end
-end

data/spec/route_sender_spec.rb

@@ -1,130 +0,0 @@
-require 'spec_helper'
-
-RSpec.describe Airbrake::RouteSender do
-  let(:endpoint) { 'https://api.airbrake.io/api/v5/projects/1/routes-stats' }
-
-  let(:config) do
-    Airbrake::Config.new(
-      project_id: 1,
-      project_key: 'banana',
-      route_stats_flush_period: 0.1
-    )
-  end
-
-  subject { described_class.new(config) }
-
-  describe "#notify_request" do
-    before do
-      stub_request(:put, endpoint).to_return(status: 200, body: '')
-    end
-
-    # Let the request finish.
-    after { sleep 0.2 }
-
-    it "rounds time to the floor minute" do
-      subject.notify_request(
-        method: 'GET',
-        route: '/foo',
-        status_code: 200,
-        start_time: Time.new(2018, 1, 1, 0, 0, 20, 0)
-      )
-      sleep 0.2
-      expect(
-        a_request(:put, endpoint).with(body: /"time":"2018-01-01T00:00:00\+00:00"/)
-      ).to have_been_made
-    end
-
-    it "increments routes with the same key" do
-      subject.notify_request(
-        method: 'GET',
-        route: '/foo',
-        status_code: 200,
-        start_time: Time.new(2018, 1, 1, 0, 0, 20, 0)
-      )
-      subject.notify_request(
-        method: 'GET',
-        route: '/foo',
-        status_code: 200,
-        start_time: Time.new(2018, 1, 1, 0, 0, 50, 0)
-      )
-      sleep 0.2
-      expect(
-        a_request(:put, endpoint).with(body: /"count":2/)
-      ).to have_been_made
-    end
-
-    it "groups routes by time" do
-      subject.notify_request(
-        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)
-      )
-      subject.notify_request(
-        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)
-      )
-      sleep 0.2
-      expect(
-        a_request(:put, endpoint).with(
-          body: %r|\A
-            {"routes":\[
-              {"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","statusCode":200,
-               "time":"2018-01-01T00:01:00\+00:00","count":1,"sum":6000.0,
-               "sumsq":36000000.0,"tdigest":"AAAAAkA0AAAAAAAAAAAAAUW7gAAB"}\]}
-          \z|x
-        )
-      ).to have_been_made
-    end
-
-    it "groups routes by route key" do
-      subject.notify_request(
-        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)
-      )
-      subject.notify_request(
-        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)
-      )
-      sleep 0.2
-      expect(
-        a_request(:put, endpoint).with(
-          body: %r|\A
-            {"routes":\[
-              {"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","statusCode":200,
-               "time":"2018-01-01T00:49:00\+00:00","count":1,"sum":60000.0,
-               "sumsq":3600000000.0,"tdigest":"AAAAAkA0AAAAAAAAAAAAAUdqYAAB"}\]}
-          \z|x
-        )
-      ).to have_been_made
-    end
-
-    it "returns a promise" do
-      promise = subject.notify_request(
-        method: 'GET',
-        route: '/foo',
-        status_code: 200,
-        start_time: Time.new(2018, 1, 1, 0, 49, 0, 0)
-      )
-      sleep 0.2
-      expect(promise).to be_an(Airbrake::Promise)
-      expect(promise.value).to eq('' => nil)
-    end
-  end
-end