exception_notification 4.5.0 → 4.6.0

data/lib/exception_notification/rake.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+# Copied/adapted from https://github.com/airbrake/airbrake/blob/master/lib/airbrake/rake.rb
+
+Rake::TaskManager.record_task_metadata = true if Rake.const_defined?(:TaskManager)
+
+module ExceptionNotification
+  module RakeTaskExtensions
+    # A wrapper around the original +#execute+, that catches all errors and
+    # passes them on to ExceptionNotifier.
+    #
+    # rubocop:disable Lint/RescueException
+    def execute(args = nil)
+      super(args)
+    rescue Exception => e
+      ExceptionNotifier.notify_exception(e, data: data_for_exception_notifier(e)) unless e.is_a?(SystemExit)
+      raise e
+    end
+    # rubocop:enable Lint/RescueException
+
+    private
+
+    def data_for_exception_notifier(exception = nil)
+      data = {}
+      data[:error_class] = exception.class.name if exception
+      data[:error_message] = exception.message if exception
+
+      data[:rake] = {}
+      data[:rake][:rake_command_line] = reconstruct_command_line
+      data[:rake][:name] = name
+      data[:rake][:timestamp] = timestamp.to_s
+      # data[:investigation] = investigation
+
+      data[:rake][:full_comment] = full_comment if full_comment
+      data[:rake][:arg_names] = arg_names if arg_names.any?
+      data[:rake][:arg_description] = arg_description if arg_description
+      data[:rake][:locations] = locations if locations.any?
+      data[:rake][:sources] = sources if sources.any?
+
+      if prerequisite_tasks.any?
+        data[:rake][:prerequisite_tasks] = prerequisite_tasks.map do |p|
+          p.__send__(:data_for_exception_notifier)[:rake]
+        end
+      end
+
+      data
+    end
+    # rubocop:enable
+
+    def reconstruct_command_line
+      "rake #{ARGV.join(' ')}"
+    end
+  end
+end
+
+module Rake
+  class Task
+    prepend ExceptionNotification::RakeTaskExtensions
+  end
+end

data/lib/exception_notification/version.rb

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

data/lib/exception_notifier/slack_notifier.rb

@@ -72,6 +72,9 @@ module ExceptionNotifier
       exception_name = "*#{measure_word}* `#{exception_class}`"
       env = options[:env]
 
+      options[:headers] ||= {}
+      options[:headers]['Content-Type'] = 'application/json'
+
       if env.nil?
         data = options[:data] || {}
         text = "#{exception_name} *occured in background*\n"

data/lib/exception_notifier/teams_notifier.rb

@@ -38,7 +38,7 @@ module ExceptionNotifier
         @controller = @request_items = nil
       else
         @controller = @env['action_controller.instance'] || MissingController.new
-
+        @additional_exception_data = @env['exception_notifier.exception_data']
         request = ActionDispatch::Request.new(@env)
 
         @request_items = { url: request.original_url,
@@ -47,10 +47,6 @@ module ExceptionNotifier
                            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
@@ -96,7 +92,7 @@ module ExceptionNotifier
 
       details['facts'].push message_request unless @request_items.nil?
       details['facts'].push message_backtrace unless @backtrace.nil?
-
+      details['facts'].push additional_exception_data unless @additional_exception_data.nil?
       details
     end
 
@@ -127,6 +123,13 @@ module ExceptionNotifier
       }
     end
 
