[refactor] Migrate from Sidekiq workers to ActiveJob jobs (#153)

* [refactor] Migrate from Sidekiq workers to ActiveJob jobs

Fixes #26

* Clean up mailer exception handling

Author: sman591

Guardfile

@@ -5,7 +5,7 @@ guard :minitest, all_on_start: false, all_after_pass: false, spring: "bin/rails
   watch(%r{^app/mailers/(.+)\.rb$})                              { |m| "test/controllers/#{m[1]}_test.rb" }
   watch(%r{^app/controllers/(.+)\.rb$})                          { |m| "test/controllers/#{m[1]}_test.rb" }
   watch(%r{^app/views/(.+)\/.+$})                                { |m| "test/controllers/#{m[1]}_controller_test.rb" }
-  watch(%r{^app/workers/(.+)\.rb$})                              { |m| "test/workers/#{m[1]}_test.rb" }
+  watch(%r{^app/jobs/(.+)\.rb$})                                 { |m| "test/jobs/#{m[1]}_test.rb" }
   watch(%r{^app/views/layouts/.+$})                              { "test/controllers" }
   watch(%r{^app/views/.+\.rb$})                                  { "test/integration" }
   watch(%r{^test/.+_test.rb$})

app/controllers/manage/messages_controller.rb

@@ -52,7 +52,7 @@ def deliver
       return redirect_to manage_messages_path
     end
     @message.update_attribute(:queued_at, Time.now)
-    BulkMessageWorker.perform_async(@message.id)
+    BulkMessageJob.perform_later(@message)
     flash[:notice] = "Message queued for delivery"
     redirect_to manage_message_path(@message)
   end

app/workers/bulk_message_worker.rb renamed to app/jobs/bulk_message_job.rb

@@ -1,16 +1,15 @@
-class BulkMessageWorker
-  include Sidekiq::Worker
+class BulkMessageJob < ApplicationJob
+  queue_as :default
 
-  def perform(message_id)
-    message = Message.find(message_id)
-    return unless message.present? && message.status == "queued"
+  def perform(message)
+    return unless message.status == "queued"
 
     message.update_attribute(:started_at, Time.now)
 
     recipients = self.class.build_recipients(message.recipients)
 
     recipients.each do |recipient|
-      Mailer.delay.bulk_message_email(message.id, recipient)
+      Mailer.bulk_message_email(message.id, recipient).deliver_later
     end
 
     message.update_attribute(:delivered_at, Time.now)

app/mailers/mailer.rb

@@ -23,24 +23,18 @@ def incomplete_reminder_email(user_id)
     Message.queue_for_trigger("user.24hr_incomplete_application", @user.id)
   end
 
+  rescue_from SparkPostRails::DeliveryException do |e|
+    error_codes_to_not_retry = [
+      "1902" # Generation rejection
+    ]
+    raise e unless e.blank? || error_codes_to_not_retry.include?(e.service_code)
+  end
+
   private
 
   def pretty_email(name, email)
     return email if name.blank?
 
     "\"#{name}\" <#{email}>"
   end
-
-  def mail_questionnaire(subject, sparkpost_data = {})
-    mail(
-      to: pretty_email(@questionnaire.full_name, @questionnaire.user.email),
-      subject: subject,
-      sparkpost_data: sparkpost_data
-    )
-  rescue SparkPostRails::DeliveryException => e
-    error_code_to_not_retry = [
-      "1902" # Generation rejection
-    ]
-    raise e unless e.blank? || error_code_to_not_retry.include?(e.service_code)
-  end
 end

app/models/message.rb

@@ -171,7 +171,7 @@ def self.for_trigger(trigger)
   end
 
   def self.queue_for_trigger(trigger, user_id)
-    for_trigger(trigger).map { |message| Mailer.delay.bulk_message_email(message.id, user_id) }
+    for_trigger(trigger).map { |message| Mailer.bulk_message_email(message.id, user_id).deliver_later }
   end
 
   def self.bulk

app/models/user.rb

@@ -32,7 +32,7 @@ def send_devise_notification(notification, *args)
 
   def queue_reminder_email
     return if reminder_sent_at
-    Mailer.delay_for(1.day).incomplete_reminder_email(id)
+    Mailer.incomplete_reminder_email(id).deliver_later(wait: 1.day)
     update_attribute(:reminder_sent_at, Time.now)
   end
 

app/views/manage/messages/show.html.haml

@@ -1,6 +1,6 @@
 :ruby
   begin
-    recipient_count = pluralize(BulkMessageWorker.build_recipients(@message.recipients).count, "recipient")
+    recipient_count = pluralize(BulkMessageJob.build_recipients(@message.recipients).count, "recipient")
   rescue => recipient_error
   end
 

config/environments/development.rb

@@ -31,7 +31,7 @@
   config.active_storage.service = :local
 
   # Don't care if the mailer can't send.
-  config.action_mailer.raise_delivery_errors = false
+  config.action_mailer.raise_delivery_errors = true
 
   # MailCatcher
   config.action_mailer.delivery_method = :smtp

config/environments/production.rb

@@ -67,7 +67,7 @@
 
   # Ignore bad email addresses and do not raise email delivery errors.
   # Set this to true and configure the email server for immediate delivery to raise delivery errors.
-  # config.action_mailer.raise_delivery_errors = false
+  config.action_mailer.raise_delivery_errors = true
 
   # Enable locale fallbacks for I18n (makes lookups for any locale fall back to
   # the I18n.default_locale when a translation cannot be found).

config/initializers/devise.rb

@@ -13,7 +13,7 @@
   # Configure the e-mail address which will be shown in Devise::Mailer,
   # note that it will be overwritten if you use your own mailer class
   # with default "from" parameter.
-  config.mailer_sender = -> { HackathonConfig['email_from'] }
+  config.mailer_sender = ->(_) { HackathonConfig['email_from'] }
 
   # Configure the class responsible to send e-mails.
   # config.mailer = 'Devise::Mailer'