Merge pull request #1976 from alphagov/add-batch-begin-at

Add batch_begin_at to deliveries

Author: stephencdaly

app/jobs/schedule_daily_batch_deliveries_job.rb

@@ -8,6 +8,7 @@ def perform
     CurrentJobLoggingAttributes.job_id = job_id
 
     date = Time.zone.yesterday
+    batch_begin_at = date.in_time_zone(TimeZoneUtils.submission_time_zone).beginning_of_day
 
     DailySubmissionBatchSelector.batches(date).each do |batch|
       existing_deliveries = batch.submissions.first.deliveries.daily
@@ -18,7 +19,11 @@ def perform
         next
       end
 
-      delivery = Delivery.create!(delivery_schedule: :daily, submissions: batch.submissions)
+      delivery = Delivery.create!(
+        delivery_schedule: :daily,
+        submissions: batch.submissions,
+        batch_begin_at:,
+      )
 
       send_batch_job = SendSubmissionBatchJob.perform_later(delivery:)
 

app/jobs/send_submission_batch_job.rb

@@ -17,7 +17,8 @@ def perform(delivery:)
     latest_submission = submissions.order(created_at: :desc).first
     form = latest_submission.form
     mode = latest_submission.mode_object
-    date = latest_submission.submission_time.to_date
+
+    batch_begin_date = delivery.batch_begin_at.in_time_zone(TimeZoneUtils.submission_time_zone).to_date
 
     set_submission_batch_logging_attributes(form:, mode:, delivery:)
 
@@ -30,7 +31,7 @@ def perform(delivery:)
       end
     end
 
-    message_id = AwsSesSubmissionBatchService.new(submissions_query: submissions, form:, date:, mode:).send_batch
+    message_id = AwsSesSubmissionBatchService.new(submissions_query: submissions, form:, date: batch_begin_date, mode:).send_batch
 
     delivery.new_attempt!
     delivery.update!(
@@ -40,14 +41,14 @@ def perform(delivery:)
     CurrentJobLoggingAttributes.delivery_reference = delivery.delivery_reference
     EventLogger.log_form_event("daily_batch_email_sent", {
       mode: mode.to_s,
-      batch_date: date,
+      batch_date: batch_begin_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,
+        batch_date: batch_begin_date,
       })
     end
   end

db/migrate/20260317125725_add_batch_begin_at_to_deliveries.rb

@@ -0,0 +1,5 @@
+class AddBatchBeginAtToDeliveries < ActiveRecord::Migration[8.1]
+  def change
+    add_column :deliveries, :batch_begin_at, :datetime
+  end
+end

db/schema.rb

@@ -53,6 +53,40 @@
       expect(enqueued_args.second).to include("delivery" => hash_including("_aj_globalid"))
       expect(locate_delivery(enqueued_args.second)).to eq(Delivery.second)
     end
+
+    describe "setting batch_begin_at" do
+      context "when the date for the batch is the day the clocks go forwards" do
+        let(:travel_time) { Time.zone.local(2025, 3, 31) }
+
+        it "sets the batch_begin_at to the beginning of the day in BST" do
+          expect(Delivery.first.batch_begin_at).to eq(Time.utc(2025, 3, 30, 0, 0, 0))
+        end
+      end
+
+      context "when the date for the batch is after the clocks have gone forwards" do
+        let(:travel_time) { Time.zone.local(2025, 4, 1) }
+
+        it "sets the batch_begin_at to the beginning of the day in BST" do
+          expect(Delivery.first.batch_begin_at).to eq(Time.utc(2025, 3, 30, 23, 0, 0))
+        end
+      end
+
+      context "when the date for the batch is the day the clocks go back" do
+        let(:travel_time) { Time.zone.local(2025, 10, 27) }
+
+        it "sets the batch_begin_at to the beginning of the day in GMT" do
+          expect(Delivery.first.batch_begin_at).to eq(Time.utc(2025, 10, 25, 23, 0, 0))
+        end
+      end
+
+      context "when the date for the batch is the day after the clocks have gone back" do
+        let(:travel_time) { Time.zone.local(2025, 10, 28) }
+
+        it "sets the batch_begin_at to the beginning of the day in GMT" do
+          expect(Delivery.first.batch_begin_at).to eq(Time.utc(2025, 10, 27, 0, 0, 0))
+        end
+      end
+    end
   end
 
   context "when a Delivery already exists for a batch" do

spec/jobs/schedule_daily_batch_deliveries_job_spec.rb

@@ -5,8 +5,9 @@
   include ActiveJob::TestHelper
 
   let(:mode_string) { "form" }
-  let(:date) { Date.new(2022, 12, 14) }
-  let(:delivery) { create(:delivery, delivery_schedule: "daily", submissions:) }
+  let(:date) { Date.new(2025, 4, 10) }
+  let(:batch_begin_at) { Time.utc(2025, 4, 9, 23, 0, 0) }
+  let(:delivery) { create(:delivery, delivery_schedule: "daily", submissions:, batch_begin_at:) }
 
   let(:form_document) { create(:v2_form_document, :with_steps, name: "My Form", submission_email:) }
   let(:submission_email) { "to@example.com" }
@@ -73,13 +74,25 @@
         expect(mail.to).to include(form_document.submission_email)
       end
 
+      it "includes the date in London time in the subject" do
+        expect(mail.subject).to include("10 April 2025")
+      end
+
       it "updates the delivery" do
         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
 
       context "when the delivery has already been attempted" do
-        let(:delivery) { create(:delivery, delivery_schedule: "daily", submissions:, delivered_at: Time.zone.now - 2.hours, failed_at: Time.zone.now - 1.hour, failure_reason: "bounced") }
+        let(:delivery) do
+          create(:delivery,
+                 delivery_schedule: "daily",
+                 submissions:,
+                 batch_begin_at:,
+                 delivered_at: Time.zone.now - 2.hours,
+                 failed_at: Time.zone.now - 1.hour,
+                 failure_reason: "bounced")
+        end
 
         it "updates the resets the delivery details" do
           expect(delivery.reload.delivered_at).to be_nil
@@ -92,7 +105,7 @@
         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")
+        expect(filenames).to contain_exactly("govuk_forms_my_form_2025-04-10.csv")
       end
 
       it "attaches a csv containing header plus one line per submission" do