exception_notification 3.0.1 → 4.4.0

data/lib/exception_notifier/teams_notifier.rb

@@ -0,0 +1,193 @@
+require 'action_dispatch'
+require 'active_support/core_ext/time'
+require 'json'
+
+module ExceptionNotifier
+  class TeamsNotifier < BaseNotifier
+    include ExceptionNotifier::BacktraceCleaner
+
+    class MissingController
+      def method_missing(*args, &block); end
+    end
+
+    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_app_name
+      @gitlab_url = @options.delete(:git_url)
+      @jira_url = @options.delete(:jira_url)
+
+      @webhook_url = @options.delete(:webhook_url)
+      raise ArgumentError, "You must provide 'webhook_url' parameter." unless @webhook_url
+
+      if @env.nil?
+        @controller = @request_items = nil
+      else
+        @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[:current_user] = { id: current_user.id, email: current_user.email }
+        end
+      end
+
+      payload = message_text
+
+      @options[:body] = payload.to_json
+      @options[:headers] ||= {}
+      @options[:headers]['Content-Type'] = 'application/json'
+      @options[:debug_output] = $stdout
+
+      @httparty.post(@webhook_url, @options)
+    end
+
+    private
+
+    def message_text
+      errors_count = @options[:accumulated_errors_count].to_i
+
+      text = {
+        '@type' => 'MessageCard',
+        '@context' => 'http://schema.org/extensions',
+        'summary' => "#{@application_name} Exception Alert",
+        'title' => "⚠️ Exception Occurred in #{env_name} ⚠️",
+        'sections' => [
+          {
+            'activityTitle' => "#{errors_count > 1 ? errors_count : 'A'} *#{@exception.class}* occurred" + (@controller ? " in *#{controller_and_method}*." : '.'),
+            'activitySubtitle' => @exception.message.to_s
+          }
+        ],
+        'potentialAction' => []
+      }
+
+      text['sections'].push details
+      text['potentialAction'].push gitlab_view_link unless @gitlab_url.nil?
+      text['potentialAction'].push gitlab_issue_link unless @gitlab_url.nil?
+      text['potentialAction'].push jira_issue_link unless @jira_url.nil?
+
+      text
+    end
+
+    def details
+      details = {
+        'title' => 'Details',
+        'facts' => []
+      }
+
+      details['facts'].push message_request unless @request_items.nil?
+      details['facts'].push message_backtrace unless @backtrace.nil?
+
+      details
+    end
+
+    def message_request
+      {
+        'name' => 'Request',
+        'value' => "#{hash_presentation(@request_items)}\n  "
+      }
+    end
+
+    def message_backtrace(size = 3)
+      text = []
+      size = @backtrace.size < size ? @backtrace.size : size
+      text << '```'
+      size.times { |i| text << '* ' + @backtrace[i] }
+      text << '```'
+
+      {
+        'name' => 'Backtrace',
+        'value' => text.join("  \n").to_s
+      }
+    end
+
+    def gitlab_view_link
+      {
+        '@type' => 'ViewAction',
+        'name' => "\u{1F98A} View in GitLab",
+        'target' => [
+          "#{@gitlab_url}/#{@application_name}"
+        ]
+      }
+    end
+
+    def gitlab_issue_link
+      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
+
+      {
+        '@type' => 'ViewAction',
+        'name' => "\u{1F98A} Create Issue in GitLab",
+        'target' => [
+          "#{link}/?#{params}"
+        ]
+      }
+    end
+
+    def jira_issue_link
+      {
+        '@type' => 'ViewAction',
+        'name' => '🐞 Create Issue in Jira',
+        'target' => [
+          "#{@jira_url}/secure/CreateIssue!default.jspa"
+        ]
+      }
+    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
+
+    def rails_app_name
+      return unless defined?(Rails) && Rails.respond_to?(:application)
+
+      if ::Gem::Version.new(Rails.version) >= ::Gem::Version.new('6.0')
+        Rails.application.class.module_parent_name.underscore
+      else
+        Rails.application.class.parent_name.underscore
+      end
+    end
+
+    def env_name
+      Rails.env if defined?(Rails) && Rails.respond_to?(:env)
+    end
+  end
+end

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

@@ -1 +1,3 @@
-<%= raw @backtrace.join("\n") %>
+<pre style="font-size: 12px; padding: 10px; border: 1px solid #e1e1e8; background-color:#f5f5f5">
+  <%= @backtrace.join("\n") %>
+</pre>

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

@@ -1 +1,6 @@
-* data: <%= raw PP.pp(@data, "") %>
+<ul style="list-style: none">
+  <li>
+    <strong>data:</strong>
+    <span><%= PP.pp(@data, "") %></span>
+  </li>
+</ul>

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

@@ -1,8 +1,10 @@
 <% filtered_env = @request.filtered_env -%>
