airbrake 3.1.2 → 3.1.3

data/lib/airbrake/shared_tasks.rb

@@ -1,7 +1,8 @@
 namespace :airbrake do
   desc "Notify Airbrake of a new deploy."
-  task :deploy => :environment do
+  task :deploy do
     require 'airbrake_tasks'
+    load File.join(Rails.root, 'config', 'initializers','airbrake.rb') if defined?(Rails.root)
     AirbrakeTasks.deploy(:rails_env      => ENV['TO'],
                         :scm_revision   => ENV['REVISION'],
                         :scm_repository => ENV['REPO'],

data/lib/airbrake/version.rb

@@ -1,3 +1,3 @@
 module Airbrake
-  VERSION = "3.1.2".freeze
+  VERSION = "3.1.3".freeze
 end

data/test/{airbrake_2_2.xsd → airbrake_2_3.xsd}

@@ -9,6 +9,7 @@
         <xs:element name="error" type="error"/>
         <xs:element name="request" type="request" minOccurs="0"/>
         <xs:element name="server-environment" type="serverEnvironment"/>
+        <xs:element name="current-user" type="current-user" minOccurs="0"/>
       </xs:all>
       <xs:attribute name="version" type="xs:string" use="required"/>
     </xs:complexType>
@@ -32,7 +33,7 @@
 
   <xs:complexType name="backtrace">
     <xs:sequence>
-      <xs:element name="line" maxOccurs="unbounded">
+      <xs:element name="line" maxOccurs="unbounded" minOccurs="0">
         <xs:complexType>
           <xs:attribute name="file" type="xs:string" use="required"/>
           <xs:attribute name="number" type="xs:string" use="required"/>
@@ -75,4 +76,13 @@
     </xs:sequence>
   </xs:complexType>
 
+  <xs:complexType name="current-user">
+    <xs:all>
+      <xs:element name="id" type="xs:string"/>
+      <xs:element name="name" type="xs:string" minOccurs="0"/>
+      <xs:element name="email" type="xs:string" minOccurs="0"/>
+      <xs:element name="username" type="xs:string" minOccurs="0"/>
+    </xs:all>
+  </xs:complexType>
+
 </xs:schema>

data/test/airbrake_tasks_test.rb

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + '/helper'
+require File.expand_path '../helper', __FILE__
 require 'rubygems'
 
 require File.dirname(__FILE__) + '/../lib/airbrake_tasks'
@@ -54,7 +54,7 @@ class AirbrakeTasksTest < Test::Unit::TestCase
 
           @options    = { :rails_env => "staging", :dry_run => false }
         end
-        
+
         context "performing a dry run" do
           setup { @output = AirbrakeTasks.deploy(@options.merge(:dry_run => true)) }
 
@@ -140,7 +140,7 @@ class AirbrakeTasksTest < Test::Unit::TestCase
         before_should "post to the custom host" do
           @post             = stub("post",     :set_form_data => nil)
           @http_proxy       = stub("proxy",    :request => @response)
-          
+
           @http_proxy_class = stub("proxy_class", :new => @http_proxy)
           @http_proxy_class.expects(:new).with("custom.host", 80).returns(@http_proxy)
           Net::HTTP.expects(:Proxy).with(any_parameters).returns(@http_proxy_class)

data/test/backtrace_test.rb

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + '/helper'
+require File.expand_path '../helper', __FILE__
 
 class BacktraceTest < Test::Unit::TestCase
 
@@ -20,7 +20,7 @@ class BacktraceTest < Test::Unit::TestCase
     assert_equal 'app/controllers/users_controller.rb', line.file
     assert_equal 'index', line.method
   end
-  
+
   should "parse a windows backtrace into lines" do
     array = [
       "C:/Program Files/Server/app/models/user.rb:13:in `magic'",

data/test/capistrano_test.rb

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + '/helper'
+require File.expand_path '../helper', __FILE__
 
 require 'capistrano/configuration'
 require 'airbrake/capistrano'
@@ -7,16 +7,16 @@ class CapistranoTest < Test::Unit::TestCase
   def setup
     super
     reset_config
-    
+
     @configuration = Capistrano::Configuration.new
     Airbrake::Capistrano.load_into(@configuration)
     @configuration.dry_run = true
   end
-  
+
   should "define airbrake:deploy task" do
     assert_not_nil @configuration.find_task('airbrake:deploy')
   end
-  
+
   should "log when calling airbrake:deploy task" do
     @configuration.set(:current_revision, '084505b1c0e0bcf1526e673bb6ac99fbcb18aecc')
     @configuration.set(:repository, 'repository')
@@ -24,10 +24,10 @@ class CapistranoTest < Test::Unit::TestCase
     io = StringIO.new
     logger = Capistrano::Logger.new(:output => io)
     logger.level = Capistrano::Logger::MAX_LEVEL
-    
+
     @configuration.logger = logger
     @configuration.find_and_execute_task('airbrake:deploy')
-    
+
     assert io.string.include?('** Notifying Airbrake of Deploy')
     assert io.string.include?('** Airbrake Notification Complete')
   end

data/test/catcher_test.rb

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + '/helper'
+require File.expand_path '../helper', __FILE__
 
 class ActionControllerCatcherTest < Test::Unit::TestCase
 
@@ -75,7 +75,7 @@ class ActionControllerCatcherTest < Test::Unit::TestCase
   end
 
   def last_sent_notice_xml
-    sender.collected.last
+    sender.collected.last.to_xml
   end
 
   def last_sent_notice_document

data/test/configuration_test.rb

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + '/helper'
+require File.expand_path '../helper', __FILE__
 
 class ConfigurationTest < Test::Unit::TestCase
 
@@ -29,6 +29,20 @@ class ConfigurationTest < Test::Unit::TestCase
                           Airbrake::Configuration::IGNORE_DEFAULT
     assert_config_default :development_lookup, true
     assert_config_default :framework, 'Standalone'
+    assert_config_default :async, nil
+  end
+
+  should "set GirlFriday-callable for async=true" do
+    config = Airbrake::Configuration.new
+    config.async = true
+    assert config.async.respond_to?(:call)
+  end
+
+  should "set provided-callable for async {}" do
+    config = Airbrake::Configuration.new
+    config.async {|notice| :ok}
+    assert config.async.respond_to?(:call)
+    assert_equal :ok, config.async.call
   end
 
   should "provide default values for secure connections" do
@@ -70,6 +84,7 @@ class ConfigurationTest < Test::Unit::TestCase
     assert_config_overridable :environment_name
     assert_config_overridable :development_lookup
     assert_config_overridable :logger
+    assert_config_overridable :async
   end
 
   should "have an api key" do
@@ -84,7 +99,7 @@ class ConfigurationTest < Test::Unit::TestCase
      :http_read_timeout, :ignore, :ignore_by_filters, :ignore_user_agent,
      :notifier_name, :notifier_url, :notifier_version, :params_filters,
      :project_root, :port, :protocol, :proxy_host, :proxy_pass, :proxy_port,
-     :proxy_user, :secure, :development_lookup].each do |option|
+     :proxy_user, :secure, :development_lookup, :async].each do |option|
       assert_equal config[option], hash[option], "Wrong value for #{option}"
     end
   end

