airbrake 5.0.5 → 5.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c9fb3a24e2ef1921f245f81469badb794354224d
-  data.tar.gz: b35c155e6ac5a49871aa16b40801e357f27205c1
+  metadata.gz: f2c700ad9e90a15de2d6482a6cc9429875fc9606
+  data.tar.gz: 74e37331ad0ebd00f2c3beede67c45480a5e607f
 SHA512:
-  metadata.gz: cf060e37c464c0054d033b6e615a45645cfa43c56431689309042071e178779fcd3ebc4688207d062ee9d68cc805653f765c2bac3a7301763fb6203b4b3659d0
-  data.tar.gz: 2dd49353df42dd92b7017b97cf0ccc888cff6ec21d886a531c21b1aefeb9fba886b7cf36038dc3290ae03b75b0541fc8292b8c6663886ee928849ed3d6f5544f
+  metadata.gz: 97c0ca4f52385e44a1512b911e2bfef8d64223916a9d52fafbd630bbdfdbc022f909a1772cfa6883e4d5ce9c1752627856e916e552a7a075db986c9d12da4fa3
+  data.tar.gz: abd13310879565f3aa327a7dd1564b89afe2573ad2ea66394c9c351835ab2855296a15142b1187500a230d71ee6fc784ad24b11ec3734ebe10dfe777372043b8

data/lib/airbrake.rb

@@ -19,3 +19,29 @@ require 'airbrake/rake/task_ext' if defined?(Rake::Task)
 require 'airbrake/resque/failure' if defined?(Resque)
 require 'airbrake/sidekiq/error_handler' if defined?(Sidekiq)
 require 'airbrake/delayed_job/plugin' if defined?(Delayed)
+
+##
+# This module reopens the original Airbrake module from airbrake-ruby and adds
+# integration specific methods.
+module Airbrake
+  class << self
+    ##
+    # Attaches a callback (builder) that runs every time the Rack integration
+    # reports an error. Can be used to attach additional data from the Rack
+    # request.
+    #
+    # @example Adding remote IP from the Rack environment
+    #   Airbrake.add_rack_builder do |notice, request|
+    #     notice[:params][:remoteIp] = request.env['REMOTE_IP']
+    #   end
+    #
+    # @yieldparam notice [Airbrake::Notice] notice that will be sent to Airbrake
+    # @yieldparam request [Rack::Request] current rack request
+    # @yieldreturn [void]
+    # @return [void]
+    # @since 5.1.0
+    def add_rack_builder(&block)
+      Airbrake::Rack::NoticeBuilder.add_builder(&block)
+    end
+  end
+end

data/lib/airbrake/capistrano/tasks.rb

@@ -9,7 +9,7 @@ if defined?(Capistrano::VERSION) &&
           with rails_env: fetch(:rails_env, fetch(:stage)) do
             execute :rake, <<-CMD
               airbrake:deploy USERNAME=#{Shellwords.shellescape(local_user)} \
-                              ENVIRONMENT=#{fetch(:rails_env, fetch(:stage))} \
+                              ENVIRONMENT=#{fetch(:airbrake_env, fetch(:rails_env, fetch(:stage)))} \
                               REVISION=#{fetch(:current_revision)} \
                               REPOSITORY=#{fetch(:repo_url)} \
                               VERSION=#{fetch(:app_version)}

data/lib/airbrake/rack/middleware.rb

@@ -26,9 +26,7 @@ module Airbrake
         end
         # rubocop:enable Lint/RescueException
 
-        # The internal framework middlewares store exceptions inside the Rack
-        # env. See: https://goo.gl/Kd694n
-        exception = env['action_dispatch.exception'] || env['sinatra.error']
+        exception = framework_exception(env)
         notify_airbrake(exception, env) if exception
 
         response
@@ -40,6 +38,19 @@ module Airbrake
         notice = NoticeBuilder.new(env).build_notice(exception)
         Airbrake.notify(notice)
       end
+
+      ##
+      # Web framework middlewares often store rescued exceptions inside the
+      # Rack env, but Rack doesn't have a standard key for it:
+      #
+      # - Rails uses action_dispatch.exception: https://goo.gl/Kd694n
+      # - Sinatra uses sinatra.error: https://goo.gl/LLkVL9
+      # - Goliath uses rack.exception: https://goo.gl/i7e1nA
+      def framework_exception(env)
+        env['action_dispatch.exception'] ||
+          env['sinatra.error'] ||
+          env['rack.exception']
+      end
     end
   end
 end

data/lib/airbrake/rack/notice_builder.rb

@@ -4,6 +4,20 @@ module Airbrake
     # A helper class for filling notices with all sorts of useful information
     # coming from the Rack environment.
     class NoticeBuilder
