exception_handling 3.0.pre.1 → 3.0.0

metadata

@@ -1,123 +1,101 @@
 --- !ruby/object:Gem::Specification
 name: exception_handling
 version: !ruby/object:Gem::Version
-  version: 3.0.pre.1
+  version: 3.0.0
 platform: ruby
 authors:
-- Colin Kelley
-autorequire: 
+- Invoca
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-02-27 00:00:00.000000000 Z
+date: 2024-03-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: actionmailer
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '5.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '5.2'
 - !ruby/object:Gem::Dependency
-  name: actionpack
+  name: contextual_logger
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: escalate
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '0.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.2'
-- !ruby/object:Gem::Dependency
-  name: contextual_logger
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.3'
 - !ruby/object:Gem::Dependency
-  name: eventmachine
+  name: invoca-utils
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '0.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '0.3'
 - !ruby/object:Gem::Dependency
-  name: hobo_support
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: invoca-utils
+  name: psych
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.0'
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.0'
-description: Exception handling logger/emailer
+        version: '3.0'
+description: Exception handling logger
 email:
-- colindkelley@gmail.com
+- development@invoca.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/CODEOWNERS"
+- ".github/workflows/pipeline.yml"
 - ".gitignore"
+- ".rspec"
 - ".rubocop.yml"
 - ".ruby-version"
+- ".tool-versions"
+- Appraisals
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - LICENSE
@@ -125,39 +103,35 @@ files:
 - Rakefile
 - config/exception_filters.yml
 - exception_handling.gemspec
+- gemfiles/rails_5.gemfile
+- gemfiles/rails_6.gemfile
+- gemfiles/rails_7.gemfile
 - lib/exception_handling.rb
+- lib/exception_handling/escalate_callback.rb
 - lib/exception_handling/exception_catalog.rb
 - lib/exception_handling/exception_description.rb
 - lib/exception_handling/exception_info.rb
-- lib/exception_handling/honeybadger_callbacks.rb
 - lib/exception_handling/log_stub_error.rb
-- lib/exception_handling/mailer.rb
-- lib/exception_handling/methods.rb
-- lib/exception_handling/sensu.rb
+- lib/exception_handling/logging_methods.rb
 - lib/exception_handling/testing.rb
 - lib/exception_handling/version.rb
-- semaphore_ci/setup.sh
-- test/helpers/controller_helpers.rb
-- test/helpers/exception_helpers.rb
-- test/test_helper.rb
-- test/unit/exception_handling/exception_catalog_test.rb
-- test/unit/exception_handling/exception_description_test.rb
-- test/unit/exception_handling/exception_info_test.rb
-- test/unit/exception_handling/honeybadger_callbacks_test.rb
-- test/unit/exception_handling/log_error_stub_test.rb
-- test/unit/exception_handling/mailer_test.rb
-- test/unit/exception_handling/methods_test.rb
-- test/unit/exception_handling/sensu_test.rb
-- test/unit/exception_handling_test.rb
-- views/exception_handling/mailer/escalate_custom.html.erb
-- views/exception_handling/mailer/escalation_notification.html.erb
-- views/exception_handling/mailer/log_parser_exception_notification.html.erb
+- spec/helpers/controller_helpers.rb
+- spec/helpers/exception_helpers.rb
+- spec/rake_test_warning_false.rb
+- spec/spec_helper.rb
+- spec/unit/exception_handling/escalate_callback_spec.rb
+- spec/unit/exception_handling/exception_catalog_spec.rb
+- spec/unit/exception_handling/exception_description_spec.rb
+- spec/unit/exception_handling/exception_info_spec.rb
+- spec/unit/exception_handling/log_error_stub_spec.rb
+- spec/unit/exception_handling/logging_methods_spec.rb
+- spec/unit/exception_handling_spec.rb
 homepage: https://github.com/Invoca/exception_handling
 licenses: []
 metadata:
   source_code_uri: https://github.com/Invoca/exception_handling
   allowed_push_host: https://rubygems.org
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -168,26 +142,23 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.13
-signing_key: 
+rubygems_version: 3.3.7
+signing_key:
 specification_version: 4
