airbrake-ruby 2.13.0.pre.1 → 3.0.0.rc.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3ae033f8b21b79ecf3902d570014f379e76b4c16
-  data.tar.gz: 131f71f8a92906a05aadf1ed3dbd4ffc35753162
+  metadata.gz: 0aef633a546613b3d46a1669505df654fcc4348b
+  data.tar.gz: c35b98d3ffa46c7ee3fe976546585f27ca6d1bd1
 SHA512:
-  metadata.gz: 62a0b41680b377eefd25a0e9433ada861ce92841d954477de949f3ee16bbb32a198d3133433b0783e7e4f747a7c7bff39e76dcf4744bfbb8da8fffbcd54c4a6d
-  data.tar.gz: 6864d904a38696d892dcca249ddeff4b1c973e61735ef792a19518bf1e17c430fc9f1bd09ea59fe4c6d7685d6d1a1e911848a657a6647199bb3208d25183192c
+  metadata.gz: 820453ab4d27d72c7f356958af555bc361507ca48cde546e6bc15f77cb32077c2cc1623d6a0afe882c37b9ade81888b58ddaadbd2c7f17b820a6011ab666877d
+  data.tar.gz: fc7078da83d4cd3d2e4e4c2602e5441e9ebd6751410cfdf8ffb6c4998f1832790a3ccfb41aa97a39470315b60a965b0b91059bc4914c366f923e986842f8adf1

data/lib/airbrake-ruby.rb

@@ -76,10 +76,6 @@ module Airbrake
   # @return [String] the label to be prepended to the log output
   LOG_LABEL = '**Airbrake:'.freeze
 
-  # @return [Boolean] true if current Ruby is Ruby 2.0.*. The result is used
-  #   for special cases where we need to work around older implementations
-  RUBY_20 = RUBY_VERSION.start_with?('2.0')
-
   # @return [Boolean] true if current Ruby is JRuby. The result is used for
   #  special cases where we need to work around older implementations
   JRUBY = (RUBY_ENGINE == 'jruby')
@@ -366,7 +362,7 @@ module Airbrake
     #   milliseconds
     # @param [Time] time When the request happened
     # @return [void]
-    # @since v2.13.0
+    # @since v3.0.0
     def inc_request(method, route, status_code, dur, time)
       @notifiers[:default].inc_request(method, route, status_code, dur, time)
     end

data/lib/airbrake-ruby/backtrace.rb

@@ -83,10 +83,6 @@ module Airbrake
           #{RUBY}
         )
       \z/x
-
-      # @return [Regexp] +EXECJS+ pattern without named captures and
-      #   uncommon frames
-      EXECJS_SIMPLIFIED = /\A.+ \(.+:\d+:\d+\)\z/
     end
 
     # @return [Integer] how many first frames should include code hunks
@@ -136,24 +132,13 @@ module Airbrake
         defined?(OCIError) && exception.is_a?(OCIError)
       end
 
-      # rubocop:disable Metrics/PerceivedComplexity, Metrics/CyclomaticComplexity
       def execjs_exception?(exception)
         return false unless defined?(ExecJS::RuntimeError)
         return true if exception.is_a?(ExecJS::RuntimeError)
-
-        if Airbrake::RUBY_20
-          # Ruby <2.1 doesn't support Exception#cause. We work around this by
-          # parsing backtraces. It's slow, so we check only a few first frames.
-          exception.backtrace[0..2].each do |frame|
-            return true if frame =~ Patterns::EXECJS_SIMPLIFIED
-          end
-        elsif exception.cause && exception.cause.is_a?(ExecJS::RuntimeError)
-          return true
-        end
+        return true if exception.cause && exception.cause.is_a?(ExecJS::RuntimeError)
 
         false
       end
-      # rubocop:enable Metrics/PerceivedComplexity, Metrics/CyclomaticComplexity
 
       def stack_frame(config, regexp, stackframe)
         if (match = match_frame(regexp, stackframe))

data/lib/airbrake-ruby/config.rb

@@ -86,7 +86,7 @@ module Airbrake
     # @return [Integer] how many seconds to wait before sending collected route
     #   stats
     # @api public
-    # @since v2.13.0
+    # @since v3.0.0
     attr_accessor :route_stats_flush_period
 
     # @param [Hash{Symbol=>Object}] user_config the hash to be used to build the

data/lib/airbrake-ruby/filter_chain.rb

@@ -18,9 +18,12 @@ module Airbrake
     # @return [Integer]
     DEFAULT_WEIGHT = 0
 
-    def initialize
+    def initialize(config, context)
+      @config = config
+      @context = context
       @filters = []
       DEFAULT_FILTERS.each { |f| add_filter(f.new) }
