Add one_email_per_occurrence option and migration task

.gitignore

@@ -8,3 +8,4 @@
 /tmp/
 .DS_Store
 test/dummy/log/*.log
+.idea

README.md

@@ -135,6 +135,7 @@ 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"] = "[email protected]" # defaults to "[email protected]"
 ENV["SOLIDERRORS_EMAIL_TO"] = "[email protected]" # no default, must be set
+ENV["SOLIDERRORS_ONE_EMAIL_PER_OCCURRENCE"] = false # defaults to false
 ```
 
 Second, you can set the values via the configuration object:
@@ -144,10 +145,14 @@ Second, you can set the values via the configuration object:
 config.solid_errors.send_emails = true
 config.solid_errors.email_from = "[email protected]"
 config.solid_errors.email_to = "[email protected]"
+# Tell Solid Errors whether or not to limit the total emails per occurrence. Defaults to false.
+config.solid_errors.one_email_per_occurrence = true
 ```
 
 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.
 
+If you have set `send_emails` to `true` and have set `one_email_per_occurrence` to `true`, Solid Errors will only send an email notification after the first occurrence of a new error or the first reoccurrence of a previously resolved error. If you have not set `one_email_per_occurrence` to `true`, Solid Errors will send an email notification for each occurrence of an error.
+
 ### Examples
 
 There are only two screens in the dashboard.

app/models/solid_errors/occurrence.rb

@@ -2,7 +2,7 @@ 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? }
+    after_create_commit :send_email, if: :should_send_email?
 
     # 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 +23,16 @@ def parse_backtrace(backtrace)
     def send_email
       ErrorMailer.error_occurred(self).deliver_later
     end
+
+    def should_send_email?
+      SolidErrors.send_emails? && SolidErrors.email_to.present? && under_limit?
+    end
+
+    def under_limit?
+      return true if error.occurrences.count == 1
+      return true if !SolidErrors.one_email_per_occurrence
+
+      error.occurrences.where(created_at: error.prev_resolved_at..).one?
+    end
   end
 end

lib/solid_errors.rb

@@ -10,6 +10,7 @@ module SolidErrors
   mattr_writer :username
   mattr_writer :password
   mattr_writer :send_emails
+  mattr_writer :one_email_per_occurrence
   mattr_writer :email_from
   mattr_writer :email_to
 
@@ -30,6 +31,12 @@ def send_emails?
       @send_emails ||= ENV["SOLIDERRORS_SEND_EMAILS"] || @@send_emails || false
     end
 
+    # only send one email per occurrence while the issue is Unresolved
+    # if the issue was resolved and then reoccurs, another email will be sent
+    def one_email_per_occurrence
+      @one_email_per_occurrence ||= ENV["SOLIDERRORS_ONE_EMAIL_PER_OCCURRENCE"] || @@one_email_per_occurrence || false
+    end
+
     def email_from
       @email_from ||= ENV["SOLIDERRORS_EMAIL_FROM"] || @@email_from || "[email protected]"
     end

lib/solid_errors/db/migrate/20240716154238_add_prev_resolved_at_to_solid_errors.rb

@@ -0,0 +1,5 @@
+class AddPrevResolvedAtToSolidErrors < ActiveRecord::Migration[6.1]
+  def change
+    add_column :solid_errors, :prev_resolved_at, :datetime
+  end
+end

lib/solid_errors/subscriber.rb

@@ -32,7 +32,7 @@ def report(error, handled:, severity:, context:, source: nil)
       }
       fingerprint = Digest::SHA256.hexdigest(error_attributes.values.join)
       if (record = SolidErrors::Error.find_by(fingerprint: fingerprint))
-        record.update!(resolved_at: nil, updated_at: Time.now)
+        record.update!(prev_resolved_at: record.resolved_at, resolved_at: nil, updated_at: Time.now)
       else
         record = SolidErrors::Error.create!(error_attributes.merge(fingerprint: fingerprint))
       end

lib/tasks/solid_errors_tasks.rake

@@ -0,0 +1,25 @@
+namespace :solid_errors do
+  desc "Copy and run migrations from Solid Errors"
+  task install_migrations: :environment do
+    source = File.expand_path("../../solid_errors/db/migrate", __FILE__)
+    destination = File.join(Rails.root, "db", "migrate")
+
+    Dir.glob("#{source}/*.rb").each do |migration|
+      filename = File.basename(migration)
+      unless File.exist?(File.join(destination, filename))
+        puts "Copying #{filename} from Solid Errors to Rails application"
+        FileUtils.cp(migration, destination)
+      end
+    end
+    # this could be a way to "force" a migration to run in the future but
+    # the more thought into this, it seems too rigid and hard-coded
+    # Plus, after we copy the migration over, Rails will alert a user
+    # to run migrations/there are pending migrations.
+    # Set version for our specific migration
+    # ENV["VERSION"] = "20240716154238"
+    # Run just our specific migration file
+    # Rake::Task["db:migrate:up"].invoke
+    # Now clear that!
+    # ENV["VERSION"] = nil
+  end
+end

solid_errors.gemspec

@@ -34,4 +34,6 @@ Gem::Specification.new do |spec|
 
   # For more information and examples about making a new gem, check out our
   # guide at: https://bundler.io/guides/creating_gem.html
+
+  spec.post_install_message = "Remember to run `rails solid_errors:install_migrations` to copy *and* run new migrations."
 end