airbrake 3.1.2 → 3.1.3

data/features/support/airbrake_shim.rb.template

@@ -1,11 +1,16 @@
 require 'sham_rack'
 
+Airbrake.configuration.logger = Logger.new STDOUT if defined?(Airbrake)
+
 ShamRack.at("api.airbrake.io") do |env|
   response = <<-end_xml
 <notice>
 <id>b6817316-9c45-ed26-45eb-780dbb86aadb</id>
 <url>http://airbrake.io/locate/b6817316-9c45-ed26-45eb-780dbb86aadb</url>
 </notice>
+
+Request:
+#{env["rack.input"].read}
   end_xml
   ["200 OK", { "Content-type" => "text/xml" }, [response]]
 end

data/generators/airbrake/lib/rake_commands.rb

@@ -2,7 +2,7 @@ Rails::Generator::Commands::Create.class_eval do
   def rake(cmd, opts = {})
     logger.rake "rake #{cmd}"
     unless system("rake #{cmd}")
-      logger.rake "#{cmd} failed. Rolling back"      
+      logger.rake "#{cmd} failed. Rolling back"
       command(:destroy).invoke!
     end
   end

data/generators/airbrake/templates/airbrake_tasks.rake

@@ -1,7 +1,7 @@
 # Don't load anything when running the gems:* tasks.
 # Otherwise, airbrake will be considered a framework gem.
 # https://thoughtbot.lighthouseapp.com/projects/14221/tickets/629
-unless ARGV.any? {|a| a =~ /^gems/} 
+unless ARGV.any? {|a| a =~ /^gems/}
 
   Dir[File.join(Rails.root, 'vendor', 'gems', 'airbrake-*')].each do |vendored_notifier|
     $: << File.join(vendored_notifier, 'lib')

data/lib/airbrake.rb

@@ -1,13 +1,8 @@
+require "girl_friday"
 require 'net/http'
 require 'net/https'
 require 'rubygems'
-begin
-  require 'active_support'
-  require 'active_support/core_ext'
-rescue LoadError
-  require 'activesupport'
-  require 'activesupport/core_ext'
-end
+require 'active_support/core_ext/object/blank'
 require 'airbrake/version'
 require 'airbrake/configuration'
 require 'airbrake/notice'
@@ -19,7 +14,7 @@ require 'airbrake/user_informer'
 require 'airbrake/railtie' if defined?(Rails::Railtie)
 
 module Airbrake