data/test/helper.rb

@@ -7,8 +7,6 @@ $LOAD_PATH << File.expand_path(File.join(File.dirname(__FILE__), "..", "lib"))
 
 require 'thread'
 
-require "bundler/setup"
-
 require 'shoulda'
 require 'mocha'
 
@@ -134,16 +132,6 @@ class Test::Unit::TestCase
     BacktracedException.new(opts)
   end
 
-  class BacktracedException < Exception
-    attr_accessor :backtrace
-    def initialize(opts)
-      @backtrace = opts[:backtrace]
-    end
-    def set_backtrace(bt)
-      @backtrace = bt
-    end
-  end
-
   def build_notice_data(exception = nil)
     exception ||= build_exception
     {
@@ -187,7 +175,7 @@ class Test::Unit::TestCase
            "but found #{nodes.map { |n| n.content }} in #{nodes.size} matching nodes." +
            "Document:\n#{document.to_s}"
   end
-  
+
   def assert_logged(expected)
     assert_received(Airbrake, :write_verbose_log) do |expect|
       expect.with {|actual| actual =~ expected }
@@ -200,7 +188,7 @@ class Test::Unit::TestCase
     end
   end
 
-  
+
 end
 
 module DefinesConstants
@@ -261,3 +249,15 @@ class FakeLogger
   def fatal(*args); end
 end
 
+class BacktracedException < Exception
+  attr_accessor :backtrace
+  def initialize(opts)
+    @backtrace = opts[:backtrace]
+  end
+  def set_backtrace(bt)
+    @backtrace = bt
+  end
+  def message
+    "Something went wrong. Did you press the red button?"
+  end
+end

data/test/javascript_notifier_test.rb

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + '/helper'
+require File.expand_path '../helper', __FILE__
 require 'airbrake/rails/javascript_notifier'
 require 'ostruct'
 
@@ -49,4 +49,3 @@ class JavascriptNotifierTest < Test::Unit::TestCase
     assert ! controller.send(:airbrake_javascript_notifier)['"bad_javascript"']
   end
 end
-

data/test/logger_test.rb

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + '/helper'
+require File.expand_path '../helper', __FILE__
 
 class LoggerTest < Test::Unit::TestCase
   def stub_http(response, body = nil)
@@ -11,7 +11,7 @@ class LoggerTest < Test::Unit::TestCase
   end
 
   def send_notice
-    Airbrake.sender.send_to_airbrake('data')
+    Airbrake.sender.send_to_airbrake({'foo' => "bar"})
   end
 
   def stub_verbose_log
@@ -70,4 +70,10 @@ class LoggerTest < Test::Unit::TestCase
     assert_logged /Response from Airbrake:/
   end
 
+  should "print information about the notice when Airbrake server fails" do
+    stub_verbose_log
+    stub_http(Net::HTTPError, "test")
+    send_notice
+    assert_logged /Notice details:/
+  end
 end

data/test/notice_test.rb

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + '/helper'
+require File.expand_path '../helper', __FILE__
 
 class NoticeTest < Test::Unit::TestCase
 
@@ -24,6 +24,79 @@ class NoticeTest < Test::Unit::TestCase
                       :env         => { 'three' => 'four' } }.update(attrs))
   end
 