-<% max = filtered_env.keys.map(&:to_s).max { |a, b| a.length <=> b.length } -%>
-<% filtered_env.keys.map(&:to_s).sort.each do |key| -%>
-* <%= raw("%-*s: %s" % [max.length, key, inspect_object(filtered_env[key])]) %>
-<% end -%>
 
-* Process: <%= raw $$ %>
-* Server : <%= raw `hostname`.chomp %>
+<ul style="list-style: none">
+  <% filtered_env.keys.map(&:to_s).sort.each do |key| -%>
+    <li>
+      <strong><%= key %>:</strong>
+      <span><%= inspect_object(filtered_env[key]) %></span>
+    </li>
+  <% end -%>
+</ul>

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

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

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

@@ -1,5 +1,36 @@
-* URL       : <%= raw @request.url %>
-* IP address: <%= raw @request.remote_ip %>
-* Parameters: <%= raw @request.filtered_parameters.inspect %>
-* Rails root: <%= raw Rails.root %>
-* Timestamp : <%= raw Time.current %>
+<ul style="list-style: none">
+  <li>
+    <strong>URL:</strong>
+    <span><%= @request.url %></span>
+  </li>
+  <li>
+    <strong>HTTP Method:</strong>
+    <span><%= @request.request_method %></span>
+  </li>
+  <li>
+    <strong>IP Address:</strong>
+    <span><%= @request.remote_ip %></span>
+  </li>
+  <li>
+    <strong>Parameters:</strong>
+    <span><%= @request.filtered_parameters.inspect %></span>
+  </li>
+  <li>
+    <strong>Timestamp:</strong>
+    <span><%= @timestamp %></span>
+  </li>
+  <li>
+    <strong>Server:</strong>
+    <span><%= Socket.gethostname %></span>
+  </li>
+  <% if defined?(Rails) && Rails.respond_to?(:root) %>
+    <li>
+      <strong>Rails root:</strong>
+      <span><%= Rails.root %></span>
+    </li>
+  <% end %>
+  <li>
+    <strong>Process:</strong>
+    <span><%= $$ %></span>
+  </li>
+</ul>

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

@@ -1,5 +1,10 @@
-* URL       : <%= raw @request.url %>
-* IP address: <%= raw @request.remote_ip %>
-* Parameters: <%= raw @request.filtered_parameters.inspect %>
-* Rails root: <%= raw Rails.root %>
-* Timestamp : <%= raw Time.current %>
+* URL        : <%= raw safe_encode @request.url %>
+* HTTP Method: <%= raw @request.request_method %>
+* IP address : <%= raw @request.remote_ip %>
+* Parameters : <%= raw safe_encode @request.filtered_parameters.inspect %>
+* Timestamp  : <%= raw @timestamp %>
+* Server : <%= raw Socket.gethostname %>
+<% if defined?(Rails) && Rails.respond_to?(:root) %>
+  * Rails root : <%= raw Rails.root %>
+<% end %>
+* Process: <%= raw $$ %>

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

@@ -1,2 +1,10 @@
-* session id: <%= @request.ssl? ? "[FILTERED]" : (raw (@request.session['session_id'] || @request.env["rack.session.options"][:id]).inspect.html_safe) %>
-* data: <%= raw PP.pp(@request.session, "") %>
+<ul style="list-style: none">
+  <li>
+    <strong>session_id: </strong>
+    <span><%= @request.ssl? ? "[FILTERED]" : (@request.session['session_id'] || (@request.env["rack.session.options"] and @request.env["rack.session.options"][:id]).inspect) %></span>
+  </li>
+  <li>
+    <strong>data: </strong>
+    <span><%= PP.pp(@request.session.to_hash, "") %></span>
+  </li>
+</ul>

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

@@ -1,2 +1,2 @@
-* session id: <%= @request.ssl? ? "[FILTERED]" : (raw (@request.session['session_id'] || @request.env["rack.session.options"][:id]).inspect.html_safe) %>
-* data: <%= raw PP.pp(@request.session, "") %>
+* session id: <%= @request.ssl? ? "[FILTERED]" : (raw (@request.session['session_id'] || (@request.env["rack.session.options"] and @request.env["rack.session.options"][:id])).inspect.html_safe) %>
+* data: <%= raw PP.pp(@request.session.to_hash, "") %>

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

@@ -1,3 +1,3 @@
--------------------------------
-<%= raw title.to_s.humanize %>:
--------------------------------
+<h2>
+  <%= title.to_s.humanize %>
+</h2>

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

@@ -5,22 +5,49 @@
     <title>Exception</title>
   </head>
   <body>
-    <pre style="font-size: 12px">
-<%= @exception.class.to_s =~ /^[aeiou]/i ? 'An' : 'A' %> <%= @exception.class %> occurred in background at <%= raw Time.current %> :
 
-<%= @exception.message %>
-<%= @backtrace.first %>
-<% 
-    sections = @sections.map do |section|
+<%
+  sections_content = @sections.map do |section|
+    begin
       summary = render(section).strip
       unless summary.blank?
         title = render("title", :title => section).strip
