airbrake-ruby 1.4.6 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4e55d1ef72a4b324c33893e56abd9e92c661461c
-  data.tar.gz: 14b98e0a8ba23394efd7c967add4ce0bdc93042c
+  metadata.gz: 2498350f956db613816b9cf8ae1579a01b0ca940
+  data.tar.gz: 3bafaf42dc712d226ac97b3ad5690f923ff49cc6
 SHA512:
-  metadata.gz: 33b3db9de069c13caf56f7b63b423e4ef83730b6f40398e251e9bd075d043d5b1aada097884748394d315af95e76274841e616a610dfe3f99d8cb93eed22f83f
-  data.tar.gz: 5f99f46b2ad687d9f9b3a11505c8189620a2f18ac63f4bb7fe5436c7b9aa88b3880f7adb0ca8f88edee299d92619e410c31f2915bff5861d3148551253c339eb
+  metadata.gz: 097a7a2681e0d28b020ea43a918b96ed0c89167a96d7b8146f27bac98682d95b61431ffe6eb1d78d278068b6321e4c28f196dec021c8a7fb7ed31c7e6465cc3d
+  data.tar.gz: 3cfdaaf798e0b85835126535434bb10bff78422b1b8890e924cf881b2b3843f0230eea43eaf6efdf0f9e3296941c2e85c217d71d6ed69b8caae3ae94be4baec7

data/lib/airbrake-ruby.rb

@@ -7,6 +7,7 @@ require 'socket'
 
 require 'airbrake-ruby/version'
 require 'airbrake-ruby/config'
+require 'airbrake-ruby/config/validator'
 require 'airbrake-ruby/sync_sender'
 require 'airbrake-ruby/async_sender'
 require 'airbrake-ruby/response'

data/lib/airbrake-ruby/backtrace.rb

@@ -26,14 +26,18 @@ module Airbrake
       ##
       # @return [Regexp] the pattern that matches JRuby Java stack frames, such
       #  as org.jruby.ast.NewlineNode.interpret(NewlineNode.java:105)
-      JAVA = /\A
-        (?<function>.+)  # Matches 'org.jruby.ast.NewlineNode.interpret
+      JAVA = %r{\A
+        (?<function>.+)  # Matches 'org.jruby.ast.NewlineNode.interpret'
         \(
-          (?<file>[^:]+) # Matches 'NewlineNode.java'
+          (?<file>
+            (?:uri:classloader:/.+(?=:)) # Matches '/META-INF/jruby.home/protocol.rb'
+            |
+            [^:]+        # Matches 'NewlineNode.java'
+          )
           :?
           (?<line>\d+)?  # Matches '105'
         \)
-      \z/x
+      \z}x
 
       ##
       # @return [Regexp] the pattern that tries to assume what a generic stack

data/lib/airbrake-ruby/config.rb

@@ -73,6 +73,8 @@ module Airbrake
     # @param [Hash{Symbol=>Object}] user_config the hash to be used to build the
     #   config
     def initialize(user_config = {})
+      @validator = Config::Validator.new(self)
+
       self.proxy = {}
       self.queue_size = 100
       self.workers = 1
@@ -130,8 +132,16 @@ module Airbrake
     #   otherwise
     def valid?
       return true if ignored_environment?
-      return false if project_id.to_i.zero?
-      project_key.is_a?(String) && !project_key.empty?
+
+      return false unless @validator.valid_project_id?
+      return false unless @validator.valid_project_key?
+      return false unless @validator.valid_environment?
+
+      true
+    end
+
+    def validation_error_message
+      @validator.error_message
     end
 
     ##

data/lib/airbrake-ruby/config/validator.rb