-  API_VERSION = "2.2"
+  API_VERSION = "2.3"
   LOG_PREFIX = "** [Airbrake] "
 
   HEADERS = {
@@ -51,6 +46,11 @@ module Airbrake
       write_verbose_log("Response from Airbrake: \n#{response}")
     end
 
+    # Prints out the details about the notice that wasn't sent to server
+    def report_notice(notice)
+      write_verbose_log("Notice details: \n#{notice}")
+    end
+
     # Returns the Ruby version, Rails version, and current Rails environment
     def environment_info
       info = "[Ruby: #{RUBY_VERSION}]"
@@ -60,7 +60,7 @@ module Airbrake
 
     # Writes out the given message to the #logger
     def write_verbose_log(message)
-      logger.info LOG_PREFIX + message if logger
+      logger.debug LOG_PREFIX + message if logger
     end
 
     # Look for the Rails logger currently defined
@@ -131,7 +131,11 @@ module Airbrake
 
     def send_notice(notice)
       if configuration.public?
-        sender.send_to_airbrake(notice.to_xml)
+        if configuration.async?
+          configuration.async.call(notice)
+        else
+          sender.send_to_airbrake(notice)
+        end
       end
     end
 

data/lib/airbrake/backtrace.rb

@@ -77,6 +77,14 @@ module Airbrake
       "<Backtrace: " + lines.collect { |line| line.inspect }.join(", ") + ">"
     end
 
+    def to_s
+      content = []
+      lines.each do |line|
+        content << line
+      end
+      content.join("\n")
+    end
+
     def ==(other)
       if other.respond_to?(:lines)
         lines == other.lines

data/lib/airbrake/capistrano.rb

@@ -41,4 +41,3 @@ end
 if Capistrano::Configuration.instance
   Airbrake::Capistrano.load_into(Capistrano::Configuration.instance)
 end
-

data/lib/airbrake/configuration.rb

@@ -12,7 +12,7 @@ module Airbrake
 
     # The API key for your project, found on the project edit form.
     attr_accessor :api_key
-    
+
     # If you're using the Javascript notifier and would want to separate
     # Javascript notifications into another Airbrake project, specify
     # its APi key here.
@@ -28,7 +28,7 @@ module Airbrake
 
     # +true+ for https connections, +false+ for http connections.
     attr_accessor :secure
-    
+
     # +true+ to use whatever CAs OpenSSL has installed on your system. +false+ to use the ca-bundle.crt file included in Airbrake itself (reccomended and default)
     attr_accessor :use_system_ssl_cert_chain
 
@@ -100,11 +100,12 @@ module Airbrake
     # (boolean or nil; set to nil to catch exceptions when rake isn't running from a terminal; default is nil)
     attr_accessor :rescue_rake_exceptions
 
+
     DEFAULT_PARAMS_FILTERS = %w(password password_confirmation).freeze
 
     DEFAULT_BACKTRACE_FILTERS = [
       lambda { |line|
-        if defined?(Airbrake.configuration.project_root) && Airbrake.configuration.project_root.to_s != '' 
+        if defined?(Airbrake.configuration.project_root) && Airbrake.configuration.project_root.to_s != ''
           line.sub(/#{Airbrake.configuration.project_root}/, "[PROJECT_ROOT]")
         else
           line
@@ -239,6 +240,26 @@ module Airbrake
       end
     end
 
+    # Should Airbrake send notifications asynchronously
+    # (boolean, nil or callable; default is nil).
+    # Can be used as callable-setter when block provided.
+    def async(&block)
+      if block_given?
+        @async = block
+      end
+      @async
+    end
+    alias_method :async?, :async
+
+    def async=(value)
+      # use default GirlFriday-async for 'true' value
+      @async = if value == true
+                 default_async_processor
+               else
+                 value
+               end
+    end
+
     def js_api_key
       @js_api_key || self.api_key
     end
@@ -276,6 +297,12 @@ module Airbrake
       end
     end
 
+    # Async notice delivery defaults to girl friday
+    def default_async_processor
+      queue = GirlFriday::WorkQueue.new(nil, :size => 3) do |notice|
+        Airbrake.sender.send_to_airbrake(notice)
+      end
+      lambda {|notice| queue << notice}
+    end
   end
-
 end

data/lib/airbrake/notice.rb

@@ -4,6 +4,21 @@ require 'socket'
 module Airbrake
   class Notice
 
+    class << self
+      def attr_reader_with_tracking(*names)
+        attr_readers.concat(names)
+        attr_reader_without_tracking(*names)
+      end
+
+      alias_method :attr_reader_without_tracking, :attr_reader
+      alias_method :attr_reader, :attr_reader_with_tracking
+
+
+      def attr_readers
+        @attr_readers ||= []
+      end
+    end
+
     # The exception that caused this notice, if any
     attr_reader :exception
 
@@ -69,6 +84,23 @@ module Airbrake
     # The host name where this error occurred (if any)
     attr_reader :hostname
 
+    # Details about the user who experienced the error
+    attr_reader :user
+
+    private
+
+    # Private writers for all the attributes
+    attr_writer :exception, :api_key, :backtrace, :error_class, :error_message,
+      :backtrace_filters, :parameters, :params_filters,
+      :environment_filters, :session_data, :project_root, :url, :ignore,
+      :ignore_by_filters, :notifier_name, :notifier_url, :notifier_version,
+      :component, :action, :cgi_data, :environment_name, :hostname, :user
+
+    # Arguments given in the initializer
+    attr_accessor :args
+
+    public
+
     def initialize(args)
       self.args         = args
       self.exception    = args[:exception]
@@ -96,10 +128,11 @@ module Airbrake
       self.backtrace        = Backtrace.parse(exception_attribute(:backtrace, caller), :filters => self.backtrace_filters)
       self.error_class      = exception_attribute(:error_class) {|exception| exception.class.name }
       self.error_message    = exception_attribute(:error_message, 'Notification') do |exception|
-        "#{exception.class.name}: #{exception.message}"
+        "#{exception.class.name}: #{args[:error_message] || exception.message}"
       end
 
       self.hostname        = local_hostname
+      self.user = args[:user]
 
       also_use_rack_params_filters
       find_session_data
@@ -161,6 +194,14 @@ module Airbrake
           env.tag!("environment-name", environment_name)
           env.tag!("hostname", hostname)
         end
+        unless user.blank?
+          notice.tag!("current-user") do |u|
+            u.tag!("id",user[:id])
+            u.tag!("name",user[:name])
+            u.tag!("email",user[:email])
+            u.tag!("username",user[:username])
+          end
+        end
       end
       xml.to_s
     end
@@ -188,14 +229,6 @@ module Airbrake
 
     private
 
-    attr_writer :exception, :api_key, :backtrace, :error_class, :error_message,
-      :backtrace_filters, :parameters, :params_filters,
-      :environment_filters, :session_data, :project_root, :url, :ignore,
-      :ignore_by_filters, :notifier_name, :notifier_url, :notifier_version,
-      :component, :action, :cgi_data, :environment_name, :hostname
-
-    # Arguments given in the initializer
-    attr_accessor :args
 
     # Gets a property named +attribute+ of an exception, either from an actual
     # exception or a hash.
@@ -317,6 +350,8 @@ module Airbrake
 
     def rack_env(method)
       rack_request.send(method) if rack_request
+    rescue
+      {:message => "failed to call #{method} on Rack::Request -- #{$!.message}"}
     end
 
     def rack_request
@@ -344,5 +379,12 @@ module Airbrake
       Socket.gethostname
     end
 
+    def to_s
+      content = []
+      self.class.attr_readers.each do |attr|
+        content << "  #{attr}: #{send(attr)}"
+      end
+      content.join("\n")
+    end
   end
 end

data/lib/airbrake/rack.rb

@@ -22,7 +22,6 @@ module Airbrake
   class Rack
     def initialize(app)
       @app = app
-      Airbrake.configuration.logger ||= Logger.new STDOUT
     end
 
     def ignored_user_agent?(env)

data/lib/airbrake/rails/controller_methods.rb

@@ -3,12 +3,15 @@ module Airbrake
     module ControllerMethods
 
       def airbrake_request_data
-        { :parameters       => airbrake_filter_if_filtering(params.to_hash),
+        {
+          :parameters       => airbrake_filter_if_filtering(params.to_hash),
           :session_data     => airbrake_filter_if_filtering(airbrake_session_data),
           :controller       => params[:controller],
           :action           => params[:action],
           :url              => airbrake_request_url,
-          :cgi_data         => airbrake_filter_if_filtering(request.env) }
+          :cgi_data         => airbrake_filter_if_filtering(request.env),
+          :user             => airbrake_current_user
+        }
       end
 
       private
@@ -20,7 +23,7 @@ module Airbrake
           Airbrake.notify(hash_or_exception, airbrake_request_data)
         end
       end
-      
+
       def airbrake_local_request?
         if defined?(::Rails.application.config)
           ::Rails.application.config.consider_all_requests_local || (request.local? && (!request.env["HTTP_X_FORWARDED_FOR"]))
@@ -39,15 +42,15 @@ module Airbrake
       def airbrake_filter_if_filtering(hash)
         return hash if ! hash.is_a?(Hash)
 
-        
+
         if respond_to?(:filter_parameters) # Rails 2
-          filter_parameters(hash)  
+          filter_parameters(hash)
         elsif defined?(ActionDispatch::Http::ParameterFilter) # Rails 3
           ActionDispatch::Http::ParameterFilter.new(::Rails.application.config.filter_parameters).filter(hash)
         else
           hash
         end rescue hash
-        
+
       end
 
       def airbrake_session_data
@@ -68,7 +71,15 @@ module Airbrake
         url << request.fullpath
         url
       end
+
+      def airbrake_current_user
+        user = current_user || current_member
+        user.attributes.select do |k, v|
+          /^(id|name|username|email)$/ === k unless v.blank?
+        end
+      rescue NoMethodError, NameError
+        {}
+      end
     end
   end
 end
-

data/lib/airbrake/rails/javascript_notifier.rb

@@ -42,7 +42,6 @@ module Airbrake
         end
 
       end
-
     end
   end
 end

data/lib/airbrake/rails/middleware/exceptions_catcher.rb

@@ -14,12 +14,16 @@ module Airbrake
         end
 
         def render_exception_with_airbrake(env,exception)
-          controller = env['action_controller.instance']
-          env['airbrake.error_id'] = Airbrake.
-            notify_or_ignore(exception,
-                   controller.try(:airbrake_request_data) || {:rack_env => env}) unless skip_user_agent?(env)
-          if defined?(controller.rescue_action_in_public_without_airbrake)
-            controller.rescue_action_in_public_without_airbrake(exception)
+          begin
+            controller = env['action_controller.instance']
+            env['airbrake.error_id'] = Airbrake.
+              notify_or_ignore(exception,
+                               controller.try(:airbrake_request_data) || {:rack_env => env}) unless skip_user_agent?(env)
+            if defined?(controller.rescue_action_in_public_without_airbrake)
+              controller.rescue_action_in_public_without_airbrake(exception)
+            end
+          rescue
+            # do nothing
           end
           render_exception_without_airbrake(env,exception)
         end

data/lib/airbrake/rails3_tasks.rb

@@ -7,7 +7,7 @@ namespace :airbrake do
     Rails.logger = defined?(ActiveSupport::TaggedLogging) ?
       ActiveSupport::TaggedLogging.new(Logger.new(STDOUT)) :
       Logger.new(STDOUT)
-      
+
     Rails.logger.level = Logger::DEBUG
     Airbrake.configure(true) do |config|
       config.logger = Rails.logger
@@ -82,4 +82,3 @@ namespace :airbrake do
     Rails.application.call(env)
   end
 end
-

data/lib/airbrake/rake_handler.rb

@@ -10,7 +10,7 @@ module Airbrake::RakeHandler
 
   def display_error_message_with_airbrake(ex)
     if Airbrake.sender && Airbrake.configuration &&
-        (Airbrake.configuration.rescue_rake_exceptions || 
+        (Airbrake.configuration.rescue_rake_exceptions ||
           (Airbrake.configuration.rescue_rake_exceptions===nil && !self.tty_output?))
 
       Airbrake.notify_or_ignore(ex, :component => reconstruct_command_line, :cgi_data => ENV)
@@ -22,11 +22,11 @@ module Airbrake::RakeHandler
   def reconstruct_command_line
     "rake #{ARGV.join( ' ' )}"
   end
-  
+
   # This module brings Rake 0.8.7 error handling to 0.9.0 standards
   module Rake087Methods
     # Method taken from Rake 0.9.0 source
-    # 
+    #
     # Provide standard exception handling for the given block.
     def standard_exception_handling
       begin
@@ -63,4 +63,3 @@ Rake.application.instance_eval do
     include Airbrake::RakeHandler
   end
 end
-

data/lib/airbrake/sender.rb

@@ -1,7 +1,7 @@
 module Airbrake
   # Sends out the notice to Airbrake
   class Sender
-    
+
     NOTICES_URI = '/notifier_api/v2/notices/'.freeze
     HTTP_ERRORS = [Timeout::Error,
                    Errno::EINVAL,
@@ -14,15 +14,15 @@ module Airbrake
 
     def initialize(options = {})
       [ :proxy_host,
-        :proxy_port, 
-        :proxy_user, 
-        :proxy_pass, 
+        :proxy_port,
+        :proxy_user,
+        :proxy_pass,
         :protocol,
-        :host, 
-        :port, 
-        :secure, 
-        :use_system_ssl_cert_chain, 
-        :http_open_timeout, 
+        :host,
+        :port,
+        :secure,
+        :use_system_ssl_cert_chain,
+        :http_open_timeout,
         :http_read_timeout
       ].each do |option|
         instance_variable_set("@#{option}", options[option])
@@ -31,22 +31,29 @@ module Airbrake
 
     # Sends the notice data off to Airbrake for processing.
     #
-    # @param [String] data The XML notice to be sent off
-    def send_to_airbrake(data)
+    # @param [Notice] notice The notice to be sent off
+    def send_to_airbrake(notice)
+      data = notice.to_xml
       http = setup_http_connection
 
       response = begin
                    http.post(url.path, data, HEADERS)
                  rescue *HTTP_ERRORS => e
-                   log :error, "Unable to contact the Airbrake server. HTTP Error=#{e}"
+                   log :level => :error,
+                       :message => "Unable to contact the Airbrake server. HTTP Error=#{e}"
                    nil
                  end
 
       case response
       when Net::HTTPSuccess then
-        log :info, "Success: #{response.class}", response
+        log :level => :info,
+            :message => "Success: #{response.class}",
+            :response => response
       else
-        log :error, "Failure: #{response.class}", response
+        log :level => :error,
+            :message => "Failure: #{response.class}",
+            :response => response,
+            :notice => notice
       end
 
       if response && response.respond_to?(:body)
@@ -54,7 +61,10 @@ module Airbrake
         error_id[1] if error_id
       end
     rescue => e
-      log :error, "[Airbrake::Sender#send_to_airbrake] Cannot send notification. Error: #{e.class} - #{e.message}\nBacktrace:\n#{e.backtrace.join("\n\t")}"
+      log :level => :error,
+        :message => "[Airbrake::Sender#send_to_airbrake] Cannot send notification. Error: #{e.class}" +
+        " - #{e.message}\nBacktrace:\n#{e.backtrace.join("\n\t")}"
+
       nil
     end
 
@@ -72,23 +82,24 @@ module Airbrake
 
     alias_method :secure?, :secure
     alias_method :use_system_ssl_cert_chain?, :use_system_ssl_cert_chain
-    
+
   private
 
     def url
       URI.parse("#{protocol}://#{host}:#{port}").merge(NOTICES_URI)
     end
 
-    def log(level, message, response = nil)
-      logger.send level, LOG_PREFIX + message if logger
+    def log(opts = {})
+      opts[:logger].send opts[:level], LOG_PREFIX + opts[:message] if opts[:logger]
       Airbrake.report_environment_info
-      Airbrake.report_response_body(response.body) if response && response.respond_to?(:body)
+      Airbrake.report_response_body(opts[:response].body) if opts[:response] && opts[:response].respond_to?(:body)
+      Airbrake.report_notice(opts[:notice]) if opts[:notice]
     end
 
     def logger
       Airbrake.logger
     end
-    
+
     def setup_http_connection
       http =
         Net::HTTP::Proxy(proxy_host, proxy_port, proxy_user, proxy_pass).
@@ -105,12 +116,13 @@ module Airbrake
       else
         http.use_ssl     = false
       end
-      
+
       http
     rescue => e
-      log :error, "[Airbrake::Sender#setup_http_connection] Failure initializing the HTTP connection.\nError: #{e.class} - #{e.message}\nBacktrace:\n#{e.backtrace.join("\n\t")}"
+      log :level => :error,
+          :message => "[Airbrake::Sender#setup_http_connection] Failure initializing the HTTP connection.\n" +
+                      "Error: #{e.class} - #{e.message}\nBacktrace:\n#{e.backtrace.join("\n\t")}"
       raise e
     end
-
   end
 end