Merge pull request #1929 from alphagov/theseanything/revert-revert-make-confirmation-emails-async

Reintroduce making sending confirmation emails async

Author: theseanything

app/jobs/send_confirmation_email_job.rb

@@ -0,0 +1,37 @@
+class SendConfirmationEmailJob < ApplicationJob
+  queue_as :confirmation_emails
+  MailerOptions = Data.define(:title, :is_preview, :timestamp, :submission_reference, :payment_url)
+
+  def perform(submission:, notify_response_id:, confirmation_email_address:)
+    set_submission_logging_attributes(submission:)
+
+    I18n.with_locale(submission.submission_locale || I18n.default_locale) do
+      form = submission.form
+      mail = FormSubmissionConfirmationMailer.send_confirmation_email(
+        what_happens_next_markdown: form.what_happens_next_markdown,
+        support_contact_details: form.support_details,
+        notify_response_id:,
+        confirmation_email_address:,
+        mailer_options: mailer_options_for(submission:, form:),
+      )
+
+      mail.deliver_now
+      CurrentJobLoggingAttributes.confirmation_email_id = mail.govuk_notify_response.id
+    end
+  rescue StandardError
+    CloudWatchService.record_job_failure_metric(self.class.name)
+    raise
+  end
+
+private
+
+  def mailer_options_for(submission:, form:)
+    MailerOptions.new(
+      title: form.name,
+      is_preview: submission.preview?,
+      timestamp: submission.submission_time,
+      submission_reference: submission.reference,
+      payment_url: submission.payment_url,
+    )
+  end
+end

app/models/current_job_logging_attributes.rb

@@ -7,6 +7,7 @@ class CurrentJobLoggingAttributes < ActiveSupport::CurrentAttributes
             :preview,
             :delivery_id,
             :delivery_reference,
+            :confirmation_email_id,
             :sqs_message_id,
             :sns_message_timestamp
 
@@ -20,6 +21,7 @@ def as_hash
       preview: preview.to_s,
       delivery_id:,
       delivery_reference:,
+      confirmation_email_id:,
       sqs_message_id:,
       sns_message_timestamp:,
     }.compact_blank

app/models/current_request_logging_attributes.rb

@@ -12,7 +12,6 @@ class CurrentRequestLoggingAttributes < ActiveSupport::CurrentAttributes
             :question_number,
             :submission_reference,
             :confirmation_email_reference,
-            :confirmation_email_id,
             :rescued_exception,
             :rescued_exception_trace,
             :validation_errors,
@@ -33,7 +32,6 @@ def as_hash
       question_number:,
       submission_reference:,
       confirmation_email_reference:,
-      confirmation_email_id:,
       rescued_exception:,
       rescued_exception_trace:,
       validation_errors:,

app/services/form_submission_service.rb

@@ -24,11 +24,12 @@ def initialize(current_context:, email_confirmation_input:, mode:)
 
   def submit
     ensure_form_english
+
     validate_submission
+    validate_confirmation_email_address if requested_confirmation?
 
-    confirmation_mail = setup_confirmation_email if requested_confirmation?
-    deliver_submission
-    send_confirmation_email(confirmation_mail) if confirmation_mail.present?
+    submission = deliver_submission
+    enqueue_send_confirmation_email_job(submission:) if requested_confirmation?
 
     submission_reference
   end
@@ -58,14 +59,15 @@ def validate_submission
   end
 
   def deliver_submission
-    case form.submission_type
-    when "s3"
-      enqueue_deliver_submission_job(SendS3SubmissionJob)
-    when "email"
-      enqueue_deliver_submission_job(SendSubmissionJob)
-    else
-      raise "unrecognized submission delivery method #{form.submission_type.inspect}"
-    end
+    submission =
+      case form.submission_type
+      when "s3"
+        enqueue_deliver_submission_job(SendS3SubmissionJob)
+      when "email"
+        enqueue_deliver_submission_job(SendSubmissionJob)
+      else
+        raise "unrecognized submission delivery method #{form.submission_type.inspect}"
+      end
 
     LogEventService.log_submit(
       current_context,
@@ -74,6 +76,8 @@ def deliver_submission
       submission_type: form.submission_type,
       submission_format: form.submission_format,
     )
+
+    submission
   end
 
   def create_submission_record
@@ -102,47 +106,38 @@ def enqueue_deliver_submission_job(job_class)
       message_suffix = ": #{job.enqueue_error&.message}" if job.enqueue_error
       raise StandardError, "Failed to enqueue submission for reference #{submission_reference}#{message_suffix}"
     end
+
+    submission
   end
 
   def submission_timestamp
     time_zone = Rails.configuration.x.submission.time_zone || "UTC"
     Time.use_zone(time_zone) { Time.zone.now }
   end
 