+    def additional_exception_data
+      {
+        'name' => 'Data',
+        'value' => "`#{@additional_exception_data}`\n  "
+      }
+    end
+
     def gitlab_view_link
       {
         '@type' => 'ViewAction',

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

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

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

@@ -1 +1 @@
-* data: <%= raw PP.pp(@data, "") %>
+* data: <%= raw PP.pp(@data, +"") %>

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

@@ -5,6 +5,6 @@
   </li>
   <li>
     <strong>data: </strong>
-    <span><%= PP.pp(@request.session.to_hash, "") %></span>
+    <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"] and @request.env["rack.session.options"][:id])).inspect.html_safe) %>
-* data: <%= raw PP.pp(@request.session.to_hash, "") %>
+* data: <%= raw PP.pp(@request.session.to_hash, +"") %>

data/lib/generators/exception_notification/install_generator.rb

@@ -2,7 +2,7 @@
 
 module ExceptionNotification
   module Generators
-    class InstallGenerator < Rails::Generators::Base
+    class InstallGenerator < ::Rails::Generators::Base
       desc 'Creates a ExceptionNotification initializer.'
 
       source_root File.expand_path('templates', __dir__)

data/lib/generators/exception_notification/templates/exception_notification.rb.erb

@@ -1,4 +1,6 @@
+# Move this require to your `config/application.rb` if you want to be notified from runner commands too.
 require 'exception_notification/rails'
+require 'exception_notification/rake'
 <% if options.sidekiq? %>
 require 'exception_notification/sidekiq'
 <% end %>
@@ -19,7 +21,7 @@ ExceptionNotification.configure do |config|
   # Adds a condition to decide when an exception must be ignored or not.
   # The ignore_if method can be invoked multiple times to add extra conditions.
   # config.ignore_if do |exception, options|
-  #   not Rails.env.production?
+  #   Rails.env.local?
   # end
 
   # Ignore exceptions generated by crawlers

data/test/exception_notification/rake_test.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require 'test_helper'
+
+require 'rake'
+require 'exception_notification/rake'
+
+class RakeTest < ActiveSupport::TestCase
+  setup do
+    Rake::Task.define_task :dependency_1 do
+      puts :dependency_1
+    end
+    Rake::Task.define_task raise_exception: :dependency_1 do
+      raise 'test exception'
+    end
+    @task = Rake::Task[:raise_exception]
+  end
+
+  test 'notifies of exception' do
+    ExceptionNotifier.expects(:notify_exception).with do |ex, opts|
+      data = opts[:data]
+      ex.is_a?(RuntimeError) &&
+        ex.message == 'test exception' &&
+        data[:error_class] == 'RuntimeError' &&
+        data[:error_message] == 'test exception' &&
+        data[:rake][:rake_command_line] == 'rake ' &&
+        data[:rake][:name] == 'raise_exception' &&
+        data[:rake][:timestamp] &&
+        data[:rake][:sources] == ['dependency_1'] &&
+        data[:rake][:prerequisite_tasks][0][:name] == 'dependency_1'
+    end
+
+    # The original error is re-raised
+    assert_raises(RuntimeError) do
+      @task.invoke
+    end
+  end
+end

data/test/exception_notifier/email_notifier_test.rb

@@ -295,8 +295,7 @@ class EmailNotifierWithEnvTest < ActiveSupport::TestCase
       Environment:
       -------------------------------
 
-        * CONTENT_LENGTH                            : 0
-          * HTTPS                                     : on
+        * HTTPS                                     : on
           * HTTP_HOST                                 : test.address
           * HTTP_USER_AGENT                           : Rails Testing
           * PATH_INFO                                 : /
@@ -306,24 +305,19 @@ class EmailNotifierWithEnvTest < ActiveSupport::TestCase
           * SCRIPT_NAME                               :
           * SERVER_NAME                               : example.org
           * SERVER_PORT                               : 80
+          * SERVER_PROTOCOL                           : HTTP/1.1
           * action_controller.instance                : #{@controller}
           * action_dispatch.parameter_filter          : [\"secret\"]
-          * action_dispatch.request.content_type      :
           * action_dispatch.request.parameters        : {"id"=>"foo", "secret"=>"[FILTERED]"}
           * action_dispatch.request.path_parameters   : {}
           * action_dispatch.request.query_parameters  : {"id"=>"foo", "secret"=>"[FILTERED]"}
           * action_dispatch.request.request_parameters: {}
           * rack.errors                               : #{@test_env['rack.errors']}
-          * rack.input                                : #{@test_env['rack.input']}
-          * rack.multiprocess                         : true
-          * rack.multithread                          : true
-          * rack.request.query_hash                   : {"id"=>"foo", "secret"=>"[FILTERED]"}
-          * rack.request.query_string                 : id=foo&secret=secret
-          * rack.run_once                             : false
+          * rack.request.form_hash                    : {}
+          * rack.request.form_input                   :
           * rack.session                              : #{@test_env['rack.session']}
           * rack.session.options                      : #{@test_env['rack.session.options']}
           * rack.url_scheme                           : http
-          * rack.version                              : #{Rack::VERSION}
 
       -------------------------------
       Backtrace:

data/test/exception_notifier/hipchat_notifier_test.rb

@@ -2,13 +2,7 @@
 
 require 'test_helper'
 require 'rack'
-
-# silence_warnings trick around require can be removed once
-# https://github.com/hipchat/hipchat-rb/pull/174
-# gets merged and released
-silence_warnings do
-  require 'hipchat'
-end
+require 'hipchat'
 
 class HipchatNotifierTest < ActiveSupport::TestCase
   test 'should send hipchat notification if properly configured' do

data/test/exception_notifier/sidekiq_test.rb

@@ -11,7 +11,11 @@ require 'sidekiq/testing'
 require 'exception_notification/sidekiq'
 
 class MockSidekiqServer
-  include ::Sidekiq::ExceptionHandler
+  include ::Sidekiq::Component
+
+  def config
+    Sidekiq.default_configuration
+  end
 end
 
 class SidekiqTest < ActiveSupport::TestCase

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: exception_notification
 version: !ruby/object:Gem::Version
-  version: 4.5.0
+  version: 4.6.0
 platform: ruby
 authors:
 - Jamis Buck
 - Josh Peek
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-01-20 00:00:00.000000000 Z
+date: 2025-03-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionmailer
@@ -20,7 +20,7 @@ dependencies:
         version: '5.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '8'
+        version: '9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -30,7 +30,7 @@ dependencies:
         version: '5.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '8'
+        version: '9'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -40,7 +40,7 @@ dependencies:
         version: '5.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '8'
+        version: '9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -50,7 +50,7 @@ dependencies:
         version: '5.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '8'
+        version: '9'
 - !ruby/object:Gem::Dependency
   name: appraisal
   requirement: !ruby/object:Gem::Requirement
@@ -200,7 +200,7 @@ dependencies:
         version: '5.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '8'
+        version: '9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -210,7 +210,7 @@ dependencies:
         version: '5.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '8'
+        version: '9'
 - !ruby/object:Gem::Dependency
   name: resque
   requirement: !ruby/object:Gem::Requirement
@@ -229,16 +229,16 @@ dependencies:
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.78.0
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.78.0
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: sidekiq
   requirement: !ruby/object:Gem::Requirement
@@ -281,7 +281,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.9.0
-description: 
+description:
 email: smartinez87@gmail.com
 executables: []
 extensions: []
@@ -292,6 +292,7 @@ files:
 - CODE_OF_CONDUCT.md
 - CONTRIBUTING.md
 - Gemfile
+- Gemfile.lock
 - MIT-LICENSE
 - README.md
 - Rakefile
@@ -307,13 +308,6 @@ files:
 - docs/notifiers/sns.md
 - docs/notifiers/teams.md
 - docs/notifiers/webhook.md
-- examples/sample_app.rb
-- examples/sinatra/Gemfile
-- examples/sinatra/Gemfile.lock
-- examples/sinatra/Procfile
-- examples/sinatra/README.md
-- examples/sinatra/config.ru
-- examples/sinatra/sinatra_app.rb
 - exception_notification.gemspec
 - gemfiles/rails5_2.gemfile
 - gemfiles/rails6_0.gemfile
@@ -322,6 +316,8 @@ files:
 - lib/exception_notification.rb
 - lib/exception_notification/rack.rb
 - lib/exception_notification/rails.rb
+- lib/exception_notification/rails/runner_tie.rb
+- lib/exception_notification/rake.rb
 - lib/exception_notification/resque.rb
 - lib/exception_notification/sidekiq.rb
 - lib/exception_notification/version.rb
@@ -360,6 +356,7 @@ files:
 - lib/generators/exception_notification/install_generator.rb
 - lib/generators/exception_notification/templates/exception_notification.rb.erb
 - test/exception_notification/rack_test.rb
+- test/exception_notification/rake_test.rb
 - test/exception_notification/resque_test.rb
 - test/exception_notifier/datadog_notifier_test.rb
 - test/exception_notifier/email_notifier_test.rb
@@ -384,8 +381,9 @@ files:
 homepage: https://smartinez87.github.io/exception_notification/
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  changelog_uri: https://github.com/smartinez87/exception_notification/blob/master/CHANGELOG.rdoc
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -400,12 +398,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.8.11
 requirements: []
-rubygems_version: 3.2.32
-signing_key: 
+rubygems_version: 3.5.22
+signing_key:
 specification_version: 4
 summary: Exception notification for Rails apps
 test_files:
 - test/exception_notification/rack_test.rb
+- test/exception_notification/rake_test.rb
 - test/exception_notification/resque_test.rb
 - test/exception_notifier/datadog_notifier_test.rb
 - test/exception_notifier/email_notifier_test.rb

data/examples/sample_app.rb

@@ -1,56 +0,0 @@
-# frozen_string_literal: true
-
-# -------------------------------------------
-# To run the application: ruby examples/sample_app.rb
-# -------------------------------------------
-
-require 'bundler/inline'
-
-gemfile do
-  source 'https://rubygems.org'
-
-  gem 'rails', '5.0.0'
-  gem 'exception_notification', '4.3.0'
-  gem 'httparty', '0.15.7'
-end
-
-class SampleApp < Rails::Application
-  config.middleware.use ExceptionNotification::Rack,
-                        webhook: {
-                          url: 'http://example.com'
-                        }
-
-  config.secret_key_base = 'my secret key base'
-
-  Rails.logger = Logger.new($stdout)
-
-  routes.draw do
-    get '/', to: 'exceptions#index'
-  end
-end
-
-require 'action_controller/railtie'
-
-class ExceptionsController < ActionController::Base
-  def index
-    raise 'Sample exception raised, you should receive a notification!'
-  end
-end
-
-require 'minitest/autorun'
-
-class Test < Minitest::Test
-  include Rack::Test::Methods
-
-  def test_raise_exception
-    get '/'
-
-    assert last_response.server_error?
-  end
-
-  private
-
-  def app
-    Rails.application
-  end
-end

data/examples/sinatra/Gemfile

@@ -1,10 +0,0 @@
-# frozen_string_literal: true
-
-source 'https://rubygems.org'
-
-gem 'exception_notification', path: '../../'
-
-gem 'foreman'
-gem 'mailcatcher'
-gem 'sinatra', '~> 1.3.5'
-gem 'thin', '~> 1.5.1'

data/examples/sinatra/Gemfile.lock

@@ -1,95 +0,0 @@
-PATH
-  remote: ../../
-  specs:
-    exception_notification (3.0.1)
-      actionmailer (>= 3.0.4)
-      activesupport (>= 3.0.4)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    actionmailer (3.2.13)
-      actionpack (= 3.2.13)
-      mail (~> 2.5.3)
-    actionpack (3.2.13)
-      activemodel (= 3.2.13)
-      activesupport (= 3.2.13)
-      builder (~> 3.0.0)
-      erubis (~> 2.7.0)
-      journey (~> 1.0.4)
-      rack (~> 1.4.5)
-      rack-cache (~> 1.2)
-      rack-test (~> 0.6.1)
-      sprockets (~> 2.2.1)
-    activemodel (3.2.13)
-      activesupport (= 3.2.13)
-      builder (~> 3.0.0)
-    activesupport (3.2.13)
-      i18n (= 0.6.1)
-      multi_json (~> 1.0)
-    builder (3.0.4)
-    daemons (1.1.9)
-    erubis (2.7.0)
-    eventmachine (1.0.3)
-    foreman (0.61.0)
-      thor (>= 0.13.6)
-    haml (4.0.2)
-      tilt
-    hike (1.2.1)
-    i18n (0.6.1)
-    journey (1.0.4)
-    mail (2.5.3)
-      i18n (>= 0.4.0)
-      mime-types (~> 1.16)
-      treetop (~> 1.4.8)
-    mailcatcher (0.5.11)
-      activesupport (~> 3.0)
-      eventmachine (~> 1.0.0)
-      haml (>= 3.1, < 5)
-      mail (~> 2.3)
-      sinatra (~> 1.2)
-      skinny (~> 0.2.3)
-      sqlite3 (~> 1.3)
-      thin (~> 1.5.0)
-    mime-types (1.22)
-    multi_json (1.7.2)
-    polyglot (0.3.3)
-    rack (1.4.5)
-    rack-cache (1.2)
-      rack (>= 0.4)
-    rack-protection (1.5.0)
-      rack
-    rack-test (0.6.2)
-      rack (>= 1.0)
-    sinatra (1.3.6)
-      rack (~> 1.4)
-      rack-protection (~> 1.3)
-      tilt (~> 1.3, >= 1.3.3)
-    skinny (0.2.3)
-      eventmachine (~> 1.0.0)
-      thin (~> 1.5.0)
-    sprockets (2.2.2)
-      hike (~> 1.2)
-      multi_json (~> 1.0)
-      rack (~> 1.0)
-      tilt (~> 1.1, != 1.3.0)
-    sqlite3 (1.3.7)
-    thin (1.5.1)
-      daemons (>= 1.0.9)
-      eventmachine (>= 0.12.6)
-      rack (>= 1.0.0)
-    thor (0.18.1)
-    tilt (1.3.6)
-    treetop (1.4.12)
-      polyglot
-      polyglot (>= 0.3.1)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  exception_notification!
-  foreman
-  mailcatcher
-  sinatra (~> 1.3.5)
-  thin (~> 1.5.1)

data/examples/sinatra/Procfile

@@ -1,2 +0,0 @@
-web: bundle exec thin start --port 3000
-mail: bundle exec mailcatcher --foreground --smtp-port 1025 --http-port 1080

data/examples/sinatra/README.md

@@ -1,11 +0,0 @@
-# Using Exception Notification with Sinatra
-
-## Quick start
-
-    git clone git@github.com:smartinez87/exception_notification.git
-    cd exception_notification/examples/sinatra
-    bundle install
-    bundle exec foreman start
-
-
-The last command starts two services, a smtp server and the sinatra app itself. Thus, visit [http://localhost:1080/](http://localhost:1080/) to check the emails sent and, in a separated tab, visit [http://localhost:3000](http://localhost:3000) and cause some errors. For more info, use the [source](https://github.com/smartinez87/exception_notification/blob/master/examples/sinatra/sinatra_app.rb) Luke.

data/examples/sinatra/config.ru

@@ -1,5 +0,0 @@
-# frozen_string_literal: true
-
-require ::File.expand_path('../sinatra_app', __FILE__)
-
-run SinatraApp

data/examples/sinatra/sinatra_app.rb

@@ -1,40 +0,0 @@
-# frozen_string_literal: true
-
-require 'rubygems'
-require 'bundler/setup'
-require 'sinatra/base'
-require 'exception_notification'
-
-class SinatraApp < Sinatra::Base
-  use Rack::Config do |env|
-    # This is highly recommended.  It will prevent the ExceptionNotification email from including your users' passwords
-    env['action_dispatch.parameter_filter'] = [:password]
-  end
-
-  use ExceptionNotification::Rack,
-      email: {
-        email_prefix: '[Example] ',
-        sender_address: %("notifier" <notifier@example.com>),
-        exception_recipients: %w[exceptions@example.com],
-        smtp_settings: {
-          address: 'localhost',
-          port: 1025
-        }
-      }
-
-  get '/' do
-    raise StandardError, "ERROR: #{params[:error]}" unless params[:error].blank?
-
-    'Everything is fine! Now, lets break things clicking <a href="/?error=ops"> here </a>.' \
-    'Dont forget to see the emails at <a href="http://localhost:1080">mailcatcher</a> !'
-  end
-
-  get '/background_notification' do
-    begin
-      1 / 0
-    rescue StandardError => e
-      ExceptionNotifier.notify_exception(e, data: { msg: 'Cannot divide by zero!' })
-    end
-    'Check email at <a href="http://localhost:1080">mailcatcher</a>.'
-  end
-end