solid_errors 0.3.4 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a034955a760c572f2e8e317e1120eed78d92a0fe1a55cae7f96e571c66ef00cd
-  data.tar.gz: 8d7490b0198ee2e899c712c749a9e907755df31c3a900a51f21db5d089267ea7
+  metadata.gz: b0f7fa69e2efa8949c085b3ba7b72b407dd3d670643c76260a6f8addf836305f
+  data.tar.gz: f931d1de445d5d3fe124dc352e2a81513d174d37ed6ae923122e95e2468ccc7e
 SHA512:
-  metadata.gz: 9f674d6137d43517bc2c984c49bef87b521cc8fd72001f0d7fc6c14ac9072bd5a944af1f78ee06a74f10e0793db5187015d995915fda37bf5ed6f9e4f2314ea8
-  data.tar.gz: 39b0a00ec120b2d2a4c80b7602cacbc18ce97ad268cba8a62426d4c77c593ca7d10d7af18bb54c768530f2f7fe6999bdff76e533db74c7adc2680c2104d19f24
+  metadata.gz: 3a2eb10327f7a11569d1cc90f2418bd28252d177b23c329c8a4105b2cb22a4fa17e36b44dbe5f1f341c222de2be9ba149fb4ce6e308b5c6aa99b1160de678b83
+  data.tar.gz: 52f3d7fd1669173da1ce9155370d92bae1678c4ae4326c2637e026c93cc9eeb84e091c587f8322fd6b9f9228c79f31262c0cd9b42be98d65837004754efc2ec3

data/README.md

@@ -30,22 +30,28 @@ Solid Errors is a DB-based, app-internal exception tracker for Rails application
 ## Installation
 
 Install the gem and add to the application's Gemfile by executing:
-
-    $ bundle add solid_errors
+```bash
+$ bundle add solid_errors
+```
 
 If bundler is not being used to manage dependencies, install the gem by executing:
-
-    $ gem install solid_errors
+```bash
+$ gem install solid_errors
+```
 
 After installing the gem, run the installer:
-
-    $ rails generate solid_errors:install
+```bash
+$ rails generate solid_errors:install
+```
 
 This will copy the required migration over to your app.
 
