airbrake-ruby 1.0.0.rc.1

data/spec/async_sender_spec.rb

@@ -0,0 +1,121 @@
+require 'spec_helper'
+
+RSpec.describe Airbrake::AsyncSender do
+  before do
+    stub_request(:post, /.*/).to_return(status: 201, body: '{}')
+    @sender = described_class.new(Airbrake::Config.new)
+    @workers = @sender.instance_variable_get(:@workers)
+  end
+
+  describe "#new" do
+    context "workers_count parameter" do
+      let(:new_workers) { 5 }
+      let(:config) { Airbrake::Config.new(workers: new_workers) }
+
+      it "spawns alive threads in an enclosed ThreadGroup" do
+        expect(@workers).to be_a(ThreadGroup)
+        expect(@workers.list).to all(be_alive)
+        expect(@workers).to be_enclosed
+      end
+
+      it "controls the number of spawned threads" do
+        expect(@workers.list.size).to eq(1)
+
+        sender = described_class.new(config)
+        workers = sender.instance_variable_get(:@workers)
+
+        expect(workers.list.size).to eq(new_workers)
+        sender.close
+      end
+    end
+
+    context "queue" do
+      before do
+        @stdout = StringIO.new
+      end
+
+      let(:notices) { 1000 }
+
+      let(:config) do
+        Airbrake::Config.new(logger: Logger.new(@stdout), workers: 3, queue_size: 10)
+      end
+
+      it "limits the size of the queue, but still sends all notices" do
+        sender = described_class.new(config)
+
+        notices.times { |i| sender.send(i) }
+        sender.close
+
+        log = @stdout.string.split("\n")
+        expect(log.grep(/\*\*Airbrake: \{\}/).size).to eq(notices)
+      end
+    end
+  end
+
+  describe "#close" do
+    before do
+      @stderr = StringIO.new
+      config = Airbrake::Config.new(logger: Logger.new(@stderr))
+      @sender = described_class.new(config)
+      @workers = @sender.instance_variable_get(:@workers).list
+    end
+
+    context "when there are no unsent notices" do
+      it "joins the spawned thread" do
+        expect(@workers).to all(be_alive)
+        @sender.close
+        expect(@workers).to all(be_stop)
+      end
+    end
+
+    context "when there are some unsent notices" do
+      before do
+        300.times { |i| @sender.send(i) }
+        expect(@sender.instance_variable_get(:@unsent).size).not_to be_zero
+        @sender.close
+      end
+
+      it "warns about the number of notices" do
+        expect(@stderr.string).to match(/waiting to send \d+ unsent notice/)
+      end
+
+      it "prints the debug message the correct number of times" do
+        log = @stderr.string.split("\n")
+        expect(log.grep(/\*\*Airbrake: \{\}/).size).to eq(300)
+      end
+
+      it "waits until the unsent notices queue is empty" do
+        expect(@sender.instance_variable_get(:@unsent).size).to be_zero
+      end
+    end
+
+    context "when it was already closed" do
+      it "doesn't increase the unsent queue size" do
+        @sender.close
+        expect(@sender.instance_variable_get(:@unsent).size).to be_zero
+
+        expect { @sender.close }.
+          to raise_error(Airbrake::Error, 'attempted to close already closed sender')
+      end
+    end
+  end
+
+  describe "#has_workers?" do
+    it "returns false when the sender is not closed, but has 0 workers" do
+      sender = described_class.new(Airbrake::Config.new)
+      expect(sender.has_workers?).to be_truthy
+
+      sender.instance_variable_get(:@workers).list.each(&:kill)
+      sleep 1
+      expect(sender.has_workers?).to be_falsey
+    end
+
+    it "returns false when the sender is closed" do
+      sender = described_class.new(Airbrake::Config.new)
+      expect(sender.has_workers?).to be_truthy
+
+      sender.close
+      expect(sender.has_workers?).to be_falsey
+    end
+  end
+end

data/spec/backtrace_spec.rb

