solid_errors 0.6.1 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: acc9e46b7ee94e391df6d5fa4b11fd0550dcef9eca0f1b2089ec8ea81d6dc47e
-  data.tar.gz: 37fda129cbac297cb10da823a70188515f29f57f02160b2acf01fd010345698a
+  metadata.gz: 877768652877df99eb678441601fa65e3329ad898ae4a163c2a260e5ab88d40b
+  data.tar.gz: dc5cd7fcb81f7548ea8657f74670971682f530c6149114b97bad9d943c282764
 SHA512:
-  metadata.gz: 1f2cd0c74b2a38ac93abb353cc8083cb623b942cd117df06efaf246afc0e42e2cd40732692fb6e7510c2962fab5a3826d88c674c21d1c2582de8264a4ccbca82
-  data.tar.gz: 1ecc1ebc03b277fa8840cdc3550ad0e64f566761a3ecdc5ad45a2daa39fde4b8922c528eec6fa3097fd15f098bfcbe7b372bc26197855e5507990d04e1729ce3
+  metadata.gz: 4482cfe25a500becec052384f224214e9946d97f1f034a03ea4d52f2549814863e00632da29b659bb78f9b0b58667a4773020141597f2e517be7dd08fbccb76c
+  data.tar.gz: bf4e567dcc81fe59ab1aac561abfd3110c69b83db080c317401caa19206f5e36c0e6b12a6afd6e232aeb883cfd85de822fa7fc802672348b01b3ca6aaa2ae32e

data/README.md

@@ -98,6 +98,12 @@ end
 
 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.
@@ -160,10 +166,13 @@ You can configure Solid Errors via the Rails configuration object, under the `so
 * `sends_email` - Whether or not to send emails when an error occurs. See [Email notifications](#email-notifications) for more information.
 * `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.
