Including exception-notification implementations

Author: huacnlee

.github/workflows/build.yml

@@ -8,20 +8,27 @@ jobs:
       fail-fast: false
       matrix:
         include:
-        - ruby: 2.7
-          gemfile: Gemfile
-          postgres: 13
+          - ruby: 2.7
+            gemfile: Gemfile
+          - ruby: 3.0
+            gemfile: gemfiles/Gemfile-7-0
+          - ruby: 2.7
+            gemfile: gemfiles/Gemfile-6-1
+          - ruby: 2.6
+            gemfile: gemfiles/Gemfile-6-0
+          - ruby: 2.6
+            gemfile: gemfiles/Gemfile-5-2
     env:
       BUNDLE_GEMFILE: ${{ matrix.gemfile }}
       USE_OFFICIAL_GEM_SOURCE: 1
     steps:
-    - uses: actions/checkout@v2
-    - uses: ruby/setup-ruby@v1
-      with:
-        ruby-version: ${{ matrix.ruby }}
-        bundler-cache: true
-    - uses: ankane/setup-postgres@v1
-      with:
-        postgres-version: ${{ matrix.postgres }}
-    - run: createdb dummy_test
-    - run: bundle exec rails test
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+      - uses: ankane/setup-postgres@v1
+        with:
+          postgres-version: 13
+      - run: createdb dummy_test
+      - run: bundle exec rails test

Gemfile

@@ -3,6 +3,3 @@
 source "https://rubygems.org"
 
 gemspec
-gem "pg"
-gem "codecov"
-gem "simplecov"

Gemfile.lock

@@ -2,7 +2,6 @@ PATH
   remote: .
   specs:
     exception-track (1.2.0)
-      exception_notification (~> 4)
       kaminari (>= 0.15)
       rails (>= 5.2)
 
@@ -69,21 +68,14 @@ GEM
       tzinfo (~> 2.0)
       zeitwerk (~> 2.3)
     builder (3.2.4)
-    codecov (0.2.12)
-      json
-      simplecov
     concurrent-ruby (1.1.7)
+    connection_pool (2.2.5)
     crass (1.0.6)
-    docile (1.3.2)
     erubi (1.10.0)
-    exception_notification (4.4.3)
-      actionmailer (>= 4.0, < 7)
-      activesupport (>= 4.0, < 7)
     globalid (0.4.2)
       activesupport (>= 4.2.0)
     i18n (1.8.5)
       concurrent-ruby (~> 1.0)
-    json (2.4.0)
     kaminari (1.2.1)
       activesupport (>= 4.1.0)
       kaminari-actionview (= 1.2.1)
@@ -104,15 +96,25 @@ GEM
     marcel (0.3.3)
       mimemagic (~> 0.3.2)
     method_source (1.0.0)
-    mimemagic (0.3.5)
+    mimemagic (0.3.10)
+      nokogiri (~> 1)
+      rake
     mini_mime (1.0.2)
-    mini_portile2 (2.4.0)
+    mini_portile2 (2.6.1)
     minitest (5.14.2)
+    mocha (1.13.0)
+    mock_redis (0.19.0)
+    mustermann (1.1.1)
+      ruby2_keywords (~> 0.0.1)
     nio4r (2.5.4)
-    nokogiri (1.10.10)
-      mini_portile2 (~> 2.4.0)
+    nokogiri (1.12.5)
+      mini_portile2 (~> 2.6.1)
+      racc (~> 1.4)
     pg (1.2.3)
+    racc (1.6.0)
     rack (2.2.3)
+    rack-protection (2.1.0)
+      rack
     rack-test (1.1.0)
       rack (>= 1.0, < 3)
     rails (6.1.0)
@@ -142,12 +144,24 @@ GEM
       rake (>= 0.8.7)
       thor (~> 1.0)
     rake (13.0.1)
-    simplecov (0.20.0)
-      docile (~> 1.1)
-      simplecov-html (~> 0.11)
-      simplecov_json_formatter (~> 0.1)
-    simplecov-html (0.12.3)
-    simplecov_json_formatter (0.1.2)
+    redis (4.5.1)
+    redis-namespace (1.8.1)
+      redis (>= 3.0.4)
+    resque (1.8.2)
+      redis
+      redis-namespace
+      sinatra (>= 0.9.2)
+      vegas (>= 0.1.2)
+    ruby2_keywords (0.0.5)
+    sidekiq (6.3.1)
+      connection_pool (>= 2.2.2)
+      rack (~> 2.0)
+      redis (>= 4.2.0)
+    sinatra (2.1.0)
+      mustermann (~> 1.0)
+      rack (~> 2.2)
+      rack-protection (= 2.1.0)
+      tilt (~> 2.0)
     sprockets (4.0.2)
       concurrent-ruby (~> 1.0)
       rack (> 1, < 3)