@@ -0,0 +1,73 @@
+module Airbrake
+  class Config
+    ##
+    # Validates values of {Airbrake::Config} options.
+    #
+    # @api private
+    # @since v1.5.0
+    class Validator
+      ##
+      # @return [String]
+      REQUIRED_KEY_MSG = ':project_key is required'.freeze
+
+      ##
+      # @return [String]
+      REQUIRED_ID_MSG = ':project_id is required'.freeze
+
+      ##
+      # @return [String]
+      WRONG_ENV_TYPE_MSG = "the 'environment' option must be configured " \
+                           "with a Symbol (or String), but '%s' was provided: " \
+                           "%s".freeze
+
+      ##
+      # @return [Array<Class>] the list of allowed types to configure the
+      #   environment option
+      VALID_ENV_TYPES = [NilClass, String, Symbol].freeze
+
+      ##
+      # @return [String] error message, if validator was able to find any errors
+      #   in the config
+      attr_reader :error_message
+
+      ##
+      # Validates given config and stores error message, if any errors were
+      # found.
+      #
+      # @param config [Airbrake::Config] the config to validate
+      def initialize(config)
+        @config = config
+        @error_message = nil
+      end
+
+      ##
+      # @return [Boolean]
+      def valid_project_id?
+        valid = @config.project_id.to_i > 0
+        @error_message = REQUIRED_ID_MSG unless valid
+        valid
+      end
+
+      ##
+      # @return [Boolean]
+      def valid_project_key?
+        valid = @config.project_key.is_a?(String) && !@config.project_key.empty?
+        @error_message = REQUIRED_KEY_MSG unless valid
+        valid
+      end
+
+      ##
+      # @return [Boolean]
+      def valid_environment?
+        environment = @config.environment
+        valid = VALID_ENV_TYPES.any? { |type| environment.is_a?(type) }
+
+        unless valid
+          @error_message = format(WRONG_ENV_TYPE_MSG, environment.class, environment)
+        end
+
+        valid
+      end
+    end
+  end
+end

data/lib/airbrake-ruby/filter_chain.rb

@@ -13,7 +13,10 @@ module Airbrake
       notice[:errors].each do |error|
         Gem.path.each do |gem_path|
           error[:backtrace].each do |frame|
