Move submission_email checks to batch service job

Shifts the checks for a form having a submission_email out of the
submission batch service and into the batch job. This will mean that the
job will terminate early when no submission_email is present, rather
than continuing even though no email gets sent.

Author: SamJamCul

app/jobs/send_submission_batch_job.rb

@@ -18,6 +18,15 @@ def perform(form_id:, mode_string:, date:, delivery:)
     mode = Mode.new(mode_string)
     set_submission_batch_logging_attributes(form:, mode:)
 
+    if form.submission_email.blank?
+      if mode.preview?
+        Rails.logger.info "Skipping sending batch for preview submissions, as the submission email address has not been set"
+        return
+      else
+        raise StandardError, "Form id: #{form.id} is missing a submission email address"
+      end
+    end
+
     message_id = AwsSesSubmissionBatchService.new(submissions_query: submissions, form:, date:, mode:).send_batch
 
     delivery.update!(

app/services/aws_ses_submission_batch_service.rb

@@ -7,21 +7,6 @@ def initialize(submissions_query:, form:, date:, mode:)
   end
 
   def send_batch
-    if @form.submission_email.blank?
-      if @mode.preview?
-        Rails.logger.info "Skipping sending batch for preview submissions, as the submission email address has not been set"
-        return
-      else
-        raise StandardError, "Form id: #{@form.id} is missing a submission email address"
-      end
-    end
-
-    deliver_batch_email
-  end
-
-private
-
-  def deliver_batch_email
     files = {}
 
     csvs = CsvGenerator.generate_batched_submissions(submissions_query: @submissions_query, is_s3_submission: false)

spec/jobs/send_submission_batch_job_spec.rb

@@ -8,52 +8,74 @@
   let(:date) { Date.new(2022, 12, 14) }
   let(:delivery) { create(:delivery, delivery_schedule: "daily") }
 
-  let(:form_document) { create(:v2_form_document, :with_steps, name: "My Form", submission_email: "to@example.com") }
+  let(:form_document) { create(:v2_form_document, :with_steps, name: "My Form", submission_email:) }
+  let(:submission_email) { "to@example.com" }
   let(:form_id) { form_document.form_id }
   let(:submissions) { [] }
 
   before do
     submissions
     ActionMailer::Base.deliveries.clear
+    described_class.perform_later(form_id:, mode_string:, date:, delivery:)
   end
 
-  context "when the job is processed" do
+  context "when there are no submissions" 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
+      perform_enqueued_jobs
     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 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
+    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] }
+
+    context "when the form does not have a submission email address" do
+      let(:submission_email) { nil }
 
-    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,
-        )
+      it "raises an error" do
+        expect {
+          perform_enqueued_jobs
+        }.to raise_error(StandardError, "Form id: #{form_id} is missing a submission email address")
       end
-      let(:submission_not_on_date) do
-        create(:submission, form_document:, form_id:, mode: mode_string, created_at: date.beginning_of_day - 1.day)
+
+      context "when the mode is preview" do
+        let(:mode_string) { "preview-live" }
+
+        it "does not call the submission batch service" do
+          perform_enqueued_jobs
+          expect(AwsSesSubmissionBatchService).not_to receive(:new)
+        end
       end
-      let(:preview_submission) do
-        create(:submission, :preview, form_document:, form_id:, created_at: date.beginning_of_day + 1.hour)
+    end
+
+    context "when the form has a submission email address" do
+      before do
+        @job_ran_at = Time.zone.now
+        perform_enqueued_jobs
       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)

spec/services/aws_ses_submission_batch_service_spec.rb

@@ -16,24 +16,6 @@
       create_list(:submission, 3, form_document:)
     end
 
-    context "when the form does not have a submission email address" do
-      let(:submission_email) { nil }
-
-      it "raises an error" do
-        expect(AwsSesSubmissionBatchMailer).not_to receive(:batch_submission_email)
-        expect { service.send_batch }.to raise_error(StandardError, "Form id: #{form.id} is missing a submission email address")
-      end
-
-      context "when the mode is preview" do
-        let(:mode) { instance_double(Mode, preview?: true) }
-
-        it "does not send an email" do
-          expect(AwsSesSubmissionBatchMailer).not_to receive(:batch_submission_email)
-          service.send_batch
-        end
-      end
-    end
-
     it "calls the SubmissionFilenameGenerator with a nil form version" do
       expect(SubmissionFilenameGenerator).to receive(:batch_csv_filename).with(form_name: form.name, date:, mode:, form_version: nil)
       service.send_batch