exception_notification 4.1.4 → 4.2.0.rc1

data/lib/exception_notifier/email_notifier.rb

@@ -1,4 +1,5 @@
 require "active_support/core_ext/hash/reverse_merge"
+require 'active_support/core_ext/time'
 require 'action_mailer'
 require 'action_dispatch'
 require 'pp'
@@ -33,6 +34,7 @@ module ExceptionNotifier
             @kontroller = env['action_controller.instance'] || MissingController.new
             @request    = ActionDispatch::Request.new(env)
             @backtrace  = exception.backtrace ? clean_backtrace(exception) : []
+            @timestamp  = Time.current
             @sections   = @options[:sections]
             @data       = (env['exception_notifier.exception_data'] || {}).merge(options[:data] || {})
             @sections   = @sections + %w(data) unless @data.empty?
@@ -46,8 +48,10 @@ module ExceptionNotifier
             @exception = exception
             @options   = options.reverse_merge(default_options)
             @backtrace = exception.backtrace || []
+            @timestamp = Time.current
             @sections  = @options[:background_sections]
             @data      = options[:data] || {}
+            @env = @kontroller = nil
 
             compose_email
           end
@@ -94,10 +98,11 @@ module ExceptionNotifier
             set_data_variables
             subject = compose_subject
             name = @env.nil? ? 'background_exception_notification' : 'exception_notification'
+            exception_recipients = maybe_call(@options[:exception_recipients])
 
             headers = {
               :delivery_method => @options[:delivery_method],
-              :to => @options[:exception_recipients],
+              :to => exception_recipients,
               :from => @options[:sender_address],
               :subject => subject,
               :template_name => name
@@ -118,6 +123,10 @@ module ExceptionNotifier
               self.prepend_view_path Rails.root.nil? ? "app/views" : "#{Rails.root}/app/views"
             end
           end
+
+          def maybe_call(maybe_proc)
+            maybe_proc.respond_to?(:call) ? maybe_proc.call : maybe_proc
+          end
         end
       end
     end
@@ -150,7 +159,18 @@ module ExceptionNotifier
     end
 
     def call(exception, options={})
-      create_email(exception, options).send(deliver_with)
+      message = create_email(exception, options)
+
+      # FIXME: use `if Gem::Version.new(ActionMailer::VERSION::STRING) < Gem::Version.new('4.1')`
+      if deliver_with == :default
+        if message.respond_to?(:deliver_now)
+          message.deliver_now
+        else
+          message.deliver
+        end
+      else
+        message.send(deliver_with)
+      end
     end
 
     def create_email(exception, options={})
@@ -182,7 +202,7 @@ module ExceptionNotifier
         :email_headers => {},
         :mailer_parent => 'ActionMailer::Base',
         :template_path => 'exception_notifier',
-        :deliver_with => :deliver_now
+        :deliver_with => :default
       }
     end
 

data/lib/exception_notifier/mattermost_notifier.rb