+  def assert_accepts_exception_attribute(attribute, args = {}, &block)
+    exception = build_exception
+    block ||= lambda { exception.send(attribute) }
+    value = block.call(exception)
+
+    notice_from_exception = build_notice(args.merge(:exception => exception))
+
+    assert_equal notice_from_exception.send(attribute),
+                 value,
+                 "#{attribute} was not correctly set from an exception"
+
+    notice_from_hash = build_notice(args.merge(attribute => value))
+    assert_equal notice_from_hash.send(attribute),
+                 value,
+                 "#{attribute} was not correctly set from a hash"
+  end
+
+  def assert_serializes_hash(attribute)
+    [File.open(__FILE__), Proc.new { puts "boo!" }, Module.new].each do |object|
+      hash = {
+        :strange_object => object,
+        :sub_hash => {
+          :sub_object => object
+        },
+        :array => [object]
+      }
+      notice = build_notice(attribute => hash)
+      hash = notice.send(attribute)
+      assert_equal object.to_s, hash[:strange_object], "objects should be serialized"
+      assert_kind_of Hash, hash[:sub_hash], "subhashes should be kept"
+      assert_equal object.to_s, hash[:sub_hash][:sub_object], "subhash members should be serialized"
+      assert_kind_of Array, hash[:array], "arrays should be kept"
+      assert_equal object.to_s, hash[:array].first, "array members should be serialized"
+    end
+  end
+
+  def assert_valid_notice_document(document)
+    xsd_path = File.join(File.dirname(__FILE__), "airbrake_2_3.xsd")
+    schema = Nokogiri::XML::Schema.new(IO.read(xsd_path))
+    errors = schema.validate(document)
+    assert errors.empty?, errors.collect{|e| e.message }.join
+  end
+
+  def assert_filters_hash(attribute)
+    filters  = ["abc", :def]
+    original = { 'abc' => "123", 'def' => "456", 'ghi' => "789", 'nested' => { 'abc' => '100' },
+      'something_with_abc' => 'match the entire string'}
+    filtered = { 'abc'    => "[FILTERED]",
+                 'def'    => "[FILTERED]",
+                 'something_with_abc' => "match the entire string",
+                 'ghi'    => "789",
+                 'nested' => { 'abc' => '[FILTERED]' } }
+
+    notice = build_notice(:params_filters => filters, attribute => original)
+
+    assert_equal(filtered,
+                 notice.send(attribute))
+  end
+
+  def build_backtrace_array
+    ["app/models/user.rb:13:in `magic'",
+      "app/controllers/users_controller.rb:8:in `index'"]
+  end
+
+  def hostname
+    `hostname`.chomp
+  end
+
+  def user
+    Struct.new(:email,:id,:name).
+      new("darth@vader.com",1,"Anakin Skywalker")
+  end
+
   should "set the api key" do
     api_key = 'key'
     notice = build_notice(:api_key => api_key)
@@ -78,6 +151,12 @@ class NoticeTest < Test::Unit::TestCase
                  "backtrace was not correctly set from a hash"
   end
 
+  should "accept user" do
+    assert_equal user.id, build_notice(:user => user).user.id
+    assert_equal user.email, build_notice(:user => user).user.email
+    assert_equal user.name, build_notice(:user => user).user.name
+  end
+
   should "pass its backtrace filters for parsing" do
     backtrace_array = ['my/file/backtrace:3']
     exception = build_exception
@@ -316,14 +395,7 @@ class NoticeTest < Test::Unit::TestCase
     end
   end
 
