Add method to get all weekly batches for a given date

Add a method, that given a date, will return batches of submissions
per form and mode where the form has `send_weekly_submission_batch`
set to true for the final submission in the week.

Include all submissions for the week in the batch, even if they were
submitted for an older version of the form that did not have
`send_weekly_submission_batch` set to true.

Author: stephencdaly

app/lib/batch_submissions_selector.rb

@@ -16,6 +16,20 @@ def daily_batches(date)
       end
     end
 
+    def weekly_batches(time_in_week)
+      Enumerator.new do |yielder|
+        form_ids_and_modes_with_send_weekly_submission_batch(time_in_week).each do |form_id, mode|
+          submissions = Submission.for_form_and_mode(form_id, mode).in_week(time_in_week).order(created_at: :desc)
+
+          # If the send_weekly_submission_batch is true for the most recent submission, include all submissions in that
+          # week in the batch. If it is false do not return a batch for any of the submissions in that week.
+          next unless submissions.any? && submissions.first.form_document["send_weekly_submission_batch"] == true
+
+          yielder << Batch.new(form_id, mode, submissions)
+        end
+      end
+    end
+
   private
 
     def form_ids_and_modes_with_send_daily_submission_batch(date)
@@ -26,5 +40,14 @@ def form_ids_and_modes_with_send_daily_submission_batch(date)
                 .distinct
                 .pluck(:form_id, :mode)
     end
+
+    def form_ids_and_modes_with_send_weekly_submission_batch(begin_at)
+      # Get all form_ids and modes that have at least one submission in the week with send_weekly_submission_batch
+      # set to true.
+      Submission.in_week(begin_at)
+                .where("(form_document->>'send_weekly_submission_batch')::boolean = true")
+                .distinct
+                .pluck(:form_id, :mode)
+    end
   end
 end

spec/lib/batch_submissions_selector_spec.rb

@@ -1,20 +1,20 @@
 require "rails_helper"
 
 RSpec.describe BatchSubmissionsSelector do
-  let(:form_document_with_batch_enabled) { create(:v2_form_document, send_daily_submission_batch: true) }
-  let(:form_document_with_batch_disabled) { create(:v2_form_document, send_daily_submission_batch: false) }
-
-  let(:date) { Time.zone.local(2022, 12, 1) }
   let(:form_id) { 101 }
 
   describe ".daily_batches" do
     subject(:daily_batches) { described_class.daily_batches(date) }
 
+    let(:date) { Time.zone.local(2022, 12, 1) }
+    let(:form_document_with_batch_enabled) { create(:v2_form_document, send_daily_submission_batch: true) }
+    let(:form_document_with_batch_disabled) { create(:v2_form_document, send_daily_submission_batch: false) }
+
     it "returns an enumerator" do
       expect(daily_batches).to be_an(Enumerator)
     end
 
-    context "when send_daily_submissions_batch is enabled for the form document" do
+    context "when send_daily_submission_batch is enabled for the form document" do
       context "when the date is during BST" do
         let(:date) { Time.zone.local(2022, 6, 1) }
 
@@ -35,7 +35,7 @@
           create(:submission, form_id: form_id, mode: "form", reference: "OMITTED4", created_at: Time.utc(2022, 6, 1, 23, 0, 0), form_document: form_document_with_batch_enabled)
         end
 