-summary: Invoca's exception handling logger/emailer layer, based on exception_notifier.
-  Works with Rails or EventMachine or EventMachine+Synchrony.
+summary: Invoca's exception handling logger layer, based on exception_notifier.
 test_files:
-- test/helpers/controller_helpers.rb
-- test/helpers/exception_helpers.rb
-- test/test_helper.rb
-- test/unit/exception_handling/exception_catalog_test.rb
-- test/unit/exception_handling/exception_description_test.rb
-- test/unit/exception_handling/exception_info_test.rb
-- test/unit/exception_handling/honeybadger_callbacks_test.rb
-- test/unit/exception_handling/log_error_stub_test.rb
-- test/unit/exception_handling/mailer_test.rb
-- test/unit/exception_handling/methods_test.rb
-- test/unit/exception_handling/sensu_test.rb
-- test/unit/exception_handling_test.rb
+- spec/helpers/controller_helpers.rb
+- spec/helpers/exception_helpers.rb
+- spec/rake_test_warning_false.rb
+- spec/spec_helper.rb
+- spec/unit/exception_handling/escalate_callback_spec.rb
+- spec/unit/exception_handling/exception_catalog_spec.rb
+- spec/unit/exception_handling/exception_description_spec.rb
+- spec/unit/exception_handling/exception_info_spec.rb
+- spec/unit/exception_handling/log_error_stub_spec.rb
+- spec/unit/exception_handling/logging_methods_spec.rb
+- spec/unit/exception_handling_spec.rb

data/lib/exception_handling/honeybadger_callbacks.rb

@@ -1,59 +0,0 @@
-# frozen_string_literal: true
-
-module ExceptionHandling
-  module HoneybadgerCallbacks
-    class << self
-      def register_callbacks
-        if ExceptionHandling.honeybadger_defined?
-          Honeybadger.local_variable_filter(&method(:local_variable_filter))
-        end
-      end
-
-      private
-
-      def inspect_object(object, filter_keys)
-        inspection_output = object.inspect
-
-        if contains_filter_key?(filter_keys, inspection_output)
-          filtered_object(object)
-        else
-          inspection_output
-        end
-      rescue => ex
-        details = if object.respond_to?(:to_pk)
-                    " @pk=#{object.to_pk}"
-                  elsif object.respond_to?(:id)
-                    " @id=#{object.id}"
-                  end
-
-        "#<#{object.class.name}#{details} [error '#{ex.class.name}: #{ex.message}' while calling #inspect]>"
-      end
-
-      def local_variable_filter(_symbol, object, filter_keys)
-        case object
-        # Honeybadger will filter these data types for us
-        when String, Hash, Array, Set, Numeric, TrueClass, FalseClass, NilClass
-          object
-        else # handle other Ruby objects, intended for POROs
-          inspect_object(object, filter_keys)
-        end
-      end
-
-      def contains_filter_key?(filter_keys, string)
-        filter_keys._?.any? { |key| string.include?(key) }
-      end
-
-      def filtered_object(object)
-        # make the output look similar to inspect
-        # use [FILTERED], just like honeybadger does
-        if object.respond_to?(:to_pk)
-          "#<#{object.class.name} @pk=#{object.to_pk}, [FILTERED]>"
-        elsif object.respond_to?(:id)
-          "#<#{object.class.name} @id=#{object.id}, [FILTERED]>"
-        else
-          "#<#{object.class.name} [FILTERED]>"
-        end
-      end
-    end
-  end
-end

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,101 +0,0 @@
-# frozen_string_literal: true
-
-require 'active_support/concern'
-
-module ExceptionHandling
-  module Methods # included on models and controllers
-    extend ActiveSupport::Concern
-
-    protected
-
-    def log_error(exception_or_string, exception_context = '')
-      controller = self if respond_to?(:request) && respond_to?(:session)
-      ExceptionHandling.log_error(exception_or_string, exception_context, controller)
-    end
-
-    def log_error_rack(exception_or_string, exception_context = '', rack_filter = '')
-      ExceptionHandling.log_error_rack(exception_or_string, exception_context, rack_filter)
-    end
-
-    def log_warning(message)
-      ExceptionHandling.log_warning(message)
-    end
-
-    def log_info(message)
-      ExceptionHandling.logger.info(message)
-    end
-
-    def log_debug(message)
-      ExceptionHandling.logger.debug(message)
-    end
-
-    def ensure_safe(exception_context = "")
-      yield
-    rescue => ex
-      log_error ex, exception_context
-      nil
-    end
-
-    def escalate_error(exception_or_string, email_subject)
-      ExceptionHandling.escalate_error(exception_or_string, email_subject)
-    end
-
-    def escalate_warning(message, email_subject)
-      ExceptionHandling.escalate_warning(message, email_subject)
-    end
-
-    def ensure_escalation(*args)
-      ExceptionHandling.ensure_escalation(*args) do
-        yield
-      end
-    end
-
-    def alert_warning(*args)
-      ExceptionHandling.alert_warning(*args)
-    end
-
-    def ensure_alert(*args)
-      ExceptionHandling.ensure_alert(*args) do
-        yield
-      end
-    end
-
-    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
-      around_filter :set_current_controller if respond_to? :around_filter
-    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/semaphore_ci/setup.sh