+* `destroy_after` - If set, Solid Errors will periodically destroy resolved records that are older than the value specified. See [Automatically destroying old records](#automatically-destroying-old-records) for more information.
 
-#### Database Configuration
+### Database Configuration
 
-`config.solid_errors.connects_to` takes a custom database configuration hash that will be used in the abstract `SolidErrors::Record` Active Record model. This is required to use a different database than the main app. For example:
+`config.solid_errors.connects_to` takes a custom database configuration hash that will be used in the abstract `SolidErrors::Record` Active Record model. This is required to use a different database than the main app ([but the primary database can also be used](#single-database-configuration)). For example:
 
 ```ruby
 # Use a single separate DB for Solid Errors
@@ -177,6 +186,16 @@ or
 config.solid_errors.connects_to = { database: { writing: :solid_errors_primary, reading: :solid_errors_replica } }
 ```
 
+#### Single Database Configuration
+
+Running Solid Errors in a separate database is recommended, but it's also possible to use one single database for both the app and the errors. Just follow these steps to add errors to the primary database:
+
+1. Copy the contents of `db/errors_schema.rb` into a normal migration and delete `db/errors_schema.rb`
+2. Remove `config.solid_errors.connects_to` from your configuration files.
+3. Migrate your database.
+
+You won't have multiple databases, so `database.yml` doesn't need to have the errors database configuration.
+
 #### Authentication
 
 Solid Errors does not restrict access out of the box. You must secure the dashboard yourself. However, it does provide basic HTTP authentication that can be used with basic authentication or Devise. All you need to do is setup a username and password.
@@ -206,9 +225,16 @@ 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.
+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.
 
 There are two ways to configure email notifications. First, you can use environment variables:
 
@@ -216,19 +242,35 @@ There are two ways to configure email notifications. First, you can use environm
 ENV["SOLIDERRORS_SEND_EMAILS"] = true # defaults to false
 ENV["SOLIDERRORS_EMAIL_FROM"] = "errors@myapp.com" # defaults to "solid_errors@noreply.com"
 ENV["SOLIDERRORS_EMAIL_TO"] = "devs@myapp.com" # no default, must be set
+ENV["SOLIDERRORS_EMAIL_SUBJECT_PREFIX"] = "[Application name][Environment]" # no default, optional
 ```
 
 Second, you can set the values via the configuration object:
 
 ```ruby
-# Set authentication credentials for Solid Errors
+# Set authentication credentials and optional subject prefix for Solid Errors
 config.solid_errors.send_emails = true
 config.solid_errors.email_from = "errors@myapp.com"
 config.solid_errors.email_to = "devs@myapp.com"
+config.solid_errors.email_subject_prefix = "[#{Rails.application.name}][#{Rails.env}]"
 ```
 
 If you have set `send_emails` to `true` and have set an `email_to` address, Solid Errors will send an email notification whenever an error occurs. If you have not set `send_emails` to `true` or have not set an `email_to` address, Solid Errors will not send any email notifications.
 
+#### Automatically destroying old records
+
+Setting `destroy_after` to a duration will allow Solid Errors to be self-maintaining by peridically destroying **resolved** records that are older than that value. The value provided must respond to `.ago`.
+
+```ruby
+# Automatically destroy records older than 30 days
+config.solid_errors.destroy_after = 30.days
+```
+
+```ruby
+# Automatically destroy records older than 6 months
+config.solid_errors.destroy_after = 6.months
+```
+
 ### Examples
 
 There are only two screens in the dashboard.
@@ -311,9 +353,20 @@ You can always take control of the views by creating your own views and/or parti
 </html>
 ```
 
+## Sponsors
+
+<p align="center">
+  <em>Proudly sponsored by</em>
+</p>
+<p align="center">
+  <a href="https://www.honeybadger.io?utm_source=fractaledmind&utm_medium=open-source&utm_campaign=solid_errors">
+    <img src="https://honeybadger-static.s3.amazonaws.com/brand_assets/honeybadger_logo/honeybadger_logo.svg" width="575" />
+  </a>
+</p>
+
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment. If you want to set up a local development database, run `rake db:migrate`.
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
@@ -328,3 +381,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 ## Code of Conduct
 
 Everyone interacting in the SolidErrors project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/fractaledmind/solid_errors/blob/main/CODE_OF_CONDUCT.md).
+

data/Rakefile

@@ -1,14 +1,18 @@
 # frozen_string_literal: true
 
+require "bundler/setup"
+
+APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
+load "rails/tasks/engine.rake"
+
 require "bundler/gem_tasks"
 require "rake/testtask"
+require "standard/rake"
+
+task default: %i[test standard]
 
 Rake::TestTask.new(:test) do |t|
   t.libs << "test"
   t.libs << "lib"
-  t.test_files = FileList["test/**/test_*.rb"]
+  t.test_files = FileList["test/**/*_test.rb"]
 end
-
-require "standard/rake"
-
-task default: %i[test standard]

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

data/app/mailers/solid_errors/error_mailer.rb

@@ -1,12 +1,18 @@
 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}"
+      if SolidErrors.email_subject_prefix.present?
+        subject = [SolidErrors.email_subject_prefix, subject].join(" ").squish!
+      end
       mail(
-        subject: "#{@error.severity_emoji} #{@error.exception_class}",
+        subject: subject,
         from: SolidErrors.email_from,
         to: SolidErrors.email_to
       )

data/app/models/solid_errors/backtrace_line.rb

@@ -2,7 +2,7 @@ module SolidErrors
   # adapted from: https://github.com/honeybadger-io/honeybadger-ruby/blob/master/lib/honeybadger/backtrace.rb
   class BacktraceLine
     # Backtrace line regexp (optionally allowing leading X: for windows support).
-    INPUT_FORMAT = %r{^((?:[a-zA-Z]:)?[^:]+):(\d+)(?::in `([^']+)')?$}
+    INPUT_FORMAT = %r{^((?:[a-zA-Z]:)?[^:]+):(\d+)(?::in [`']([^']+)')?$}
     STRING_EMPTY = "".freeze
     GEM_ROOT = "[GEM_ROOT]".freeze
     PROJECT_ROOT = "[PROJECT_ROOT]".freeze

data/app/models/solid_errors/occurrence.rb

@@ -3,6 +3,7 @@ module SolidErrors
     belongs_to :error, class_name: "SolidErrors::Error"
 
     after_create_commit :send_email, if: -> { SolidErrors.send_emails? && SolidErrors.email_to.present? }
+    after_create_commit :clear_resolved_errors, if: :should_clear_resolved_errors?
 
     # The parsed exception backtrace. Lines in this backtrace that are from installed gems
     # have the base path for gem installs replaced by "[GEM_ROOT]", while those in the project
@@ -23,5 +24,26 @@ module SolidErrors
     def send_email
       ErrorMailer.error_occurred(self).deliver_later
     end
+
+    def clear_resolved_errors
+      transaction do
+        SolidErrors::Occurrence
+          .where(error: SolidErrors::Error.resolved)
+          .where(created_at: ...SolidErrors.destroy_after.ago)
+          .delete_all
+        SolidErrors::Error.resolved
+          .where
+          .missing(:occurrences)
+          .delete_all
+      end
+    end
+
+    def should_clear_resolved_errors?
+      return false unless SolidErrors.destroy_after
+      return false unless SolidErrors.destroy_after.respond_to?(:ago)
+      return false unless (id % 100).zero?
+
+      true
+    end
   end
 end

data/lib/solid_errors/engine.rb

@@ -10,6 +10,11 @@ module SolidErrors
       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

data/lib/solid_errors/subscriber.rb

@@ -39,7 +39,7 @@ module SolidErrors
 
       SolidErrors::Occurrence.create(
         error_id: record.id,
-        backtrace: error.backtrace.join("\n"),
+        backtrace: error.backtrace&.join("\n"),
         context: s(context)
       )
     end

data/lib/solid_errors/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SolidErrors
-  VERSION = "0.6.1"
+  VERSION = "0.7.0"
 end

data/lib/solid_errors.rb

@@ -7,35 +7,30 @@ require_relative "solid_errors/engine"
 
 module SolidErrors
   mattr_accessor :connects_to
+  mattr_accessor :base_controller_class, default: "::ActionController::Base"
   mattr_writer :username
   mattr_writer :password
-  mattr_writer :send_emails
-  mattr_writer :email_from
-  mattr_writer :email_to
+  mattr_accessor :send_emails, default: false
+  mattr_accessor :email_from, default: "solid_errors@noreply.com"
+  mattr_accessor :email_to
+  mattr_accessor :email_subject_prefix
+  mattr_accessor :destroy_after
 
   class << self
     # use method instead of attr_accessor to ensure
-    # this works if variable set after SolidErrors is loaded
+    # this works if ENV variable set after SolidErrors is loaded
     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
+    # this works if ENV variable set after SolidErrors is loaded
     def password
       @password ||= ENV["SOLIDERRORS_PASSWORD"] || @@password
     end
 
     def send_emails?
-      @send_emails ||= ENV["SOLIDERRORS_SEND_EMAILS"] || @@send_emails || false
-    end
-
-    def email_from
-      @email_from ||= ENV["SOLIDERRORS_EMAIL_FROM"] || @@email_from || "solid_errors@noreply.com"
-    end
-
-    def email_to
-      @email_to ||= ENV["SOLIDERRORS_EMAIL_TO"] || @@email_to
+      send_emails && email_to.present?
     end
   end
 end

metadata

@@ -1,29 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: solid_errors
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.7.0
 platform: ruby
 authors:
 - Stephen Margheim
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-09-18 00:00:00.000000000 Z
+date: 2025-06-11 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: actionmailer
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '7.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '7.0'
 - !ruby/object:Gem::Dependency
   name: actionpack
   requirement: !ruby/object:Gem::Requirement
@@ -108,7 +93,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description:
 email:
 - stephen.margheim@gmail.com
 executables: []
@@ -154,7 +138,6 @@ licenses:
 metadata:
   homepage_uri: https://github.com/fractaledmind/solid_errors
   source_code_uri: https://github.com/fractaledmind/solid_errors
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -169,8 +152,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.11
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
 summary: Database-backed Rails error subscriber
 test_files: []