rails_exception_handler 1.0.0

data/spec/integration/configuration_spec.rb

@@ -0,0 +1,161 @@
+require File.expand_path(File.dirname(__FILE__)) + '/../spec_helper.rb'
+
+describe RailsExceptionHandler::Configuration do
+  describe ".storage_strategies" do
+    it "should store errors in the database when storage_strategies contains :active_record" do
+      RailsExceptionHandler.configure { |config| config.storage_strategies = [:active_record] }
+      get('/incorrect_route')
+      ErrorMessage.count.should == 1
+    end
+
+    it "should store errors in the rails log when storage_strategies contains :rails_log" do
+      RailsExceptionHandler.configure { |config| config.storage_strategies = [:rails_log] }
+      get('/home/model_error')
+      read_test_log.should match /NoMethodError \(undefined method `foo' for nil:NilClass\)/
+      read_test_log.should match /lib\/active_support\/whiny_nil\.rb:48/
+      read_test_log.should match /PARAMS:\s+{\"controller\"=>\"home\", \"action\"=>\"model_error\"}/
+      read_test_log.should match /TARGET:\s+http:\/\/example\.org\/home\/model_error/
+    end
+
+    # No idea how to integration test remote_url without spawning a dedicated test server
+  end
+
+  describe '.filters' do
+    describe ":all_404s" do
+      it "should ignore routing errors when the filters contains :all_404s" do
+        RailsExceptionHandler.configure { |config| config.filters = [:all_404s]}
+        get('/incorrect_route')
+        ErrorMessage.count.should == 0
+      end
+
+      it "should not ignore routing errors when the filters doesnt contain :all_404s" do
+        RailsExceptionHandler.configure { |config| config.filters = []}
+        get('/incorrect_route')
+        ErrorMessage.count.should == 1
+      end
+    end
+
+    describe ":no_referer_404s" do
+      it "should not store a routing error that contains a referer" do
+        RailsExceptionHandler.configure { |config| config.filters = [:no_referer_404s]}
+        get "/incorrect_route"
+        ErrorMessage.count.should == 0
+      end
+
+      it "should store a routing error that has a referer" do
+        RailsExceptionHandler.configure { |config| config.filters = [:no_referer_404s]}
+        get "/incorrect_route", {}, {'HTTP_REFERER' => 'http://example.com'}
+        ErrorMessage.count.should == 1
+      end
+
+      it "should store a non routing error without referer" do
+        RailsExceptionHandler.configure { |config| config.filters = [:no_referer_404s]}
+        get "/home/view_error"
+        ErrorMessage.count.should == 1
+      end
+    end
+
+    describe ":user_agent_regxp" do
+      it "should not store the error message when the user agent matches this regxp" do
+        RailsExceptionHandler.configure { |config| config.filters = [:user_agent_regxp => /\b(NaughtyBot)\b/]}
+        get "/incorrect_route", {}, {'HTTP_USER_AGENT' => 'I am a NaughtyBot'}
+        ErrorMessage.count.should == 0
+      end
+
+      it "should store the error message when the user agent doesnt match this regxp" do
+        RailsExceptionHandler.configure { |config| config.filters = [:user_agent_regxp => /\b(NaughtyBot)\b/]}
+        get "/incorrect_route", {}, {'HTTP_USER_AGENT' => "Mozilla/5.0 (Windows NT 6.1; rv:5.0) Gecko/20100101 Firefox/5.0"}
+        ErrorMessage.count.should == 1
+      end
+    end
+
+    describe ":target_url_regxp" do
+      it "should not store the error message when the url matches this regxp" do
+        RailsExceptionHandler.configure { |config| config.filters = [:target_url_regxp => /incorrect/]}
+        get "/incorrect_route"
+        ErrorMessage.count.should == 0
+      end
+
+      it "should store the error message when the url doesnt matche this regxp" do
+        RailsExceptionHandler.configure { |config| config.filters = [:target_url_regxp => /\b(phpMyAdmin)\b/]}
+        get "/incorrect_route"
+        ErrorMessage.count.should == 1
+      end
+    end
+  end
+
+  describe ".environments" do
+    it "should not log routing errors if the current rails environment is not included" do
+      Rails.configuration.middleware.delete RailsExceptionHandler
+      RailsExceptionHandler.configure { |config| config.environments = [:production] }
+      lambda { get('/incorrect_route') }.should raise_exception
+      ErrorMessage.count.should == 0
+    end
+
+    it "should not log regular errors if the current rails environment is not included" do
+      Rails.configuration.middleware.delete RailsExceptionHandler
+      RailsExceptionHandler.configure { |config| config.environments = [:production] }
+      lambda { get('/home/model_error') }.should raise_exception
+      ErrorMessage.count.should == 0
+    end
+
+    it "should log routing errors if the rails environment is included" do
+      Rails.configuration.middleware.delete RailsExceptionHandler
+      RailsExceptionHandler.configure { |config| config.environments = [Rails.env.to_sym] }
+      get('/incorrect_route')
+      ErrorMessage.count.should == 1
+      last_response.body.should match(/this_is_the_fallback_layout/)
+    end
+
+    it "should log regular errors if the rails environment is included" do
+      Rails.configuration.middleware.delete RailsExceptionHandler
+      RailsExceptionHandler.configure { |config| config.environments = [Rails.env.to_sym] }
+      get('/home/model_error')
+      ErrorMessage.count.should == 1
+      last_response.body.should match(/this_is_the_home_layout/)
+    end
+  end
+
+  describe ".fallback_layout" do
+    it "should use the supplied layout on routing errors" do
+      RailsExceptionHandler.configure { |config| config.fallback_layout = 'home' }
+      get('/incorrect_route')
+      last_response.body.should match(/this_is_the_home_layout/)
+    end
+  end
+
+  describe ".store_user_info" do
+    it "should not store user info when disbled" do
+      RailsExceptionHandler.configure do |config|
+        config.environments = [Rails.env.to_sym]
+        config.storage_strategies = [:active_record]
+        config.store_user_info = nil
+      end
+      get('/incorrect_route')
+      ErrorMessage.count.should == 1
+      ErrorMessage.first.user_info.should == nil
+    end
+
+    it "should store user info on routing errors" do
+      RailsExceptionHandler.configure do |config|
+        config.environments = [Rails.env.to_sym]
+        config.storage_strategies = [:active_record]
+        config.store_user_info = {:method => :current_user, :field => :login}
+      end
+      get('/incorrect_route')
+      ErrorMessage.count.should == 1
+      ErrorMessage.first.user_info.should == 'matz'
+    end
+
+    it "should store user info on application errors" do
+      RailsExceptionHandler.configure do |config|
+        config.environments = [Rails.env.to_sym]
+        config.storage_strategies = [:active_record]
+        config.store_user_info = {:method => :current_user, :field => :login}
+      end
+      get('/home/view_error')
+      ErrorMessage.count.should == 1
+      ErrorMessage.first.user_info.should == 'matz'
+    end
+  end
+end

data/spec/integration/rails_exception_handler_spec.rb

@@ -0,0 +1,67 @@
+require File.expand_path(File.dirname(__FILE__)) + '/../spec_helper.rb'
+
+describe RailsExceptionHandler do
+  it "should catch controller errors" do
+    get "/home/controller_error"
+    ErrorMessage.count.should == 1
+    last_response.body.should match(/Internal server error/)
+    ErrorMessage.first.class_name.should == 'NoMethodError'
+  end
+
+  it "should catch model errors" do
+    get "/home/model_error"
+    ErrorMessage.count.should == 1
+    last_response.body.should match(/Internal server error/)
+    ErrorMessage.first.class_name.should == 'NoMethodError'
+  end
+
+  it "should catch view errors" do
+    get "/home/view_error"
+    ErrorMessage.count.should == 1
+    last_response.body.should match(/Internal server error/)
+    ErrorMessage.first.class_name.should == 'ActionView::Template::Error'
+  end
+
+  it "should catch routing errors"  do
+    get "/incorrect_route"
+    ErrorMessage.count.should == 1
+    last_response.body.should match(/Page not found/)
+    ErrorMessage.first.class_name.should == 'ActionController::RoutingError'
+  end
+
+  it "should catch syntax errors" do
+    get "/home/syntax_error"
+    ErrorMessage.count.should == 1
+    last_response.body.should match(/Internal server error/)
+    ErrorMessage.first.class_name.should == 'SyntaxError'
+  end
+
+  it "should append the failed controllers view layout when rendering the response" do
+    get "/home/view_error"
+    last_response.body.should match(/this_is_the_home_layout/)
+  end
+
+  it "should fall back to using the application layout on routing errors" do
+    get "/incorrect_route"
+    last_response.body.should match(/this_is_the_fallback_layout/)
+  end
+
+  it "should store the correct information in the database" do
+    RailsExceptionHandler.configure { |config| config.store_user_info = {:method => :current_user, :field => :login} }
+    get "/home/controller_error", {}, {'HTTP_REFERER' => 'http://google.com/', 'HTTP_USER_AGENT' => 'Mozilla/4.0 (compatible; MSIE 8.0)'}
+    ErrorMessage.count.should == 1
+    msg = ErrorMessage.first
+    msg.app_name.should ==      'ExceptionHandlerTestApp'
+    msg.class_name.should ==    'NoMethodError'
+    msg.message.should ==       "undefined method `foo' for nil:NilClass"
+    msg.trace.should match      /#{TEST_APP}\/app\/controllers\/home_controller.rb:5:in `controller_error'/
+    msg.params.should match     /"controller"=>"home"/
+    msg.params.should match     /"action"=>"controller_error"/
+    msg.user_agent.should ==    'Mozilla/4.0 (compatible; MSIE 8.0)'
+    msg.target_url.should ==    'http://example.org/home/controller_error'
+    msg.referer_url.should ==   'http://google.com/'
+    msg.user_info.should ==     'matz'
+    msg.created_at.should be >  5.seconds.ago
+    msg.created_at.should be <  Time.now
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,25 @@
+
+TEST_APP = 'testapp_30'
+ENV["RAILS_ENV"] = 'test'
+require File.expand_path(File.dirname(__FILE__)) + "/#{TEST_APP}/config/environment.rb"
+
+require File.expand_path(File.dirname(__FILE__)) + '/test_macros.rb'
+
+require "rspec/rails"
+require "rack/test"
+
+ActiveRecord::Base.logger = nil
+ActionController::Base.logger = nil
+
+RSpec.configure do |config|
+  config.include Rack::Test::Methods
+  config.include TestMacros
+  config.around do |example|
+    ErrorMessage.delete_all
+    clear_test_log
+    reset_configuration
+    example.call
+  end
+  config.color_enabled = true
+  config.full_backtrace = true
+end

data/spec/test_macros.rb

@@ -0,0 +1,61 @@
+
+require 'fileutils'
+
+module TestMacros
+  def app # Used by by Rack::Test to get the application object
+    Rails.application.app
+  end
+
+  def create_env(*args)
+    options = args.extract_options!
+    referer = options[:referer] || 'http://google.com/'
+    s = Rack::Test::Session.new(nil)
+    env = s.send(:env_for,'/home', {:params => {:foo => 'bar'}, 'HTTP_REFERER' => referer, 'HTTP_USER_AGENT' => "Mozilla/4.0 (compatible; MSIE 8.0)"})
+  end
+
+  def create_parser(exception = nil, request = nil, controller = nil)
+      env = create_env
+      controller ||= mock(ApplicationController, :current_user => mock(Object, :login => 'matz'))
+      request ||= ActionDispatch::Request.new(env)
+      exception ||= create_exception
+      parser = RailsExceptionHandler::Parser.new(exception, request, controller)
+  end
+
+  def create_exception
+    exception = nil
+    begin
+      nil.foo
+    rescue Exception => e
+      exception = e
+    end
+  end
+
+  def clear_test_log
+    File.open(log_path, 'w') {|f| f.write('') }
+  end
+
+  def read_test_log
+    data = ""
+    File.open(log_path, 'r').each_line do |line|
+      data += line + '\n'
+    end
+    return data
+  end
+
+  def reset_configuration
+    Rails.configuration.middleware.delete(RailsExceptionHandler)
+    RailsExceptionHandler.configure do |config|
+      config.storage_strategies = [:active_record]
+      config.environments = [:test]
+      config.store_user_info = false
+      config.filters = []
+      config.fallback_layout = 'fallback'
+    end
+  end
+
+  private
+
+  def log_path
+    File.expand_path(File.dirname(__FILE__)) + "/#{TEST_APP}/log/test.log"
+  end
+end

data/spec/testapp_30/.gitignore

@@ -0,0 +1,4 @@
+.bundle
+db/*.sqlite3
+log/*.log
+tmp/

data/spec/testapp_30/Gemfile

@@ -0,0 +1,31 @@
+source 'http://rubygems.org'
+
+gem 'rails', '3.0.9'
+
+# Bundle edge Rails instead:
+# gem 'rails', :git => 'git://github.com/rails/rails.git'
+
+gem 'mysql2'
+
+# Use unicorn as the web server
+# gem 'unicorn'
+
+# Deploy with Capistrano
+# gem 'capistrano'
+
+# To use debugger (ruby-debug for Ruby 1.8.7+, ruby-debug19 for Ruby 1.9.2+)
+# gem 'ruby-debug'
+# gem 'ruby-debug19', :require => 'ruby-debug'
+
+# Bundle the extra gems:
+# gem 'bj'
+# gem 'nokogiri'
+# gem 'sqlite3-ruby', :require => 'sqlite3'
+# gem 'aws-s3', :require => 'aws/s3'
+
+# Bundle gems for the local environment. Make sure to
+# put test-only gems in this group so their generators
+# and rake tasks are available in development mode:
+# group :development, :test do
+#   gem 'webrat'
+# end

data/spec/testapp_30/Gemfile.lock

@@ -0,0 +1,75 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    abstract (1.0.0)
+    actionmailer (3.0.9)
+      actionpack (= 3.0.9)
+      mail (~> 2.2.19)
+    actionpack (3.0.9)
+      activemodel (= 3.0.9)
+      activesupport (= 3.0.9)
+      builder (~> 2.1.2)
+      erubis (~> 2.6.6)
+      i18n (~> 0.5.0)
+      rack (~> 1.2.1)
+      rack-mount (~> 0.6.14)
+      rack-test (~> 0.5.7)
+      tzinfo (~> 0.3.23)
+    activemodel (3.0.9)
+      activesupport (= 3.0.9)
+      builder (~> 2.1.2)
+      i18n (~> 0.5.0)
+    activerecord (3.0.9)
+      activemodel (= 3.0.9)
+      activesupport (= 3.0.9)
+      arel (~> 2.0.10)
+      tzinfo (~> 0.3.23)
+    activeresource (3.0.9)
+      activemodel (= 3.0.9)
+      activesupport (= 3.0.9)
+    activesupport (3.0.9)
+    arel (2.0.10)
+    builder (2.1.2)
+    erubis (2.6.6)
+      abstract (>= 1.0.0)
+    i18n (0.5.0)
+    mail (2.2.19)
+      activesupport (>= 2.3.6)
+      i18n (>= 0.4.0)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.16)
+    mysql2 (0.3.6)
+    polyglot (0.3.1)
+    rack (1.2.3)
+    rack-mount (0.6.14)
+      rack (>= 1.0.0)
+    rack-test (0.5.7)
+      rack (>= 1.0)
+    rails (3.0.9)
+      actionmailer (= 3.0.9)
+      actionpack (= 3.0.9)
+      activerecord (= 3.0.9)
+      activeresource (= 3.0.9)
+      activesupport (= 3.0.9)
+      bundler (~> 1.0)
+      railties (= 3.0.9)
+    railties (3.0.9)
+      actionpack (= 3.0.9)
+      activesupport (= 3.0.9)
+      rake (>= 0.8.7)
+      rdoc (~> 3.4)
+      thor (~> 0.14.4)
+    rake (0.9.2)
+    rdoc (3.8)
+    thor (0.14.6)
+    treetop (1.4.9)
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.29)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  mysql2
+  rails (= 3.0.9)

data/spec/testapp_30/Rakefile

@@ -0,0 +1,7 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+require 'rake'
+
+ExceptionHandlerTestApp::Application.load_tasks

data/spec/testapp_30/app/controllers/application_controller.rb

@@ -0,0 +1,12 @@
+class ApplicationController < ActionController::Base
+  protect_from_forgery
+
+  def current_user
+    mock = Object.new
+    def mock.login
+      'matz'
+    end
+    return mock
+  end
+
+end

data/spec/testapp_30/app/controllers/home_controller.rb

@@ -0,0 +1,22 @@
+class HomeController < ApplicationController
+  layout 'home'
+
+  def controller_error
+    nil.foo
+    render(:text => 'did not fail')
+  end
+
+  def model_error
+    s = StoredException.new
+    s.failure
+    render(:text => 'did not fail')
+  end
+
+  def view_error
+  end
+
+  def syntax_error
+    eval("arr = [")
+    render(:text => 'did not fail')
+  end
+end

data/spec/testapp_30/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/spec/testapp_30/app/models/stored_exception.rb

@@ -0,0 +1,9 @@
+# Only used for testing model errors
+class StoredException < ActiveRecord::Base
+  set_table_name :error_messages
+
+
+  def failure
+    nil.foo
+  end
+end

data/spec/testapp_30/app/views/home/view_error.html.erb

@@ -0,0 +1,2 @@
+
+<%= nil.foo %>

data/spec/testapp_30/app/views/layouts/fallback.html.erb

@@ -0,0 +1,15 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>ExceptionHandlerTestApp</title>
+  <%= stylesheet_link_tag :all %>
+  <%= javascript_include_tag :defaults %>
+  <%= csrf_meta_tag %>
+</head>
+<body>
+
+this_is_the_fallback_layout
+<%= yield %>
+
+</body>
+</html>

data/spec/testapp_30/app/views/layouts/home.html.erb

@@ -0,0 +1,15 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>ExceptionHandlerTestApp</title>
+  <%= stylesheet_link_tag :all %>
+  <%= javascript_include_tag :defaults %>
+  <%= csrf_meta_tag %>
+</head>
+<body>
+
+this_is_the_home_layout
+<%= yield %>
+
+</body>
+</html>

data/spec/testapp_30/config/application.rb

@@ -0,0 +1,44 @@
+require File.expand_path('../boot', __FILE__)
+
+require 'rails/all'
+
+# If you have a Gemfile, require the gems listed there, including any gems
+# you've limited to :test, :development, or :production.
+Bundler.require(:default, Rails.env) if defined?(Bundler)
+
+module ExceptionHandlerTestApp
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    # Custom directories with classes and modules you want to be autoloadable.
+    # config.autoload_paths += %W(#{config.root}/extras)
+
+    # Only load the plugins named here, in the order given (default is alphabetical).
+    # :all can be used as a placeholder for all plugins not explicitly named.
+    # config.plugins = [ :exception_notification, :ssl_requirement, :all ]
+
+    # Activate observers that should always be running.
+    # config.active_record.observers = :cacher, :garbage_collector, :forum_observer
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+
+    # JavaScript files you want as :defaults (application.js is always included).
+    config.action_view.javascript_expansions[:defaults] = []
+
+    # Configure the default encoding used in templates for Ruby 1.9.
+    config.encoding = "utf-8"
+
+    # Configure sensitive parameters which will be filtered from the log file.
+    config.filter_parameters += [:password]
+
+    config.session_store :active_record_store
+  end
+end

data/spec/testapp_30/config/boot.rb

@@ -0,0 +1,6 @@
+require 'rubygems'
+
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+
+require 'bundler/setup' if File.exists?(ENV['BUNDLE_GEMFILE'])

data/spec/testapp_30/config/database.yml

@@ -0,0 +1,12 @@
+test: &test
+  adapter: mysql2
+  encoding: utf8
+  reconnect: false
+  database: exception_handler_test_app_test
+  pool: 5
+  username: root
+  password: admin
+  socket: /var/run/mysqld/mysqld.sock
+
+exception_database:
+  <<: *test

data/spec/testapp_30/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the rails application
+require File.expand_path('../application', __FILE__)
+
+# Initialize the rails application
+ExceptionHandlerTestApp::Application.initialize!

data/spec/testapp_30/config/environments/development.rb

@@ -0,0 +1,26 @@
+ExceptionHandlerTestApp::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb
+
+  # In the development environment your application's code is reloaded on
+  # every request.  This slows down response time but is perfect for development
+  # since you don't have to restart the webserver when you make code changes.
+  config.cache_classes = false
+
+  # Log error messages when you accidentally call methods on nil.
+  config.whiny_nils = true
+
+  # Show full error reports and disable caching
+  config.consider_all_requests_local       = true
+  config.action_view.debug_rjs             = true
+  config.action_controller.perform_caching = false
+
+  # Don't care if the mailer can't send
+  config.action_mailer.raise_delivery_errors = false
+
+  # Print deprecation notices to the Rails logger
+  config.active_support.deprecation = :log
+
+  # Only use best-standards-support built into browsers
+  config.action_dispatch.best_standards_support = :builtin
+end
+

data/spec/testapp_30/config/environments/production.rb

@@ -0,0 +1,49 @@
+ExceptionHandlerTestApp::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb
+
+  # The production environment is meant for finished, "live" apps.
+  # Code is not reloaded between requests
+  config.cache_classes = true
+
+  # Full error reports are disabled and caching is turned on
+  config.consider_all_requests_local       = false
+  config.action_controller.perform_caching = true
+
+  # Specifies the header that your server uses for sending files
+  config.action_dispatch.x_sendfile_header = "X-Sendfile"
+
+  # For nginx:
+  # config.action_dispatch.x_sendfile_header = 'X-Accel-Redirect'
+
+  # If you have no front-end server that supports something like X-Sendfile,
+  # just comment this out and Rails will serve the files
+
+  # See everything in the log (default is :info)
+  # config.log_level = :debug
+
+  # Use a different logger for distributed setups
+  # config.logger = SyslogLogger.new
+
+  # Use a different cache store in production
+  # config.cache_store = :mem_cache_store
+
+  # Disable Rails's static asset server
+  # In production, Apache or nginx will already do this
+  config.serve_static_assets = false
+
+  # Enable serving of images, stylesheets, and javascripts from an asset server
+  # config.action_controller.asset_host = "http://assets.example.com"
+
+  # Disable delivery errors, bad email addresses will be ignored
+  # config.action_mailer.raise_delivery_errors = false
+
+  # Enable threaded mode
+  # config.threadsafe!
+
+  # Enable locale fallbacks for I18n (makes lookups for any locale fall back to
+  # the I18n.default_locale when a translation can not be found)
+  config.i18n.fallbacks = true
+
+  # Send deprecation notices to registered listeners
+  config.active_support.deprecation = :notify
+end