-  ignored_error_classes = %w(
-    ActiveRecord::RecordNotFound
-    AbstractController::ActionNotFound
-    ActionController::RoutingError
-    ActionController::InvalidAuthenticityToken
-    CGI::Session::CookieStore::TamperedWithCookie
-    ActionController::UnknownAction
-  )
+  ignored_error_classes = Airbrake::Configuration::IGNORE_DEFAULT
 
   ignored_error_classes.each do |ignored_error_class|
     should "ignore #{ignored_error_class} error by default" do
@@ -349,7 +421,6 @@ class NoticeTest < Test::Unit::TestCase
     end
   end
 
-
   should "ensure #to_ary is called on objects that support it" do
     assert_nothing_raised do
       build_notice(:session => { :object => stub(:to_ary => {}) })
@@ -368,6 +439,20 @@ class NoticeTest < Test::Unit::TestCase
     assert_equal 'GET', notice.cgi_data['REQUEST_METHOD']
   end
 
+  should "show a nice warning when rack environment exceeds rack keyspace" do
+    # simulate exception for too big query
+    Rack::Request.any_instance.expects(:params).raises(RangeError.new("exceeded available parameter key space"))
+
+    url = "https://subdomain.happylane.com:100/test/file.rb?var=x"
+    env = Rack::MockRequest.env_for(url)
+
+    notice = build_notice(:rack_env => env)
+
+    assert_equal url, notice.url
+    assert_equal({:message => "failed to call params on Rack::Request -- exceeded available parameter key space"}, notice.parameters)
+    assert_equal 'GET', notice.cgi_data['REQUEST_METHOD']
+  end
+
   should "extract data from a rack environment hash with action_dispatch info" do
     params = { 'controller' => 'users', 'action' => 'index', 'id' => '7' }
     env = Rack::MockRequest.env_for('/', { 'action_dispatch.request.parameters' => params })
@@ -397,72 +482,9 @@ class NoticeTest < Test::Unit::TestCase
     assert_equal session_data, notice.session_data
   end
 
-  def assert_accepts_exception_attribute(attribute, args = {}, &block)
+  should "prefer passed error_message to exception message" do
     exception = build_exception
-    block ||= lambda { exception.send(attribute) }
-    value = block.call(exception)
-
-    notice_from_exception = build_notice(args.merge(:exception => exception))
-
-    assert_equal notice_from_exception.send(attribute),
-                 value,
-                 "#{attribute} was not correctly set from an exception"
-
-    notice_from_hash = build_notice(args.merge(attribute => value))
-    assert_equal notice_from_hash.send(attribute),
-                 value,
-                 "#{attribute} was not correctly set from a hash"
+    notice = build_notice(:exception => exception,:error_message => "Random ponies")
+    assert_equal "BacktracedException: Random ponies", notice.error_message
   end
-
-  def assert_serializes_hash(attribute)
-    [File.open(__FILE__), Proc.new { puts "boo!" }, Module.new].each do |object|
-      hash = {
-        :strange_object => object,
-        :sub_hash => {
-          :sub_object => object
-        },
-        :array => [object]
-      }
-      notice = build_notice(attribute => hash)
-      hash = notice.send(attribute)
-      assert_equal object.to_s, hash[:strange_object], "objects should be serialized"
-      assert_kind_of Hash, hash[:sub_hash], "subhashes should be kept"
-      assert_equal object.to_s, hash[:sub_hash][:sub_object], "subhash members should be serialized"
-      assert_kind_of Array, hash[:array], "arrays should be kept"
-      assert_equal object.to_s, hash[:array].first, "array members should be serialized"
-    end
-  end
-
-  def assert_valid_notice_document(document)
-    xsd_path = File.join(File.dirname(__FILE__), "airbrake_2_2.xsd")
-    schema = Nokogiri::XML::Schema.new(IO.read(xsd_path))
-    errors = schema.validate(document)
-    assert errors.empty?, errors.collect{|e| e.message }.join
-  end
-
-  def assert_filters_hash(attribute)
-    filters  = ["abc", :def]
-    original = { 'abc' => "123", 'def' => "456", 'ghi' => "789", 'nested' => { 'abc' => '100' },
-      'something_with_abc' => 'match the entire string'}
-    filtered = { 'abc'    => "[FILTERED]",
-                 'def'    => "[FILTERED]",
-                 'something_with_abc' => "match the entire string",
-                 'ghi'    => "789",
-                 'nested' => { 'abc' => '[FILTERED]' } }
-
-    notice = build_notice(:params_filters => filters, attribute => original)
-
-    assert_equal(filtered,
-                 notice.send(attribute))
-  end
-
-  def build_backtrace_array
-    ["app/models/user.rb:13:in `magic'",
-      "app/controllers/users_controller.rb:8:in `index'"]
-  end
-
-  def hostname
-    `hostname`.chomp
-  end
-
 end