@@ -156,8 +170,12 @@ GEM
       activesupport (>= 4.0)
       sprockets (>= 3.0.0)
     thor (1.0.1)
+    tilt (2.0.10)
+    timecop (0.9.4)
     tzinfo (2.0.3)
       concurrent-ruby (~> 1.0)
+    vegas (0.1.11)
+      rack (>= 1.0.0)
     websocket-driver (0.7.3)
       websocket-extensions (>= 0.1.0)
     websocket-extensions (0.1.5)
@@ -167,10 +185,13 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  codecov
   exception-track!
-  pg
-  simplecov
+  mocha (>= 0.13.0)
+  mock_redis (~> 0.19.0)
+  pg (>= 1)
+  resque (~> 1.8.0)
+  sidekiq (>= 5.0.4)
+  timecop (~> 0.9.0)
 
 BUNDLED WITH
-   2.1.4
+   2.2.22

exception-track.gemspec

@@ -7,18 +7,23 @@ require "exception-track/version"
 
 # Describe your gem and declare its dependencies:
 Gem::Specification.new do |s|
-  s.name        = "exception-track"
-  s.version     = ExceptionTrack::VERSION
-  s.authors     = ["Jason Lee"]
-  s.email       = ["[email protected]"]
-  s.homepage    = "https://github.com/rails-engine/exception-track"
-  s.summary     = "Tracking exceptions for Rails application store them in database."
+  s.name = "exception-track"
+  s.version = ExceptionTrack::VERSION
+  s.authors = ["Jason Lee"]
+  s.email = ["[email protected]"]
+  s.homepage = "https://github.com/rails-engine/exception-track"
+  s.summary = "Tracking exceptions for Rails application store them in database."
   s.description = "Tracking exceptions for Rails application store them in database by exception_notification gem."
-  s.license     = "MIT"
+  s.license = "MIT"
 
   s.files = Dir["{app,config,db,lib}/**/*", "MIT-LICENSE", "README.md"]
 
-  s.add_dependency "exception_notification", "~> 4"
   s.add_dependency "kaminari", ">= 0.15"
   s.add_dependency "rails", ">= 5.2"
+  s.add_development_dependency "pg", ">= 1"
+  s.add_development_dependency "mocha", ">= 0.13.0"
+  s.add_development_dependency "mock_redis", "~> 0.19.0"
+  s.add_development_dependency "resque", "~> 1.8.0"
+  s.add_development_dependency "sidekiq", ">= 5.0.4"
+  s.add_development_dependency "timecop", "~> 0.9.0"
 end

gemfiles/Gemfile-5-2

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+gem "rails", "~> 5.2.0"
+
+gemspec path: "../"

gemfiles/Gemfile-6-0

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+gem "rails", "~> 6.0.0"
+
+gemspec path: "../"

gemfiles/Gemfile-6-1

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+gem "rails", "~> 6.1.0"
+
+gemspec path: "../"

gemfiles/Gemfile-7-0

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+gem "rails", "~> 7.0.0"
+
+gemspec path: "../"

lib/exception-track.rb

@@ -7,7 +7,6 @@
 
 require "exception_notification"
 require "exception_notification/rails"
-require "exception_notifier/exception_track_notifier"
 
 require "kaminari"
 
@@ -28,5 +27,5 @@ def configure(&block)
 end
 
 ExceptionNotification.configure do |config|
-  config.add_notifier :exception_track, {}
+  config.add_notifier :db, {}
 end

lib/exception_notification.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require "exception_notifier/notifier"
+require "exception_notification/rack"
+require "exception_notification/version"
+
+module ExceptionNotification
+  # Alternative way to setup ExceptionNotification.
+  # Run 'rails generate exception_notification:install' to create
+  # a fresh initializer with all configuration values.
+  def self.configure
+    yield ExceptionNotifier
+  end
+end

lib/exception_notification/rack.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+module ExceptionNotification
+  class Rack
+    class CascadePassException < RuntimeError; end
+
+    def initialize(app, options = {})
+      @app = app
+
+      ExceptionNotifier.tap do |en|
+        en.ignored_exceptions = options.delete(:ignore_exceptions) if options.key?(:ignore_exceptions)
+        en.error_grouping = options.delete(:error_grouping) if options.key?(:error_grouping)
+        en.error_grouping_period = options.delete(:error_grouping_period) if options.key?(:error_grouping_period)
+        en.notification_trigger = options.delete(:notification_trigger) if options.key?(:notification_trigger)
+
+        if options.key?(:error_grouping_cache)
+          en.error_grouping_cache = options.delete(:error_grouping_cache)
+        elsif defined?(Rails) && Rails.respond_to?(:cache)
+          en.error_grouping_cache = Rails.cache
+        end
+      end
+
+      if options.key?(:ignore_if)
+        rack_ignore = options.delete(:ignore_if)
+        ExceptionNotifier.ignore_if do |exception, opts|
+          opts.key?(:env) && rack_ignore.call(opts[:env], exception)
+        end
+      end
+
+      if options.key?(:ignore_notifier_if)
+        rack_ignore_by_notifier = options.delete(:ignore_notifier_if)
+        rack_ignore_by_notifier.each do |notifier, proc|
+          ExceptionNotifier.ignore_notifier_if(notifier) do |exception, opts|
+            opts.key?(:env) && proc.call(opts[:env], exception)
+          end
+        end
+      end
+
+      ExceptionNotifier.ignore_crawlers(options.delete(:ignore_crawlers)) if options.key?(:ignore_crawlers)
+
+      @ignore_cascade_pass = options.delete(:ignore_cascade_pass) { true }
+
+      options.each do |notifier_name, opts|
+        ExceptionNotifier.register_exception_notifier(notifier_name, opts)
+      end
+    end
+
+    def call(env)
+      _, headers, = response = @app.call(env)
+
+      if !@ignore_cascade_pass && headers["X-Cascade"] == "pass"
+        msg = "This exception means that the preceding Rack middleware set the 'X-Cascade' header to 'pass' -- in " \
+              "Rails, this often means that the route was not found (404 error)."
+        raise CascadePassException, msg
+      end
+
+      response
+    rescue Exception => e
+      env["exception_notifier.delivered"] = true if ExceptionNotifier.notify_exception(e, env: env)
+
+      raise e unless e.is_a?(CascadePassException)
+
+      response
+    end
+  end
+end

lib/exception_notification/rails.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module ExceptionNotification
+  class Engine < ::Rails::Engine
+    config.exception_notification = ExceptionNotifier
+    config.exception_notification.logger = Rails.logger
+    config.exception_notification.error_grouping_cache = Rails.cache
+
+    config.app_middleware.use ExceptionNotification::Rack
+  end
+end

lib/exception_notification/resque.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require "resque/failure/base"
+
+module ExceptionNotification
+  class Resque < Resque::Failure::Base
+    def self.count
+      ::Resque::Stat[:failed]
+    end
+
+    def save
+      data = {
+        error_class: exception.class.name,
+        error_message: exception.message,
+        failed_at: Time.now.to_s,
+        payload: payload,
+        queue: queue,
+        worker: worker.to_s
+      }
+
+      ExceptionNotifier.notify_exception(exception, data: {resque: data})
+    end
+  end
+end

lib/exception_notification/sidekiq.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require "sidekiq"
+
+# Note: this class is only needed for Sidekiq version < 3.
+module ExceptionNotification
+  class Sidekiq
+    def call(_worker, msg, _queue)
+      yield
+    rescue Exception => e
+      ExceptionNotifier.notify_exception(e, data: {sidekiq: msg})
+      raise e
+    end
+  end
+end
+
+if ::Sidekiq::VERSION < "3"
+  ::Sidekiq.configure_server do |config|
+    config.server_middleware do |chain|
+      chain.add ::ExceptionNotification::Sidekiq
+    end
+  end
+else
+  ::Sidekiq.configure_server do |config|
+    config.error_handlers << proc do |ex, context|
+      ExceptionNotifier.notify_exception(ex, data: {sidekiq: context})
+    end
+  end
+end

lib/exception_notification/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module ExceptionNotification
+  VERSION = "4.5.0"
+end