Merge remote-tracking branch 'upstream/main'

Author: imageaid

Gemfile

@@ -10,3 +10,5 @@ gem "rake", "~> 13.0"
 gem "minitest", "~> 5.0"
 
 gem "standard", "~> 1.3"
+
+gem "actionmailer", ">= 7.0"

Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    solid_errors (0.7.0)
+    solid_errors (0.6.1)
       actionmailer (>= 7.0)
       actionpack (>= 7.0)
       actionview (>= 7.0)
@@ -63,7 +63,7 @@ GEM
     concurrent-ruby (1.3.4)
     connection_pool (2.4.1)
     crass (1.0.6)
-    date (3.3.4)
+    date (3.4.1)
     drb (2.2.1)
     erubi (1.13.0)
     globalid (1.2.1)
@@ -88,18 +88,18 @@ GEM
       net-smtp
     mini_mime (1.1.5)
     minitest (5.25.1)
-    net-imap (0.4.14)
+    net-imap (0.5.6)
       date
       net-protocol
     net-pop (0.1.2)
       net-protocol
     net-protocol (0.2.2)
       timeout
-    net-smtp (0.5.0)
+    net-smtp (0.5.1)
       net-protocol
-    nokogiri (1.18.6-arm64-darwin)
+    nokogiri (1.18.2-arm64-darwin)
       racc (~> 1.4)
-    nokogiri (1.18.6-x86_64-linux-gnu)
+    nokogiri (1.18.2-x86_64-linux-gnu)
       racc (~> 1.4)
     parallel (1.26.3)
     parser (3.3.4.2)
@@ -158,8 +158,8 @@ GEM
       rubocop-ast (>= 1.31.1, < 2.0)
     ruby-progressbar (1.13.0)
     securerandom (0.3.1)
-    sqlite3 (2.6.0-arm64-darwin)
-    sqlite3 (2.6.0-x86_64-linux-gnu)
+    sqlite3 (2.5.0-arm64-darwin)
+    sqlite3 (2.5.0-x86_64-linux-gnu)
     standard (1.40.0)
       language_server-protocol (~> 3.17.0.2)
       lint_roller (~> 1.0)
@@ -188,6 +188,7 @@ PLATFORMS
   x86_64-linux
 
 DEPENDENCIES
+  actionmailer (>= 7.0)
   minitest (~> 5.0)
   rake (~> 13.0)
   solid_errors!

README.md

@@ -103,6 +103,12 @@ $ rails solid_errors:install_migrations
 
 All exceptions are recorded automatically. No additional code required.
 
