exception_handling 2.17.0.pre.tstarck.1 → 3.0.0.pre.2

data/lib/exception_handling/mailer.rb

@@ -1,70 +0,0 @@
-# frozen_string_literal: true
-
-require 'action_mailer'
-
-module ExceptionHandling
-  class Mailer < ActionMailer::Base
-    default content_type: "text/html"
-
-    append_view_path "#{File.dirname(__FILE__)}/../../views"
-
-    [:email_environment, :server_name, :sender_address, :exception_recipients, :escalation_recipients].each do |method|
-      define_method method do
-        ExceptionHandling.send(method) or raise "No #{method} set!"
-      end
-    end
-
-    def email_prefix
-      "#{email_environment} exception: "
-    end
-
-    class << self
-      def reloadable?
-        false
-      end
-
-      def mailer_method_category
-        {
-          log_parser_exception_notification: :NetworkOptout
-        }
-      end
-    end
-
-    def escalation_notification(summary, data, custom_recipients = nil)
-      subject       = "#{email_environment} Escalation: #{summary}"
-      from          = sender_address.gsub('xception', 'scalation')
-      recipients    = begin
-                        custom_recipients || escalation_recipients
-                      rescue
-                        exception_recipients
-                      end
-
-      @summary      = summary
-      @server       = ExceptionHandling.server_name
-      @cleaned_data = data
-
-      mail(from: from,
-           to: recipients,
-           subject: subject)
-    end
-
-    def log_parser_exception_notification(cleaned_data, key)
-      if cleaned_data.is_a?(Hash)
-        cleaned_data = cleaned_data.symbolize_keys
-        local_subject = cleaned_data[:error]
-      else
-        local_subject = "#{key}: #{cleaned_data}"
-        cleaned_data  = { error: cleaned_data.to_s }
-      end
-
-      @subject       = "#{email_prefix}#{local_subject}"[0, 300]
-      @recipients    = exception_recipients
-      from           = sender_address
-      @cleaned_data  = cleaned_data
-
-      mail(from: from,
-           to: @recipients,
-           subject: @subject)
-    end
-  end
-end

data/lib/exception_handling/methods.rb

@@ -1,54 +0,0 @@
-# frozen_string_literal: true
-
-require 'active_support/concern'
-require_relative 'logging_methods'
-
-module ExceptionHandling
-  module Methods # included on models and controllers
-    extend ActiveSupport::Concern
-    include ExceptionHandling::LoggingMethods
-
-    protected
-
-    def long_controller_action_timeout
-      if defined?(Rails) && Rails.respond_to?(:env) && Rails.env == 'test'
-        300
-      else
-        30
-      end
-    end
-
-    def set_current_controller
-      ExceptionHandling.current_controller = self
-      result = nil
-      time = Benchmark.measure do
-        result = yield
-      end
-      if time.real > long_controller_action_timeout && !['development', 'test'].include?(ExceptionHandling.email_environment)
-        name = begin
-                 " in #{controller_name}::#{action_name}"
-               rescue
-                 " "
-               end
-        log_error("Long controller action detected#{name} %.4fs  " % time.real)
-      end
-      result
-    ensure
-      ExceptionHandling.current_controller = nil
-    end
-
-    included do
-      Deprecation3_0.deprecation_warning('ExceptionHandling::Methods', 'include LoggingMethods; in controllers, set your own around_filter to set logging context')
-      if respond_to? :around_filter
-        around_filter :set_current_controller
-      end
-    end
-
-    class_methods do
-      def set_long_controller_action_timeout(timeout)
-        define_method(:long_controller_action_timeout) { timeout }
-        protected :long_controller_action_timeout
-      end
-    end
-  end
-end

data/lib/exception_handling/sensu.rb