@@ -0,0 +1,77 @@
+require 'spec_helper'
+
+RSpec.describe Airbrake::Backtrace do
+  describe ".parse" do
+    context "UNIX backtrace" do
+      let(:backtrace) { described_class.new(AirbrakeTestError.new) }
+
+      let(:parsed_backtrace) do
+        # rubocop:disable Metrics/LineLength, Style/HashSyntax, Style/SpaceAroundOperators, Style/SpaceInsideHashLiteralBraces
+        [{:file=>"/home/kyrylo/code/airbrake/ruby/spec/spec_helper.rb", :line=>23, :function=>"<top (required)>"},
+         {:file=>"/opt/rubies/ruby-2.2.2/lib/ruby/2.2.0/rubygems/core_ext/kernel_require.rb", :line=>54, :function=>"require"},
+         {:file=>"/opt/rubies/ruby-2.2.2/lib/ruby/2.2.0/rubygems/core_ext/kernel_require.rb", :line=>54, :function=>"require"},
+         {:file=>"/home/kyrylo/code/airbrake/ruby/spec/airbrake_spec.rb", :line=>1, :function=>"<top (required)>"},
+         {:file=>"/home/kyrylo/.gem/ruby/2.2.2/gems/rspec-core-3.3.2/lib/rspec/core/configuration.rb", :line=>1327, :function=>"load"},
+         {:file=>"/home/kyrylo/.gem/ruby/2.2.2/gems/rspec-core-3.3.2/lib/rspec/core/configuration.rb", :line=>1327, :function=>"block in load_spec_files"},
+         {:file=>"/home/kyrylo/.gem/ruby/2.2.2/gems/rspec-core-3.3.2/lib/rspec/core/configuration.rb", :line=>1325, :function=>"each"},
+         {:file=>"/home/kyrylo/.gem/ruby/2.2.2/gems/rspec-core-3.3.2/lib/rspec/core/configuration.rb", :line=>1325, :function=>"load_spec_files"},
+         {:file=>"/home/kyrylo/.gem/ruby/2.2.2/gems/rspec-core-3.3.2/lib/rspec/core/runner.rb", :line=>102, :function=>"setup"},
+         {:file=>"/home/kyrylo/.gem/ruby/2.2.2/gems/rspec-core-3.3.2/lib/rspec/core/runner.rb", :line=>88, :function=>"run"},
+         {:file=>"/home/kyrylo/.gem/ruby/2.2.2/gems/rspec-core-3.3.2/lib/rspec/core/runner.rb", :line=>73, :function=>"run"},
+         {:file=>"/home/kyrylo/.gem/ruby/2.2.2/gems/rspec-core-3.3.2/lib/rspec/core/runner.rb", :line=>41, :function=>"invoke"},
+         {:file=>"/home/kyrylo/.gem/ruby/2.2.2/gems/rspec-core-3.3.2/exe/rspec", :line=>4, :function=>"<main>"}]
+        # rubocop:enable Metrics/LineLength, Style/HashSyntax,Style/SpaceAroundOperators, Style/SpaceInsideHashLiteralBraces
+      end
+
+      it "returns a properly formatted array of hashes" do
+        expect(described_class.parse(AirbrakeTestError.new)).
+          to eq(parsed_backtrace)
+      end
+    end
+
+    context "Windows backtrace" do
+      let(:windows_bt) do
+        ["C:/Program Files/Server/app/models/user.rb:13:in `magic'",
+         "C:/Program Files/Server/app/controllers/users_controller.rb:8:in `index'"]
+      end
+
+      let(:ex) { AirbrakeTestError.new.tap { |e| e.set_backtrace(windows_bt) } }
+
+      let(:parsed_backtrace) do
+        # rubocop:disable Metrics/LineLength, Style/HashSyntax, Style/SpaceInsideHashLiteralBraces, Style/SpaceAroundOperators
+        [{:file=>"C:/Program Files/Server/app/models/user.rb", :line=>13, :function=>"magic"},
+         {:file=>"C:/Program Files/Server/app/controllers/users_controller.rb", :line=>8, :function=>"index"}]
+        # rubocop:enable Metrics/LineLength, Style/HashSyntax, Style/SpaceInsideHashLiteralBraces, Style/SpaceAroundOperators
+      end
+
+      it "returns a properly formatted array of hashes" do
+        expect(described_class.parse(ex)).to eq(parsed_backtrace)
+      end
+    end
+
+    context "JRuby Java exceptions" do
+      let(:backtrace_array) do
+        # rubocop:disable Metrics/LineLength, Style/HashSyntax, Style/SpaceInsideHashLiteralBraces, Style/SpaceAroundOperators
+        [{:file=>"InstanceMethodInvoker.java", :line=>26, :function=>"org.jruby.java.invokers.InstanceMethodInvoker.call"},
+         {:file=>"Interpreter.java", :line=>126, :function=>"org.jruby.ir.interpreter.Interpreter.INTERPRET_EVAL"},
+         {:file=>"RubyKernel$INVOKER$s$0$3$eval19.gen", :line=>nil, :function=>"org.jruby.RubyKernel$INVOKER$s$0$3$eval19.call"},
+         {:file=>"RubyKernel$INVOKER$s$0$0$loop.gen", :line=>nil, :function=>"org.jruby.RubyKernel$INVOKER$s$0$0$loop.call"},
+         {:file=>"IRBlockBody.java", :line=>139, :function=>"org.jruby.runtime.IRBlockBody.doYield"},
+         {:file=>"RubyKernel$INVOKER$s$rbCatch19.gen", :line=>nil, :function=>"org.jruby.RubyKernel$INVOKER$s$rbCatch19.call"},
+         {:file=>"/opt/rubies/jruby-9.0.0.0/bin/irb", :line=>nil, :function=>"opt.rubies.jruby_minus_9_dot_0_dot_0_dot_0.bin.irb.invokeOther4:start"},
+         {:file=>"/opt/rubies/jruby-9.0.0.0/bin/irb", :line=>13, :function=>"opt.rubies.jruby_minus_9_dot_0_dot_0_dot_0.bin.irb.RUBY$script"},
+         {:file=>"Compiler.java", :line=>111, :function=>"org.jruby.ir.Compiler$1.load"},
+         {:file=>"Main.java", :line=>225, :function=>"org.jruby.Main.run"},
+         {:file=>"Main.java", :line=>197, :function=>"org.jruby.Main.main"}]
+        # rubocop:enable Metrics/LineLength, Style/HashSyntax, Style/SpaceInsideHashLiteralBraces, Style/SpaceAroundOperators
+      end
+
+      it "returns a properly formatted array of hashes" do
+        allow(described_class).to receive(:java_exception?).and_return(true)
+
+        expect(described_class.parse(JavaAirbrakeTestError.new)).
+          to eq(backtrace_array)
+      end
+    end
+  end
+end