-Then mount the engine in your config/routes.rb file
-
-    mount SolidErrors::Engine, at: "/solid_errors"
+Then mount the engine in your `config/routes.rb` file:
+```ruby
+authenticate :user, -> (user) { user.admin? } do
+  mount SolidErrors::Engine, at: "/solid_errors"
+end
+```
 
 > [!NOTE]
 > Be sure to [secure the dashboard](#authentication) in production.
@@ -60,11 +66,14 @@ There are intentionally few features; you can view and resolve errors. That’s
 
 ### Configuration
 
-You can configure Solid Errors via the Rails configuration object, under the `solid_errors` key. Currently, only 3 configuration options are available:
+You can configure Solid Errors via the Rails configuration object, under the `solid_errors` key. Currently, 6 configuration options are available:
 
 * `connects_to` - The database configuration to use for the Solid Errors database. See [Database Configuration](#database-configuration) for more information.
 * `username` - The username to use for HTTP authentication. See [Authentication](#authentication) for more information.
 * `password` - The password to use for HTTP authentication. See [Authentication](#authentication) for more information.
+* `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.
 
 #### Database Configuration
 
@@ -103,7 +112,7 @@ config.solid_errors.password = Rails.application.credentials.solid_errors.passwo
 
 Either way, if you have set a username and password, Solid Errors will use basic HTTP authentication. If you have not set a username and password, Solid Errors will not require any authentication to view the dashboard.
 
-If you use Devise for authenctication in your app, you can also restrict access to the dashboard by using their `authenticate` contraint in your routes file:
+If you use Devise for authentication in your app, you can also restrict access to the dashboard by using their `authenticate` constraint in your routes file:
 
 ```ruby
 authenticate :user, -> (user) { user.admin? } do
@@ -111,6 +120,29 @@ authenticate :user, -> (user) { user.admin? } do
 end
 ```
 
+#### 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.
+
+There are two ways to configure email notifications. First, you can use environment variables:
+
+```ruby
+ENV["SOLIDERRORS_SEND_EMAILS"] = true # defaults to true
+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
+```
+
+Second, you can set the values via the configuration object:
+
+```ruby
+# Set authentication credentials 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"
+```
+
+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.
+
 ### Examples
 
 There are only two screens in the dashboard.
@@ -123,6 +155,76 @@ There are only two screens in the dashboard.
 
 ![image description](images/show-screenshot.png)
 
+### Usage with API-only Applications
+
+If your Rails application is an API-only application (generated with the `rails new --api` command), you will need to add the following middleware to your `config/application.rb` file in order to use the dashboard UI provided by Solid Errors:
+
+```ruby
+# /config/application.rb
+config.middleware.use ActionDispatch::Cookies
+config.middleware.use ActionDispatch::Session::CookieStore
+config.middleware.use ActionDispatch::Flash
+```
+
+### Overwriting the views
+
+You can find the views in [`app/views`](https://github.com/fractaledmind/solid_errors/tree/main/app/views).
+
+```bash
+app/views/
+├── layouts
+│   └── solid_errors
+│       ├── _style.html
+│       └── application.html.erb
+└── solid_errors
+    ├── error_mailer
+    │   ├── error_occurred.html.erb
+    │   └── error_occurred.text.erb
+    ├── errors
+    │   ├── _actions.html.erb
+    │   ├── _error.html.erb
+    │   ├── _row.html.erb
+    │   ├── index.html.erb
+    │   └── show.html.erb
+    └── occurrences
+        ├── _collection.html.erb
+        └── _occurrence.html.erb
+```
+
+You can always take control of the views by creating your own views and/or partials at these paths in your application. For example, if you wanted to overwrite the application layout, you could create a file at `app/views/layouts/solid_errors/application.html.erb`. If you wanted to remove the footer and the automatically disappearing flash messages, as one concrete example, you could define that file as:
+
+```erb
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>Solid Errors</title>
+    <%= csrf_meta_tags %>
+    <%= csp_meta_tag %>
+
+    <%= render "layouts/solid_errors/style" %>
+  </head>
+  <body class="pb-4">
+    <main class="container mx-auto mt-4">
+      <%= content_for?(:content) ? yield(:content) : yield %>
+    </main>
+
+    <div class="fixed top-0 left-0 right-0 text-center py-2">
+      <% if notice.present? %>
+        <p class="py-2 px-3 bg-green-50 text-green-500 font-medium rounded-lg inline-block">
+          <%= notice %>
+        </p>
+      <% end %>
+
+      <% if alert.present? %>
+        <p class="py-2 px-3 bg-red-50 text-red-500 font-medium rounded-lg inline-block">
+          <%= alert %>
+        </p>
+      <% end %>
+    </div>
+  </body>
+</html>
+```
+
 ## 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.

data/app/controllers/solid_errors/application_controller.rb

@@ -3,5 +3,25 @@ module SolidErrors
     protect_from_forgery with: :exception
 
     http_basic_authenticate_with name: SolidErrors.username, password: SolidErrors.password if SolidErrors.password
+
+    # adapted from: https://github.com/ddnexus/pagy/blob/master/gem/lib/pagy.rb
+    OverflowError = Class.new(StandardError)
+    class Page
+      attr_reader :count, :items, :pages, :first, :last, :prev, :next, :offset, :from, :to
+
+      def initialize(collection, params)
+        @count = collection.count
+        @items = (params[:items] || 20).to_i
+        @pages = [(@count.to_f / @items).ceil, 1].max
+        @page = ((page = (params[:page] || 1).to_i) > @pages) ? @pages : page
+        @first = (1 unless @page == 1)
+        @last = (@pages unless @page == @pages)
+        @prev = (@page - 1 unless @page == 1)
+        @next = (@page == @pages) ? nil : @page + 1
+        @offset = (@items * (@page - 1))
+        @from = [@offset + 1, @count].min
+        @to = [@offset + @items, @count].min
+      end
+    end
   end
 end

data/app/controllers/solid_errors/errors_controller.rb

@@ -1,5 +1,7 @@
 module SolidErrors
   class ErrorsController < ApplicationController
+    around_action :force_english_locale!
+
     before_action :set_error, only: %i[show update]
 
     # GET /errors
@@ -9,13 +11,17 @@ module SolidErrors
 
       @errors = Error.unresolved
         .joins(:occurrences)
-        .select(errors_table[Arel.star], occurrences_table[:created_at].maximum.as("recent_occurrence"))
+        .select(errors_table[Arel.star],
+          occurrences_table[:created_at].maximum.as("recent_occurrence"),
+          occurrences_table[:id].count.as("occurrences_count"))
         .group(errors_table[:id])
         .order(recent_occurrence: :desc)
     end
 
     # GET /errors/1
     def show
+      @page = Page.new(@error.occurrences, params)
+      @occurrences = @error.occurrences.offset(@page.offset).limit(@page.items)
     end
 
     # PATCH/PUT /errors/1
@@ -34,5 +40,9 @@ module SolidErrors
     def set_error
       @error = Error.find(params[:id])
     end
+
+    def force_english_locale!(&action)
+      I18n.with_locale(:en, &action)
+    end
   end
 end

data/app/mailers/solid_errors/error_mailer.rb

@@ -0,0 +1,15 @@
+module SolidErrors
+  # adapted from: https://github.com/codergeek121/email_error_reporter/blob/main/lib/email_error_reporter/error_mailer.rb
+  class ErrorMailer < ActionMailer::Base
+    def error_occurred(occurrence)
+      @occurrence = occurrence
+      @error = occurrence.error
+
+      mail(
+        subject: "#{@error.emoji} #{@error.exception_class}",
+        from: SolidErrors.email_from,
+        to: SolidErrors.email_to
+      )
+    end
+  end
+end

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 `([^']+)')?$}.freeze
+    INPUT_FORMAT = %r{^((?:[a-zA-Z]:)?[^:]+):(\d+)(?::in `([^']+)')?$}
     STRING_EMPTY = "".freeze
     GEM_ROOT = "[GEM_ROOT]".freeze
     PROJECT_ROOT = "[PROJECT_ROOT]".freeze
@@ -29,7 +29,7 @@ module SolidErrors
     attr_reader :file
     attr_reader :number
     attr_reader :method
-    attr_reader :filtered_file, :filtered_number, :filtered_method
+    attr_reader :filtered_file, :filtered_number, :filtered_method, :unparsed_line
 
     # Parses a single line of a given backtrace
     #
@@ -47,13 +47,14 @@ module SolidErrors
 
         file, number, method = match[1], match[2], match[3]
         filtered_args = [fmatch[1], fmatch[2], fmatch[3]]
-        new(file, number, method, *filtered_args, opts.fetch(:source_radius, 2))
+        new(unparsed_line, file, number, method, *filtered_args, opts.fetch(:source_radius, 2))
       end
     end
 
-    def initialize(file, number, method, filtered_file = file,
+    def initialize(unparsed_line, file, number, method, filtered_file = file,
       filtered_number = number, filtered_method = method,
       source_radius = 2)
+      self.unparsed_line = unparsed_line
       self.filtered_file = filtered_file
       self.filtered_number = filtered_number
       self.filtered_method = filtered_method
@@ -87,7 +88,7 @@ module SolidErrors
 
     private
 
-    attr_writer :file, :number, :method, :filtered_file, :filtered_number, :filtered_method
+    attr_writer :file, :number, :method, :filtered_file, :filtered_number, :filtered_method, :unparsed_line
 
     attr_accessor :source_radius
 

data/app/models/solid_errors/occurrence.rb

@@ -2,6 +2,8 @@ module SolidErrors
   class Occurrence < Record
     belongs_to :error, class_name: "SolidErrors::Error"
 
+    after_create_commit :send_email, if: -> { SolidErrors.send_emails? && SolidErrors.email_to.present? }
+
     # 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
     # have "[PROJECT_ROOT]".
@@ -17,5 +19,9 @@ module SolidErrors
     def parse_backtrace(backtrace)
       Backtrace.parse(backtrace)
     end
+
+    def send_email
+      ErrorMailer.error_occurred(self).deliver_later
+    end
   end
 end