airbrake-ruby 2.9.0 → 2.10.0

data/lib/airbrake-ruby/notifier.rb

@@ -1,16 +1,14 @@
 module Airbrake
-  ##
   # This class is reponsible for sending notices to Airbrake. It supports
   # synchronous and asynchronous delivery.
   #
   # @see Airbrake::Config The list of options
   # @since v1.0.0
+  # @api private
   class Notifier
-    ##
     # @return [String] the label to be prepended to the log output
     LOG_LABEL = '**Airbrake:'.freeze
 
-    ##
     # Creates a new Airbrake notifier with the given config options.
     #
     # @example Configuring with a Hash
@@ -40,29 +38,21 @@ module Airbrake
       @sync_sender = SyncSender.new(@config)
     end
 
-    ##
-    # @!macro see_public_api_method
-    #   @see Airbrake.$0
-
-    ##
     # @macro see_public_api_method
     def notify(exception, params = {}, &block)
       send_notice(exception, params, default_sender, &block)
     end
 
-    ##
     # @macro see_public_api_method
     def notify_sync(exception, params = {}, &block)
       send_notice(exception, params, @sync_sender, &block).value
     end
 
-    ##
     # @macro see_public_api_method
     def add_filter(filter = nil, &block)
       @filter_chain.add_filter(block_given? ? block : filter)
     end
 
-    ##
     # @macro see_public_api_method
     def build_notice(exception, params = {})
       if @async_sender.closed?
@@ -78,13 +68,11 @@ module Airbrake
       end
     end
 
-    ##
     # @macro see_public_api_method
     def close
       @async_sender.close
     end
 
-    ##
     # @macro see_public_api_method
     def create_deploy(deploy_params)
       deploy_params[:environment] ||= @config.environment
@@ -94,13 +82,11 @@ module Airbrake
       promise
     end
 
-    ##
     # @macro see_public_api_method
     def configured?
       @config.valid?
     end
 
-    ##
     # @macro see_public_api_method
     def merge_context(context)
       @context.merge!(context)
@@ -171,6 +157,9 @@ module Airbrake
       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)
       @filter_chain.add_filter(
@@ -178,29 +167,4 @@ module Airbrake
       )
     end
   end
-
-  ##
-  # NilNotifier is a no-op notifier, which mimics +Airbrake::Notifier+ and
-  # serves only for the purpose of making the library API easier to use.
-  #
-  # @since 2.1.0
-  class NilNotifier
-    def notify(_exception, _params = {}, &block); end
-
-    def notify_sync(_exception, _params = {}, &block); end
-
-    def add_filter(_filter = nil, &_block); end
-
-    def build_notice(_exception, _params = {}); end
-
-    def close; end
-
-    def create_deploy(_deploy_params); end
-
-    def configured?
-      false
-    end
-
-    def merge_context(_context); end
-  end
 end

data/lib/airbrake-ruby/promise.rb

@@ -1,5 +1,4 @@
 module Airbrake
-  ##
   # Represents a simplified promise object (similar to promises found in
   # JavaScript), which allows chaining callbacks that are executed when the
   # promise is either resolved or rejected.
@@ -8,7 +7,6 @@ module Airbrake
   # @see https://github.com/ruby-concurrency/concurrent-ruby/blob/master/lib/concurrent/promise.rb
   # @since v1.7.0
   class Promise
-    ##
     # @api private
     # @return [Hash<String,String>] either successful response containing the
     #   +id+ key or unsuccessful response containing the +error+ key
@@ -22,7 +20,6 @@ module Airbrake
       @mutex = Mutex.new
     end
 
-    ##
     # Attaches a callback to be executed when the promise is resolved.
     #
     # @example
@@ -46,7 +43,6 @@ module Airbrake
       self
     end
 
-    ##
     # Attaches a callback to be executed when the promise is rejected.
     #
     # @example
@@ -68,7 +64,6 @@ module Airbrake
       self
     end
 
-    ##
     # Resolves the promise.
     #
     # @example
@@ -85,7 +80,6 @@ module Airbrake
       self
     end
 
-    ##
     # Rejects the promise.
     #
     # @example

data/lib/airbrake-ruby/response.rb

@@ -1,20 +1,16 @@
 module Airbrake
-  ##
   # Parses responses coming from the Airbrake API. Handles HTTP errors by
   # logging them.
   #
   # @api private
   # @since v1.0.0
   module Response
-    ##
     # @return [Integer] the limit of the response body
     TRUNCATE_LIMIT = 100
 
-    ##
     # @return [Integer] HTTP code returned when an IP sends over 10k/min notices
     TOO_MANY_REQUESTS = 429
 
-    ##
     # Parses HTTP responses from the Airbrake API.
     #
     # @param [Net::HTTPResponse] response

data/lib/airbrake-ruby/sync_sender.rb