-            frame[:file].sub!(/\A#{gem_path}/, '[GEM_ROOT]'.freeze)
+            # If the frame is unparseable, then 'file' is nil, thus nothing to
+            # filter (all frame's data is in 'function' instead).
+            next unless (file = frame[:file])
+            file.sub!(/\A#{gem_path}/, '[GEM_ROOT]'.freeze)
           end
         end
       end
@@ -67,7 +70,8 @@ module Airbrake
       proc do |notice|
         notice[:errors].each do |error|
           error[:backtrace].each do |frame|
-            frame[:file].sub!(/\A#{root_directory}/, '[PROJECT_ROOT]'.freeze)
+            next unless (file = frame[:file])
+            file.sub!(/\A#{root_directory}/, '[PROJECT_ROOT]'.freeze)
           end
         end
       end

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

@@ -32,8 +32,12 @@ module Airbrake
       def call(notice)
         FILTERABLE_KEYS.each { |key| filter_hash(notice[key]) }
 
-        if notice[:context][:user] && should_filter?(:user)
-          notice[:context][:user] = FILTERED
+        if notice[:context][:user]
+          if should_filter?(:user)
+            notice[:context][:user] = FILTERED
+          else
+            filter_hash(notice[:context][:user])
+          end
         end
 
         return unless notice[:context][:url]

data/lib/airbrake-ruby/notice.rb

@@ -2,7 +2,9 @@ module Airbrake
   ##
   # Represents a chunk of information that is meant to be either sent to
   # Airbrake or ignored completely.
+  # rubocop:disable Metrics/ClassLength
   class Notice
+    ##
     # @return [Hash{Symbol=>String}] the information about the notifier library
     NOTIFIER = {
       name: 'airbrake-ruby'.freeze,
@@ -66,6 +68,7 @@ module Airbrake
         session: {},
         params: params
       }
+      extract_custom_attributes(exception)
 
       @truncator = PayloadTruncator.new(PAYLOAD_MAX_SIZE, @config.logger)
     end
@@ -199,5 +202,30 @@ module Airbrake
 
       new_max_size
     end
+
+    def extract_custom_attributes(exception)
+      return unless exception.respond_to?(:to_airbrake)
+      attributes = nil
+
+      begin
+        attributes = exception.to_airbrake
+      rescue => ex
+        @config.logger.error(
+          "#{LOG_LABEL} #{exception.class}#to_airbrake failed: #{ex.class}: #{ex}"
+        )
+      end
+
+      return unless attributes
+
+      begin
+        @modifiable_payload.merge!(attributes)
+      rescue TypeError
+        @config.logger.error(
+          "#{LOG_LABEL} #{exception.class}#to_airbrake failed:" \
+          " #{attributes} must be a Hash"
+        )
+      end
+    end
   end
+  # rubocop:enable Metrics/ClassLength
 end

data/lib/airbrake-ruby/notifier.rb

@@ -31,7 +31,7 @@ module Airbrake
       @config = (user_config.is_a?(Config) ? user_config : Config.new(user_config))
 
       unless @config.valid?
-        raise Airbrake::Error, 'both :project_id and :project_key are required'
+        raise Airbrake::Error, @config.validation_error_message
       end
 
       @filter_chain = FilterChain.new(@config)

data/lib/airbrake-ruby/version.rb

@@ -4,5 +4,5 @@
 module Airbrake
   ##
   # @return [String] the library version
-  AIRBRAKE_RUBY_VERSION = '1.4.6'.freeze
+  AIRBRAKE_RUBY_VERSION = '1.5.0'.freeze
 end

data/spec/backtrace_spec.rb

@@ -76,6 +76,32 @@ RSpec.describe Airbrake::Backtrace do
       end
     end
 
+    context "JRuby classloader exceptions" do
+      let(:backtrace) do
+        # rubocop:disable Metrics/LineLength
+        ['uri_3a_classloader_3a_.META_minus_INF.jruby_dot_home.lib.ruby.stdlib.net.protocol.rbuf_fill(uri:classloader:/META-INF/jruby.home/lib/ruby/stdlib/net/protocol.rb:158)',
+         'bin.processors.image_uploader.block in make_streams(bin/processors/image_uploader.rb:21)']
+        # rubocop:enable Metrics/LineLength
+      end
+
+      let(:parsed_backtrace) do
+        # rubocop:disable Metrics/LineLength
+        [{ file: 'uri:classloader:/META-INF/jruby.home/lib/ruby/stdlib/net/protocol.rb', line: 158, function: 'uri_3a_classloader_3a_.META_minus_INF.jruby_dot_home.lib.ruby.stdlib.net.protocol.rbuf_fill' },
+         { file: 'bin/processors/image_uploader.rb', line: 21, function: 'bin.processors.image_uploader.block in make_streams' }]
+        # rubocop:enable Metrics/LineLength
+      end
+
+      let(:ex) { JavaAirbrakeTestError.new.tap { |e| e.set_backtrace(backtrace) } }
+
+      it "returns a properly formatted array of hashes" do
+        allow(described_class).to receive(:java_exception?).and_return(true)
+
+        expect(
+          described_class.parse(ex, Logger.new('/dev/null'))
+        ).to eq(parsed_backtrace)
+      end
+    end
+
     context "generic backtrace" do
       context "when function is absent" do
         # rubocop:disable Metrics/LineLength

data/spec/config/validator_spec.rb

@@ -0,0 +1,189 @@
+require 'spec_helper'
+
+RSpec.describe Airbrake::Config::Validator do
+  subject { described_class.new(config) }
+
+  describe "#valid_project_id?" do
+    context "when project id is zero" do
+      let(:config) { Airbrake::Config.new(project_id: 0) }
+
+      it "returns false" do
+        expect(subject.valid_project_id?).to be false
+      end
+
+      it "sets correct error message" do
+        expect { subject.valid_project_id? }.
+          to change { subject.error_message }.
+          to(/:project_id is required/)
+      end
+    end
+
+    context "when project_id is a String" do
+      let(:config) { Airbrake::Config.new(project_id: '000') }
+
+      context "and when it's zero" do
+        it "returns false" do
+          expect(subject.valid_project_id?).to be false
+        end
+
+        it "sets correct error message" do
+          expect { subject.valid_project_id? }.
+            to change { subject.error_message }.
+            to(/:project_id is required/)
+        end
+      end
+
+      context "and when it consists of letters" do
+        let(:config) { Airbrake::Config.new(project_id: 'bingo') }
+
+        it "returns false" do
+          expect(subject.valid_project_id?).to be false
+        end
+
+        it "sets correct error message" do
+          expect { subject.valid_project_id? }.
+            to change { subject.error_message }.
+            to(/:project_id is required/)
+        end
+      end
+
+      context "and when it's numerical" do
+        let(:config) { Airbrake::Config.new(project_id: '123') }
+
+        it "returns true" do
+          expect(subject.valid_project_id?).to be true
+        end
+
+        it "doesn't set the error message" do
+          expect { subject.valid_project_id? }.not_to change { subject.error_message }
+        end
+      end
+    end
+
+    context "when project id is non-zero" do
+      let(:config) { Airbrake::Config.new(project_id: 123) }
+
+      it "returns true" do
+        expect(subject.valid_project_id?).to be true
+      end
+
+      it "doesn't set the error message" do
+        expect { subject.valid_project_id? }.not_to change { subject.error_message }
+      end
+    end
+  end
+
+  describe "#valid_project_key?" do
+    context "when it's a String" do
+      context "and when it's empty" do
+        let(:config) { Airbrake::Config.new(project_key: '') }
+
+        it "returns false" do
+          expect(subject.valid_project_key?).to be false
+        end
+
+        it "sets correct error message" do
+          expect { subject.valid_project_key? }.
+            to change { subject.error_message }.
+            to(/:project_key is required/)
+        end
+      end
+
+      context "and when it's non-empty" do
+        let(:config) { Airbrake::Config.new(project_key: '123abc') }
+
+        it "returns true" do
+          expect(subject.valid_project_key?).to be true
+        end
+
+        it "doesn't set the error message" do
+          expect { subject.valid_project_key? }.not_to change { subject.error_message }
+        end
+      end
+    end
+
+    context "when it's not a String" do
+      let(:config) { Airbrake::Config.new(project_key: 123) }
+
+      it "returns false" do
+        expect(subject.valid_project_key?).to be false
+      end
+
+      it "sets correct error message" do
+        expect { subject.valid_project_key? }.
+          to change { subject.error_message }.
+          to(/:project_key is required/)
+      end
+    end
+  end
+
+  describe "#valid_environment?" do
+    context "when config.environment is not set" do
+      let(:config) { Airbrake::Config.new }
+
+      it "returns true" do
+        expect(subject.valid_environment?).to be true
+      end
+
+      it "doesn't set the error message" do
+        expect { subject.valid_environment? }.not_to change { subject.error_message }
+      end
+    end
+
+    context "when config.environment is set" do
+      context "and when it is not a Symbol or String" do
+        let(:config) { Airbrake::Config.new(environment: 123) }
+
+        it "returns false" do
+          expect(subject.valid_environment?).to be false
+        end
+
+        it "sets the error message" do
+          expect { subject.valid_environment? }.
+            to change { subject.error_message }.
+            to(/the 'environment' option must be configured with a Symbol/)
+        end
+      end
+
+      context "and when it is a Symbol" do
+        let(:config) { Airbrake::Config.new(environment: :bingo) }
+
+        it "returns true" do
+          expect(subject.valid_environment?).to be true
+        end
+
+        it "doesn't set the error message" do
+          expect { subject.valid_environment? }.not_to change { subject.error_message }
+        end
+      end
+
+      context "and when it is a String" do
+        let(:config) { Airbrake::Config.new(environment: 'bingo') }
+
+        it "returns true" do
+          expect(subject.valid_environment?).to be true
+        end
+
+        it "doesn't set the error message" do
+          expect { subject.valid_environment? }.not_to change { subject.error_message }
+        end
+      end
+
+      context "and when it is kind of a String" do
+        let(:string_inquirer) { Class.new(String) }
+
+        let(:config) do
+          Airbrake::Config.new(environment: string_inquirer.new('bingo'))
+        end
+
+        it "returns true" do
+          expect(subject.valid_environment?).to be true
+        end
+
+        it "doesn't set the error message" do
+          expect { subject.valid_environment? }.not_to change { subject.error_message }
+        end
+      end
+    end
+  end
+end

data/spec/config_spec.rb

@@ -155,6 +155,22 @@ RSpec.describe Airbrake::Config do
         expect(config).not_to be_valid
       end
     end
+
+    context "when the environment value is not a String" do
+      let(:out) { StringIO.new }
+      let(:config) { described_class.new(logger: Logger.new(out)) }
+
+      before do
+        config.project_id = 123
+        config.project_key = '321'
+
+        config.environment = ['bingo']
+      end
+
+      it "returns false" do
+        expect(config).not_to be_valid
+      end
+    end
   end
 
   describe "#ignored_environment?" do

data/spec/filter_chain_spec.rb

@@ -152,6 +152,42 @@ RSpec.describe Airbrake::FilterChain do
             to(change { notice.ignored? }.from(false).to(true))
         end
       end
+
+      context "gem root filter" do
+        let(:ex) do
+          AirbrakeTestError.new.tap do |error|
+            error.set_backtrace(['(unparseable/frame.rb:23)'])
+          end
+        end
+
+        it "does not filter file if it is nil" do
+          config.logger = Logger.new('/dev/null')
+          notice = Airbrake::Notice.new(config, ex)
+
+          expect(notice[:errors].first[:file]).to be_nil
+          expect { @chain.refine(notice) }.
+            not_to change { notice[:errors].first[:file] }
+        end
+      end
+
+      context "root directory filter" do
+        let(:ex) do
+          AirbrakeTestError.new.tap do |error|
+            error.set_backtrace(['(unparseable/frame.rb:23)'])
+          end
+        end
+
+        it "does not filter file if it is nil" do
+          config.logger = Logger.new('/dev/null')
+          config.root_directory = '/bingo/bango'
+          notice = Airbrake::Notice.new(config, ex)
+          filter_chain = described_class.new(config)
+
+          expect(notice[:errors].first[:file]).to be_nil
+          expect { filter_chain.refine(notice) }.
+            not_to change { notice[:errors].first[:file] }
+        end
+      end
     end
   end
 end

data/spec/notice_spec.rb

@@ -5,6 +5,75 @@ RSpec.describe Airbrake::Notice do
     described_class.new(Airbrake::Config.new, AirbrakeTestError.new, bingo: '1')
   end
 
+  describe "#new" do
+    let(:params) do
+      { bingo: 'bango', bongo: 'bish' }
+    end
+
+    let(:ex) { airbrake_exception_class.new(params) }
+
+    context "given an exception class, which supports #to_airbrake" do
+      context "and when #to_airbrake returns a non-Hash object" do
+        let(:airbrake_exception_class) do
+          Class.new(AirbrakeTestError) do
+            def to_airbrake
+              Object.new
+            end
+          end
+        end
+
+        it "rescues the error, logs it and doesn't modify the payload" do
+          out = StringIO.new
+          config = Airbrake::Config.new(logger: Logger.new(out))
+          notice = nil
+
+          expect { notice = described_class.new(config, ex) }.not_to raise_error
+          expect(out.string).to match(/#to_airbrake failed:.+Object.+must be a Hash/)
+          expect(notice[:params]).to be_empty
+        end
+      end
+
+      context "and when #to_airbrake errors out" do
+        let(:airbrake_exception_class) do
+          Class.new(AirbrakeTestError) do
+            def to_airbrake
+              1 / 0
+            end
+          end
+        end
+
+        it "rescues the error, logs it and doesn't modify the payload" do
+          out = StringIO.new
+          config = Airbrake::Config.new(logger: Logger.new(out))
+          notice = nil
+
+          expect { notice = described_class.new(config, ex) }.not_to raise_error
+          expect(out.string).to match(/#to_airbrake failed: ZeroDivisionError/)
+          expect(notice[:params]).to be_empty
+        end
+      end
+
+      context "and when #to_airbrake succeeds" do
+        let(:airbrake_exception_class) do
+          Class.new(AirbrakeTestError) do
+            def initialize(params)
+              @params = params
+            end
+
+            def to_airbrake
+              { params: @params }
+            end
+          end
+        end
+
+        it "merges the parameters with the notice" do
+          notice = described_class.new(Airbrake::Config.new, ex)
+          expect(notice[:params]).to eq(params)
+        end
+      end
+    end
+  end
+
   describe "#to_json" do
     context "app_version" do
       context "when missing" do

data/spec/notifier_spec.rb

@@ -30,21 +30,18 @@ RSpec.describe Airbrake::Notifier do
   describe "#new" do
     context "raises error if" do
       example ":project_id is not provided" do
-        expect { described_class.new(project_id: project_id) }.
-          to raise_error(Airbrake::Error,
-                         'both :project_id and :project_key are required')
+        expect { described_class.new(project_key: project_key) }.
+          to raise_error(Airbrake::Error, ':project_id is required')
       end
 
       example ":project_key is not provided" do
-        expect { described_class.new(project_key: project_key) }.
-          to raise_error(Airbrake::Error,
-                         'both :project_id and :project_key are required')
+        expect { described_class.new(project_id: project_id) }.
+          to raise_error(Airbrake::Error, ':project_key is required')
       end
 
       example "neither :project_id nor :project_key are provided" do
         expect { described_class.new({}) }.
-          to raise_error(Airbrake::Error,
-                         'both :project_id and :project_key are required')
+          to raise_error(Airbrake::Error, ':project_id is required')
       end
     end
 
@@ -571,6 +568,17 @@ RSpec.describe Airbrake::Notifier do
 
       expect_a_request_with_body(/"user":"\[Filtered\]"/)
     end
+
+    it "filters out individual user fields" do
+      @airbrake.blacklist_keys('name')
+
+      notice = @airbrake.build_notice(ex)
+      notice[:context][:user] = { id: 1337, name: 'Bingo Bango' }
+
+      @airbrake.notify_sync(notice)
+
+      expect_a_request_with_body(/"user":{"id":1337,"name":"\[Filtered\]"}/)
+    end
   end
 
   describe "#whitelist_keys" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: airbrake-ruby
 version: !ruby/object:Gem::Version
-  version: 1.4.6
+  version: 1.5.0
 platform: ruby
 authors:
 - Airbrake Technologies, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-18 00:00:00.000000000 Z
+date: 2016-09-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -99,6 +99,7 @@ files:
 - lib/airbrake-ruby/async_sender.rb
 - lib/airbrake-ruby/backtrace.rb
 - lib/airbrake-ruby/config.rb
+- lib/airbrake-ruby/config/validator.rb
 - lib/airbrake-ruby/filter_chain.rb
 - lib/airbrake-ruby/filters.rb
 - lib/airbrake-ruby/filters/keys_blacklist.rb
@@ -114,6 +115,7 @@ files:
 - spec/airbrake_spec.rb
 - spec/async_sender_spec.rb
 - spec/backtrace_spec.rb
+- spec/config/validator_spec.rb
 - spec/config_spec.rb
 - spec/filter_chain_spec.rb
 - spec/nested_exception_spec.rb
@@ -151,6 +153,7 @@ test_files:
 - spec/airbrake_spec.rb
 - spec/async_sender_spec.rb
 - spec/backtrace_spec.rb
+- spec/config/validator_spec.rb
 - spec/config_spec.rb
 - spec/filter_chain_spec.rb
 - spec/nested_exception_spec.rb