data/spec/config_spec.rb

@@ -0,0 +1,67 @@
+require 'spec_helper'
+
+RSpec.describe Airbrake::Config do
+  let(:config) { described_class.new }
+
+  describe "#new" do
+    describe "options" do
+      it "doesn't set the default project_id" do
+        expect(config.project_id).to be_nil
+      end
+
+      it "doesn't set the default project_key" do
+        expect(config.project_key).to be_nil
+      end
+
+      it "doesn't set the default proxy" do
+        expect(config.proxy).to be_empty
+      end
+
+      it "sets the default logger" do
+        expect(config.logger).to be_a Logger
+      end
+
+      it "doesn't set the default app_version" do
+        expect(config.app_version).to be_nil
+      end
+
+      it "sets the default host" do
+        expect(config.host).to eq('https://airbrake.io')
+      end
+
+      it "sets the default endpoint" do
+        expect(config.endpoint).not_to be_nil
+      end
+
+      it "creates a new Config and merges it with the user config" do
+        cfg = described_class.new(logger: StringIO.new)
+        expect(cfg.logger).to be_a StringIO
+      end
+
+      it "raises error on unknown config options" do
+        expect { described_class.new(unknown_option: true) }.
+          to raise_error(Airbrake::Error, /unknown option/)
+      end
+
+      it "sets the default number of workers" do
+        expect(config.workers).to eq(1)
+      end
+
+      it "sets the default number of queue size" do
+        expect(config.queue_size).to eq(100)
+      end
+
+      it "doesn't set the default root_directory" do
+        expect(config.root_directory).to be_nil
+      end
+
+      it "doesn't set the default environment" do
+        expect(config.environment).to be_nil
+      end
+
+      it "doesn't set default notify_environments" do
+        expect(config.ignore_environments).to be_empty
+      end
+    end
+  end
+end

data/spec/filter_chain_spec.rb