@@ -1,23 +1,19 @@
 module Airbrake
-  ##
   # Responsible for sending notices to Airbrake synchronously. Supports proxies.
   #
   # @see AsyncSender
   # @api private
   # @since v1.0.0
   class SyncSender
-    ##
     # @return [String] body for HTTP requests
     CONTENT_TYPE = 'application/json'.freeze
 
-    ##
     # @param [Airbrake::Config] config
     def initialize(config)
       @config = config
       @rate_limit_reset = Time.now
     end
 
-    ##
     # Sends a POST request to the given +endpoint+ with the +notice+ payload.
     #
     # @param [Airbrake::Notice] notice

data/lib/airbrake-ruby/version.rb

@@ -1,8 +1,6 @@
-##
 # We use Semantic Versioning v2.0.0
 # More information: http://semver.org/
 module Airbrake
-  ##
   # @return [String] the library version
-  AIRBRAKE_RUBY_VERSION = '2.9.0'.freeze
+  AIRBRAKE_RUBY_VERSION = '2.10.0'.freeze
 end

data/spec/airbrake_spec.rb

@@ -1,182 +1,113 @@
 require 'spec_helper'
 
 RSpec.describe Airbrake do
-  let(:endpoint) { 'https://airbrake.io/api/v3/projects/113743/notices' }
-
-  let!(:notifier) do
-    described_class.configure do |c|
-      c.project_id = 113743
-      c.project_key = 'fd04e13d806a90f96614ad8e529b2822'
+  describe ".[]" do
+    it "returns a NilNotifier" do
+      expect(described_class[:test]).to be_an(Airbrake::NilNotifier)
     end
   end
 
-  before do
-    stub_request(:post, endpoint).to_return(status: 201, body: '{}')
-  end
-
-  after do
-    described_class.instance_variable_set(
-      :@notifiers,
-      Hash.new(Airbrake::NilNotifier.new)
-    )
+  let(:default_notifier) do
+    described_class.instance_variable_get(:@notifiers)[:default]
   end
 
-  shared_examples 'non-configured notifier handling' do |method|
-    it "returns nil if there is no configured notifier when using #{method}" do
-      described_class.instance_variable_set(
-        :@notifiers,
-        Hash.new(Airbrake::NilNotifier.new)
-      )
-      expect(described_class.__send__(method, 'bingo')).to be_nil
-    end
-  end
+  describe ".configure" do
+    let(:config_params) { { project_id: 1, project_key: 'abc' } }
 
-  describe ".notify" do
-    include_examples 'non-configured notifier handling', :notify
+    after { described_class.instance_variable_get(:@notifiers).clear }
 
-    it "sends exceptions asynchronously" do
-      described_class.notify('bingo')
-      sleep 2
-      expect(a_request(:post, endpoint)).to have_been_made.once
+    it "yields the config" do
+      expect do |b|
+        begin
+          described_class.configure(&b)
+        rescue Airbrake::Error
+          nil
+        end
+      end.to yield_with_args(Airbrake::Config)
     end
 
-    it "yields a notice" do
-      described_class.notify('bongo') do |notice|
-        notice[:params][:bingo] = :bango
+    context "when invoked with a notifier name" do
+      it "sets notifier name to the provided name" do
+        described_class.configure(:test) { |c| c.merge(config_params) }
+        expect(described_class[:test]).to be_an(Airbrake::Notifier)
       end