+      @builders = []
+
+      class << self
+        ##
+        # @return [Array<#call>] the list of notice's builders
+        attr_reader :builders
+
+        ##
+        # Adds user defined builders to the chain.
+        def add_builder(&block)
+          @builders << block
+        end
+      end
+
       ##
       # @return [Array<String>] the prefixes of the majority of HTTP headers in
       #   Rack (some prefixes match the header names for simplicity)
@@ -16,20 +30,7 @@ module Airbrake
       ##
       # @param [Hash{String=>Object}] rack_env The Rack environment
       def initialize(rack_env)
-        @rack_env = rack_env
         @request = ::Rack::Request.new(rack_env)
-        @controller = rack_env['action_controller.instance']
-        @session = @request.session
-        @user = Airbrake::Rack::User.extract(rack_env)
-
-        @framework_version =
-          if defined?(::Rails)
-            "Rails/#{::Rails.version}"
-          elsif defined?(::Sinatra)
-            "Sinatra/#{Sinatra::VERSION}"
-          else
-            "Rack.version/#{::Rack.version} Rack.release/#{::Rack.release}"
-          end.freeze
       end
 
       ##
@@ -39,64 +40,71 @@ module Airbrake
       # @return [Airbrake::Notice] the notice with extra information
       def build_notice(exception)
         notice = Airbrake.build_notice(exception)
-
-        add_context(notice)
-        add_session(notice)
-        add_params(notice)
-        add_environment(notice)
-
+        NoticeBuilder.builders.each { |builder| builder.call(notice, @request) }
         notice
       end
 
-      private
-
-      def add_context(notice)
+      # Adds context (url, user agent, framework version, controller, etc)
+      add_builder do |notice, request|
         context = notice[:context]
 
-        context[:url] = @request.url
-        context[:userAgent] = @request.user_agent
+        context[:url] = request.url
+        context[:userAgent] = request.user_agent
+
+        framework_version =
+          if defined?(::Rails)
+            "Rails/#{::Rails.version}"
+          elsif defined?(::Sinatra)
+            "Sinatra/#{Sinatra::VERSION}"
+          else
+            "Rack.version/#{::Rack.version} Rack.release/#{::Rack.release}"
+          end.freeze
 
         if context.key?(:version)
-          context[:version] += " #{@framework_version}"
+          context[:version] += " #{framework_version}"
         else
-          context[:version] = @framework_version
+          context[:version] = framework_version
         end
 
-        if @controller
-          context[:component] = @controller.controller_name
-          context[:action] = @controller.action_name
+        controller = request.env['action_controller.instance']
+        if controller
+          context[:component] = controller.controller_name
+          context[:action] = controller.action_name
         end
 
-        notice[:context].merge!(@user.as_json) if @user
+        user = Airbrake::Rack::User.extract(request.env)
+        notice[:context].merge!(user.as_json) if user
 
         nil
       end
 
-      def add_session(notice)
-        notice[:session] = @session if @session
+      # Adds session
+      add_builder do |notice, request|
+        session = request.session
+        notice[:session] = session if session
       end
 
-      def add_params(notice)
-        params = @request.env['action_dispatch.request.parameters']
+      # Adds request params
+      add_builder do |notice, request|
+        params = request.env['action_dispatch.request.parameters']
         notice[:params] = params if params
       end
 
-      def add_environment(notice)
-        notice[:environment] = {
-          httpMethod: @request.request_method,
-          referer: @request.referer,
-          headers: request_headers
-        }
-      end
-
-      def request_headers
-        @rack_env.map.with_object({}) do |(key, value), headers|
+      # Adds http referer, method and headers to the environment
+      add_builder do |notice, request|
+        http_headers = request.env.map.with_object({}) do |(key, value), headers|
           if HTTP_HEADER_PREFIXES.any? { |prefix| key.to_s.start_with?(prefix) }
             headers[key] = value
           end
 
           headers
         end
+
+        notice[:environment].merge!(
+          httpMethod: request.request_method,
+          referer: request.referer,
+          headers: http_headers
+        )
       end
     end
   end

data/lib/airbrake/rake/task_ext.rb

@@ -27,7 +27,7 @@ module Rake
         argv: ARGV.join(' ')
       }
 
-      Airbrake.notify(notice)
+      Airbrake.notify_sync(notice)
       raise ex
     end
     # rubocop:enable Lint/RescueException

data/lib/airbrake/version.rb

@@ -2,5 +2,5 @@
 # We use Semantic Versioning v2.0.0
 # More information: http://semver.org/
 module Airbrake
-  AIRBRAKE_VERSION = '5.0.5'.freeze
+  AIRBRAKE_VERSION = '5.1.0'.freeze
 end