+      add_default_filters
     end
 
     # Adds a filter to the filter chain. Sorts filters by weight.
@@ -44,5 +47,57 @@ module Airbrake
         filter.call(notice)
       end
     end
+
+    # @return [String] customized inspect to lessen the amount of clutter
+    def inspect
+      @filters.map(&:class)
+    end
+
+    # @return [String] {#inspect} for PrettyPrint
+    def pretty_print(q)
+      q.text('[')
+
+      # Make nesting of the first element consistent on JRuby and MRI.
+      q.nest(2) { q.breakable }
+
+      q.nest(2) do
+        q.seplist(@filters) { |f| q.pp(f.class) }
+      end
+      q.text(']')
+    end
+
+    private
+
+    # rubocop:disable Metrics/AbcSize
+    def add_default_filters
+      if (whitelist_keys = @config.whitelist_keys).any?
+        add_filter(
+          Airbrake::Filters::KeysWhitelist.new(@config.logger, whitelist_keys)
+        )
+      end
+
+      if (blacklist_keys = @config.blacklist_keys).any?
+        add_filter(
+          Airbrake::Filters::KeysBlacklist.new(@config.logger, blacklist_keys)
+        )
+      end
+
+      add_filter(Airbrake::Filters::ContextFilter.new(@context))
+      add_filter(Airbrake::Filters::ExceptionAttributesFilter.new(@config.logger))
+
+      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(@config.logger, root_directory)
+      )
+    end
+    # rubocop:enable Metrics/AbcSize
   end
 end

data/lib/airbrake-ruby/notifier.rb

@@ -9,6 +9,12 @@ module Airbrake
     # @return [String] the label to be prepended to the log output
     LOG_LABEL = '**Airbrake:'.freeze
 
+    # @return [String] inspect output template
+    INSPECT_TEMPLATE =
+      "#<#{self}:0x%<id>s project_id=\"%<project_id>s\" " \
+      "project_key=\"%<project_key>s\" " \
+      "host=\"%<host>s\" filter_chain=%<filter_chain>s>".freeze
+
     # Creates a new Airbrake notifier with the given config options.
     #
     # @example Configuring with a Hash
@@ -30,13 +36,9 @@ module Airbrake
       raise Airbrake::Error, @config.validation_error_message unless @config.valid?
 
       @context = {}
-
-      @filter_chain = FilterChain.new
-      add_default_filters
-
+      @filter_chain = FilterChain.new(@config, @context)
       @async_sender = AsyncSender.new(@config)
       @sync_sender = SyncSender.new(@config)
-
       @route_sender = RouteSender.new(@config)
     end
 
@@ -102,6 +104,29 @@ module Airbrake
       @route_sender.inc_request(*args)
     end
 
+    # @return [String] customized inspect to lessen the amount of clutter
+    def inspect
+      format(
+        INSPECT_TEMPLATE,
+        id: (object_id << 1).to_s(16).rjust(16, '0'),
+        project_id: @config.project_id,
+        project_key: @config.project_key,
+        host: @config.host,
+        filter_chain: @filter_chain.inspect
+      )
+    end
+
+    # @return [String] {#inspect} for PrettyPrint
+    def pretty_print(q)
+      q.text("#<#{self.class}:0x#{(object_id << 1).to_s(16).rjust(16, '0')} ")
+      q.text(
+        "project_id=\"#{@config.project_id}\" project_key=\"#{@config.project_key}\" " \
+        "host=\"#{@config.host}\" filter_chain="
+      )
+      q.pp(@filter_chain)
+      q.text('>')
+    end
+
     private
 
     def convert_to_exception(ex)
@@ -152,39 +177,5 @@ module Airbrake
       return caller_copy if clean_bt.empty?
       clean_bt
     end
-
-    # rubocop:disable Metrics/AbcSize
-    def add_default_filters
-      if (whitelist_keys = @config.whitelist_keys).any?
-        @filter_chain.add_filter(
-          Airbrake::Filters::KeysWhitelist.new(@config.logger, whitelist_keys)
-        )
-      end
-
-      if (blacklist_keys = @config.blacklist_keys).any?
-        @filter_chain.add_filter(
-          Airbrake::Filters::KeysBlacklist.new(@config.logger, blacklist_keys)
-        )
-      end
-
-      @filter_chain.add_filter(Airbrake::Filters::ContextFilter.new(@context))
-      @filter_chain.add_filter(
-        Airbrake::Filters::ExceptionAttributesFilter.new(@config.logger)
-      )
-
-      return unless (root_directory = @config.root_directory)
-      [
-        Airbrake::Filters::RootDirectoryFilter,
-        Airbrake::Filters::GitRevisionFilter,
-        Airbrake::Filters::GitRepositoryFilter
-      ].each do |filter|
-        @filter_chain.add_filter(filter.new(root_directory))
-      end
-
-      @filter_chain.add_filter(
-        Airbrake::Filters::GitLastCheckoutFilter.new(@config.logger, root_directory)
-      )
-    end
-    # rubocop:enable Metrics/AbcSize
   end
 end

data/lib/airbrake-ruby/response.rb

@@ -23,7 +23,7 @@ module Airbrake
 
       begin
         case code
-        when 200
+        when 200, 204
           logger.debug("#{LOG_LABEL} #{name} (#{code}): #{body}")
           { response.msg => response.body }
         when 201

data/lib/airbrake-ruby/route_sender.rb

@@ -1,20 +1,76 @@
+require 'tdigest'
+require 'base64'
+
 module Airbrake
   # RouteSender aggregates information about requests and periodically sends
   # collected data to Airbrake.
-  # @since v2.13.0
+  # @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, :min, :max) do
+    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 [Float] min The minimal request duration
-      # @param [Float] max The maximum request duration
-      def initialize(count: 0, sum: 0.0, sumsq: 0.0, min: 0.0, max: 0.0)
-        super(count, sum, sumsq, min, max)
+      # @param [TDigest::TDigest] tdigest
+      def initialize(count: 0, sum: 0.0, sumsq: 0.0, tdigest: TDigest::TDigest.new)
+        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
 
@@ -66,8 +122,7 @@ module Airbrake
       stat.sum += ms
       stat.sumsq += ms * ms
 
-      stat.min = ms if ms < stat.min || stat.min == 0
-      stat.max = ms if ms > stat.max
+      stat.tdigest.push(ms)
     end
 
     def schedule_flush(promise)

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 = '2.13.0.pre.1'.freeze
+  AIRBRAKE_RUBY_VERSION = '3.0.0.rc.2'.freeze
 end

data/spec/backtrace_spec.rb

@@ -248,6 +248,8 @@ RSpec.describe Airbrake::Backtrace do
          "/opt/rubies/ruby-2.3.1/lib/ruby/2.3.0/benchmark.rb:308:in `realtime'"]
       end
 
+      let(:ex) { ExecJS::RuntimeError.new.tap { |e| e.set_backtrace(bt) } }
+
       let(:parsed_backtrace) do
         [{ file: '(execjs)', line: 6692, function: 'compile' },
          { file: '<anonymous>', line: 1, function: 'eval' },
@@ -261,31 +263,9 @@ RSpec.describe Airbrake::Backtrace do
            function: 'realtime' }]
       end
 
-      context "when not on Ruby 2.0" do
-        let(:ex) { ExecJS::RuntimeError.new.tap { |e| e.set_backtrace(bt) } }
-
-        it "returns a properly formatted array of hashes" do
-          stub_const('ExecJS::RuntimeError', AirbrakeTestError)
-          stub_const('Airbrake::RUBY_20', false)
-
-          expect(described_class.parse(config, ex)).to eq(parsed_backtrace)
-        end
-      end
-
-      context "when on Ruby 2.0" do
-        context "and when exception's class isn't ExecJS" do
-          let(:ex) do
-            ActionView::Template::Error.new.tap { |e| e.set_backtrace(bt) }
-          end
-
-          it "returns a properly formatted array of hashes" do
-            stub_const('ActionView::Template::Error', AirbrakeTestError)
-            stub_const('ExecJS::RuntimeError', NameError)
-            stub_const('Airbrake::RUBY_20', true)
-
-            expect(described_class.parse(config, ex)).to eq(parsed_backtrace)
-          end
-        end
+      it "returns a properly formatted array of hashes" do
+        stub_const('ExecJS::RuntimeError', AirbrakeTestError)
+        expect(described_class.parse(config, ex)).to eq(parsed_backtrace)
       end
     end
 

data/spec/filter_chain_spec.rb

@@ -1,8 +1,12 @@
 require 'spec_helper'
 
 RSpec.describe Airbrake::FilterChain do
+  subject { described_class.new(config, {}) }
+
+  let(:config) { Airbrake::Config.new }
+
   let(:notice) do
-    Airbrake::Notice.new(Airbrake::Config.new, AirbrakeTestError.new)
+    Airbrake::Notice.new(config, AirbrakeTestError.new)
   end
 
   describe "#refine" do

data/spec/notifier_spec.rb

@@ -459,5 +459,35 @@ RSpec.describe Airbrake::Notifier do
       subject.inc_request('GET', '/foo', 200, 1000, t)
     end
   end