-  def setup_confirmation_email
-    mail = FormSubmissionConfirmationMailer.send_confirmation_email(
-      what_happens_next_markdown: form.what_happens_next_markdown,
-      support_contact_details: form.support_details,
-      notify_response_id: email_confirmation_input.confirmation_email_reference,
-      confirmation_email_address: email_confirmation_input.confirmation_email_address,
-      mailer_options:,
-    )
+  def validate_confirmation_email_address
+    mail = Mail.new(to: email_confirmation_input.confirmation_email_address)
+    to_address_error = mail.errors.select { |error| error[0] == "To" }.first
+    return unless to_address_error
 
-    if mail.message.errors.any?
-      to_address_error = mail.message.errors.select { |error| error[0] == "To" }.first
-      if to_address_error
-        redacted_error = redact_emails_from_sentry_message(to_address_error[2].to_s)
-        Sentry.capture_message("ActionMailer error for To email address in confirmation email", extra: {
-          action_mailer_error: redacted_error,
-        })
-        raise ConfirmationEmailToAddressError
-      end
-    end
-
-    mail
+    redacted_error = redact_emails_from_sentry_message(to_address_error[2].to_s)
+    Sentry.capture_message("ActionMailer error for To email address in confirmation email", extra: {
+      action_mailer_error: redacted_error,
+    })
+    raise ConfirmationEmailToAddressError
   end
 
-  def send_confirmation_email(mail)
-    mail.deliver_now
-    CurrentRequestLoggingAttributes.confirmation_email_id = mail.govuk_notify_response.id
-  end
+  def enqueue_send_confirmation_email_job(submission:)
+    SendConfirmationEmailJob.perform_later(
+      submission:,
+      notify_response_id: email_confirmation_input.confirmation_email_reference,
+      confirmation_email_address: email_confirmation_input.confirmation_email_address,
+    ) do |job|
+      next if job.successfully_enqueued?
 
-  def mailer_options
-    MailerOptions.new(title: form.name,
-                      is_preview: mode.preview?,
-                      timestamp: timestamp,
-                      submission_reference: submission_reference,
-                      payment_url: form.payment_url_with_reference(submission_reference))
+      message_suffix = ": #{job.enqueue_error&.message}" if job.enqueue_error
+      raise StandardError, "Failed to enqueue confirmation email for reference #{submission_reference}#{message_suffix}"
+    end
   end
 
   def requested_confirmation?

spec/jobs/send_confirmation_email_job_spec.rb

@@ -0,0 +1,112 @@
+require "rails_helper"
+
+RSpec.describe SendConfirmationEmailJob, type: :job do
+  let(:submission_created_at) { Time.utc(2022, 12, 14, 13, 0o0, 0o0) }
+  let(:form_document) do
+    build(
+      :v2_form_document,
+      name: "Form 1",
+      what_happens_next_markdown: "Please wait for a response",
+      support_phone: "0203 222 2222",
+      support_email: "help@example.gov.uk",
+      support_url: "https://example.gov.uk/help",
+      support_url_text: "Get help",
+      payment_url: "https://www.gov.uk/payments/test-service/pay-for-licence",
+    )
+  end
+  let(:submission) do
+    create(
+      :submission,
+      form_document:,
+      created_at: submission_created_at,
+      reference: "ABC12345",
+      submission_locale: "en",
+    )
+  end
+  let(:notify_response_id) { "confirmation-ref" }
+  let(:confirmation_email_address) { "testing@gov.uk" }
+
+  before do
+    Settings.govuk_notify.form_filler_confirmation_email_template_id = "123456"
+    Settings.govuk_notify.form_filler_confirmation_email_welsh_template_id = "7891011"
+  end
+
+  it "sends the confirmation email" do
+    expect {
+      described_class.perform_now(
+        submission:,
+        notify_response_id:,
+        confirmation_email_address:,
+      )
+    }.to change(ActionMailer::Base.deliveries, :count).by(1)
+
+    mail = ActionMailer::Base.deliveries.last
+    expect(mail.to).to eq(["testing@gov.uk"])
+  end
+
+  it "builds mailer arguments from the submission" do
+    allow(FormSubmissionConfirmationMailer).to receive(:send_confirmation_email).and_call_original
+
+    described_class.perform_now(
+      submission:,
+      notify_response_id:,
+      confirmation_email_address:,
+    )
+
+    expect(FormSubmissionConfirmationMailer).to have_received(:send_confirmation_email).with(
+      what_happens_next_markdown: "Please wait for a response",
+      support_contact_details: have_attributes(
+        phone: "0203 222 2222",
+        call_charges_url: "https://www.gov.uk/call-charges",
+        email: "help@example.gov.uk",
+        url: "https://example.gov.uk/help",
+        url_text: "Get help",
+      ),
+      notify_response_id: "confirmation-ref",
+      confirmation_email_address: "testing@gov.uk",
+      mailer_options: an_instance_of(SendConfirmationEmailJob::MailerOptions),
+    )
+  end
+
+  context "when locale is Welsh" do
+    it "uses the Welsh template" do
+      submission.update!(submission_locale: "cy")
+      described_class.perform_now(
+        submission:,
+        notify_response_id:,
+        confirmation_email_address:,
+      )
+
+      mail = ActionMailer::Base.deliveries.last
+      expect(mail.govuk_notify_template).to eq("7891011")
+    end
+  end
+
+  context "when there is an error during processing" do
+    before do
+      allow(FormSubmissionConfirmationMailer).to receive(:send_confirmation_email).and_raise(StandardError, "Test error")
+      allow(CloudWatchService).to receive(:record_job_failure_metric)
+    end
+
+    it "raises an error" do
+      expect {
+        described_class.perform_now(
+          submission:,
+          notify_response_id:,
+          confirmation_email_address:,
+        )
+      }.to raise_error(StandardError, "Test error")
+    end
+
+    it "sends cloudwatch metric for failure" do
+      described_class.perform_now(
+        submission:,
+        notify_response_id:,
+        confirmation_email_address:,
+      )
+      expect(CloudWatchService).to have_received(:record_job_failure_metric).with("SendConfirmationEmailJob")
+    rescue StandardError
+      nil
+    end
+  end
+end