-        "#{title}\n\n#{summary.gsub(/^/, "  ")}\n\n"
+        [title, summary]
       end
-    end.join
-    sections = sections.force_encoding('UTF-8').encode('UTF-16LE', :invalid => :replace).encode('UTF-8') if sections.respond_to?(:force_encoding)
+
+    rescue Exception => e
+      title = render("title", :title => section).strip
+      summary = ["ERROR: Failed to generate exception summary:", [e.class.to_s, e.message].join(": "), e.backtrace && e.backtrace.join("\n")].compact.join("\n\n")
+
+      [title, summary]
+    end
+  end
 %>
-<%= raw sections %>
-    </pre>
+
+<table width="100%" border="0" cellpadding="0" cellspacing="0">
+  <tr><td align="center" valign="top">
+    <table width="650" border="0" cellpadding="0" cellspacing="20">
+      <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 <%= @timestamp %> :
+          </h3>
+          <p style="color: #b94a48"><%= @exception.message %></p>
+          <pre style="font-size: 12px; padding: 5px; background-color:#f5f5f5">
+<%= @backtrace.first %>
+          </pre>
+        </td>
+      </tr>
+      <% sections_content.each do |title, summary| %>
+        <tr>
+          <td style="border-bottom: 1px solid #eeeeee;"><%= raw title %></td>
+        </tr>
+        <tr>
+          <td><%= raw summary %></td>
+        </tr>
+      <% end %>
+    </table>
+  </td></tr>
+</table>
   </body>
 </html>

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

@@ -1,15 +1,14 @@
-<%= @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 %>
 
-  <%  sections = @sections.map do |section|
-        summary = render(section).strip
-        unless summary.blank?
-          title = render("title", :title => section).strip
-          "#{title}\n\n#{summary.gsub(/^/, "  ")}\n\n"
-        end
-      end.join
-      sections = sections.force_encoding('UTF-8').encode('UTF-16LE', :invalid => :replace).encode('UTF-8') if sections.respond_to?(:force_encoding)
-  %>
-  <%= raw sections %>
+<%  sections = @sections.map do |section|
+      summary = render(section).strip
+      unless summary.blank?
+        title = render("title", :title => section).strip
+        "#{title}\n\n#{summary.gsub(/^/, "  ")}\n\n"
+      end
+    end.join
+%>
+<%= raw sections %>

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

@@ -5,32 +5,48 @@
     <title>Exception</title>
   </head>
   <body>
-    <pre style="font-size: 12px">
-<%= @exception.class.to_s =~ /^[aeiou]/i ? 'An' : 'A' %> <%= @exception.class %> occurred in <%= @kontroller.controller_name %>#<%= @kontroller.action_name %>:
-
-<%= raw @exception.message %>
-<%= raw @backtrace.first %>
 
 <%
-    sections = @sections.map do |section|
-      begin
-        summary = render(section).strip
-        unless summary.blank?
-          title = render("title", :title => section).strip
-          "#{title}\n\n#{summary.gsub(/^/, "  ")}\n\n"
-        end
-
-      rescue Exception => e
-        title = render("title", :title => section).strip
-        summary = ["ERROR: Failed to generate exception summary:", [e.class.to_s, e.message].join(": "), e.backtrace && e.backtrace.join("\n")].compact.join("\n\n")
-
-        [title, summary.gsub(/^/, "  "), nil].join("\n\n")
+  sections_content = @sections.map do |section|
+    begin
+      summary = render(section).strip
+      unless summary.blank?
+        title = render("title", title: section).strip
+        [title, summary]
       end
-    end.join
-    sections = sections.force_encoding('UTF-8').encode('UTF-16LE', :invalid => :replace).encode('UTF-8') if sections.respond_to?(:force_encoding)
+    rescue Exception => e
+      title = render("title", title: section).strip
+      summary = ["ERROR: Failed to generate exception summary:", [e.class.to_s, e.message].join(": "), e.backtrace && e.backtrace.join("\n")].compact.join("\n\n")
+      [title, summary]
+    end
+  end
 %>
 
-<%= raw sections %>
-  </pre>
+<table width="100%" border="0" cellpadding="0" cellspacing="0">
+  <tr><td align="center" valign="top">
+    <table width="650" border="0" cellpadding="0" cellspacing="20">
+      <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 <%= @kontroller.controller_name %>#<%= @kontroller.action_name %>:
+          </h3>
+          <p style="color: #b94a48"><%= @exception.message %></p>
+          <pre style="font-size: 12px; padding: 5px; background-color:#f5f5f5">
+<%= @backtrace.first %>
+          </pre>
+        </td>
+      </tr>
+      <% sections_content.each do |title, summary| %>
+        <tr>
+          <td style="border-bottom: 1px solid #eeeeee;"><%= raw title %></td>
+        </tr>
+        <tr>
+          <td><%= raw summary %></td>
+        </tr>
+      <% end %>
+    </table>
+  </td></tr>
+</table>
+
   </body>
 </html>