@@ -0,0 +1,159 @@
+require 'action_dispatch'
+require 'active_support/core_ext/time'
+
+module ExceptionNotifier
+  class MattermostNotifier
+    include ExceptionNotifier::BacktraceCleaner
+
+    attr_accessor :httparty
+
+    def initialize(options = {})
+      super()
+      @default_options = options
+      @httparty = HTTParty
+    end
+
+    def call(exception, options = {})
+      @options = options.merge(@default_options)
+      @exception = exception
+      @backtrace = exception.backtrace ? clean_backtrace(exception) : nil
+
+      @env = @options.delete(:env)
+
+      @application_name = @options.delete(:app_name) || Rails.application.class.parent_name.underscore
+      @gitlab_url = @options.delete(:git_url)
+      @username = @options.delete(:username) || "Exception Notifier"
+      @avatar = @options.delete(:avatar)
+
+      @channel = @options.delete(:channel)
+      @webhook_url = @options.delete(:webhook_url)
+      raise ArgumentError.new "You must provide 'webhook_url' parameter." unless @webhook_url
+
+      unless @env.nil?
+        @controller = @env['action_controller.instance'] || MissingController.new
+
+        request = ActionDispatch::Request.new(@env)
+
+        @request_items = { url: request.original_url,
+                           http_method: request.method,
+                           ip_address: request.remote_ip,
+                           parameters: request.filtered_parameters,
+                           timestamp: Time.current }
+
+        if request.session["warden.user.user.key"]
+          current_user = User.find(request.session["warden.user.user.key"][0][0])
+          @request_items.merge!({ current_user: { id: current_user.id, email: current_user.email  } })
+        end
+      else
+        @controller = @request_items = nil
+      end
+
+      payload = message_text.merge(user_info).merge(channel_info)
+
+      @options[:body] = payload.to_json
+      @options[:headers] ||= {}
+      @options[:headers].merge!({ 'Content-Type' => 'application/json' })
+
+      @httparty.post(@webhook_url, @options)
+    end
+
+    private
+
+      def channel_info
+        if @channel
+          { channel: @channel }
+        else
+          {}
+        end
+      end
+
+      def user_info
+        infos = {}
+
+        infos.merge!({ username: @username }) if @username
+        infos.merge!({ icon_url: @avatar }) if @avatar
+
+        infos
+      end
+
+      def message_text
+        text = []
+
+        text += ["@channel"]
+        text += message_header
+        text += message_request if @request_items
+        text += message_backtrace if @backtrace
+        text += message_issue_link if @gitlab_url
+
+        { text: text.join("\n") }
+      end
+
+      def message_header
+        text = []
+
+        text << "### :warning: Error 500 in #{Rails.env} :warning:"
+        text << "An *#{@exception.class}* occured" + if @controller then " in *#{controller_and_method}*." else "." end
+        text << "*#{@exception.message}*"
+
+        text
+      end
+
+      def message_request
+        text = []
+
+        text << "### Request"
+        text << "```"
+        text << hash_presentation(@request_items)
+        text << "```"
+
+        text
+      end
+
+      def message_backtrace(size = 3)
+        text = []
+
+        size = @backtrace.size < size ? @backtrace.size : size
+        text << "### Backtrace"
+        text << "```"
+        size.times { |i| text << "* " + @backtrace[i] }
+        text << "```"
+
+        text
+      end
+
+      def message_issue_link
+        text = []
+
+        link = [@gitlab_url, @application_name, "issues", "new"].join("/")
+        params = {
+          "issue[title]" => ["[BUG] Error 500 :",
+                                       controller_and_method,
+                                       "(#{@exception.class})",
+                                       @exception.message].compact.join(" ")
+        }.to_query
+
+        text << "[Create an issue](#{link}/?#{params})"
+
+        text
+      end
+
+      def controller_and_method
+        if @controller
+          "#{@controller.controller_name}##{@controller.action_name}"
+        else
+          ""
+        end
+      end
+
+      def hash_presentation(hash)
+        text = []
+
+        hash.each do |key, value|
+          text << "* #{key} : #{value}"
+        end
+
+        text.join("\n")
+      end
+
+  end
+end

data/lib/exception_notifier/slack_notifier.rb

@@ -26,8 +26,10 @@ module ExceptionNotifier
       clean_message = exception.message.gsub("`", "'")
       fields = [ { title: 'Exception', value: clean_message} ]
 
+      fields.push({ title: 'Hostname', value: Socket.gethostname })
+
       if exception.backtrace
-        formatted_backtrace = "```#{exception.backtrace.first(5).join("\n")}```"
+        formatted_backtrace = "```#{exception.backtrace.join("\n")}```"
         fields.push({ title: 'Backtrace', value: formatted_backtrace })
       end
 
@@ -40,7 +42,7 @@ module ExceptionNotifier
       attchs = [color: 'danger', text: text, fields: fields, mrkdwn_in: %w(text fields)]
 
       if valid?
-        send_notice(exception, options, clean_message, @message_opts.merge(attachments: attchs)) do |msg, message_opts| 
+        send_notice(exception, options, clean_message, @message_opts.merge(attachments: attchs)) do |msg, message_opts|
           @notifier.ping '', message_opts
         end
       end

data/lib/exception_notifier/views/exception_notifier/_request.html.erb

@@ -17,7 +17,7 @@
   </li>
   <li>
     <strong>Timestamp:</strong>
-    <span><%= Time.current %></span>
+    <span><%= @timestamp %></span>
   </li>
   <li>
     <strong>Server:</strong>

data/lib/exception_notifier/views/exception_notifier/_request.text.erb

@@ -2,7 +2,7 @@
 * HTTP Method: <%= raw @request.request_method %>
 * IP address : <%= raw @request.remote_ip %>
 * Parameters : <%= raw safe_encode @request.filtered_parameters.inspect %>