-
-      sleep 1
-
-      expect(
-        a_request(:post, endpoint).
-        with(body: /params":{.*"bingo":"bango".*}/)
-      ).to have_been_made.once
-    end
-  end
-
-  describe ".notify_sync" do
-    include_examples 'non-configured notifier handling', :notify_sync
-
-    it "sends exceptions synchronously" do
-      expect(described_class.notify_sync('bingo')).to be_a(Hash)
-      expect(a_request(:post, endpoint)).to have_been_made.once
     end
 
-    it "yields a notice" do
-      described_class.notify_sync('bongo') do |notice|
-        notice[:params][:bingo] = :bango
+    context "when invoked without a notifier name" do
+      it "defaults to the :default notifier name" do
+        described_class.configure { |c| c.merge(config_params) }
+        expect(described_class[:default]).to be_an(Airbrake::Notifier)
       end
-
-      expect(
-        a_request(:post, endpoint).
-        with(body: /params":{.*"bingo":"bango".*}/)
-      ).to have_been_made.once
     end
 
-    describe "clean backtrace" do
-      shared_examples 'backtrace building' do |msg, argument|
-        it(msg) do
-          described_class.notify_sync(argument)
-
-          # rubocop:disable Metrics/LineLength
-          expected_body = %r|
-            {"errors":\[{"type":"RuntimeError","message":"bingo","backtrace":\[
-            {"file":"/PROJECT_ROOT/spec/airbrake_spec.rb","line":\d+,"function":"[\w/\s\(\)<>]+","code".+},
-            {"file":"/GEM_ROOT/gems/rspec-core-.+/.+","line":\d+,"function":"[\w/\s\(\)<>]+".+
-          |x
-          # rubocop:enable Metrics/LineLength
-
-          expect(
-            a_request(:post, endpoint).
-            with(body: expected_body)
-          ).to have_been_made.once
-        end
-      end
-
-      context "given a String" do
-        include_examples(
-          'backtrace building',
-          'converts it to a RuntimeException and builds a fake backtrace',
-          'bingo'
-        )
-      end
-
-      context "given an Exception with missing backtrace" do
-        include_examples(
-          'backtrace building',
-          'builds a backtrace for it and sends the notice',
-          RuntimeError.new('bingo')
+    context "when invoked twice with the same notifier name" do
+      it "raises Airbrake::Error" do
+        described_class.configure { |c| c.merge(config_params) }
+        expect do
+          described_class.configure { |c| c.merge(config_params) }
+        end.to raise_error(
+          Airbrake::Error, "the 'default' notifier was already configured"
         )
       end
     end
   end
 
-  describe ".configure" do
-    context "given an argument" do
-      it "configures a notifier with the given name" do
-        described_class.configure(:bingo) do |c|
-          c.project_id = 123
-          c.project_key = '321'
-        end
-
-        notifiers = described_class.instance_variable_get(:@notifiers)
-
-        expect(notifiers).to be_a(Hash)
-        expect(notifiers.keys).to eq(%i[default bingo])
-        expect(notifiers.values).to all(satisfy { |v| v.is_a?(Airbrake::Notifier) })
-      end
-
-      it "raises error when a notifier of the given type was already configured" do
-        described_class.configure(:bingo) do |c|
-          c.project_id = 123
-          c.project_key = '321'
-        end
-
-        expect do
-          described_class.configure(:bingo) do |c|
-            c.project_id = 123
-            c.project_key = '321'
-          end
-        end.to raise_error(Airbrake::Error,
-                           "the 'bingo' notifier was already configured")
-      end
+  describe ".configured?" do
+    it "forwards 'configured?' to the notifier" do
+      expect(default_notifier).to receive(:configured?)
+      described_class.configured?
     end
   end
 
-  describe ".configured?" do
-    before do
-      described_class.instance_variable_set(
-        :@notifiers,
-        Hash.new(Airbrake::NilNotifier.new)
-      )
+  describe ".notify" do
+    it "forwards 'notify' to the notifier" do
+      block = proc {}
+      expect(default_notifier).to receive(:notify).with('ex', foo: 'bar', &block)
+      described_class.notify('ex', foo: 'bar', &block)
     end
+  end
 
-    it "returns false" do
-      expect(described_class).not_to be_configured
+  describe ".notify_sync" do
+    it "forwards 'notify_sync' to the notifier" do
+      block = proc {}
+      expect(default_notifier).to receive(:notify).with('ex', foo: 'bar', &block)
+      described_class.notify('ex', foo: 'bar', &block)
     end
   end
 
   describe ".add_filter" do
-    include_examples 'non-configured notifier handling', :add_filter
-
-    it "adds filters with help of blocks" do
-      filter_chain = notifier.instance_variable_get(:@filter_chain)
-      filters = filter_chain.instance_variable_get(:@filters)
-
-      expect(filters.size).to eq(4)
+    it "forwards 'add_filter' to the notifier" do
+      block = proc {}
+      expect(default_notifier).to receive(:add_filter).with(nil, &block)
+      described_class.add_filter(&block)
+    end
+  end
 
-      described_class.add_filter {}
+  describe ".build_notice" do
+    it "forwards 'build_notice' to the notifier" do
+      expect(default_notifier).to receive(:build_notice).with('ex', foo: 'bar')
+      described_class.build_notice('ex', foo: 'bar')
+    end
+  end
 
-      expect(filters.size).to eq(5)
-      expect(filters.last).to be_a(Proc)
+  describe ".close" do
+    it "forwards 'close' to the notifier" do
+      expect(default_notifier).to receive(:close)
+      described_class.close
     end
   end
 
-  describe ".build_notice" do
-    include_examples 'non-configured notifier handling', :build_notice
+  describe ".create_deploy" do
+    it "forwards 'create_deploy' to the notifier" do
+      expect(default_notifier).to receive(:create_deploy).with(foo: 'bar')
+      described_class.create_deploy(foo: 'bar')
+    end
   end
 
   describe ".merge_context" do
-    include_examples 'non-configured notifier handling', :merge_context
+    it "forwards 'merge_context' to the notifier" do
+      expect(default_notifier).to receive(:merge_context).with(foo: 'bar')
+      described_class.merge_context(foo: 'bar')
+    end
   end
 end