airbrake 5.6.1 → 5.7.0.rc.1

data/spec/integration/rails/rails_spec.rb

@@ -179,29 +179,30 @@ RSpec.describe "Rails integration specs" do
     end
   end
 
-  # Delayed Job doesn't support Ruby 1.9.2
-  if Gem::Version.new(RUBY_VERSION) > Gem::Version.new('1.9.2')
-    describe "DelayedJob jobs" do
-      it "reports exceptions occurring in DelayedJob jobs" do
-        get '/delayed_job'
-        sleep 2
+  describe "DelayedJob jobs" do
+    it "reports exceptions occurring in DelayedJob jobs" do
+      get '/delayed_job'
+      sleep 2
 
-        wait_for_a_request_with_body(
-          %r("message":"delayed_job\serror".*"params":{.*
+      wait_for_a_request_with_body(
+        %r("message":"delayed_job\serror".*"params":{.*
            "handler":"---\s!ruby/struct:BangoJob\\nbingo:\s
                      bingo\\nbongo:\sbongo\\n".*})x
-        )
+      )
 
-        # Two requests are performed during this example. We care only about one.
-        # Sleep guarantees that we let the unimportant request occur here and not
-        # elsewhere.
-        sleep 2
-      end
+      # Two requests are performed during this example. We care only about one.
+      # Sleep guarantees that we let the unimportant request occur here and not
+      # elsewhere.
+      sleep 2
     end
   end
 
   describe "notice payload when a user is authenticated without Warden" do
     context "when the current_user method is defined" do
+      before do
+        allow(Warden::Proxy).to receive(:new) { nil }
+      end
+
       it "contains the user information" do
         user = OpenStruct.new(id: 1, email: 'qa@example.com', username: 'qa-dept')
         allow_any_instance_of(DummyController).to receive(:current_user) { user }

data/spec/spec_helper.rb

@@ -2,7 +2,6 @@
 require 'webmock'
 require 'webmock/rspec'
 require 'rspec/wait'
-require 'pry'
 require 'rack'
 require 'rack/test'
 require 'rake'
@@ -10,6 +9,23 @@ require 'rake'
 require 'airbrake'
 require 'airbrake/rake/tasks'
 
+Airbrake.configure do |c|
+  c.project_id = 113743
+  c.project_key = 'fd04e13d806a90f96614ad8e529b2822'
+  c.logger = Logger.new('/dev/null')
+  c.app_version = '1.2.3'
+  c.workers = 5
+end
+
+RSpec.configure do |c|
+  c.order = 'random'
+  c.color = true
+  c.disable_monkey_patching!
+  c.wait_timeout = 3
+
+  c.include Rack::Test::Methods
+end
+
 # Load integration tests only when they're run through appraisals.
 if ENV['APPRAISAL_INITIALIZED']
   # Gems from appraisals that every application uses.
@@ -75,23 +91,6 @@ if ENV['APPRAISAL_INITIALIZED']
   end
 end
 
-RSpec.configure do |c|
-  c.order = 'random'
-  c.color = true
-  c.disable_monkey_patching!
-  c.wait_timeout = 3
-
-  c.include Rack::Test::Methods
-end
-
-Airbrake.configure do |c|
-  c.project_id = 113743
-  c.project_key = 'fd04e13d806a90f96614ad8e529b2822'
-  c.logger = Logger.new('/dev/null')
-  c.app_version = '1.2.3'
-  c.workers = 5
-end
-
 # Make sure tests that use async requests fail.
 Thread.abort_on_exception = true
 

data/spec/unit/airbrake_spec.rb

@@ -0,0 +1,65 @@
+require 'spec_helper'
+
+RSpec.describe Airbrake do
+  let(:endpoint) do
+    'https://airbrake.io/api/v3/projects/113743/notices?key=fd04e13d806a90f96614ad8e529b2822'
+  end
+
+  def env_for(url, opts = {})
+    Rack::MockRequest.env_for(url, opts)
+  end
+
+  before do
+    stub_request(:post, endpoint).to_return(status: 201, body: '{}')
+  end
+
+  describe ".add_rack_builder" do
+    let(:filters) do
+      notifier = Airbrake.instance_variable_get(:@notifiers)[:default]
+      filter_chain = notifier.instance_variable_get(:@filter_chain)
+      filter_chain.instance_variable_get(:@filters)
+    end
+
+    after { filters.pop }
+
+    it "adds new builder to the filter chain" do
+      expect do
+        Airbrake.add_rack_builder(&proc { |_, _| nil })
+      end.to change { filters.count }.by(1)
+    end
+
+    context "when notice has :rack_request in stash" do
+      it "executes the filter yielding 2 params (last one is request)" do
+        executed = false
+        builder = proc do |notice, request|
+          executed = true
+          expect(notice).to be_an(Airbrake::Notice)
+          expect(request).to be_a(Rack::Request)
+        end
+        Airbrake.add_rack_builder(&builder)
+
+        notice = Airbrake.build_notice('oops')
+        notice.stash[:rack_request] = Rack::Request.new(env_for('/'))
+        Airbrake.notify_sync(notice)
+
+        expect(executed).to be_truthy
+      end
+    end
+
+    context "when notice doesn't have :rack_request in stash" do
+      it "executes the filter yielding only one param" do
+        executed = false
+        builder = proc do |notice, request|
+          executed = true
+          expect(notice).to be_an(Airbrake::Notice)
+          expect(request).to be_nil
+        end
+        Airbrake.add_rack_builder(&builder)
+
+        Airbrake.notify_sync('oops')
+
+        expect(executed).to be_truthy
+      end
+    end
+  end
+end

data/spec/unit/rack/context_filter_spec.rb

@@ -0,0 +1,70 @@
+require 'spec_helper'
+
+RSpec.describe Airbrake::Rack::ContextFilter do
+  def env_for(url, opts = {})
+    Rack::MockRequest.env_for(url, opts)
+  end
+
+  subject { described_class.new }
+
+  let(:notice) do
+    Airbrake.build_notice('oops').tap do |notice|
+      notice.stash[:rack_request] = Rack::Request.new(env_for(uri, opts))
+    end
+  end
+
+  let(:uri) { '/' }
+  let(:opts) { Hash.new }
+
+  it "adds framework version to the context" do
+    subject.call(notice)
+    expect(notice[:context][:version]).
+      to match(/\d.\d.\d Rack\.version.+Rack\.release/)
+  end
+
+  context "when URL is present" do
+    let(:uri) { '/bingo' }
+    let(:opts) { Hash.new }
+
+    it "adds URL to the context" do
+      subject.call(notice)
+      expect(notice[:context][:url]).to eq('http://example.org/bingo')
+    end
+  end
+
+  context "when User-Agent is present" do
+    let(:uri) { '/' }
+    let(:opts) do
+      { 'HTTP_USER_AGENT' => 'Bingo Agent' }
+    end
+
+    it "adds User-Agent to the context" do
+      subject.call(notice)
+      expect(notice[:context][:userAgent]).to eq('Bingo Agent')
+    end
+  end
+
+  context "when controller is present" do
+    let(:controller) do
+      double.tap do |ctrl|
+        allow(ctrl).to receive(:controller_name).and_return('BingoController')
+        allow(ctrl).to receive(:action_name).and_return('bango_name')
+      end
+    end
+
+    let(:uri) { '/' }
+    let(:opts) do
+      { 'action_controller.instance' => controller }
+    end
+
+    it "adds controller name as component" do
+      subject.call(notice)
+      expect(notice[:context][:component]).to eq('BingoController')
+    end
+
+    it "adds action name as action" do
+      subject.call(notice)
+      expect(notice[:context][:action]).to eq('bango_name')
+    end
+  end
+end

data/spec/unit/rack/http_headers_filter_spec.rb

@@ -0,0 +1,48 @@
+require 'spec_helper'
+
+RSpec.describe Airbrake::Rack::HttpHeadersFilter do
+  def env_for(url, opts = {})
+    Rack::MockRequest.env_for(url, opts)
+  end
+
+  subject { described_class.new }
+
+  let(:notice) do
+    Airbrake.build_notice('oops').tap do |notice|
+      notice.stash[:rack_request] = Rack::Request.new(env_for(uri, opts))
+    end
+  end
+
+  let(:headers) do
+    {
+      'HTTP_HOST' => 'example.com',
+      'CONTENT_TYPE' => 'text/html',
+      'CONTENT_LENGTH' => 100500
+    }
+  end
+
+  let(:uri) { '/' }
+  let(:opts) { headers.dup }
+
+  it "preserves data that already has been added to the environment" do
+    notice[:environment]['SOME_KEY'] = 'SOME_VALUE'
+    subject.call(notice)
+    expect(notice[:environment]['SOME_KEY']).to eq('SOME_VALUE')
+  end
+
+  context "when CONTENT_TYPE, CONTENT_LENGTH and HTTP_* headers are present" do
+    it "adds them to the environment hash" do
+      subject.call(notice)
+      expect(notice[:environment][:headers]).to eq(headers)
+    end
+  end
+
+  context "when unexpected headers are present" do
+    let(:opts) { headers.dup.merge('X-SOME-HEADER' => 'value') }
+
+    it "adds them to the environment hash" do
+      subject.call(notice)
+      expect(notice[:environment][:headers]).to eq(headers)
+    end
+  end
+end

data/spec/unit/rack/http_params_filter_spec.rb

@@ -0,0 +1,56 @@
+require 'spec_helper'
+
+RSpec.describe Airbrake::Rack::HttpParamsFilter do
+  def env_for(url, opts = {})
+    Rack::MockRequest.env_for(url, opts)
+  end
+
+  subject { described_class.new }
+
+  let(:notice) do
+    Airbrake.build_notice('oops').tap do |notice|
+      notice.stash[:rack_request] = Rack::Request.new(env_for(uri, opts))
+    end
+  end
+
+  context "when rack params is nil" do
+    let(:uri) { '/' }
+    let(:opts) { Hash.new }
+
+    it "doesn't overwrite the params key with nil" do
+      subject.call(notice)
+      expect(notice[:params]).to eq({})
+    end
+  end
+
+  context "when form params are present" do
+    let(:params) do
+      { a: 1, b: 2 }
+    end
+
+    let(:input) { StringIO.new }
+    let(:uri) { '/' }
+    let(:opts) do
+      {
+        'rack.request.form_hash' => params,
+        'rack.request.form_input' => input,
+        'rack.input' => input
+      }
+    end
+
+    it "sets the params hash" do
+      subject.call(notice)
+      expect(notice[:params]).to eq(params)
+    end
+  end
+
+  context "when query string params are present" do
+    let(:uri) { '/?bingo=bango&bongo=bish' }
+    let(:opts) { Hash.new }
+
+    it "sets the params hash" do
+      subject.call(notice)
+      expect(notice[:params]).to eq('bingo' => 'bango', 'bongo' => 'bish')
+    end
+  end
+end

data/spec/unit/rack/request_body_filter_spec.rb

@@ -0,0 +1,48 @@
+require 'spec_helper'
+
+RSpec.describe Airbrake::Rack::RequestBodyFilter do
+  def env_for(url, opts = {})
+    Rack::MockRequest.env_for(url, opts)
+  end
+
+  subject { described_class.new }
+
+  let(:notice) do
+    Airbrake.build_notice('oops').tap do |notice|
+      notice.stash[:rack_request] = Rack::Request.new(env_for(uri, opts))
+    end
+  end
+
+  let(:uri) { '/' }
+  let(:opts) do
+    { 'rack.input' => body }
+  end
+
+  context "when a request has a body" do
+    let(:body) { StringIO.new('<bingo>bongo</bango>') }
+
+    it "reads the body" do
+      subject.call(notice)
+      expect(notice[:environment][:body]).to eq(body.string)
+    end
+  end
+
+  context "when body was read" do
+    let(:body) { StringIO.new('<bingo>bongo</bango>' * 512) }
+
+    it "rewinds rack.input" do
+      subject.call(notice)
+      expect(body.pos).to be_zero
+    end
+  end
+
+  context "when body is bigger than the limit" do
+    let(:len) { 4097 }
+    let(:body) { StringIO.new('a' * len) }
+
+    it "reads only first 4096 bytes" do
+      subject.call(notice)
+      expect(notice[:environment][:body]).to eq(body.string[0...len - 1])
+    end
+  end
+end

data/spec/unit/rack/session_filter_spec.rb

@@ -0,0 +1,48 @@
+require 'spec_helper'
+
+RSpec.describe Airbrake::Rack::SessionFilter do
+  def env_for(url, opts = {})
+    Rack::MockRequest.env_for(url, opts)
+  end
+
+  subject { described_class.new }
+
+  let(:notice) do
+    Airbrake.build_notice('oops').tap do |notice|
+      notice.stash[:rack_request] = Rack::Request.new(env_for(uri, opts))
+    end
+  end
+
+  context "when rack session is nil" do
+    let(:uri) { '/' }
+
+    let(:opts) do
+      { 'rack.session' => nil }
+    end
+
+    it "doesn't overwrite the session key with nil" do
+      expect(notice[:session]).to eq({})
+
+      subject.call(notice)
+
+      expect(notice[:session]).to eq({})
+    end
+  end
+
+  context "when session is present" do
+    let(:session) do
+      { a: 1, b: 2 }
+    end
+
+    let(:uri) { '/' }
+
+    let(:opts) do
+      { 'rack.session' => session }
+    end
+
+    it "sets session if it is present" do
+      subject.call(notice)
+      expect(notice[:session]).to eq(session)
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: airbrake
 version: !ruby/object:Gem::Version
-  version: 5.6.1
+  version: 5.7.0.rc.1
 platform: ruby
 authors:
 - Airbrake Technologies, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-24 00:00:00.000000000 Z
+date: 2017-01-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: airbrake-ruby
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '1.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '1.7'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10'
+        version: '12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10'
+        version: '12'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -122,6 +122,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.6.8.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.6.8.1
 - !ruby/object:Gem::Dependency
   name: rack-test
   requirement: !ruby/object:Gem::Requirement
@@ -150,6 +164,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '4'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.47'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.47'
 description: |
   Airbrake is an online tool that provides robust exception tracking in any of
   your Ruby applications. In doing so, it allows you to easily review errors, tie
@@ -169,8 +197,12 @@ files:
 - lib/airbrake.rb
 - lib/airbrake/capistrano/tasks.rb
 - lib/airbrake/delayed_job/plugin.rb
+- lib/airbrake/rack/context_filter.rb
+- lib/airbrake/rack/http_headers_filter.rb
+- lib/airbrake/rack/http_params_filter.rb
 - lib/airbrake/rack/middleware.rb
-- lib/airbrake/rack/notice_builder.rb
+- lib/airbrake/rack/request_body_filter.rb
+- lib/airbrake/rack/session_filter.rb
 - lib/airbrake/rack/user.rb
 - lib/airbrake/rails/action_controller.rb
 - lib/airbrake/rails/active_job.rb
@@ -183,12 +215,14 @@ files:
 - lib/airbrake/version.rb
 - lib/generators/airbrake_generator.rb
 - lib/generators/airbrake_initializer.rb.erb
-- spec/airbrake_spec.rb
 - spec/apps/rack/dummy_app.rb
 - spec/apps/rails/dummy_app.rb
 - spec/apps/rails/dummy_task.rake
+- spec/apps/rails/logs/32.log
+- spec/apps/rails/logs/40.log
+- spec/apps/rails/logs/41.log
+- spec/apps/rails/logs/42.log
 - spec/apps/rails/logs/50.log
-- spec/apps/rails/logs/51.log
 - spec/apps/sinatra/composite_app/sinatra_app1.rb
 - spec/apps/sinatra/composite_app/sinatra_app2.rb
 - spec/apps/sinatra/dummy_app.rb
@@ -198,8 +232,13 @@ files:
 - spec/integration/shared_examples/rack_examples.rb
 - spec/integration/sinatra/sinatra_spec.rb
 - spec/spec_helper.rb
+- spec/unit/airbrake_spec.rb
+- spec/unit/rack/context_filter_spec.rb
+- spec/unit/rack/http_headers_filter_spec.rb
+- spec/unit/rack/http_params_filter_spec.rb
 - spec/unit/rack/middleware_spec.rb
-- spec/unit/rack/notice_builder_spec.rb
+- spec/unit/rack/request_body_filter_spec.rb
+- spec/unit/rack/session_filter_spec.rb
 - spec/unit/rack/user_spec.rb
 - spec/unit/rake/tasks_spec.rb
 - spec/unit/sidekiq/error_handler_spec.rb
@@ -215,26 +254,28 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: Airbrake is an online tool that provides robust exception tracking in any
   of your Ruby applications.
 test_files:
-- spec/airbrake_spec.rb
 - spec/apps/rack/dummy_app.rb
 - spec/apps/rails/dummy_app.rb
 - spec/apps/rails/dummy_task.rake
+- spec/apps/rails/logs/32.log
+- spec/apps/rails/logs/40.log
+- spec/apps/rails/logs/41.log
+- spec/apps/rails/logs/42.log
 - spec/apps/rails/logs/50.log
-- spec/apps/rails/logs/51.log
 - spec/apps/sinatra/composite_app/sinatra_app1.rb
 - spec/apps/sinatra/composite_app/sinatra_app2.rb
 - spec/apps/sinatra/dummy_app.rb
@@ -244,8 +285,13 @@ test_files:
 - spec/integration/shared_examples/rack_examples.rb
 - spec/integration/sinatra/sinatra_spec.rb
 - spec/spec_helper.rb
+- spec/unit/airbrake_spec.rb
+- spec/unit/rack/context_filter_spec.rb
+- spec/unit/rack/http_headers_filter_spec.rb
+- spec/unit/rack/http_params_filter_spec.rb
 - spec/unit/rack/middleware_spec.rb
-- spec/unit/rack/notice_builder_spec.rb
+- spec/unit/rack/request_body_filter_spec.rb
+- spec/unit/rack/session_filter_spec.rb
 - spec/unit/rack/user_spec.rb
 - spec/unit/rake/tasks_spec.rb
 - spec/unit/sidekiq/error_handler_spec.rb