Refactor exception notifier for Rails 3

Author: josh

README

@@ -39,23 +39,6 @@ just set any or all of the following values:
   # defaults to "[ERROR] "
   ExceptionNotifier.email_prefix = "[APP] "
 
-Email notifications will only occur when the IP address is determined not to
-be local. You can specify certain addresses to always be local so that you'll
-get a detailed error instead of the generic error page. You do this in your
-controller (or even per-controller):
-
-  consider_local "64.72.18.143", "14.17.21.25"
-
-You can specify subnet masks as well, so that all matching addresses are
-considered local:
-
-  consider_local "64.72.18.143/24"
-
-The address "127.0.0.1" is always considered local. If you want to completely
-reset the list of all addresses (for instance, if you wanted "127.0.0.1" to
-NOT be considered local), you can simply do, somewhere in your controller:
-
-  local_addresses.clear
 
 == Customization
 
@@ -68,9 +51,7 @@ access to the following variables:
 * @controller: the controller that caused the error
 * @request: the current request object
 * @exception: the exception that was raised
-* @host: the name of the host that made the request
 * @backtrace: a sanitized version of the exception's backtrace
-* @rails_root: a sanitized version of RAILS_ROOT
 * @data: a hash of optional data values that were passed to the notifier
 * @sections: the array of sections to include in the email
 
@@ -82,13 +63,14 @@ new section requires information that isn't available by default, make sure
 it is made available to the email using the exception_data macro:
 
   class ApplicationController < ActionController::Base
+    before_filter :log_additional_data
     ...
     protected
-      exception_data :additional_data
-
-      def additional_data
-        { :document => @document,
-          :person => @person }
+      def log_additional_data
+        request.env["exception_notifier.exception_data"] = {
+          :document => @document,
+          :person => @person
+        }
       end
     ...
   end
@@ -97,15 +79,5 @@ In the above case, @document and @person would be made available to the email
 renderer, allowing your new section(s) to access and display them. See the
 existing sections defined by the plugin for examples of how to write your own.
 
-== Advanced Customization
-
-By default, the email notifier will only notify on critical errors. For
-ActiveRecord::RecordNotFound and ActionController::UnknownAction, it will
-simply render the contents of your public/404.html file. Other exceptions
-will render public/500.html and will send the email notification. If you want
-to use different rules for the notification, you will need to implement your
-own rescue_action_in_public method. You can look at the default implementation
-in ExceptionNotifiable for an example of how to go about that.
-
 
 Copyright (c) 2005 Jamis Buck, released under the MIT license

init.rb

@@ -1,66 +1,16 @@
-require 'pathname'
+require 'action_dispatch'
+require 'exception_notifier/notifier'
 
-# Copyright (c) 2005 Jamis Buck
-#
-# Permission is hereby granted, free of charge, to any person obtaining
-# a copy of this software and associated documentation files (the
-# "Software"), to deal in the Software without restriction, including
-# without limitation the rights to use, copy, modify, merge, publish,
-# distribute, sublicense, and/or sell copies of the Software, and to
-# permit persons to whom the Software is furnished to do so, subject to
-# the following conditions:
-#
-# The above copyright notice and this permission notice shall be
-# included in all copies or substantial portions of the Software.
-#
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-class ExceptionNotifier < ActionMailer::Base
-  @@sender_address = %("Exception Notifier" <[email protected]>)
-  cattr_accessor :sender_address
-
-  @@exception_recipients = []
-  cattr_accessor :exception_recipients
-
-  @@email_prefix = "[ERROR] "
-  cattr_accessor :email_prefix
-
-  @@sections = %w(request session environment backtrace)
-  cattr_accessor :sections
-
-  self.template_root = "#{File.dirname(__FILE__)}/../views"
-
-  def self.reloadable?() false end
-
-  def exception_notification(exception, controller, request, data={})
-    content_type "text/plain"
-
-    subject    "#{email_prefix}#{controller.controller_name}##{controller.action_name} (#{exception.class}) #{exception.message.inspect}"
-
-    recipients exception_recipients
-    from       sender_address
-
-    body       data.merge({ :controller => controller, :request => request,
-                  :exception => exception, :host => (request.env["HTTP_X_FORWARDED_HOST"] || request.env["HTTP_HOST"]),
-                  :backtrace => sanitize_backtrace(exception.backtrace),
-                  :rails_root => rails_root, :data => data,
-                  :sections => sections })
+class ExceptionNotifier
+  def initialize(app, options = {})
+    @app, @options = app, options
   end
 