spec/models/current_request_logging_attributes_spec.rb

@@ -23,7 +23,6 @@
       current.question_number = 3
       current.submission_reference = "a-submission-ref"
       current.confirmation_email_reference = "a-confirmation-email-ref"
-      current.confirmation_email_id = "a-confirmation-email-id"
       current.rescued_exception = "StandardError"
       current.rescued_exception_trace = "a trace"
       current.validation_errors = ["text: blank"]
@@ -43,7 +42,6 @@
         question_number: 3,
         submission_reference: "a-submission-ref",
         confirmation_email_reference: "a-confirmation-email-ref",
-        confirmation_email_id: "a-confirmation-email-id",
         rescued_exception: "StandardError",
         rescued_exception_trace: "a trace",
         validation_errors: ["text: blank"],
@@ -55,10 +53,6 @@
       expect(current.as_hash.key?(:confirmation_email_reference)).to be false
     end
 
-    it "does not include nil confirmation_email_id" do
-      expect(current.as_hash.key?(:confirmation_email_id)).to be false
-    end
-
     it "does not include the validation errors array if empty" do
       current.validation_errors = []
       expect(current.as_hash.keys).not_to include :validation_errors

spec/services/form_submission_service_spec.rb

@@ -295,17 +295,31 @@
     end
 
     describe "sending the confirmation email to the user" do
-      it "calls FormSubmissionConfirmationMailer" do
-        freeze_time do
-          allow(FormSubmissionConfirmationMailer).to receive(:send_confirmation_email).and_call_original
+      it "enqueues a job to send the confirmation email" do
+        assert_enqueued_with(job: SendConfirmationEmailJob) do
           service.submit
-          expect(FormSubmissionConfirmationMailer).to have_received(:send_confirmation_email).with(
-            { what_happens_next_markdown: form.what_happens_next_markdown,
-              support_contact_details: form.support_details,
-              notify_response_id: email_confirmation_input.confirmation_email_reference,
-              confirmation_email_address: email_confirmation_input.confirmation_email_address,
-              mailer_options: instance_of(FormSubmissionService::MailerOptions) },
-          ).once
+        end
+      end
+
+      context "when the confirmation email job fails to enqueue" do
+        let(:enqueue_error) { nil }
+
+        before do
+          allow(SendConfirmationEmailJob).to receive(:perform_later).and_yield(instance_double(SendConfirmationEmailJob, successfully_enqueued?: false, enqueue_error:))
+        end
+
+        context "and there is no enqueue error" do
+          it "raises an error" do
+            expect { service.submit }.to change(Submission, :count).by(1).and raise_error(StandardError, "Failed to enqueue confirmation email for reference #{reference}")
+          end
+        end
+
+        context "and there is an enqueue error" do
+          let(:enqueue_error) { ActiveJob::EnqueueError.new("An error occurred enqueueing job") }
+
+          it "raises an error" do
+            expect { service.submit }.to change(Submission, :count).by(1).and raise_error(StandardError, "Failed to enqueue confirmation email for reference #{reference}: An error occurred enqueueing job")
+          end
         end
       end