@@ -0,0 +1,157 @@
+require 'spec_helper'
+
+RSpec.describe Airbrake::FilterChain do
+  before do
+    @chain = described_class.new(config)
+  end
+
+  let(:config) { Airbrake::Config.new }
+
+  describe "#refine" do
+    describe "execution order" do
+      let(:notice) do
+        Airbrake::Notice.new(config, AirbrakeTestError.new)
+      end
+
+      it "executes filters starting from the oldest" do
+        nums = []
+
+        3.times do |i|
+          @chain.add_filter(proc { nums << i })
+        end
+
+        @chain.refine(notice)
+
+        expect(nums).to eq([0, 1, 2])
+      end
+
+      it "stops execution once a notice was ignored" do
+        nums = []
+
+        5.times do |i|
+          @chain.add_filter(proc do |notice|
+                              nums << i
+                              notice.ignore! if i == 2
+                            end)
+        end
+
+        @chain.refine(notice)
+
+        expect(nums).to eq([0, 1, 2])
+      end
+    end
+
+    describe "default backtrace filters" do
+      let(:ex) { AirbrakeTestError.new.tap { |e| e.set_backtrace(backtrace) } }
+      let(:notice) { Airbrake::Notice.new(config, ex) }
+
+      before do
+        Gem.path << '/my/gem/root' << '/my/other/gem/root'
+        @chain.refine(notice)
+        @bt = notice[:errors].first[:backtrace].map { |frame| frame[:file] }
+      end
+
+      shared_examples 'root directories' do |root_directory, bt, expected_bt|
+        let(:backtrace) { bt }
+
+        before do
+          config = Airbrake::Config.new(root_directory: root_directory)
+          chain = described_class.new(config)
+          chain.refine(notice)
+          @bt = notice[:errors].first[:backtrace].map { |frame| frame[:file] }
+        end
+
+        it "filters it out" do
+          expect(@bt).to eq(expected_bt)
+        end
+      end
+
+      # rubocop:disable Metrics/LineLength
+      context "gem root" do
+        bt = [
+          "/home/kyrylo/code/airbrake/ruby/spec/spec_helper.rb:23:in `<top (required)>'",
+          "/my/gem/root/gems/rspec-core-3.3.2/lib/rspec/core/configuration.rb:1327:in `load'",
+          "/opt/rubies/ruby-2.2.2/lib/ruby/2.2.0/rubygems/core_ext/kernel_require.rb:54:in `require'",
+          "/my/other/gem/root/gems/rspec-core-3.3.2/exe/rspec:4:in `<main>'"
+        ]
+
+        expected_bt = [
+          "/home/kyrylo/code/airbrake/ruby/spec/spec_helper.rb",
+          "[GEM_ROOT]/gems/rspec-core-3.3.2/lib/rspec/core/configuration.rb",
+          "/opt/rubies/ruby-2.2.2/lib/ruby/2.2.0/rubygems/core_ext/kernel_require.rb",
+          "[GEM_ROOT]/gems/rspec-core-3.3.2/exe/rspec"
+        ]
+
+        include_examples 'root directories', nil, bt, expected_bt
+      end
+
+      context "root directory" do
+        context "when normal string path" do
+          bt = [
+            "/home/kyrylo/code/airbrake/ruby/spec/spec_helper.rb:23:in `<top (required)>'",
+            "/var/www/project/gems/rspec-core-3.3.2/lib/rspec/core/configuration.rb:1327:in `load'",
+            "/opt/rubies/ruby-2.2.2/lib/ruby/2.2.0/rubygems/core_ext/kernel_require.rb:54:in `require'",
+            "/var/www/project/gems/rspec-core-3.3.2/exe/rspec:4:in `<main>'"
+          ]
+
+          expected_bt = [
+            "/home/kyrylo/code/airbrake/ruby/spec/spec_helper.rb",
+            "[PROJECT_ROOT]/gems/rspec-core-3.3.2/lib/rspec/core/configuration.rb",
+            "/opt/rubies/ruby-2.2.2/lib/ruby/2.2.0/rubygems/core_ext/kernel_require.rb",
+            "[PROJECT_ROOT]/gems/rspec-core-3.3.2/exe/rspec"
+          ]
+
+          include_examples 'root directories', '/var/www/project', bt, expected_bt
+        end
+
+        context "when equals to a part of filename" do
+          bt = [
+            "/home/kyrylo/code/airbrake/ruby/spec/spec_helper.rb:23:in `<top (required)>'",
+            "/var/www/gems/gems/rspec-core-3.3.2/lib/rspec/core/configuration.rb:1327:in `load'",
+            "/opt/rubies/ruby-2.2.2/lib/ruby/2.2.0/rubygems/core_ext/kernel_require.rb:54:in `require'",
+            "/var/www/gems/gems/rspec-core-3.3.2/exe/rspec:4:in `<main>'"
+          ]
+
+          expected_bt = [
+            "/home/kyrylo/code/airbrake/ruby/spec/spec_helper.rb",
+            "[PROJECT_ROOT]/gems/rspec-core-3.3.2/lib/rspec/core/configuration.rb",
+            "/opt/rubies/ruby-2.2.2/lib/ruby/2.2.0/rubygems/core_ext/kernel_require.rb",
+            "[PROJECT_ROOT]/gems/rspec-core-3.3.2/exe/rspec"
+          ]
+
+          include_examples 'root directories', '/var/www/gems', bt, expected_bt
+        end
+
+        context "when normal pathname path" do
+          bt = [
+            "/home/kyrylo/code/airbrake/ruby/spec/spec_helper.rb:23:in `<top (required)>'",
+            "/var/www/project/gems/rspec-core-3.3.2/lib/rspec/core/configuration.rb:1327:in `load'",
+            "/opt/rubies/ruby-2.2.2/lib/ruby/2.2.0/rubygems/core_ext/kernel_require.rb:54:in `require'",
+            "/var/www/project/gems/rspec-core-3.3.2/exe/rspec:4:in `<main>'"
+          ]
+
+          expected_bt = [
+            "/home/kyrylo/code/airbrake/ruby/spec/spec_helper.rb",
+            "[PROJECT_ROOT]/gems/rspec-core-3.3.2/lib/rspec/core/configuration.rb",
+            "/opt/rubies/ruby-2.2.2/lib/ruby/2.2.0/rubygems/core_ext/kernel_require.rb",
+            "[PROJECT_ROOT]/gems/rspec-core-3.3.2/exe/rspec"
+          ]
+
+          include_examples 'root directories',
+                           Pathname.new('/var/www/project'), bt, expected_bt
+        end
+      end
+      # rubocop:enable Metrics/LineLength
+    end
+
+    describe "default ignore filters" do
+      context "system exit filter" do
+        it "marks SystemExit exceptions as ignored" do
+          notice = Airbrake::Notice.new(config, SystemExit.new)
+          expect { @chain.refine(notice) }.
+            to(change { notice.ignored? }.from(false).to(true))
+        end
+      end
+    end
+  end
+end