@@ -1,28 +0,0 @@
-# frozen_string_literal: true
-
-require "socket"
-
-module ExceptionHandling
-  module Sensu
-    LEVELS = {
-      warning: 1,
-      critical: 2
-    }.freeze
-
-    class << self
-      def generate_event(name, message, level = :warning)
-        status = LEVELS[level] or raise "Invalid alert level #{level}"
-
-        event = { name: ExceptionHandling.sensu_prefix.to_s + name, output: message, status: status }
-
-        send_event(event)
-      end
-
-      def send_event(event)
-        Socket.tcp(ExceptionHandling.sensu_host, ExceptionHandling.sensu_port) do |sock|
-          sock.send(event.to_json, 0)
-        end
-      end
-    end
-  end
-end

data/spec/unit/exception_handling/mailer_spec.rb

@@ -1,97 +0,0 @@
-# frozen_string_literal: true
-
-require File.expand_path('../../spec_helper',  __dir__)
-require 'rails-dom-testing'
-
-module ExceptionHandling
-  describe Mailer do
-
-    include ::Rails::Dom::Testing::Assertions::SelectorAssertions
-
-    def dont_stub_log_error
-      true
-    end
-
-    context "ExceptionHandling::Mailer" do
-      before do
-        ExceptionHandling.email_environment = 'Test'
-        ExceptionHandling.sender_address = %("Test Exception Mailer" <null_exception@invoca.com>)
-        ExceptionHandling.exception_recipients = ['test_exception@invoca.com']
-        ExceptionHandling.escalation_recipients = ['test_escalation@invoca.com']
-      end
-
-      context "log_parser_exception_notification" do
-        it "send with string" do
-          result = ExceptionHandling::Mailer.log_parser_exception_notification("This is my fake error", "My Fake Subj").deliver_now
-          expect(result.subject).to eq("Test exception: My Fake Subj: This is my fake error")
-          expect(result.body.to_s).to match(/This is my fake error/)
-          assert_emails 1
-        end
-      end
-
-      context "escalation_notification" do
-        before do
-          def document_root_element
-            @body_html.root
-          end
-        end
-
-        it "send all the information" do
-          ExceptionHandling.email_environment = 'Staging Full'
-          ExceptionHandling.server_name = 'test-fe3'
-
-          ExceptionHandling::Mailer.escalation_notification("Your Favorite <b>Feature<b> Failed", error_string: "It failed because of an error\n <i>More Info<i>", timestamp: 1234567).deliver_now
-
-          assert_emails 1
-          result = ActionMailer::Base.deliveries.last
-          @body_html = Nokogiri::HTML(result.body.to_s)
-          assert_equal_with_diff ['test_escalation@invoca.com'], result.to
-          expect(result[:from].formatted).to eq(["Test Escalation Mailer <null_escalation@invoca.com>"])
-          expect(result.subject).to eq("Staging Full Escalation: Your Favorite <b>Feature<b> Failed")
-          assert_select "title", "Exception Escalation"
-          assert_select "html" do
-            assert_select "body br", { count: 4 }, result.body.to_s # plus 1 for the multiline summary
-            assert_select "body h3", "Your Favorite <b>Feature<b> Failed", result.body.to_s
-            assert_select "body", /1234567/
-            assert_select "body", /It failed because of an error/
-            assert_select "body", /\n <i>More Info<i>/
-            assert_select "body", /test-fe3/
-            # assert_select "body", /#{Web::Application::GIT_REVISION}/
-          end
-        end
-
-        it "use defaults for missing fields" do
-          result = ExceptionHandling::Mailer.escalation_notification("Your Favorite Feature Failed", error_string: "It failed because of an error\n More Info")
-          @body_html = Nokogiri::HTML(result.body.to_s)
-
-          assert_equal_with_diff ['test_escalation@invoca.com'], result.to
-          expect(result.from).to eq(["null_escalation@invoca.com"])
-          expect(result.subject).to eq('Test Escalation: Your Favorite Feature Failed')
-          assert_select "html" do
-            assert_select "body i", true, result.body.to_s do |is|
-              assert_select is, "i", 'no error #'
-            end
-          end
-        end
-
-        context "ExceptionHandling.escalate_to_production_support" do
-          before do
-            Time.now_override = Time.parse('1986-5-21 4:17 am UTC')
-          end
-
-          it "notify production support" do
-            subject = "Runtime Error found!"
-            exception = RuntimeError.new("Test")
-            recipients = ["prodsupport@example.com"]
-
-            ExceptionHandling.production_support_recipients = recipients
-            ExceptionHandling.last_exception_timestamp = Time.now.to_i
-
-            expect(ExceptionHandling).to receive(:escalate).with(subject, exception, Time.now.to_i, recipients)
-            ExceptionHandling.escalate_to_production_support(exception, subject)
-          end
-        end
-      end
-    end
-  end
-end