@@ -1,3 +0,0 @@
-#!/bin/sh -x
-
-bundle install --path vendor/bundle

data/test/unit/exception_handling/exception_catalog_test.rb

@@ -1,85 +0,0 @@
-# frozen_string_literal: true
-
-require File.expand_path('../../test_helper',  __dir__)
-
-module ExceptionHandling
-  class ExceptionCatalogTest < ActiveSupport::TestCase
-
-    context "With stubbed yaml content" do
-      setup do
-        filter_list = { exception1: { error: "my error message" },
-                        exception2: { error: "some other message", session: "misc data" } }
-        stub(YAML).load_file { filter_list }
-
-        # bump modified time up to get the above filter loaded
-        stub(File).mtime { incrementing_mtime }
-      end
-
-      context "with loaded data" do
-        setup do
-          stub(File).mtime { incrementing_mtime }
-          @exception_catalog = ExceptionCatalog.new(ExceptionHandling.filter_list_filename)
-          @exception_catalog.send :load_file
-        end
-
-        should "have loaded filters" do
-          assert_equal 2, @exception_catalog.instance_eval("@filters").size
-        end
-
-        should "find messages in the catalog" do
-          assert !@exception_catalog.find(error: "Scott says unlikely to ever match")
-        end
-
-        should "find matching data" do
-          exception_description = @exception_catalog.find(error: "this is my error message, which should match something")
-          assert exception_description
-          assert_equal :exception1, exception_description.filter_name
-        end
-      end
-
-      should "write errors loading the yaml file directly to the log file" do
-        @exception_catalog = ExceptionCatalog.new(ExceptionHandling.filter_list_filename)
-
-        mock(ExceptionHandling).log_error.never
-        mock(ExceptionHandling).write_exception_to_log(anything, "ExceptionCatalog#refresh_filters: ./config/exception_filters.yml", anything)
-        mock(@exception_catalog).load_file { raise "noooooo" }
-
-        @exception_catalog.find({})
-      end
-    end
-
-    context "with live yaml content" do
-      setup do
-        @filename = File.expand_path('../../../config/exception_filters.yml',  __dir__)
-        @exception_catalog = ExceptionCatalog.new(@filename)
-        assert_nothing_raised "Loading the exception filter should not raise" do
-          @exception_catalog.send :load_file
-        end
-      end
-
-      should "load the filter data" do
-        assert !@exception_catalog.find(error: "Scott says unlikely to ever match")
-        assert !@exception_catalog.find(error: "Scott says unlikely to ever match")
-      end
-    end
-
-    context "with no yaml content" do
-      setup do
-        @exception_catalog = ExceptionCatalog.new(nil)
-      end
-
-      should "not load filter data" do
-        mock(ExceptionHandling).write_exception_to_log.with_any_args.never
-        @exception_catalog.find(error: "Scott says unlikely to ever match")
-      end
-    end
-
-    private
-
-    def incrementing_mtime
-      @mtime ||= Time.now
-      @mtime += 1.day
-    end
-
-  end
-end

data/test/unit/exception_handling/exception_description_test.rb

