email_error_reporter 0.1.0.pre

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3b5bd625697e275051c8d51cee4ccbbe14faf8aa2cf2a09c18c225292d7dbf52
+  data.tar.gz: 762d0ec2963ea8fe672a35732699a02c0d9da507b10e5cd100b2d5ea48650f04
+SHA512:
+  metadata.gz: '0824b30d48460da923cadca8d6cb3ef9a2f3ec60f1ce1bba25a45cedc7c610331c477ea022a1929fc80091e4edf7bb3d5d0f02460b91488c7f0dfcac17166467'
+  data.tar.gz: 5dd1577971dbcd095b4a3a4658433c98cd850a07c2521dae1bf0e9d513da36370ddc9ab6866f0c1fc14c4be7b81da03b3d596a795866eaefa314fe77dee03f58

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright Niklas Haeusele
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,43 @@
+# EmailErrorReporter
+
+> [!CAUTION]
+> This is a very early prototype
+
+`email_error_reporter` uses the new [Rails error reporting API](https://guides.rubyonrails.org/error_reporting.html#error-reporting) to send emails whenever an exception is being reported. It works out of the box with HTTP requests, jobs and the rails runner.
+
+## Installation
+
+Add the gem:
+
+```bash
+bundle add email_error_reporter && bundle install
+```
+
+and configure the email addresses that should receive an email in the case of an exception:
+
+```ruby
+# application.rb
+config.email_error_reporter.to = ["youremail@example.com"]
+```
+
+`email_error_reporter` will reuse your environment specific ActionMailer configuration for delivering emails.
+
+## Usage
+
+All exceptions are reported automatically. No additional code required.
+
+Please consult the [official guides](https://guides.rubyonrails.org/error_reporting.html) for an introduction to the error reporting API.
+
+## Test your setup
+
+You can use the built-in rake task `rake email_error_reporter:check` to check if everything works correctly in your setup.
+
+If you're using Kamal, you can run the following command to test the setup in production:
+
+```
+kamal app exec -p 'bundle exec rake email_error_reporter:test_email'
+```
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,3 @@
+require "bundler/setup"
+
+require "bundler/gem_tasks"

data/app/views/email_error_reporter/error_mailer/_frame.html.erb

@@ -0,0 +1 @@
+<li><%= frame %></li>

data/app/views/email_error_reporter/error_mailer/_no_backtrace.html.erb

@@ -0,0 +1 @@
+<p>No backtrace available</p>

data/app/views/email_error_reporter/error_mailer/error.html.erb

@@ -0,0 +1,6 @@
+<h1><%= @error.class %></h1>
+<p><%= @error.message %></p>
+
+<div>
+<%= render(partial: "frame", collection: @backtrace) || render("no_backtrace") -%>
+</div>

data/lib/email_error_reporter/engine.rb

@@ -0,0 +1,17 @@
+module EmailErrorReporter
+  class Engine < ::Rails::Engine
+    isolate_namespace EmailErrorReporter
+
+    config.email_error_reporter = ActiveSupport::OrderedOptions.new
+    config.email_error_reporter.to = []
+
+    initializer "email_error_reporter.error_subscribe" do
+      Rails.error.subscribe(Subscriber.new)
+    end
+
+    # ActiveJob cannot (de)-serialize exceptions by default
+    initializer "email_error_reporter.exception_serializer" do |app|
+      app.config.active_job.custom_serializers << ExceptionSerializer
+    end
+  end
+end

data/lib/email_error_reporter/error_mailer.rb

@@ -0,0 +1,18 @@
+module EmailErrorReporter
+  class ErrorMailer < ActionMailer::Base
+    def error(error, handled:, severity:, context:, source: nil)
+      @error = error
+      @handled = handled
+      @severity = severity
+      @context = context
+      @source = source
+
+      @backtrace = Array.wrap(error.backtrace)
+
+      mail(
+        subject: "#{error.class}",
+        to: Rails.application.config.email_error_reporter.to
+      )
+    end
+  end
+end

data/lib/email_error_reporter/exception_serializer.rb

@@ -0,0 +1,23 @@
+module EmailErrorReporter
+  class ExceptionSerializer < ActiveJob::Serializers::ObjectSerializer
+    def serialize(exception)
+      super(
+        exception_class: exception.class.to_s,
+        message: exception.message,
+        backtrace: exception.backtrace
+      )
+    end
+
+    def deserialize(hash)
+      hash[:exception_class].constantize.new(hash[:message]).tap do |e|
+        e.set_backtrace(hash[:backtrace])
+      end
+    end
+
+    private
+
+    def klass
+      Exception
+    end
+  end
+end

data/lib/email_error_reporter/subscriber.rb

@@ -0,0 +1,11 @@
+module EmailErrorReporter
+  class Subscriber
+    def report(error, handled:, severity:, context:, source: nil)
+      ErrorMailer.error(error, 
+        handled: handled,
+        context: context,
+        severity: severity,
+        source: source).deliver_later
+    end
+  end
+end

data/lib/email_error_reporter/version.rb

@@ -0,0 +1,3 @@
+module EmailErrorReporter
+  VERSION = "0.1.0.pre"
+end

data/lib/email_error_reporter.rb

@@ -0,0 +1,10 @@
+require "email_error_reporter/version"
+require "email_error_reporter/engine"
+
+module EmailErrorReporter
+  extend ActiveSupport::Autoload
+
+  autoload :ErrorMailer
+  autoload :Subscriber
+  autoload :ExceptionSerializer
+end

data/lib/tasks/email_error_reporter_tasks.rake

@@ -0,0 +1,12 @@
+desc "Report a test exception"
+namespace :email_error_reporter do
+  task check: :environment do
+    Rails.error.handle { raise "This is a test!" }
+    $stdout.puts <<~TXT
+      Test exception triggered.
+
+      Recipients:
+      #{Rails.application.config.email_error_reporter.to.join("\n").gsub(/^/, "* ")}
+    TXT
+  end
+end

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification
+name: email_error_reporter
+version: !ruby/object:Gem::Version
+  version: 0.1.0.pre
+platform: ruby
+authors:
+- Niklas Haeusele
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-01-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.1.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.1.2
+description: Report your Rails errors via email.
+email:
+- niklas.haeusele@hey.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/views/email_error_reporter/error_mailer/_frame.html.erb
+- app/views/email_error_reporter/error_mailer/_no_backtrace.html.erb
+- app/views/email_error_reporter/error_mailer/error.html.erb
+- lib/email_error_reporter.rb
+- lib/email_error_reporter/engine.rb
+- lib/email_error_reporter/error_mailer.rb
+- lib/email_error_reporter/exception_serializer.rb
+- lib/email_error_reporter/subscriber.rb
+- lib/email_error_reporter/version.rb
+- lib/tasks/email_error_reporter_tasks.rake
+homepage: https://github.com/codergeek121/email_error_reporter
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/codergeek121/email_error_reporter
+  source_code_uri: https://github.com/codergeek121/email_error_reporter
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.3
+signing_key:
+specification_version: 4
+summary: Report your Rails errors via email.
+test_files: []