airbrake-ruby 4.8.0

data/spec/promise_spec.rb

@@ -0,0 +1,197 @@
+RSpec.describe Airbrake::Promise do
+  describe ".then" do
+    let(:resolved_with) { [] }
+    let(:rejected_with) { [] }
+
+    context "when it is not resolved" do
+      it "returns self" do
+        expect(subject.then {}).to eq(subject)
+      end
+
+      it "doesn't call the resolve callbacks yet" do
+        subject.then { resolved_with << 1 }.then { resolved_with << 2 }
+        expect(resolved_with).to be_empty
+      end
+    end
+
+    context "when it is resolved" do
+      shared_examples "then specs" do
+        it "returns self" do
+          expect(subject.then {}).to eq(subject)
+        end
+
+        it "yields the resolved value" do
+          yielded = nil
+          subject.then { |value| yielded = value }
+          expect(yielded).to eq('id' => '123')
+        end
+
+        it "calls the resolve callbacks" do
+          expect(resolved_with).to match_array([1, 2])
+        end
+
+        it "doesn't call the reject callbacks" do
+          expect(rejected_with).to be_empty
+        end
+      end
+
+      context "and there are some resolve and reject callbacks in place" do
+        before do
+          subject.then { resolved_with << 1 }.then { resolved_with << 2 }
+          subject.rescue { rejected_with << 1 }.rescue { rejected_with << 2 }
+          subject.resolve('id' => '123')
+        end
+
+        include_examples "then specs"
+
+        it "registers the resolve callbacks" do
+          subject.resolve('id' => '456')
+          expect(resolved_with).to match_array([1, 2, 1, 2])
+        end
+      end
+
+      context "and additional then callbacks are added" do
+        before do
+          subject.resolve('id' => '123')
+          subject.then { resolved_with << 1 }.then { resolved_with << 2 }
+        end
+
+        include_examples "then specs"
+
+        it "doesn't register new resolve callbacks" do
+          subject.resolve('id' => '456')
+          expect(resolved_with).to match_array([1, 2])
+        end
+      end
+    end
+  end
+
+  describe ".rescue" do
+    let(:resolved_with) { [] }
+    let(:rejected_with) { [] }
+
+    context "when it is not rejected" do
+      it "returns self" do
+        expect(subject.then {}).to eq(subject)
+      end
+
+      it "doesn't call the reject callbacks yet" do
+        subject.rescue { rejected_with << 1 }.rescue { rejected_with << 2 }
+        expect(rejected_with).to be_empty
+      end
+    end
+
+    context "when it is rejected" do
+      shared_examples "rescue specs" do
+        it "returns self" do
+          expect(subject.rescue {}).to eq(subject)
+        end
+
+        it "yields the rejected value" do
+          yielded = nil
+          subject.rescue { |value| yielded = value }
+          expect(yielded).to eq('bingo')
+        end
+
+        it "doesn't call the resolve callbacks" do
+          expect(resolved_with).to be_empty
+        end
+
+        it "calls the reject callbacks" do
+          expect(rejected_with).to match_array([1, 2])
+        end
+      end
+
+      context "and there are some resolve and reject callbacks in place" do
+        before do
+          subject.then { resolved_with << 1 }.then { resolved_with << 2 }
+          subject.rescue { rejected_with << 1 }.rescue { rejected_with << 2 }
+          subject.reject('bingo')
+        end
+
+        include_examples "rescue specs"
+
+        it "registers the reject callbacks" do
+          subject.reject('bingo again')
+          expect(rejected_with).to match_array([1, 2, 1, 2])
+        end
+      end
+
+      context "and additional reject callbacks are added" do
+        before do
+          subject.reject('bingo')
+          subject.rescue { rejected_with << 1 }.rescue { rejected_with << 2 }
+        end
+
+        include_examples "rescue specs"
+
+        it "doesn't register new reject callbacks" do
+          subject.reject('bingo again')
+          expect(rejected_with).to match_array([1, 2])
+        end
+      end
+    end
+  end
+
+  describe ".resolve" do
+    it "returns self" do
+      expect(subject.resolve(1)).to eq(subject)
+    end
+
+    it "executes callbacks attached with .then" do
+      array = []
+      subject.then { |notice_id| array << notice_id }.rescue { array << 999 }
+
+      expect(array.size).to be_zero
+      subject.resolve(1)
+      expect(array).to match_array([1])
+    end
+  end
+
+  describe ".reject" do
+    it "returns self" do
+      expect(subject.reject(1)).to eq(subject)
+    end
+
+    it "executes callbacks attached with .rescue" do
+      array = []
+      subject.then { array << 1 }.rescue { |error| array << error }
+
+      expect(array.size).to be_zero
+      subject.reject(999)
+      expect(array).to match_array([999])
+    end
+  end
+
+  describe "#rejected?" do
+    context "when it was rejected" do
+      before { subject.reject(1) }
+      it { is_expected.to be_rejected }
+    end
+
+    context "when it wasn't rejected" do
+      it { is_expected.not_to be_rejected }
+    end
+
+    context "when it was resolved" do
+      before { subject.resolve }
+      it { is_expected.not_to be_rejected }
+    end
+  end
+
+  describe "#resolved?" do
+    context "when it was resolved" do
+      before { subject.resolve }
+      it { is_expected.to be_resolved }
+    end
+
+    context "when it wasn't resolved" do
+      it { is_expected.not_to be_resolved }
+    end
+
+    context "when it was rejected" do
+      before { subject.reject(1) }
+      it { is_expected.not_to be_resolved }
+    end
+  end
+end