data/spec/notice_spec.rb

@@ -0,0 +1,190 @@
+require 'spec_helper'
+
+RSpec.describe Airbrake::Notice do
+  let(:notice) do
+    described_class.new(Airbrake::Config.new, AirbrakeTestError.new, bingo: '1')
+  end
+
+  describe "#new" do
+    context "nested exceptions" do
+      it "unwinds nested exceptions" do
+        begin
+          begin
+            raise AirbrakeTestError
+          rescue AirbrakeTestError
+            Ruby21Error.raise_error('bingo')
+          end
+        rescue Ruby21Error => ex
+          notice = described_class.new(Airbrake::Config.new, ex)
+
+          expect(notice[:errors].size).to eq(2)
+          expect(notice[:errors][0][:message]).to eq('bingo')
+          expect(notice[:errors][1][:message]).to eq('App crashed!')
+        end
+      end
+
+      it "unwinds no more than 3 nested exceptions" do
+        begin
+          begin
+            raise AirbrakeTestError
+          rescue AirbrakeTestError
+            begin
+              Ruby21Error.raise_error('bongo')
+            rescue Ruby21Error
+              begin
+                Ruby21Error.raise_error('bango')
+              rescue Ruby21Error
+                Ruby21Error.raise_error('bingo')
+              end
+            end
+          end
+        rescue Ruby21Error => ex
+          notice = described_class.new(Airbrake::Config.new, ex)
+
+          expect(notice[:errors].size).to eq(3)
+          expect(notice[:errors][0][:message]).to eq('bingo')
+          expect(notice[:errors][1][:message]).to eq('bango')
+          expect(notice[:errors][2][:message]).to eq('bongo')
+        end
+      end
+    end
+  end
+
+  describe "#to_json" do
+    context "app_version" do
+      context "when missing" do
+        it "doesn't include app_version" do
+          expect(notice.to_json).not_to match(/"context":{"version":"1.2.3"/)
+        end
+      end
+
+      context "when present" do
+        let(:config) do
+          Airbrake::Config.new(app_version: '1.2.3', root_directory: '/one/two')
+        end
+
+        let(:notice) { described_class.new(config, AirbrakeTestError.new) }
+
+        it "includes app_version" do
+          expect(notice.to_json).to match(/"context":{"version":"1.2.3"/)
+        end
+
+        it "includes root_directory" do
+          expect(notice.to_json).to match(%r{"rootDirectory":"/one/two"})
+        end
+      end
+    end
+
+    context "truncation" do
+      shared_examples 'payloads' do |size, msg|
+        it msg do
+          ex = AirbrakeTestError.new
+
+          backtrace = []
+          size.times { backtrace << "bin/rails:3:in `<main>'" }
+          ex.set_backtrace(backtrace)
+
+          notice = described_class.new(Airbrake::Config.new, ex)
+
+          expect(notice.to_json.bytesize).to be < 64000
+        end
+      end
+
+      max_msg = 'truncates to the max allowed size'
+
+      context "with an extremely huge payload" do
+        include_examples 'payloads', 200_000, max_msg
+      end
+
+      context "with a big payload" do
+        include_examples 'payloads', 50_000, max_msg
+      end
+
+      small_msg = "doesn't truncate it"
+
+      context "with a small payload" do
+        include_examples 'payloads', 1000, small_msg
+      end
+
+      context "with a tiny payload" do
+        include_examples 'payloads', 300, small_msg
+      end
+
+      describe "object replacement with its string version" do
+        let(:klass) { Class.new {} }
+        let(:ex) { AirbrakeTestError.new }
+        let(:params) { { bingo: [Object.new, klass.new] } }
+        let(:notice) { described_class.new(Airbrake::Config.new, ex, params) }
+
+        before do
+          backtrace = []
+          backtrace_size.times { backtrace << "bin/rails:3:in `<main>'" }
+          ex.set_backtrace(backtrace)
+        end
+
+        context "with payload within the limits" do
+          let(:backtrace_size) { 1000 }
+
+          it "doesn't happen" do
+            expect(notice.to_json).
+              to match(/bingo":\["#<Object:.+>","#<#<Class:.+>:.+>"/)
+          end
+        end
+
+        context "with payload bigger than the limit" do
+          context "with payload within the limits" do
+            let(:backtrace_size) { 50_000 }
+
+            it "happens" do
+              expect(notice.to_json).
+                to match(/bingo":\[".+Object.+",".+Class.+"/)
+            end
+          end
+        end
+      end
+    end
+
+    it "overwrites the 'notifier' payload with the default values" do
+      notice[:notifier] = { name: 'bingo', bango: 'bongo' }
+
+      expect(notice.to_json).
+        to match(/"notifier":{"name":"airbrake-ruby","version":".+","url":".+"}/)
+    end
+  end
+
+  describe "#[]" do
+    it "accesses payload" do
+      expect(notice[:params]).to eq(bingo: '1')
+    end
+
+    it "raises error if notice is ignored" do
+      notice.ignore!
+      expect { notice[:params] }.
+        to raise_error(Airbrake::Error, 'cannot access ignored notice')
+    end
+  end
+
+  describe "#[]=" do
+    it "sets a payload value" do
+      hash = { bingo: 'bango' }
+      notice[:params] = hash
+      expect(notice[:params]).to equal(hash)
+    end
+
+    it "raises error if notice is ignored" do
+      notice.ignore!
+      expect { notice[:params] = {} }.
+        to raise_error(Airbrake::Error, 'cannot access ignored notice')
+    end
+
+    it "raises error when trying to assign unrecognized key" do
+      expect { notice[:bingo] = 1 }.
+        to raise_error(Airbrake::Error, /:bingo is not recognized among/)
+    end
+
+    it "raises when setting non-hash objects as the value" do
+      expect { notice[:params] = Object.new }.
+        to raise_error(Airbrake::Error, 'Got Object value, wanted a Hash')
+    end
+  end
+end