Add job to schedule weekly deliveries

Add a job that will be run on a recurring schedule that finds all
form_ids and modes to send submission batches for the previous week.

For each form_id and mode, create a Delivery, associating the
submissions with it, and schedule a SendSubmissionBatchJob to send
the email.

Author: stephencdaly

app/jobs/schedule_weekly_batch_deliveries_job.rb

@@ -0,0 +1,38 @@
+class ScheduleWeeklyBatchDeliveriesJob < ApplicationJob
+  # If we change the queue for this job, ensure we add a new alert in CloudWatch for failed executions
+  queue_as :submissions
+
+  def perform
+    CloudWatchService.record_job_started_metric(self.class.name)
+    CurrentJobLoggingAttributes.job_class = self.class.name
+    CurrentJobLoggingAttributes.job_id = job_id
+
+    batch_begin_at = 1.week.ago.in_time_zone(TimeZoneUtils.submission_time_zone).beginning_of_week(:monday)
+
+    BatchSubmissionsSelector.weekly_batches(batch_begin_at).each do |batch|
+      existing_deliveries = batch.submissions.first.deliveries.weekly
+      if existing_deliveries.any?
+        Rails.logger.warn("Weekly batch delivery already exists for batch - skipping", {
+          form_id: batch.form_id, mode: batch.mode, batch_begin_at:, delivery_id: existing_deliveries.first.id
+        })
+        next
+      end
+
+      delivery = Delivery.create!(
+        delivery_schedule: :weekly,
+        submissions: batch.submissions,
+        batch_begin_at:,
+      )
+
+      send_batch_job = SendSubmissionBatchJob.perform_later(delivery:)
+
+      Rails.logger.info("Scheduled SendSubmissionBatchJob to send weekly submission batch", {
+        form_id: batch.form_id,
+        mode: batch.mode,
+        batch_begin_date: batch_begin_at.to_date,
+        send_submission_batch_job_id: send_batch_job.job_id,
+        delivery_id: delivery.id,
+      })
+    end
+  end
+end

spec/jobs/schedule_weekly_batch_deliveries_job_spec.rb

@@ -0,0 +1,132 @@
+require "rails_helper"
+
+RSpec.describe ScheduleWeeklyBatchDeliveriesJob do
+  include ActiveSupport::Testing::TimeHelpers
+  include ActiveJob::TestHelper
+
+  let(:travel_time) { Time.utc(2025, 5, 20, 2, 0, 0) }
+  let(:form_id) { 101 }
+  let(:other_form_id) { 201 }
+  let(:form_submissions) { create_list(:submission, 2, form_id: form_id, mode: "form") }
+  let(:other_form_submissions) { create_list(:submission, 1, form_id: other_form_id, mode: "preview-draft") }
+  let!(:batches) do
+    [
+      BatchSubmissionsSelector::Batch.new(101, "form", form_submissions),
+      BatchSubmissionsSelector::Batch.new(201, "preview-draft", other_form_submissions),
+    ]
+  end
+
+  around do |example|
+    travel_to travel_time do
+      example.run
+    end
+  end
+
+  before do
+    allow(BatchSubmissionsSelector).to receive(:weekly_batches).and_return(batches.to_enum)
+  end
+
+  context "when Deliveries do not already exist for batches" do
+    before do
+      described_class.perform_now
+    end
+
+    it "calls the selector passing in the start time of the previous week" do
+      expect(BatchSubmissionsSelector).to have_received(:weekly_batches).with(Time.utc(2025, 5, 11, 23, 0, 0))
+    end
+
+    it "creates a delivery record per batch job" do
+      expect(Delivery.weekly.count).to eq(2)
+      expect(Delivery.first.submissions.map(&:id)).to match_array(form_submissions.map(&:id))
+      expect(Delivery.second.submissions.map(&:id)).to match_array(other_form_submissions.map(&:id))
+    end
+
+    it "enqueues a SendSubmissionBatchJob per batch" do
+      expect(ActiveJob::Base.queue_adapter.enqueued_jobs.size).to eq(2)
+    end
+
+    it "enqueues the jobs with the correct args" do
+      enqueued_args = ActiveJob::Base.queue_adapter.enqueued_jobs.map { |j| j[:args].first }
+      expect(enqueued_args.first).to include("delivery" => hash_including("_aj_globalid"))
+      expect(locate_delivery(enqueued_args.first)).to eq(Delivery.first)
+
+      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 week for the batch is the week the clocks go forwards" do
+        let(:travel_time) { Time.utc(2025, 3, 31, 2, 0, 0) }
+
+        it "sets the batch_begin_at to the beginning of the week in GMT" do
+          expect(Delivery.first.batch_begin_at).to eq(Time.utc(2025, 3, 24, 0, 0, 0))
+        end
+      end
+
+      context "when the week for the batch is the week after the clocks have gone forwards" do
+        let(:travel_time) { Time.utc(2025, 4, 7, 2, 0, 0) }
+
+        it "sets the batch_begin_at to the beginning of the week in BST" do
+          expect(Delivery.first.batch_begin_at).to eq(Time.utc(2025, 3, 30, 23, 0, 0))
+        end
+      end
+
+      context "when the week for the batch is the week the clocks go back" do
+        let(:travel_time) { Time.zone.local(2025, 10, 27, 2, 0, 0) }
+
+        it "sets the batch_begin_at to the beginning of the week in BST" do
+          expect(Delivery.first.batch_begin_at).to eq(Time.utc(2025, 10, 19, 23, 0, 0))
+        end
+      end
+
+      context "when the week for the batch is the week after the clocks have gone back" do
+        let(:travel_time) { Time.utc(2025, 11, 3, 2, 0, 0) }
+
+        it "sets the batch_begin_at to the beginning of the week 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
+    let!(:existing_delivery) { create(:delivery, delivery_schedule: :weekly, submissions: form_submissions) }
+
+    it "logs that the delivery will be skipped" do
+      expect(Rails.logger).to receive(:warn).with(
+        "Weekly batch delivery already exists for batch - skipping",
+        hash_including(
+          form_id: form_id,
+          mode: "form",
+          batch_begin_at: Time.utc(2025, 5, 11, 23, 0, 0),
+          delivery_id: existing_delivery.id,
+        ),
+      )
+
+      described_class.perform_now
+    end
+
+    it "only creates a delivery for the batch without an existing delivery" do
+      expect {
+        described_class.perform_now
+      }.to change(Delivery, :count).by(1)
+
+      expect(Delivery.last.submissions.map(&:id)).to match_array(other_form_submissions.map(&:id))
+    end
+
+    it "only schedules a job for the batch without an existing delivery" do
+      expect {
+        described_class.perform_now
+      }.to change { ActiveJob::Base.queue_adapter.enqueued_jobs.size }.by(1)
+
+      enqueued_args = ActiveJob::Base.queue_adapter.enqueued_jobs.map { |j| j[:args].first }
+      expect(enqueued_args.first).to include("delivery" => hash_including("_aj_globalid"))
+      expect(locate_delivery(enqueued_args.first)).to eq(Delivery.last)
+    end
+  end
+
+  def locate_delivery(enqueued_args)
+    gid_string = enqueued_args.dig("delivery", "_aj_globalid")
+    GlobalID::Locator.locate(gid_string)
+  end
+end