data/spec/unit/exception_handling/methods_spec.rb

@@ -1,105 +0,0 @@
-# frozen_string_literal: true
-
-require File.expand_path('../../spec_helper',  __dir__)
-
-require "exception_handling/testing"
-require_relative '../../helpers/exception_helpers.rb'
-
-module ExceptionHandling
-  describe Methods do
-    include ExceptionHelpers
-
-    def dont_stub_log_error
-      true
-    end
-
-    context "ExceptionHandling::Methods" do
-      before do
-        @controller = Testing::MethodsControllerStub.new
-        ExceptionHandling.stub_handler = nil
-      end
-
-      it "set the around filter" do
-        expect(Testing::MethodsControllerStub.around_filter_method).to eq(:set_current_controller)
-        expect(ExceptionHandling.current_controller).to be_nil
-        @controller.simulate_around_filter do
-          expect(ExceptionHandling.current_controller).to eq(@controller)
-        end
-        expect(ExceptionHandling.current_controller).to be_nil
-      end
-
-      it "use the current_controller when available" do
-        capture_notifications
-
-        expect(ExceptionHandling.logger).to receive(:fatal).with(/blah/, any_args).at_least(:once)
-        @controller.simulate_around_filter do
-          ExceptionHandling.log_error(ArgumentError.new("blah"))
-          expect(sent_notifications.size).to eq(1)
-          expect(/#{Regexp.new(Regexp.escape(@controller.request.request_uri))}/).to match(sent_notifications.last.enhanced_data['request'].to_s)
-        end
-      end
-
-      it "report long running controller action" do
-        expect(@controller.send(:long_controller_action_timeout)).to eq(2)
-        expect(ExceptionHandling).to receive(:log_error).with(/Long controller action detected in #{@controller.class.name.split("::").last}::test_action/)
-        @controller.simulate_around_filter do
-          sleep(3)
-        end
-      end
-
-      it "not report long running controller actions if it is less than the timeout" do
-        expect(@controller.send(:long_controller_action_timeout)).to eq(2)
-        allow(ExceptionHandling).to receive(:log_error).and_return("Should not timeout")
-        @controller.simulate_around_filter do
-          sleep(1)
-        end
-      end
-
-      it "default long running controller action(300/30 for test/prod)" do
-        class DummyController
-          include ExceptionHandling::Methods
-        end
-
-        controller = DummyController.new
-
-        Rails.env = 'production'
-        expect(controller.send(:long_controller_action_timeout)).to eq(30)
-
-        Rails.env = 'test'
-        expect(controller.send(:long_controller_action_timeout)).to eq(300)
-      end
-
-      context "#log_warning" do
-        it "be available to the controller" do
-          expect(@controller.methods.include?(:log_warning)).to eq(true)
-        end
-      end
-
-      context  "included deprecation" do
-        before do
-          mock_deprecation_3_0
-        end
-
-        it "deprecate when no around_filter in included hook" do
-          k = Class.new
-          k.include ExceptionHandling::Methods
-        end
-
-        it "deprecate controller around_filter in included hook" do
-          controller = Class.new
-          class << controller
-            def around_filter(*)
-            end
-          end
-          controller.include ExceptionHandling::Methods
-        end
-      end
-
-      private
-
-      def mock_deprecation_3_0
-        expect(STDERR).to receive(:puts).with(/DEPRECATION WARNING: ExceptionHandling::Methods is deprecated and will be removed from exception_handling 3\.0/)
-      end
-    end
-  end
-end

data/spec/unit/exception_handling/sensu_spec.rb

@@ -1,51 +0,0 @@
-# frozen_string_literal: true
-
-require File.expand_path('../../spec_helper',  __dir__)
-
-module ExceptionHandling
-  describe Sensu do
-    context "#generate_event" do
-      it "create an event" do
-        expect(ExceptionHandling::Sensu).to receive(:send_event).with({ name: "world_is_ending", output: "stick head between knees and kiss ass goodbye", status: 1 })
-
-        ExceptionHandling::Sensu.generate_event("world_is_ending", "stick head between knees and kiss ass goodbye")
-      end
-
-      it "add the sensu prefix" do
-        ExceptionHandling.sensu_prefix = "cnn_"
-
-        expect(ExceptionHandling::Sensu).to receive(:send_event).with({ name: "cnn_world_is_ending", output: "stick head between knees and kiss ass goodbye", status: 1 })
-
-        ExceptionHandling::Sensu.generate_event("world_is_ending", "stick head between knees and kiss ass goodbye")
-      end
-
-      it "allow the level to be set to critical" do
-        expect(ExceptionHandling::Sensu).to receive(:send_event).with({ name: "world_is_ending", output: "stick head between knees and kiss ass goodbye", status: 2 })
-
-        ExceptionHandling::Sensu.generate_event("world_is_ending", "stick head between knees and kiss ass goodbye", :critical)
-      end
-
-      it "error if an invalid level is supplied" do
-        expect(ExceptionHandling::Sensu).to_not receive(:send_event)
-
-        expect do
-          ExceptionHandling::Sensu.generate_event("world_is_ending", "stick head between knees and kiss ass goodbye", :hair_on_fire)
-        end.to raise_exception(RuntimeError, /Invalid alert level/)
-      end
-    end
-
-    context "#send_event" do
-      before do
-        @event = { name: "world_is_ending", output: "stick head between knees and kiss ass goodbye", status: 1 }
-        @socket = SocketStub.new
-      end
-
-      it "send event json to sensu client" do
-        expect_any_instance_of(Addrinfo).to receive(:connect).with(any_args) { @socket }
-        ExceptionHandling::Sensu.send_event(@event)
-
-        expect(@socket.sent.first).to eq(@event.to_json)
-      end
-    end
-  end
-end

data/views/exception_handling/mailer/escalate_custom.html.erb

@@ -1,17 +0,0 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
-   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-  <head>
-    <title>Exception Escalation</title>
-    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
-  </head>
-  <body>
-    <h3><%=h @summary %></h3>
-    <b>Error #:</b>  <%= h(@cleaned_data[:timestamp]).presence || '<i>no error #</i>'.html_safe -%><br />
-    <b>Exception:</b>  <%= h(@cleaned_data[:error_string]).gsub("\n","<br/>\n").gsub(/ {2,}/) { |spaces| '&nbsp;'*spaces.size }.html_safe %><br />
-    <b>Server:</b>   <%= h(@server).presence || '<i>hostname not set</i>'.html_safe -%><br />
-    <% if @cleaned_data[:scm_revision] %>
-      <b>Revision:</b> <%= @cleaned_data[:scm_revision] %><br />
-    <% end %>
-  </body>
-</html>

data/views/exception_handling/mailer/escalation_notification.html.erb

@@ -1,17 +0,0 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
-   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-  <head>
-    <title>Exception Escalation</title>
-    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
-  </head>
-  <body>
-    <h3><%=h @summary %></h3>
-    <b>Error #:</b>  <%= h(@cleaned_data[:timestamp]).presence || '<i>no error #</i>'.html_safe -%><br />
-    <b>Exception:</b>  <%= h(@cleaned_data[:error_string]).gsub("\n","<br/>\n").gsub(/ {2,}/) { |spaces| '&nbsp;'*spaces.size }.html_safe %><br />
-    <b>Server:</b>   <%= h(@server).presence || '<i>hostname not set</i>'.html_safe -%><br />
-    <% if @cleaned_data[:scm_revision] %>
-    <b>Revision:</b> <%= @cleaned_data[:scm_revision] %><br />
-    <% end %>
-  </body>
-</html>

data/views/exception_handling/mailer/log_parser_exception_notification.html.erb

@@ -1,82 +0,0 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
-   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-  <head>
-    <title>Exception Email</title>
-    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
-  </head>
-  <body>
-
-    <% if @cleaned_data[:first_seen_at] %>
-    <p> This exception occurred <%= @cleaned_data[:occurrences] %> times since <%= @cleaned_data[:first_seen_at] %>.</p>
-    <% end %>
-
-    <b>Error # </b><%= @cleaned_data[:timestamp] -%><br />
-
-    <b>URL:</b><br />
-      <% if (request = @cleaned_data[:request]) %>
-        <%= request[:url] || '<i>no URL in request data</i>'.html_safe %> <br />
-        Referred from: <%= (@cleaned_data[:environment]['HTTP_REFERER'] || '<i>no referrer</i>').html_safe %>
-      <% else %>
-        <i>no URL accessed</i>
-      <% end %>
-    <br />
-    <br />
-
-    <b>User summary:</b><br />
-    <% if (user_details = @cleaned_data[:user_details]) && ( user_details[:user] || user_details[:organization] ) %>
-      User: <%= h user_details[:user] %> (<%= h user_details[:username] %>)<br />
-      Organization: <%= user_details[:organization] %> <br />
-      <%= "Network: #{h user_details[:organization].network if user_details[:organization]}" if !user_details[:organization].is_a?(Network) %>
-
-      <% if @cleaned_data[:user_details][:impersonated_organization] %>
-        <br />
-        <b>Impersonating:</b><br />
-        Organization: <%= h @cleaned_data[:user_details][:impersonated_organization] %>
-      <% end %>
-    <% else %>
-     <i>No user logged in.</i>
-    <% end %>
-
-    <br />
-    <br />
-    <hr />
-
-    <h3>Exception:</h3>
-    <span id="error">
-    <%= h(@cleaned_data[:error]).gsub("\n","<br/>\n").gsub(/ {2,}/) { |spaces| '&nbsp;'*spaces.size }.html_safe %>
-    </span>
-
-    <br />
-    <br />
-
-    <h3>Where:</h3>
-    <%= "#{ h location[:controller]}##{ h location[:action]}<br />".html_safe if (location = @cleaned_data[:location]) && location[:controller] -%>
-    <%= "#{ h location[:file]}, line #{ h location[:line]}<br />".html_safe   if (location = @cleaned_data[:location]) && location[:file] -%>
-
-    <br />
-
-
-
-    <% for section in ExceptionHandling::ExceptionInfo::SECTIONS %>
-      <% section_value = @cleaned_data[section] %>
-      <% if section_value %>
-        <h3><%= section.to_s.capitalize -%>:</h3>
-        <pre id="<%= section.to_s.capitalize -%>" style="font-size: 12px; font-family: 'Courier New',Arial,sans-serif">
-  <%= case section_value
-       when Hash
-         section_value[:to_s]
-       when Array
-         section_value.join( "\n" )
-       when NilClass # omitted
-       else
-         raise "Unexpected value #{section_value.inspect} for section #{section}"
-       end
--%>
-    </pre>
-      <% end %>
-
-    <% end %>
-
-  </body>
-</html>