-* Timestamp  : <%= raw Time.current %>
+* Timestamp  : <%= raw @timestamp %>
 * Server : <%= raw Socket.gethostname %>
 <% if defined?(Rails) && Rails.respond_to?(:root) %>
 * Rails root : <%= raw Rails.root %>

data/lib/exception_notifier/views/exception_notifier/background_exception_notification.html.erb

@@ -30,7 +30,7 @@
       <tr>
         <td style="padding: 10px; border: 1px solid #eed3d7; background-color: #f2dede">
           <h3 style="color: #b94a48">
-            <%= @exception.class.to_s =~ /^[aeiou]/i ? 'An' : 'A' %> <%= @exception.class %> occurred in background at <%= Time.current %> :
+            <%= @exception.class.to_s =~ /^[aeiou]/i ? 'An' : 'A' %> <%= @exception.class %> occurred in background at <%= @timestamp %> :
           </h3>
           <p style="color: #b94a48"><%= @exception.message %></p>
           <pre style="font-size: 12px; padding: 5px; background-color:#f5f5f5">

data/lib/exception_notifier/views/exception_notifier/background_exception_notification.text.erb

@@ -1,4 +1,4 @@
-<%= @exception.class.to_s =~ /^[aeiou]/i ? 'An' : 'A' %> <%= @exception.class %> occurred in background at <%= raw Time.current %> :
+<%= @exception.class.to_s =~ /^[aeiou]/i ? 'An' : 'A' %> <%= @exception.class %> occurred in background at <%= raw @timestamp %> :
 
   <%= @exception.message %>
   <%= @backtrace.first %>

data/lib/exception_notifier/webhook_notifier.rb

@@ -1,4 +1,5 @@
 require 'action_dispatch'
+require 'active_support/core_ext/time'
 
 module ExceptionNotifier
   class WebhookNotifier < BaseNotifier

data/test/dummy/test/functional/posts_controller_test.rb

@@ -5,8 +5,7 @@ class PostsControllerTest < ActionController::TestCase
     Time.stubs(:current).returns('Sat, 20 Apr 2013 20:58:55 UTC +00:00')
     @email_notifier = ExceptionNotifier.registered_exception_notifier(:email)
     begin
-      @post = posts(:one)
-      post :create, :post => @post.attributes
+      post :create, method: :post, params: { secret: "secret" }
     rescue => e
       @exception = e
       @mail = @email_notifier.create_email(@exception, {:env => request.env, :data => {:message => 'My Custom Message'}})
@@ -71,23 +70,22 @@ class PostsControllerTest < ActionController::TestCase
 
   test "should not send notification if one of ignored exceptions" do
     begin
-      get :show, :id => @post.to_param + "10"
+      get :invalid
     rescue => e
       @ignored_exception = e
       unless ExceptionNotifier.ignored_exceptions.include?(@ignored_exception.class.name)
-        @ignored_mail = @email_notifier.create_email(@ignored_exception, {:env => request.env})
+        ignored_mail = @email_notifier.create_email(@ignored_exception, {:env => request.env})
       end
     end
 
-    assert_equal @ignored_exception.class.inspect, "ActiveRecord::RecordNotFound"
-    assert_nil @ignored_mail
+    assert_equal @ignored_exception.class.inspect, "ActionController::UrlGenerationError"
+    assert_nil ignored_mail
   end
 
   test "should filter session_id on secure requests" do
     request.env['HTTPS'] = 'on'
     begin
-      @post = posts(:one)
-      post :create, :post => @post.attributes
+      post :create, method: :post
     rescue => e
       @secured_mail = @email_notifier.create_email(e, {:env => request.env})
     end
@@ -99,8 +97,7 @@ class PostsControllerTest < ActionController::TestCase
   test "should ignore exception if from unwanted crawler" do
     request.env['HTTP_USER_AGENT'] = "Mozilla/5.0 (compatible; Googlebot/2.1; +http://www.google.com/bot.html)"
     begin
-      @post = posts(:one)
-      post :create, :post => @post.attributes
+      post :create, method: :post
     rescue => e
       @exception = e
       custom_env = request.env
@@ -108,17 +105,16 @@ class PostsControllerTest < ActionController::TestCase
       custom_env['exception_notifier.options'].merge!(:ignore_crawlers => %w(Googlebot))
       ignore_array = custom_env['exception_notifier.options'][:ignore_crawlers]
       unless ExceptionNotification::Rack.new(Dummy::Application, custom_env['exception_notifier.options']).send(:from_crawler, custom_env, ignore_array)