-        it "includes only forms/modes with submissions on the date and their submissions" do
+        it "includes only forms/modes with submissions on the date" do
           expect(daily_batches.map(&:to_h)).to contain_exactly(
             a_hash_including(form_id: form_id, mode: "form"),
             a_hash_including(form_id: form_id, mode: "preview-draft"),
@@ -82,9 +82,7 @@
       end
     end
 
-    context "when send_daily_submissions_batch is enabled part-way through the day for the form document" do
-      let(:other_form_id) { 102 }
-
+    context "when send_daily_submission_batch is enabled part-way through the day for the form document" do
       let!(:latest_submission) do
         create(:submission, form_id: form_id, mode: "form", reference: "INCLUDED1", created_at: Time.utc(2022, 12, 1, 10, 0, 0), form_document: form_document_with_batch_enabled)
       end
@@ -104,7 +102,7 @@
       end
     end
 
-    context "when send_daily_submissions_batch is disabled for the form document" do
+    context "when send_daily_submission_batch is disabled for the form document" do
       before do
         create(:submission, form_id: form_id, mode: "form", created_at: Time.utc(2022, 12, 1, 10, 0, 0), form_document: form_document_with_batch_disabled)
       end
@@ -114,7 +112,7 @@
       end
     end
 
-    context "when send_daily_submissions_batch is disabled part-way through the day for the form document" do
+    context "when send_daily_submission_batch is disabled part-way through the day for the form document" do
       before do
         create(:submission, form_id: form_id, mode: "form", created_at: Time.utc(2022, 12, 1, 10, 0, 0), form_document: form_document_with_batch_disabled)
         create(:submission, form_id: form_id, mode: "form", created_at: Time.utc(2022, 12, 1, 9, 0, 0), form_document: form_document_with_batch_enabled)
@@ -125,4 +123,131 @@
       end
     end
   end
+
+  describe ".weekly_batches" do
+    subject(:weekly_batches) { described_class.weekly_batches(date) }
+
+    let(:date) { Time.zone.local(2025, 5, 19) }
+    let(:form_document_with_batch_enabled) { create(:v2_form_document, send_weekly_submission_batch: true) }
+    let(:form_document_with_batch_disabled) { create(:v2_form_document, send_weekly_submission_batch: false) }
+
+    it "returns an enumerator" do
+      expect(weekly_batches).to be_an(Enumerator)
+    end
+
+    context "when send_weekly_submission_batch is enabled for the form document" do
+      context "when the week is during BST" do
+        let(:date) { Time.zone.local(2025, 5, 19) }
+
+        let!(:form_submission) do
+          create(:submission, form_id: form_id, mode: "form", reference: "INCLUDED1", created_at: Time.utc(2025, 5, 18, 23, 0, 0), form_document: form_document_with_batch_enabled)
+        end
+        let!(:preview_draft_submission) do
+          create(:submission, form_id: form_id, mode: "preview-draft", reference: "INCLUDED2", created_at: Time.utc(2025, 5, 25, 22, 59, 59), form_document: form_document_with_batch_enabled)
+        end
+
+        before do
+          # create form/mode combinations that only have submissions outside the BST week
+          create(:submission, form_id: form_id, mode: "preview-archived", reference: "OMITTED1", created_at: Time.utc(2025, 5, 18, 22, 59, 59), form_document: form_document_with_batch_enabled)
+          create(:submission, form_id: 102, mode: "form", reference: "OMITTED2", created_at: Time.utc(2025, 5, 25, 23, 0, 0), form_document: form_document_with_batch_enabled)
+
+          # create submissions for the form/mode included in a batch outside the BST week to ensure they are excluded
+          create(:submission, form_id: form_id, mode: "form", reference: "OMITTED3", created_at: Time.utc(2025, 5, 18, 22, 59, 59), form_document: form_document_with_batch_enabled)
+          create(:submission, form_id: form_id, mode: "form", reference: "OMITTED4", created_at: Time.utc(2025, 5, 25, 23, 0, 0), form_document: form_document_with_batch_enabled)
+        end
+
+        it "includes only forms/modes with submissions in the week" do
+          expect(weekly_batches.map(&:to_h)).to contain_exactly(
+            a_hash_including(form_id: form_id, mode: "form"),
+            a_hash_including(form_id: form_id, mode: "preview-draft"),
+          )
+        end
+
+        it "includes only submissions in the week in the batches" do
+          expect(weekly_batches.to_a[0].submissions.pluck(:reference)).to contain_exactly(form_submission.reference)
+          expect(weekly_batches.to_a[1].submissions.pluck(:reference)).to contain_exactly(preview_draft_submission.reference)
+        end
+      end
+
+      context "when the week is not in BST" do
+        let(:date) { Time.zone.local(2025, 11, 3) }
+
+        let!(:form_submission) do
+          create(:submission, form_id: form_id, mode: "form", reference: "INCLUDED1", created_at: Time.utc(2025, 11, 3, 0, 0, 0), form_document: form_document_with_batch_enabled)
+        end
+        let!(:preview_draft_submission) do
+          create(:submission, form_id: form_id, mode: "preview-draft", reference: "INCLUDED2", created_at: Time.utc(2025, 11, 9, 23, 59, 59), form_document: form_document_with_batch_enabled)
+        end
+
+        before do
+          # create form/mode combinations that only have submissions outside the week
+          create(:submission, form_id: form_id, mode: "preview-archived", reference: "OMITTED1", created_at: Time.utc(2025, 11, 2, 23, 59, 59), form_document: form_document_with_batch_enabled)
+          create(:submission, form_id: 102, mode: "form", reference: "OMITTED2", created_at: Time.utc(2025, 11, 10, 0, 0, 0), form_document: form_document_with_batch_enabled)
+
+          # create submissions for the form/mode included in a batch outside the week to ensure they are excluded
+          create(:submission, form_id: form_id, mode: "form", reference: "OMITTED3", created_at: Time.utc(2025, 11, 2, 23, 59, 59), form_document: form_document_with_batch_enabled)
+          create(:submission, form_id: form_id, mode: "form", reference: "OMITTED4", created_at: Time.utc(2025, 11, 10, 0, 0, 0), form_document: form_document_with_batch_enabled)
+        end
+
+        it "includes only forms/modes with submissions in the week" do
+          expect(weekly_batches.map(&:to_h)).to contain_exactly(
+            a_hash_including(form_id: form_id, mode: "form"),
+            a_hash_including(form_id: form_id, mode: "preview-draft"),
+          )
+        end
+
+        it "includes only submissions in the week in the batches" do
+          expect(weekly_batches.to_a[0].submissions.pluck(:reference)).to contain_exactly(form_submission.reference)
+          expect(weekly_batches.to_a[1].submissions.pluck(:reference)).to contain_exactly(preview_draft_submission.reference)
+        end
+      end
+    end
+
+    context "when send_weekly_submission_batch is enabled part-way through the week for the form document" do
+      let(:date) { Time.zone.local(2025, 11, 3) }
+
+      let!(:latest_submission) do
+        create(:submission, form_id: form_id, mode: "form", reference: "INCLUDED1", created_at: Time.utc(2025, 11, 5, 0, 0, 0), form_document: form_document_with_batch_enabled)
+      end
+      let!(:earlier_submission) do
+        create(:submission, form_id: form_id, mode: "form", reference: "INCLUDED2", created_at: Time.utc(2025, 11, 4, 0, 0, 0), form_document: form_document_with_batch_disabled)
+      end
+
+      it "includes a batch for the form and mode" do
+        expect(weekly_batches.map(&:to_h)).to contain_exactly(
+          a_hash_including(form_id: form_id, mode: "form"),
+        )
+      end
+
+      it "includes all the submissions in the batch" do
+        submissions = weekly_batches.first.submissions
+        expect(submissions.pluck(:reference)).to contain_exactly(latest_submission.reference, earlier_submission.reference)
+      end
+    end
+
+    context "when send_weekly_submission_batch is disabled for the form document" do
+      let(:date) { Time.zone.local(2025, 11, 3) }
+
+      before do
+        create(:submission, form_id: form_id, mode: "form", created_at: Time.utc(2025, 11, 5, 10, 0, 0), form_document: form_document_with_batch_disabled)
+      end
+
+      it "does not include a batch for the form and mode" do
+        expect(weekly_batches.to_a).to be_empty
+      end
+    end
+
+    context "when send_weekly_submission_batch is disabled part-way through the week for the form document" do
+      let(:date) { Time.zone.local(2025, 11, 3) }
+
+      before do
+        create(:submission, form_id: form_id, mode: "form", created_at: Time.utc(2025, 11, 5, 0, 0, 0), form_document: form_document_with_batch_disabled)
+        create(:submission, form_id: form_id, mode: "form", created_at: Time.utc(2025, 11, 4, 0, 0, 0), form_document: form_document_with_batch_enabled)
+      end
+
+      it "does not include a batch for the form and mode" do
+        expect(weekly_batches.to_a).to be_empty
+      end
+    end
+  end
 end