+You can add default additional information to the context of the error by adding this line to your application controller:
+```ruby
+before_action { Rails.error.set_context(request_url: request.original_url, params: params, session: session.inspect) }
+```
+The additional context information will be automatically displayed on the occurence details page.
+
 Please consult the [official guides](https://guides.rubyonrails.org/error_reporting.html) for an introduction to the error reporting API.
 
 There are intentionally few features; you can view and resolve errors. That’s it. The goal is to provide a simple, lightweight, and performant solution for tracking exceptions in your Rails application. If you need more features, you should probably use a 3rd party service like [Honeybadger](https://www.honeybadger.io/), whose MIT-licensed [Ruby agent gem](https://github.com/honeybadger-io/honeybadger-ruby) provided a couple of critical pieces of code for this project.
@@ -166,6 +172,7 @@ You can configure Solid Errors via the Rails configuration object, under the `so
 * `email_from` - The email address to send a notification from. See [Email notifications](#email-notifications) for more information.
 * `email_to` - The email address(es) to send a notification to. See [Email notifications](#email-notifications) for more information.
 * `email_subject_prefix` - Prefix added to the subject line for email notifications. See [Email notifications](#email-notifications) for more information.
+* `base_controller_class` - Specify a different controller as the base class for the Solid Errors controller. See [Authentication](#authentication) for more information.
 
 ### Database Configuration
 
@@ -222,6 +229,13 @@ authenticate :user, -> (user) { user.admin? } do
 end
 ```
 
+You can also specify a different controller to use as the Solid Errors controller base class:
+
+```ruby
+# Override the base controller class with your own controller
+config.solid_errors.base_controller_class = "YourAdminController"
+```
+
 #### Email notifications
 
 Solid Errors _can_ send email notifications whenever an error occurs, if your application has ActionMailer already properly setup to send emails. However, in order to activate this feature you must define the email address(es) to send the notifications to. Optionally, you can also define the email address to send the notifications from (useful if your email provider only allows emails to be sent from a predefined list of addresses) or simply turn off this feature altogether. You can also define a subject prefix for the email notifications to quickly identify the source of the error.

app/controllers/solid_errors/application_controller.rb

@@ -1,5 +1,6 @@
 module SolidErrors
-  class ApplicationController < ActionController::Base
+  class ApplicationController < SolidErrors.base_controller_class.constantize
+    layout "solid_errors/application"
     protect_from_forgery with: :exception
 
     http_basic_authenticate_with name: SolidErrors.username, password: SolidErrors.password if SolidErrors.password

app/mailers/solid_errors/error_mailer.rb

@@ -1,7 +1,10 @@
 module SolidErrors
   # adapted from: https://github.com/codergeek121/email_error_reporter/blob/main/lib/email_error_reporter/error_mailer.rb
-  class ErrorMailer < ActionMailer::Base
+  class ErrorMailer < (defined?(ActionMailer::Base) ? ActionMailer::Base : Object)
     def error_occurred(occurrence)
+      unless defined?(ActionMailer::Base)
+        raise "ActionMailer is not available. Make sure that you require \"action_mailer/railtie\" in application.rb"
+      end
       @occurrence = occurrence
       @error = occurrence.error
       subject = "#{@error.severity_emoji} #{@error.exception_class}"

bin/console

@@ -2,6 +2,7 @@
 # frozen_string_literal: true
 
 require "bundler/setup"
+require "rails"
 require "solid_errors"
 
 # You can add fixtures and/or initialization code here to make experimenting

lib/solid_errors.rb

@@ -8,6 +8,7 @@
 module SolidErrors
   mattr_accessor :connects_to
   mattr_accessor :full_backtrace
+  mattr_accessor :base_controller_class, default: "::ActionController::Base"
   mattr_writer :username
   mattr_writer :password
   mattr_writer :send_emails
@@ -28,8 +29,6 @@ def username
       @username ||= ENV["SOLIDERRORS_USERNAME"] || @@username
     end
 
-    # use method instead of attr_accessor to ensure
-    # this works if variable set after SolidErrors is loaded
     def password
       @password ||= ENV["SOLIDERRORS_PASSWORD"] || @@password
     end

lib/solid_errors/engine.rb

@@ -10,6 +10,11 @@ class Engine < ::Rails::Engine
       config.solid_errors.each do |name, value|
         SolidErrors.public_send(:"#{name}=", value)
       end
+
+      if SolidErrors.send_emails? && !defined?(ActionMailer)
+        raise "You have configured solid_errors.send_emails = true but ActionMailer is not available." \
+              "Make sure that you require \"action_mailer/railtie\" in application.rb or set solid_errors.send_emails = false."
+      end
     end
 
     initializer "solid_errors.active_record.error_subscriber" do

solid_errors.gemspec

@@ -21,7 +21,6 @@ Gem::Specification.new do |spec|
   end
 
   ">= 7.0".tap do |rails_version|
-    spec.add_dependency "actionmailer", rails_version
     spec.add_dependency "actionpack", rails_version
     spec.add_dependency "actionview", rails_version
     spec.add_dependency "activerecord", rails_version

test/test_backtrace.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "test_helper"
+
+class TestSolidErrors < Minitest::Test
+  def test_backtrace
+    backtrace = SolidErrors::Backtrace.parse(caller(0)).to_a
+    assert_includes backtrace[0][:method], "test_backtrace"
+  end
+end