-        @ignored_mail = @email_notifier.create_email(@exception, {:env => custom_env})
+        ignored_mail = @email_notifier.create_email(@exception, {:env => custom_env})
       end
     end
 
-    assert_nil @ignored_mail
+    assert_nil ignored_mail
   end
 
   test "should send html email when selected html format" do
     begin
-      @post = posts(:one)
-      post :create, :post => @post.attributes
+      post :create, method: :post
     rescue => e
       @exception = e
       custom_env = request.env
@@ -136,8 +132,7 @@ class PostsControllerTestWithoutVerboseSubject < ActionController::TestCase
   setup do
     @email_notifier = ExceptionNotifier::EmailNotifier.new(:verbose_subject => false)
     begin
-      @post = posts(:one)
-      post :create, :post => @post.attributes
+      post :create, method: :post
     rescue => e
       @exception = e
       @mail = @email_notifier.create_email(@exception, {:env => request.env})
@@ -145,7 +140,9 @@ class PostsControllerTestWithoutVerboseSubject < ActionController::TestCase
   end
 
   test "should not include exception message in subject" do
-    assert_equal "[ERROR] # (NoMethodError)", @mail.subject
+    assert_includes @mail.subject, '[ERROR]'
+    assert_includes @mail.subject, '(NoMethodError)'
+    refute_includes @mail.subject, 'undefined method'
   end
 end
 
@@ -158,8 +155,7 @@ class PostsControllerTestWithSmtpSettings < ActionController::TestCase
     })
 
     begin
-      @post = posts(:one)
-      post :create, :post => @post.attributes
+      post :create, method: :post
     rescue => e
       @exception = e
       @mail = @email_notifier.create_email(@exception, {:env => request.env})
@@ -178,47 +174,45 @@ class PostsControllerTestWithSmtpSettings < ActionController::TestCase
   end
 end
 
-class PostsControllerTestBadRequestData < ActionController::TestCase
+class PostsControllerTestBackgroundNotification < ActionController::TestCase
   tests PostsController
   setup do
     @email_notifier = ExceptionNotifier.registered_exception_notifier(:email)
     begin
-      # This might seem synthetic, but the point is that the data used by
-      # ExceptionNotification could be rendered "invalid" by e.g. a badly
-      # behaving middleware, and we want to test that ExceptionNotification
-      # still manages to send off an email in those cases.
-      #
-      # The trick here is to trigger an exception in the template used by
-      # ExceptionNotification. (The original test stuffed request.env with
-      # badly encoded strings, but that only works in Ruby 1.9+.)
-      request.send :instance_variable_set, :@env, {}
-
-      @post = posts(:one)
-      post :create, :post => @post.attributes
-    rescue => e
-      @exception = e
-      @mail = @email_notifier.create_email(@exception, {:env => request.env})
+      post :create, method: :post
+    rescue => exception
+      @mail = @email_notifier.create_email(exception)
     end
   end
 
-  test "should include error message in body" do
-    assert_match /ERROR: Failed to generate exception summary/, @mail.encoded.to_s
+  test "mail should contain the specified section" do
+    assert_includes @mail.encoded, "* New background section for testing"
   end
 end
 
-class PostsControllerTestBackgroundNotification < ActionController::TestCase
+class PostsControllerTestWithExceptionRecipientsAsProc < ActionController::TestCase
   tests PostsController
   setup do
-    @email_notifier = ExceptionNotifier.registered_exception_notifier(:email)
-    begin
-      @post = posts(:one)
-      post :create, :post => @post.attributes
-    rescue => exception
-      @mail = @email_notifier.create_email(exception)
+    exception_recipients = %w{first@example.com second@example.com}
+
+    @email_notifier = ExceptionNotifier::EmailNotifier.new(
+      exception_recipients: -> { [ exception_recipients.shift ] }
+    )
+
+    @action = proc do
+      begin
+        post :create, method: :post
+      rescue => e
+        @exception = e
+        @mail = @email_notifier.create_email(@exception, {:env => request.env})
+      end
     end
   end
 
-  test "mail should contain the specified section" do
-    assert_includes @mail.encoded, "* New background section for testing"
+  test "should lazily evaluate exception_recipients" do
+    @action.call
+    assert_equal [ "first@example.com" ], @mail.to
+    @action.call
+    assert_equal [ "second@example.com" ], @mail.to
   end
 end