data/spec/airbrake_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+RSpec.describe Airbrake do
+  describe ".add_rack_builder" do
+    let :builder do
+      proc { |_, _| nil }
+    end
+
+    after { Airbrake::Rack::NoticeBuilder.builders.delete(builder) }
+
+    it "adds new builder to the chain" do
+      expect { Airbrake.add_rack_builder(&builder) }.to change {
+        Airbrake::Rack::NoticeBuilder.builders.count
+      }.by(1)
+    end
+  end
+end

data/spec/unit/rack/middleware_spec.rb

@@ -57,7 +57,7 @@ RSpec.describe Airbrake::Rack::Middleware do
           end
         end
 
-        ['action_dispatch.exception', 'sinatra.error'].each do |type|
+        ['rack.exception', 'action_dispatch.exception', 'sinatra.error'].each do |type|
           include_examples 'stored exception', type
         end
       end

data/spec/unit/rack/notice_builder_spec.rb

@@ -31,5 +31,53 @@ RSpec.describe Airbrake::Rack::NoticeBuilder do
 
       expect(notice[:params]).to eq(params)
     end
+
+    it "adds CONTENT_TYPE, CONTENT_LENGTH and HTTP_* headers in the environment" do
+      headers = {
+        "HTTP_HOST" => "example.com",
+        "CONTENT_TYPE" => "text/html",
+        "CONTENT_LENGTH" => 100500
+      }
+      notice_builder = described_class.new(headers.dup)
+      notice = notice_builder.build_notice(AirbrakeTestError.new)
+      expect(notice[:environment][:headers]).to eq(headers)
+    end
+
+    it "skips headers that were not selected to be stored in the environment" do
+      headers = {
+        "HTTP_HOST" => "example.com",
+        "CONTENT_TYPE" => "text/html",
+        "CONTENT_LENGTH" => 100500
+      }
+      notice_builder = described_class.new(headers.merge("X-SOME-HEADER" => "value"))
+      notice = notice_builder.build_notice(AirbrakeTestError.new)
+      expect(notice[:environment][:headers]).to eq(headers)
+    end
+
+    it "preserves data that already has been added to the environment" do
+      headers = {
+        "HTTP_HOST" => "example.com",
+        "CONTENT_TYPE" => "text/html",
+        "CONTENT_LENGTH" => 100500
+      }
+      allow(Airbrake).to receive(:build_notice).and_wrap_original do |method, *args|
+        notice = method.call(*args)
+        notice[:environment]["SOME_KEY"] = "SOME_VALUE"
+        notice
+      end
+      notice_builder = described_class.new(headers)
+      notice = notice_builder.build_notice(AirbrakeTestError.new)
+      expect(notice[:environment]["SOME_KEY"]).to eq("SOME_VALUE")
+    end
+
+    it "runs user defined builders against notices" do
+      extended_class = described_class.dup
+      extended_class.add_builder do |notice, request|
+        notice[:params][:remoteIp] = request.env['REMOTE_IP']
+      end
+      notice_builder = extended_class.new('REMOTE_IP' => '127.0.0.1')
+      notice = notice_builder.build_notice(AirbrakeTestError.new)
+      expect(notice[:params][:remoteIp]).to eq("127.0.0.1")
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: airbrake
 version: !ruby/object:Gem::Version
-  version: 5.0.5
+  version: 5.1.0
 platform: ruby
 authors:
 - Airbrake Technologies, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-10 00:00:00.000000000 Z
+date: 2016-02-29 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.0'
+        version: '1.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -230,25 +230,25 @@ 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/sinatra/dummy_app.rb
 - spec/integration/rack/rack_spec.rb
-- spec/integration/sinatra/sinatra_spec.rb
 - spec/integration/rails/rails_spec.rb
 - spec/integration/rails/rake_spec.rb
 - spec/integration/shared_examples/rack_examples.rb
+- spec/integration/sinatra/sinatra_spec.rb
 - spec/spec_helper.rb
-- spec/apps/rack/dummy_app.rb
-- spec/apps/sinatra/dummy_app.rb
-- spec/apps/rails/logs/40.log
-- spec/apps/rails/logs/42.log
-- spec/apps/rails/logs/50.log
-- spec/apps/rails/logs/32.log
-- spec/apps/rails/logs/41.log
-- spec/apps/rails/dummy_app.rb
-- spec/apps/rails/dummy_task.rake
-- spec/airbrake_spec.rb
 - spec/unit/rack/middleware_spec.rb
-- spec/unit/rack/user_spec.rb
 - spec/unit/rack/notice_builder_spec.rb
-- spec/unit/sidekiq/error_handler_spec.rb
+- spec/unit/rack/user_spec.rb
 - spec/unit/rake/tasks_spec.rb
+- spec/unit/sidekiq/error_handler_spec.rb
 has_rdoc: