exception-track 0.6.2 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b096b42d1e359c95d02180e76597932827bf0552887c98c30ab4c5655c014d86
-  data.tar.gz: 47f461e204a87e35cf4c0bad912fa2b99e38662ff12678e21f3faa9ffd0bd13c
+  metadata.gz: 71a2bc45d225661a466bdd4fe3ae8227253cf0e4e48430a3f3db33605c04aed7
+  data.tar.gz: fbf989949bd59b5ac8ea1b44c159cae09ded01832c21c42193729a95b20f3015
 SHA512:
-  metadata.gz: ecd0dfa7ebc4a8ec10622ee01f3109f140b6174288fb23cc90cca5f8f1539e0c7cf40a4340211486e3cafd5f41da32201144c969abf0e1f5d14bd35df33af1bc
-  data.tar.gz: ee57578ba6af00e75eb92200434de9d4c3bdd96f49f68ba3bca44221c14831f771757059217c4bd0a8dd3bb9210b9ddf32e197be3389c5392ee2a11a571a6017
+  metadata.gz: a7b776ccbda802c32ca77f60ec4257e198d2e9e96c611ccc03c14fb00efc1fb5f127a60e9df627b985ddef347d1e1ceb2f04c8919894ab73da3ac796fe8cc0c5
+  data.tar.gz: 14a4f70638b02742170ff3138d553624a8c379b2c0480624f178354fd0324dbcb58d5d75627e78f24026338fbeb750478431034ac76eb3b7cb3f8cd42df4dc9e

data/README.md

@@ -1,5 +1,4 @@
-ExceptionTrack
---------------
+## ExceptionTrack
 
 Tracking exceptions for Rails application store them in database.
 
@@ -7,7 +6,7 @@ This gem is base on [exception_notification](https://github.com/smartinez87/exce
 
 [中文介绍和使用说明](https://ruby-china.org/topics/32325)
 
-[![Gem Version](https://badge.fury.io/rb/exception-track.svg)](https://badge.fury.io/rb/exception-track) [![Build Status](https://travis-ci.org/rails-engine/exception-track.svg)](https://travis-ci.org/rails-engine/exception-track) [![Code Climate](https://codeclimate.com/github/rails-engine/exception-track/badges/gpa.svg)](https://codeclimate.com/github/rails-engine/exception-track) [![codecov.io](https://codecov.io/github/rails-engine/exception-track/coverage.svg?branch=master)](https://codecov.io/github/rails-engine/exception-track?branch=master) [![](http://inch-ci.org/github/rails-engine/exception-track.svg?branch=master)](http://inch-ci.org/github/rails-engine/exception-track?branch=master)
+[![Gem Version](https://badge.fury.io/rb/exception-track.svg)](https://badge.fury.io/rb/exception-track) [![build](https://github.com/rails-engine/exception-track/workflows/build/badge.svg)](https://github.com/rails-engine/exception-track/actions?query=workflow%3Abuild) [![codecov.io](https://codecov.io/github/rails-engine/exception-track/coverage.svg?branch=master)](https://codecov.io/github/rails-engine/exception-track?branch=master)
 
 ![2017-02-17 12 35 18](https://cloud.githubusercontent.com/assets/5518/23052599/8e267c02-f50d-11e6-8d6e-cef0cc1991b7.png)
 
@@ -41,6 +40,12 @@ Rails.application.routes.draw do
 end
 ```
 
+Migrate database:
+
+```shell
+bundle exec rails db:migrate
+```
+
 Now you can open: http://localhost:3000/exception-track
 
 ## Configuration

data/app/assets/stylesheets/exception-track/application.css

@@ -1,27 +1,78 @@
+:root {
+  --body-background-color: #eee;
+  --card-background-color: #fff;
+  --card-border-color: #fff;
+  --card-shadow-color: rgba(200, 200, 200, 0.26);
+  --text-color: #333;
+  --text-color1: #666;
+  --text-color2: #999;
+  --link-color: #364cc9;
+  --table-background-color1: #f5f5f5;
+  --table-border-color: #f0f0f0;
+  --input-border-color: #ddd;
+  --button-background-color: #fff;
+  --button-border-color: #eee;
+  --button-text-color: #555;
+  --button-hover-background-color: #f7f7f7;
+  --button-hover-border-color: #eee;
+  --button-danger-color: #f85149;
+  --button-danger-hover-background-color: #f85149;
+  --button-danger-hover-color: #fff;
+  --pre-background-color: #f7f7f7;
+  --notice-color: #fff;
+  --notice-background-color: #3CBD46;
+}
+
+@media (prefers-color-scheme: dark) {
+  :root {
+    --body-background-color: #0d1117;
+    --card-background-color: rgba(200, 200, 200, 0.02);
+    --card-border-color: #30363d;
+    --card-shadow-color: rgba(0, 0, 0, 0.16);
+    --text-color: #c9d1d9;
+    --text-color1: #999;
+    --text-color2: #888;
+    --link-color: #58a6ff;
+    --table-background-color1: #161b22;
+    --table-border-color: #30363d;
+    --input-border-color: #333;
+    --button-background-color: #21262d;
+    --button-border-color: #30363d;
+    --button-text-color: #c9d1d9;
+    --button-hover-background-color: #30363d;
+    --button-hover-border-color: #8b949e;
+    --pre-background-color: #161b22;
+    --notice-color: #3CBD46;
+    --notice-background-color: #3cbd4621;
+  }
+}
 
 body {
   margin: 0;
   padding: 20px 0;
-  background-color: #eee;
+  background-color: var(--body-background-color);
 }
 
 body, textarea {
   font-family: -apple-system, BlinkMacSystemFont, "Helvetica Neue", Arial, Helvetica, sans-serif;
   font-size: 14px;
   line-height: 1.4;
-  color: #333;
+  color: var(--text-color);
 }
 
 .footer {
   padding: 15px;
   text-align: center;
-  color: #999;
+  color: var(--text-color2);
+}
+
+.footer a:link, .footer a:visited {
+  color: var(--text-color1);
+  text-decoration: underline;
 }
-.footer a:link,
-.footer a:visited { color: #666; text-decoration: underline;}
 
 a, a:visited, a:active {
-  color: #364cc9;
+  color: var(--link-color);
   text-decoration: none;
 }
 
@@ -34,15 +85,15 @@ table {
   border-collapse: collapse;
   border-spacing: 0;
   margin-bottom: 20px;
+  border: 1px solid var(--table-border-color);
+  border-radius: 3px;
 }
 
-th {
-  text-align: left;
-  border-bottom: solid 1px #e0e0e0;
+td.date {
+  width: 170px;
+  font-size: 12px;
 }
 
-td.date { width: 150px; font-size: 12px; }
-
 h1 {
   margin-top: 0;
   font-size: 20px;
@@ -66,29 +117,28 @@ ul {
 table td, table th {
   padding: 10px 15px;
 }
-th { background: #f5f5f5; border-bottom: 1px solid #e0e0e0; }
-td {
-  border-top: solid 1px #e0e0e0;
+
+th {
+  text-align: left;
+  background: var(--table-background-color1);
+  border-bottom: 1px solid var(--table-border-color);
 }
 
-pre {
-  background-color: #eee;
-  padding: 10px;
-  white-space: pre-wrap;
-  word-break: break-word;
+td {
+  border-top: solid 1px var(--table-border-color);
 }
 
 textarea {
   width: 100%;
   height: 100px;
-  border: solid 1px #ddd;
+  border: solid 1px var(--input-border-color);
   padding: 10px;
 }
 
 hr {
   border: none;
   height: 0;
-  border-top: solid 1px #ddd;
+  border-top: solid 1px var(--input-border-color);
   margin-bottom: 15px;
 }
 
@@ -107,16 +157,29 @@ hr {
   -ms-user-select: none;
   user-select: none;
   border-radius: 3px;
-  border: 1px solid #ccc;
+  transition: .2s cubic-bezier(.3, 0, .5, 1);
+  transition-property: color, background-color, border-color;
+  border: 1px solid var(--button-border-color);
   padding: 6px 16px;
-  color: #555 !important;
+  color: var(--button-text-color) !important;
   outline: 0 !important;
-  background: #FFF;
+  background: var(--button-background-color);
 }
-.btn:hover { text-decoration: none !important; background: #f7f7f7; }
-.btn-danger { background: #fff; color: #E33F00 !important; border-color: #E33F00;}
+
+.btn:hover {
+  text-decoration: none !important;
+  background: var(--button-hover-background-color);
+}
+
+.btn-danger {
+  background: var(--button-background-color);
+  color: var(--button-danger-color) !important;
+  border-color: var(--button-border-color);
+}
+
 .btn-danger:hover {
-  background: #FCEDEC;
+  background: var(--button-danger-hover-background-color);
+  color: var(--button-danger-hover-color) !important;
 }
 
 .container {
@@ -124,8 +187,9 @@ hr {
   margin-left: auto;
   margin-right: auto;
   padding: 20px;
-  background-color: #fff;
-  box-shadow: 0 1px 8px rgba(200, 200, 200, 0.26);
+  background-color: var(--card-background-color);
+  box-shadow: 0 1px 8px var(--card-shadow-color);
+  border: 1px solid var(--card-border-color);
   border-radius: 3px;
 }
 
@@ -140,49 +204,67 @@ hr {
   height: 34px;
   line-height: 34px;
 }
-.toolbar form { display: inline; }
-.toolbar .pull-right { float: right; }
+
+.toolbar form {
+  display: inline;
+}
+
+.toolbar .pull-right {
+  float: right;
+}
 
 #notice {
   padding: 8px 15px;
-  background: #3CBD46;
-  color: #fff;
+  background: var(--notice-background-color);
+  color: var(--notice-color);
   margin-bottom: 15px;
   border-radius: 3px;
 }
 
 pre {
-  background: #f7f7f7;
+  white-space: pre-wrap;
+  word-break: break-word;
+  background: var(--pre-background-color);
   padding: 25px;
   border-radius: 3px;
   font-size: 12px;
   font-family: Menlo, Monaco, Consolas, monospace;
 }
 
-h1 { font-size: 16px; }
+h1 {
+  font-size: 16px;
+}
 
 .pagination {
   padding-bottom: 15px;
   font-size: 14px;
 }
 
-.pagination li { display: inline; }
+.pagination li {
+  display: inline;
+}
 
 .pagination a {
   display: inline-block;
   padding: 5px 10px;
-  border: 1px solid #eee;
-  color: #555;
+  border-radius: 3px;
+  border: 1px solid var(--button-border-color);
+  color: var(--button-text-color);
+  background: var(--button-background-color);
   text-decoration: none;
 }
+
 .pagination a:hover {
-  background: #f7f7f7;
+  background: var(--button-hover-background-color);
+  color: var(--button-hover-color);
+  border-color: var(--button-hover-border-color);
 }
-.pagination em,
-.pagination .current {
+
+.pagination em, .pagination .current {
+  border-radius: 3px;
   display: inline-block;
   padding: 5px 10px;
-  border: 1px solid #f0f0f0;
-  background: #f0f0f0;
+  border: 1px solid var(--button-hover-border-color);
+  background: var(--button-hover-background-color);
   font-style: normal;
-}
+}

data/app/controllers/exception_track/logs_controller.rb

@@ -3,7 +3,7 @@
 module ExceptionTrack
   class LogsController < ActionController::Base
     layout "exception-track/application"
-    before_action :set_log, only: %i[show destroy]
+    before_action :set_log, only: :show
 
     # GET /exception_logs
     def index
@@ -12,7 +12,7 @@ module ExceptionTrack
 
     def export
       @logs = Log.order("id desc").where("created_at >= ?", 3.months.ago)
-      send_data JSON.pretty_generate(@logs.as_json(only: [:title, :body, :created_at, :updated_at])), filename: "#{Date.current}.json", disposition: "attachment"
+      send_data JSON.pretty_generate(@logs.as_json(only: %i[title body created_at updated_at])), filename: "#{Date.current}.json", disposition: "attachment"
     end
 
     # GET /exception_logs/1
@@ -25,7 +25,6 @@ module ExceptionTrack
     end
 
     private
-
       # Use callbacks to share common setup or constraints between actions.
       def set_log
         @log = Log.find(params[:id])

data/app/views/exception_track/logs/index.html.erb

@@ -6,7 +6,7 @@
   }
 </script>
 <div class="toolbar">
-  <%= @logs.total_count %> exceptions
+  <a class="btn" href="/">Back to App</a>
 
   <div class="pull-right">
     <%= form_tag(export_logs_path, method: 'post') do %>
@@ -21,6 +21,7 @@
 <% if @logs.blank? %>
   <div class="no-record">No exceptions.</div>
 <% else %>
+  <h1><%= pluralize(@logs.total_count, 'exception') %></h1>
   <%= paginate @logs %>
 
   <table class="table table-borded tabl">

data/config/initializers/exception-track.rb

@@ -9,10 +9,15 @@ ExceptionTrack.configure do
 end
 
 # ExceptionNotification.configure do |config|
-#   config.ignored_exceptions += %w(ActionView::TemplateError
-#                                   ActionController::InvalidAuthenticityToken
-#                                   ActionController::BadRequest
-#                                   ActionView::MissingTemplate
-#                                   ActionController::UrlGenerationError
-#                                   ActionController::UnknownFormat)
+#   config.ignored_exceptions += %w[
+#     ActionView::TemplateError
+#     ActionController::InvalidAuthenticityToken
+#     ActionController::BadRequest
+#     ActionView::MissingTemplate
+#     ActionController::UrlGenerationError
+#     ActionController::UnknownFormat
+#     ActionController::InvalidCrossOriginRequest
+#     ActionController::ParameterMissing
+#     Mime::Type::InvalidMimeType
+#   ]
 # end

data/db/migrate/20170217023900_create_exception_track_logs.rb

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
-class CreateExceptionTrackLogs < ActiveRecord::Migration[5.0]
+class CreateExceptionTrackLogs < ActiveRecord::Migration[5.2]
   def change
     create_table :exception_tracks do |t|
       t.string :title
-      t.text :body, limit: 16777215
+      t.text :body, limit: 16_777_215
 
       t.timestamps
     end

data/lib/exception-track/configuration.rb

@@ -8,6 +8,7 @@ module ExceptionTrack
 
     def enabled_env?(env)
       return false if env.blank?
+
       environments.include?(env.to_sym)
     end
   end

data/lib/exception-track/engine.rb

@@ -5,7 +5,9 @@ module ExceptionTrack
     isolate_namespace ExceptionTrack
 
     initializer "exception-track.assets.precompile", group: :all do |app|
-      app.config.assets.precompile += %w( exception-track/application.css )
+      app.config.assets.precompile += %w[exception-track/application.css]
     end
+
+    ExceptionTrack::LogSubscriber.attach_to :exception_track
   end
 end

data/lib/exception-track/log_subscriber.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module ExceptionTrack
+  class LogSubscriber < ActiveSupport::LogSubscriber
+    # ActiveSupport::Notifications.instrument('track.exception_track', action: action)
+    def track(event)
+      prefix = color("ExceptionTrack", CYAN)
+      title = color(event.payload[:title], RED)
+      debug "  #{prefix} track db (#{event.duration.round(1)}ms)"
+    end
+  end
+end

data/lib/exception-track/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ExceptionTrack
-  VERSION = "0.6.2"
+  VERSION = "1.3.0"
 end

data/lib/exception-track.rb

@@ -2,11 +2,11 @@
 
 require "exception-track/version"
 require "exception-track/configuration"
+require "exception-track/log_subscriber"
 require "exception-track/engine"
 
 require "exception_notification"
 require "exception_notification/rails"
-require "exception_notifier/exception_track_notifier"
 
 require "kaminari"
 
@@ -14,17 +14,18 @@ module ExceptionTrack
   class << self
     def config
       return @config if defined?(@config)
+
       @config = Configuration.new
       @config.environments = %i[development production]
       @config
     end
 
     def configure(&block)
-      config.instance_exec(&block)
+      config.instance_eval(&block)
     end
   end
 end
 
 ExceptionNotification.configure do |config|
-  config.add_notifier :exception_track, {}
+  config.add_notifier :db, {}
 end

data/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

data/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

data/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

data/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

data/lib/exception_notification/version.rb

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

data/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

data/lib/exception_notifier/base_notifier.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module ExceptionNotifier
+  class BaseNotifier
+    attr_accessor :base_options
+
+    def initialize(options = {})
+      @base_options = options
+    end
+
+    def send_notice(exception, options, message, message_opts = nil)
+      _pre_callback(exception, options, message, message_opts)
+      result = yield(message, message_opts)
+      _post_callback(exception, options, message, message_opts)
+      result
+    end
+
+    def _pre_callback(exception, options, message, message_opts)
+      return unless @base_options[:pre_callback].respond_to?(:call)
+
+      @base_options[:pre_callback].call(options, self, exception.backtrace, message, message_opts)
+    end
+
+    def _post_callback(exception, options, message, message_opts)
+      return unless @base_options[:post_callback].respond_to?(:call)
+
+      @base_options[:post_callback].call(options, self, exception.backtrace, message, message_opts)
+    end
+  end
+end