data/spec/query_spec.rb

@@ -0,0 +1,11 @@
+RSpec.describe Airbrake::Query do
+  describe "#stash" do
+    subject do
+      described_class.new(
+        method: 'GET', route: '/', query: '', start_time: Time.now
+      )
+    end
+
+    it { is_expected.to respond_to(:stash) }
+  end
+end

data/spec/request_spec.rb

@@ -0,0 +1,11 @@
+RSpec.describe Airbrake::Request do
+  describe "#stash" do
+    subject do
+      described_class.new(
+        method: 'GET', route: '/', status_code: 200, start_time: Time.now
+      )
+    end
+
+    it { is_expected.to respond_to(:stash) }
+  end
+end

data/spec/response_spec.rb

@@ -0,0 +1,88 @@
+RSpec.describe Airbrake::Response do
+  describe ".parse" do
+    [200, 201, 204].each do |code|
+      context "when response code is #{code}" do
+        it "logs response body" do
+          expect(Airbrake::Loggable.instance).to receive(:debug).with(
+            /Airbrake::Response \(#{code}\): {}/
+          )
+          described_class.parse(OpenStruct.new(code: code, body: '{}'))
+        end
+      end
+    end
+
+    [400, 401, 403, 420].each do |code|
+      context "when response code is #{code}" do
+        it "logs response message" do
+          expect(Airbrake::Loggable.instance).to receive(:error).with(
+            /Airbrake: foo/
+          )
+          described_class.parse(
+            OpenStruct.new(code: code, body: '{"message":"foo"}')
+          )
+        end
+      end
+    end
+
+    context "when response code is 429" do
+      let(:response) { OpenStruct.new(code: 429, body: '{"message":"rate limited"}') }
+
+      it "logs response message" do
+        expect(Airbrake::Loggable.instance).to receive(:error).with(
+          /Airbrake: rate limited/
+        )
+        described_class.parse(response)
+      end
+
+      it "returns an error response" do
+        time = Time.now
+        allow(Time).to receive(:now).and_return(time)
+
+        resp = described_class.parse(response)
+        expect(resp).to include(
+          'error' => '**Airbrake: rate limited',
+          'rate_limit_reset' => time
+        )
+      end
+    end
+
+    context "when response code is unhandled" do
+      let(:response) { OpenStruct.new(code: 500, body: 'foo') }
+
+      it "logs response body" do
+        expect(Airbrake::Loggable.instance).to receive(:error).with(
+          /Airbrake: unexpected code \(500\)\. Body: foo/
+        )
+        described_class.parse(response)
+      end
+
+      it "returns an error response" do
+        resp = described_class.parse(response)
+        expect(resp).to eq('error' => 'foo')
+      end
+
+      it "truncates body" do
+        response.body *= 1000
+        resp = described_class.parse(response)
+        expect(resp).to eq('error' => ('foo' * 33) + 'fo...')
+      end
+    end
+
+    context "when response body can't be parsed as JSON" do
+      let(:response) { OpenStruct.new(code: 201, body: 'foo') }
+
+      it "logs response body" do
+        expect(Airbrake::Loggable.instance).to receive(:error).with(
+          /Airbrake: error while parsing body \(.*unexpected token.*\)\. Body: foo/
+        )
+        described_class.parse(response)
+      end
+
+      it "returns an error message" do
+        expect(described_class.parse(response)['error']).to match(
+          /\A#<JSON::ParserError.+>/
+        )
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,100 @@
+require 'simplecov'
+SimpleCov.start if ENV['COVERAGE']
+
+require 'airbrake-ruby'
+
+require 'rspec/its'
+
+require 'webmock'
+require 'webmock/rspec'
+require 'pry'
+
+require 'pathname'
+require 'webrick'
+require 'English'
+require 'base64'
+require 'pp'
+
+require 'helpers'
+
+RSpec.configure do |c|
+  c.order = 'random'
+  c.color = true
+  c.disable_monkey_patching!
+  c.include Helpers
+end
+
+Thread.abort_on_exception = true
+
+WebMock.disable_net_connect!(allow_localhost: true)
+
+class AirbrakeTestError < RuntimeError
+  attr_reader :backtrace
+
+  def initialize(*)
+    super
+    # rubocop:disable Metrics/LineLength
+    @backtrace = [
+      "/home/kyrylo/code/airbrake/ruby/spec/spec_helper.rb:23:in `<top (required)>'",
+      "/opt/rubies/ruby-2.2.2/lib/ruby/2.2.0/rubygems/core_ext/kernel_require.rb:54:in `require'",
+      "/opt/rubies/ruby-2.2.2/lib/ruby/2.2.0/rubygems/core_ext/kernel_require.rb:54:in `require'",
+      "/home/kyrylo/code/airbrake/ruby/spec/airbrake_spec.rb:1:in `<top (required)>'",
+      "/home/kyrylo/.gem/ruby/2.2.2/gems/rspec-core-3.3.2/lib/rspec/core/configuration.rb:1327:in `load'",
+      "/home/kyrylo/.gem/ruby/2.2.2/gems/rspec-core-3.3.2/lib/rspec/core/configuration.rb:1327:in `block in load_spec_files'",
+      "/home/kyrylo/.gem/ruby/2.2.2/gems/rspec-core-3.3.2/lib/rspec/core/configuration.rb:1325:in `each'",
+      "/home/kyrylo/.gem/ruby/2.2.2/gems/rspec-core-3.3.2/lib/rspec/core/configuration.rb:1325:in `load_spec_files'",
+      "/home/kyrylo/.gem/ruby/2.2.2/gems/rspec-core-3.3.2/lib/rspec/core/runner.rb:102:in `setup'",
+      "/home/kyrylo/.gem/ruby/2.2.2/gems/rspec-core-3.3.2/lib/rspec/core/runner.rb:88:in `run'",
+      "/home/kyrylo/.gem/ruby/2.2.2/gems/rspec-core-3.3.2/lib/rspec/core/runner.rb:73:in `run'",
+      "/home/kyrylo/.gem/ruby/2.2.2/gems/rspec-core-3.3.2/lib/rspec/core/runner.rb:41:in `invoke'",
+      "/home/kyrylo/.gem/ruby/2.2.2/gems/rspec-core-3.3.2/exe/rspec:4:in `<main>'"
+    ]
+    # rubocop:enable Metrics/LineLength
+  end
+
+  # rubocop:disable Naming/AccessorMethodName
+  def set_backtrace(backtrace)
+    @backtrace = backtrace
+  end
+  # rubocop:enable Naming/AccessorMethodName
+
+  def message
+    'App crashed!'
+  end
+end
+
+class JavaAirbrakeTestError < AirbrakeTestError
+  def initialize(*)
+    super
+    # rubocop:disable Metrics/LineLength
+    @backtrace = [
+      "org.jruby.java.invokers.InstanceMethodInvoker.call(InstanceMethodInvoker.java:26)",
+      "org.jruby.ir.interpreter.Interpreter.INTERPRET_EVAL(Interpreter.java:126)",
+      "org.jruby.RubyKernel$INVOKER$s$0$3$eval19.call(RubyKernel$INVOKER$s$0$3$eval19.gen)",
+      "org.jruby.RubyKernel$INVOKER$s$0$0$loop.call(RubyKernel$INVOKER$s$0$0$loop.gen)",
+      "org.jruby.runtime.IRBlockBody.doYield(IRBlockBody.java:139)",
+      "org.jruby.RubyKernel$INVOKER$s$rbCatch19.call(RubyKernel$INVOKER$s$rbCatch19.gen)",
+      "opt.rubies.jruby_minus_9_dot_0_dot_0_dot_0.bin.irb.invokeOther4:start(/opt/rubies/jruby-9.0.0.0/bin/irb)",
+      "opt.rubies.jruby_minus_9_dot_0_dot_0_dot_0.bin.irb.RUBY$script(/opt/rubies/jruby-9.0.0.0/bin/irb:13)",
+      "org.jruby.ir.Compiler$1.load(Compiler.java:111)",
+      "org.jruby.Main.run(Main.java:225)",
+      "org.jruby.Main.main(Main.java:197)"
+    ]
+    # rubocop:enable Metrics/LineLength
+  end
+
+  def is_a?(*)
+    true
+  end
+end
+
+class Ruby21Error < RuntimeError
+  attr_accessor :cause
+
+  def self.raise_error(msg)
+    ex = new(msg)
+    ex.cause = $ERROR_INFO
+
+    raise ex
+  end
+end

data/spec/stashable_spec.rb

@@ -0,0 +1,23 @@
+RSpec.describe Airbrake::Stashable do
+  let(:klass) do
+    mod = described_class
+    Class.new { include(mod) }
+  end
+
+  describe "#stash" do
+    subject { klass.new }
+
+    it "returns a hash" do
+      expect(subject.stash).to be_a(Hash)
+    end
+
+    it "returns an empty hash" do
+      expect(subject.stash).to be_empty
+    end
+
+    it "remembers what was put in the stash" do
+      subject.stash[:foo] = 1
+      expect(subject.stash[:foo]).to eq(1)
+    end
+  end
+end

data/spec/stat_spec.rb

@@ -0,0 +1,47 @@
+RSpec.describe Airbrake::Stat do
+  describe "#to_h" do
+    it "converts to a hash" do
+      expect(subject.to_h).to eq(
+        'count' => 0,
+        'sum' => 0.0,
+        'sumsq' => 0.0,
+        'tdigest' => 'AAAAAkA0AAAAAAAAAAAAAA=='
+      )
+    end
+  end
+
+  describe "#increment" do
+    let(:start_time) { Time.new(2018, 1, 1, 0, 0, 20, 0) }
+    let(:end_time) { Time.new(2018, 1, 1, 0, 0, 22, 0) }
+
+    before { subject.increment(start_time, end_time) }
+
+    its(:sum) { is_expected.to eq(2000) }
+  end
+
+  describe "#increment_ms" do
+    before { subject.increment_ms(1000) }
+
+    its(:count) { is_expected.to eq(1) }
+    its(:sum) { is_expected.to eq(1000) }
+    its(:sumsq) { is_expected.to eq(1000000) }
+
+    it "updates tdigest" do
+      expect(subject.tdigest.size).to eq(1)
+    end
+  end
+
+  describe "#inspect" do
+    it "provides custom inspect output" do
+      expect(subject.inspect).to eq(
+        '#<struct Airbrake::Stat count=0, sum=0.0, sumsq=0.0>'
+      )
+    end
+  end
+
+  describe "#pretty_print" do
+    it "is an alias of #inspect" do
+      expect(subject.method(:pretty_print)).to eql(subject.method(:inspect))
+    end
+  end
+end