+
+  describe "#inspect" do
+    it "displays object information" do
+      expect(subject.inspect).to match(/
+        #<Airbrake::Notifier:0x\w+\s
+          project_id="\d+"\s
+          project_key=".+"\s
+          host="http.+"\s
+          filter_chain=\[.+\]>
+      /x)
+    end
+  end
+
+  describe "#pretty_print" do
+    it "displays object information in a beautiful way" do
+      q = PP.new
+
+      # Guarding is needed to fix JRuby failure:
+      # NoMethodError: undefined method `[]' for nil:NilClass
+      q.guard_inspect_key { subject.pretty_print(q) }
+
+      expect(q.output).to match(/
+        #<Airbrake::Notifier:0x\w+\s
+          project_id="\d+"\s
+          project_key=".+"\s
+          host="http.+"\s
+          filter_chain=\[\n\s\s
+      /x)
+    end
+  end
 end
 # rubocop:enable Layout/DotPosition

data/spec/response_spec.rb

@@ -5,7 +5,7 @@ RSpec.describe Airbrake::Response do
     let(:out) { StringIO.new }
     let(:logger) { Logger.new(out) }
 
-    [200, 201].each do |code|
+    [200, 201, 204].each do |code|
       context "when response code is #{code}" do
         it "logs response body" do
           described_class.parse(OpenStruct.new(code: code, body: '{}'), logger)

data/spec/route_sender_spec.rb

@@ -48,10 +48,10 @@ RSpec.describe Airbrake::RouteSender do
             {"routes":\[
               {"method":"GET","route":"/foo","statusCode":200,
                "time":"2018-01-01T00:00:00\+00:00","count":1,"sum":24.0,
-               "sumsq":576.0,"min":24.0,"max":24.0},
+               "sumsq":576.0,"tDigest":"AAAAAkBZAAAAAAAAAAAAAUHAAAAB"},
               {"method":"GET","route":"/foo","statusCode":200,
                "time":"2018-01-01T00:01:00\+00:00","count":1,"sum":10.0,
-               "sumsq":100.0,"min":10.0,"max":10.0}\]}
+               "sumsq":100.0,"tDigest":"AAAAAkBZAAAAAAAAAAAAAUEgAAAB"}\]}
           \z|x
         )
       ).to have_been_made
@@ -67,10 +67,10 @@ RSpec.describe Airbrake::RouteSender do
             {"routes":\[
               {"method":"GET","route":"/foo","statusCode":200,
                "time":"2018-01-01T00:00:00\+00:00","count":1,"sum":24.0,
-               "sumsq":576.0,"min":24.0,"max":24.0},
+               "sumsq":576.0,"tDigest":"AAAAAkBZAAAAAAAAAAAAAUHAAAAB"},
               {"method":"POST","route":"/foo","statusCode":200,
                "time":"2018-01-01T00:00:00\+00:00","count":1,"sum":10.0,
-               "sumsq":100.0,"min":10.0,"max":10.0}\]}
+               "sumsq":100.0,"tDigest":"AAAAAkBZAAAAAAAAAAAAAUEgAAAB"}\]}
           \z|x
         )
       ).to have_been_made

data/spec/spec_helper.rb

@@ -8,6 +8,7 @@ require 'pathname'
 require 'webrick'
 require 'English'
 require 'base64'
+require 'pp'
 
 require 'helpers'
 

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: airbrake-ruby
 version: !ruby/object:Gem::Version
-  version: 2.13.0.pre.1
+  version: 3.0.0.rc.2
 platform: ruby
 authors:
 - Airbrake Technologies, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-10-26 00:00:00.000000000 Z
+date: 2018-10-30 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: tdigest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.1.1
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -104,12 +118,11 @@ description: |
   Airbrake Ruby is a plain Ruby notifier for Airbrake (https://airbrake.io), the
   leading exception reporting service. Airbrake Ruby provides minimalist API that
   enables the ability to send any Ruby exception to the Airbrake dashboard. The
-  library is extremely lightweight, contains no dependencies and perfectly suits
-  plain Ruby applications. For apps that are built with Rails, Sinatra or any
-  other Rack-compliant web framework we offer the airbrake gem
-  (https://github.com/airbrake/airbrake). It has additional features such as
-  reporting of any unhandled exceptions automatically, integrations with Resque,
-  Sidekiq, Delayed Job and many more.
+  library is extremely lightweight and it perfectly suits plain Ruby applications.
+  For apps that are built with Rails, Sinatra or any other Rack-compliant web
+  framework we offer the airbrake gem (https://github.com/airbrake/airbrake). It
+  has additional features such as reporting of any unhandled exceptions
+  automatically, integrations with Resque, Sidekiq, Delayed Job and many more.
 email: support@airbrake.io
 executables: []
 extensions: []
@@ -194,7 +207,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.0'
+      version: '2.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">"