-  private
-
-    def sanitize_backtrace(trace)
-      re = Regexp.new(/^#{Regexp.escape(rails_root)}/)
-      trace.map { |line| Pathname.new(line.gsub(re, "[RAILS_ROOT]")).cleanpath.to_s }
-    end
-
-    def rails_root
-      @rails_root ||= Pathname.new(RAILS_ROOT).cleanpath.to_s
-    end
-
+  def call(env)
+    @app.call(env)
+  rescue Exception => exception
+    (env['exception_notifier.options'] ||= {}).reverse_merge!(@options)
+    Notifier.deliver_exception_notification(env, exception)
+    raise exception
+  end
 end

lib/exception_notifiable.rb

@@ -0,0 +1,66 @@
+require 'action_mailer'
+require 'pp'
+
+class ExceptionNotifier
+  class Notifier < ActionMailer::Base
+    self.mailer_name = 'exception_notifier'
+    self.view_paths << "#{File.dirname(__FILE__)}/views"
+
+    class << self
+      def default_sender_address
+        %("Exception Notifier" <[email protected]>)
+      end
+
+      def default_exception_recipients
+        []
+      end
+
+      def default_email_prefix
+        "[ERROR] "
+      end
+
+      def default_sections
+        %w(request session environment backtrace)
+      end
+
+      def default_options
+        { :sender_address => default_sender_address,
+          :exception_recipients => default_exception_recipients,
+          :email_prefix => default_email_prefix,
+          :sections => default_sections }
+      end
+    end
+
+    def exception_notification(env, exception)
+      @env        = env
+      @exception  = exception
+      @options    = (env['exception_notifier.options'] || {}).reverse_merge(self.class.default_options)
+      @controller = env['action_controller.instance']
+      @request    = ActionDispatch::Request.new(env)
+      @backtrace  = clean_backtrace(exception)
+      @sections   = @options[:sections]
+      data        = env['exception_notifier.exception_data'] || {}
+
+      data.each do |name, value|
+        instance_variable_set("@#{name}", value)
+      end
+
+      content_type "text/plain"
+
+      prefix   = "#{@options[:email_prefix]}#{@controller.controller_name}##{@controller.action_name}"
+      subject    "#{prefix} (#{@exception.class}) #{@exception.message.inspect}"
+
+      recipients @options[:exception_recipients]
+      from       @options[:sender_address]
+
+      render "#{mailer_name}/exception_notification"
+    end
+
+    private
+      def clean_backtrace(exception)
+        Rails.respond_to?(:backtrace_cleaner) ?
+          Rails.backtrace_cleaner.send(:filter, exception.backtrace) :
+          exception.backtrace
+      end
+  end
+end

lib/exception_notifier.rb

@@ -0,0 +1,8 @@
+<% filtered_env = @request.filtered_env -%>
+<% max = filtered_env.keys.max { |a, b| a.length <=> b.length } -%>
+<% filtered_env.keys.sort.each do |key| -%>
+* <%= "%-*s: %s" % [max.length, key, filtered_env[key].to_s.strip] %>
+<% end -%>
+
+* Process: <%= $$ %>
+* Server : <%= `hostname -s`.chomp %>

lib/exception_notifier/notifier.rb

@@ -0,0 +1,4 @@
+* URL       : <%= @request.url %>
+* IP address: <%= @request.remote_ip %>
+* Parameters: <%= @request.fitered_params.inspect %>
+* Rails root: <%= Rails.root %>

views/exception_notifier/_backtrace.rhtml renamed to lib/exception_notifier/views/exception_notifier/_backtrace.html.erb

@@ -0,0 +1,2 @@
+* session id: <%= @request.session['session_id'].inspect %>
+* data: <%= PP.pp @request.session.inspect.gsub(/\n/, "\n  ").strip %>

lib/exception_notifier/views/exception_notifier/_environment.html.erb

@@ -0,0 +1,12 @@
+A <%= @exception.class %> occurred in <%= @controller.controller_name %>#<%= @controller.action_name %>:
+
+  <%= @exception.message %>
+  <%= @backtrace.first %>
+
+<%= @sections.map { |section|
+  summary = render(section).strip
+  unless summary.blank?
+    title = render("title", :locals => { :title => section }).strip
+    "#{title}\n\n#{summary.gsub(/^/, "  ")}\n\n"
+  end
+}.join %>