@@ -1,82 +0,0 @@
-# frozen_string_literal: true
-
-require File.expand_path('../../test_helper',  __dir__)
-
-module ExceptionHandling
-  class ExceptionDescriptionTest < ActiveSupport::TestCase
-
-    context "Filter" do
-      should "allow direct matching of strings" do
-        @f = ExceptionDescription.new(:filter1, error: "my error message")
-        assert @f.match?('error' => "my error message")
-      end
-
-      should "allow direct matching of strings on with symbol keys" do
-        @f = ExceptionDescription.new(:filter1, error: "my error message")
-        assert @f.match?(error: "my error message")
-      end
-
-      should "allow wildcards to cross line boundries" do
-        @f = ExceptionDescription.new(:filter1, error: "my error message.*with multiple lines")
-        assert @f.match?(error: "my error message\nwith more than one, with multiple lines")
-      end
-
-      should "complain when no regexps have a value" do
-        assert_raise(ArgumentError, "has all blank regexe") { ExceptionDescription.new(:filter1, error: nil) }
-      end
-
-      should "report when an invalid key is passed" do
-        assert_raise(ArgumentError, "Unknown section: not_a_parameter") { ExceptionDescription.new(:filter1, error: "my error message", not_a_parameter: false) }
-      end
-
-      should "allow send_to_honeybadger to be specified and have it disabled by default" do
-        assert !ExceptionDescription.new(:filter1, error: "my error message", send_to_honeybadger: false).send_to_honeybadger
-        assert ExceptionDescription.new(:filter1, error: "my error message", send_to_honeybadger: true).send_to_honeybadger
-        assert !ExceptionDescription.new(:filter1, error: "my error message").send_to_honeybadger
-      end
-
-      should "allow send_metric to be configured" do
-        assert !ExceptionDescription.new(:filter1, error: "my error message", send_metric: false).send_metric
-        assert ExceptionDescription.new(:filter1, error: "my error message").send_metric
-      end
-
-      should "provide metric name" do
-        assert_equal "filter1", ExceptionDescription.new(:filter1, error: "my error message").metric_name
-        assert_equal "some_other_metric_name", ExceptionDescription.new(:filter1, error: "my error message", metric_name: :some_other_metric_name).metric_name
-      end
-
-      should "replace spaces in metric name" do
-        @f = ExceptionDescription.new(:"filter has spaces", error: "my error message")
-        assert_equal "filter_has_spaces", @f.metric_name
-      end
-
-      should "allow notes to be recorded" do
-        assert_nil ExceptionDescription.new(:filter1, error: "my error message").notes
-        assert_equal "a long string", ExceptionDescription.new(:filter1, error: "my error message", notes: "a long string").notes
-      end
-
-      should "not consider config options in the filter set" do
-        assert ExceptionDescription.new(:filter1, error: "my error message", send_metric: false).match?(error: "my error message")
-        assert ExceptionDescription.new(:filter1, error: "my error message", metric_name: "false").match?(error: "my error message")
-        assert ExceptionDescription.new(:filter1, error: "my error message", notes: "hey").match?(error: "my error message")
-      end
-
-      should "provide exception details" do
-        exception_description = ExceptionDescription.new(:filter1, error: "my error message", notes: "hey")
-
-        expected = { "send_metric" => true, "metric_name" => "filter1", "notes" => "hey" }
-
-        assert_equal expected, exception_description.exception_data
-      end
-
-      should "match multiple email addresses" do
-        mobi = "ExceptionHandling::Warning: LoginAttempt::IPAddressLocked: failed login for 'mcc@mobistreak.com'"
-        credit = "ExceptionHandling::Warning: LoginAttempt::IPAddressLocked: failed login for 'damon@thecreditpros.com'"
-
-        exception_description = ExceptionDescription.new(:filter1, error: "ExceptionHandling::Warning: LoginAttempt::IPAddressLocked: failed login for '(mcc\@mobistreak|damon\@thecreditpros).com'")
-        assert exception_description.match?(error: mobi), "does not match mobi"
-        assert exception_description.match?(error: credit), "does not match credit"
-      end
-    end
-  end
-end