Add a job to send a daily batch of submissions for a form

Add a job that will send an email containing CSV(s) of submissions
for a given form on a given day for a given mode.

This job is not scheduled by anything yet.

Co-authored-by: Samuel Culley <samuel.culley@digital.cabinet-office.gov.uk>

Author: SamJamCul

app/jobs/application_job.rb

@@ -7,4 +7,12 @@ def set_submission_logging_attributes(submission)
     CurrentJobLoggingAttributes.submission_reference = submission.reference
     CurrentJobLoggingAttributes.preview = submission.preview?
   end
+
+  def set_submission_batch_logging_attributes(form:, mode:)
+    CurrentJobLoggingAttributes.job_class = self.class.name
+    CurrentJobLoggingAttributes.job_id = job_id
+    CurrentJobLoggingAttributes.form_id = form.id
+    CurrentJobLoggingAttributes.form_name = form.name
+    CurrentJobLoggingAttributes.preview = mode.preview?
+  end
 end

app/jobs/send_submission_batch_job.rb

@@ -0,0 +1,42 @@
+class SendSubmissionBatchJob < ApplicationJob
+  queue_as :submissions
+
+  # this translates to approximately 4.5 hours of retrying in total
+  TOTAL_ATTEMPTS = 10
+
+  retry_on Aws::SESV2::Errors::ServiceError, wait: :polynomially_longer, attempts: TOTAL_ATTEMPTS
+
+  def perform(form_id:, mode_string:, date:, delivery:)
+    submissions = Submission.for_daily_batch(form_id, date, mode_string)
+
+    if submissions.empty?
+      Rails.logger.info("No submissions to batch for form_id: #{form_id}, mode: #{mode_string}, date: #{date}")
+      return
+    end
+
+    form = submissions.first.form
+    mode = Mode.new(mode_string)
+    set_submission_batch_logging_attributes(form:, mode:)
+
+    message_id = AwsSesSubmissionBatchService.new(submissions:, form:, date:, mode:).send_batch
+
+    delivery.update!(
+      delivery_reference: message_id,
+      last_attempt_at: Time.zone.now,
+      submissions: submissions,
+    )
+
+    EventLogger.log_form_event("daily_batch_email_sent", {
+      mode:,
+      batch_date: date,
+      number_of_submissions: submissions.count,
+    })
+
+    submissions.each do |submission|
+      EventLogger.log_form_event("included_in_daily_batch_email", {
+        submission_reference: submission.reference,
+        batch_date: date,
+      })
+    end
+  end
+end

spec/factories/submissions.rb

@@ -14,7 +14,7 @@
         },
       }
     end
-    mode { is_preview ? "preview-live" : "live" }
+    mode { is_preview ? "preview-live" : "form" }
     form_document { build :v2_form_document, form_id: }
     submission_locale { :en }
 

spec/factories/v2_form_document.rb

@@ -32,7 +32,7 @@
       end
 
       steps do
-        Array.new(steps_count) { attributes_for(:v2_step) }
+        Array.new(steps_count) { attributes_for(:v2_question_page_step) }
       end
 
       question_section_completed { true }

spec/jobs/send_submission_batch_job_spec.rb

@@ -0,0 +1,88 @@
+require "rails_helper"
+
+# rubocop:disable RSpec/InstanceVariable
+RSpec.describe SendSubmissionBatchJob, type: :job do
+  include ActiveJob::TestHelper
+
+  let(:mode_string) { "form" }
+  let(:date) { Date.new(2022, 12, 14) }
+  let(:delivery) { create(:delivery, batch_frequency: "daily") }
+
+  let(:form_document) { create(:v2_form_document, :with_steps, name: "My Form", submission_email: "to@example.com") }
+  let(:form_id) { form_document.form_id }
+  let(:submissions) { [] }
+
+  before do
+    submissions
+    ActionMailer::Base.deliveries.clear
+  end
+
+  context "when the job is processed" do
+    before do
+      described_class.perform_later(form_id:, mode_string:, date:, delivery:)
+      travel 5.seconds do
+        @job_ran_at = Time.zone.now
+        perform_enqueued_jobs
+      end
+    end
+
+    context "when there are no submissions" do
+      it "does not send an email" do
+        expect(ActionMailer::Base.deliveries).to be_empty
+      end
+
+      it "does not update the delivery" do
+        expect(delivery.reload.last_attempt_at).to be_nil
+      end
+    end
+
+    context "when there are submissions" do
+      let(:submissions_to_include) do
+        create_list(
+          :submission,
+          3,
+          form_document:,
+          form_id:,
+          mode: mode_string,
+          created_at: date.beginning_of_day + 1.hour,
+        )
+      end
+      let(:submission_not_on_date) do
+        create(:submission, form_document:, form_id:, mode: mode_string, created_at: date.beginning_of_day - 1.day)
+      end
+      let(:preview_submission) do
+        create(:submission, :preview, form_document:, form_id:, created_at: date.beginning_of_day + 1.hour)
+      end
+      let(:submissions) { [submissions_to_include, submission_not_on_date, preview_submission] }
+
+      it "sends an email" do
+        expect(ActionMailer::Base.deliveries.count).to eq(1)
+
+        mail = ActionMailer::Base.deliveries.last
+        expect(mail.to).to include(form_document.submission_email)
+      end
+
+      it "updates the delivery" do
+        mail = ActionMailer::Base.deliveries.last
+        expect(delivery.reload.delivery_reference).to eq(mail.message_id)
+        expect(delivery.reload.last_attempt_at).to be_within(1.second).of(@job_ran_at)
+      end
+
+      it "attaches a csv with the expected filename" do
+        mail = ActionMailer::Base.deliveries.last
+        expect(mail.attachments).not_to be_empty
+
+        filenames = mail.attachments.map(&:filename)
+        expect(filenames).to contain_exactly("govuk_forms_my_form_2022-12-14.csv")
+      end
+
+      it "attaches a csv containing header plus one line per submission" do
+        mail = ActionMailer::Base.deliveries.last
+
+        csv_content = mail.attachments.first.decoded
+        expect(csv_content.lines.count).to eq(submissions_to_include.count + 1)
+      end
+    end
+  end
+end
+# rubocop:enable RSpec/InstanceVariable