Update CSV filenames for weekly submission batches

Update the filenames for CSV attached to weekly batch emails to
include both the start and end date of the batch.

Author: stephencdaly

app/lib/submission_filename_generator.rb

@@ -4,6 +4,7 @@ class << self
     PREFIX = "govuk_forms_".freeze
     CSV_EXTENSION = ".csv".freeze
     JSON_EXTENSION = ".json".freeze
+    DATE_FORMAT = "%Y-%m-%d".freeze
 
     def csv_filename(form_name:, submission_reference:)
       filename(form_name:, submission_reference:, extension: CSV_EXTENSION)
@@ -17,23 +18,35 @@ def filename(form_name:, submission_reference:, extension:)
       reference_part = "_#{submission_reference}"
 
       name_part_max_length = MAX_LENGTH - extension.length - PREFIX.length - reference_part.length
+      name_part = name_part(form_name, name_part_max_length)
 
-      name_part = form_name
-        .parameterize(separator: "_")
-        .truncate(name_part_max_length, separator: "_", omission: "")
       "#{PREFIX}#{name_part}#{reference_part}#{extension}"
     end
 
-    def batch_csv_filename(form_name:, date:, mode:, form_version:)
-      date_part = date.strftime("_%Y-%m-%d")
-      mode_prefix = mode.preview? ? "test_" : ""
-      version_part = form_version.presence ? "_#{form_version}" : ""
+    def daily_batch_csv_filename(form_name:, mode:, csv_version:, date:)
+      date_part = "_#{date.strftime(DATE_FORMAT)}"
+      batch_csv_filename(form_name:, mode:, csv_version:, date_part:)
+    end
 
-      name_part_max_length = MAX_LENGTH - CSV_EXTENSION.length - mode_prefix.length - PREFIX.length - date_part.length - version_part.length
+    def weekly_batch_csv_filename(form_name:, mode:, csv_version:, begin_date:, end_date:)
+      date_part = "_#{begin_date.strftime(DATE_FORMAT)}-#{end_date.strftime(DATE_FORMAT)}"
+      batch_csv_filename(form_name:, mode:, csv_version:, date_part:)
+    end
 
-      name_part = form_name
+  private
+
+    def name_part(form_name, name_part_max_length)
+      form_name
         .parameterize(separator: "_")
         .truncate(name_part_max_length, separator: "_", omission: "")
+    end
+
+    def batch_csv_filename(form_name:, mode:, csv_version:, date_part:)
+      mode_prefix = mode.preview? ? "test_" : ""
+      version_part = csv_version.presence ? "_#{csv_version}" : ""
+
+      name_part_max_length = MAX_LENGTH - CSV_EXTENSION.length - mode_prefix.length - PREFIX.length - date_part.length - version_part.length
+      name_part = name_part(form_name, name_part_max_length)
 
       "#{mode_prefix}#{PREFIX}#{name_part}#{date_part}#{version_part}#{CSV_EXTENSION}"
     end

app/services/aws_ses_submission_batch_service.rb

@@ -6,7 +6,14 @@ def initialize(submissions_query:, form:, mode:)
   end
 
   def send_daily_batch(date:)
-    files = csv_attachments(date)
+    files = build_csv_files do |csv_version|
+      SubmissionFilenameGenerator.daily_batch_csv_filename(
+        form_name: @form.name,
+        mode: @mode,
+        csv_version:,
+        date:,
+      )
+    end
 
     mail = AwsSesSubmissionBatchMailer.daily_submission_batch_email(form: @form, date:, mode: @mode, files:).deliver_now
 
@@ -15,7 +22,15 @@ def send_daily_batch(date:)
   end
 
   def send_weekly_batch(begin_date:, end_date:)
-    files = csv_attachments(end_date)
+    files = build_csv_files do |csv_version|
+      SubmissionFilenameGenerator.weekly_batch_csv_filename(
+        form_name: @form.name,
+        mode: @mode,
+        csv_version:,
+        begin_date: begin_date,
+        end_date: end_date,
+      )
+    end
 
     mail = AwsSesSubmissionBatchMailer.weekly_submission_batch_email(
       form: @form,
@@ -31,19 +46,13 @@ def send_weekly_batch(begin_date:, end_date:)
 
 private
 
-  def csv_attachments(date_for_filename)
+  def build_csv_files(&block)
     files = {}
 
     csvs = CsvGenerator.generate_batched_submissions(submissions_query: @submissions_query, is_s3_submission: false)
     csvs.each.with_index(1) do |csv, index|
       csv_version = csvs.size > 1 ? index : nil
-      filename = SubmissionFilenameGenerator.batch_csv_filename(
-        form_name: @form.name,
-        date: date_for_filename,
-        mode: @mode,
-        form_version: csv_version,
-      )
-
+      filename = block.call(csv_version)
       files[filename] = csv
     end
 

spec/lib/submission_filename_generator_spec.rb

@@ -45,16 +45,17 @@
     end
   end
 
-  describe "#batch_csv_filename" do
+  describe "#daily_batch_csv_filename" do
+    subject(:filename) { described_class.daily_batch_csv_filename(form_name:, mode:, csv_version:, date:) }
+
     let(:date) { Time.zone.local(2024, 6, 1) }
     let(:mode) { instance_double(Mode, preview?: false) }
-    let(:form_version) { "1" }
+    let(:csv_version) { "1" }
 
     context "when there is a long form name that would cause the filename to be longer than 100 characters" do
       let(:form_name) { "A form name that will cause the filename to be truncated to obey the limit" }
 
       it "truncates the form name in the filename" do
-        filename = described_class.batch_csv_filename(form_name:, date:, mode:, form_version:)
         expect(filename).to eq("govuk_forms_a_form_name_that_will_cause_the_filename_to_be_truncated_to_obey_the_2024-06-01_1.csv")
       end
     end
@@ -63,17 +64,15 @@
       let(:form_name) { "Form name that will cause the filename to be 100 characters long exact" }
 
       it "does not truncate the form name in the filename" do
-        filename = described_class.batch_csv_filename(form_name:, date:, mode:, form_version:)
         expect(filename).to eq("govuk_forms_form_name_that_will_cause_the_filename_to_be_100_characters_long_exact_2024-06-01_1.csv")
       end
     end
 
     context "when there is no form version provided" do
       let(:form_name) { "Form name" }
-      let(:form_version) { nil }
+      let(:csv_version) { nil }
 
       it "does not include the form version in the filename" do
-        filename = described_class.batch_csv_filename(form_name:, date:, mode:, form_version:)
         expect(filename).to eq("govuk_forms_form_name_2024-06-01.csv")
       end
     end
@@ -83,18 +82,67 @@
       let(:form_name) { "Form name" }
 
       it "includes 'test_' in the filename" do
-        filename = described_class.batch_csv_filename(form_name:, date:, mode:, form_version:)
         expect(filename).to eq("test_govuk_forms_form_name_2024-06-01_1.csv")
       end
 
       context "when the form name would cause the filename to be over 100 characters long including the 'test_' prefix" do
         let(:form_name) { "A form name that will cause the filename to be truncated to obey the limit" }
 
         it "truncates the form name in the filename" do
-          filename = described_class.batch_csv_filename(form_name:, date:, mode:, form_version:)
           expect(filename).to eq("test_govuk_forms_a_form_name_that_will_cause_the_filename_to_be_truncated_to_obey_2024-06-01_1.csv")
         end
       end
     end
   end
+
+  describe "#weekly_batch_csv_filename" do
+    subject(:filename) { described_class.weekly_batch_csv_filename(form_name:, mode:, csv_version:, begin_date:, end_date:) }
+
+    let(:begin_date) { Time.zone.local(2024, 6, 1) }
+    let(:end_date) { Time.zone.local(2024, 6, 7) }
+    let(:mode) { instance_double(Mode, preview?: false) }
+    let(:csv_version) { "1" }
+
+    context "when there is a long form name that would cause the filename to be longer than 100 characters" do
+      let(:form_name) { "A form name that will cause the filename to be truncated to obey" }
+
+      it "truncates the form name in the filename" do
+        expect(filename).to eq("govuk_forms_a_form_name_that_will_cause_the_filename_to_be_truncated_to_2024-06-01-2024-06-07_1.csv")
+      end
+    end
+
+    context "when the form name would cause the filename to be exactly 100 characters long" do
+      let(:form_name) { "Form name that will cause the filename to be 100 characterss" }
+
+      it "does not truncate the form name in the filename" do
+        expect(filename).to eq("govuk_forms_form_name_that_will_cause_the_filename_to_be_100_characterss_2024-06-01-2024-06-07_1.csv")
+      end
+    end
+
+    context "when there is no form version provided" do
+      let(:form_name) { "Form name" }
+      let(:csv_version) { nil }
+
+      it "does not include the form version in the filename" do
+        expect(filename).to eq("govuk_forms_form_name_2024-06-01-2024-06-07.csv")
+      end
+    end
+
+    context "when the mode is preview" do
+      let(:mode) { instance_double(Mode, preview?: true) }
+      let(:form_name) { "Form name" }
+
+      it "includes 'test_' in the filename" do
+        expect(filename).to eq("test_govuk_forms_form_name_2024-06-01-2024-06-07_1.csv")
+      end
+
+      context "when the form name would cause the filename to be over 100 characters long including the 'test_' prefix" do
+        let(:form_name) { "A form name that will cause the filename to be truncated" }
+
+        it "truncates the form name in the filename" do
+          expect(filename).to eq("test_govuk_forms_a_form_name_that_will_cause_the_filename_to_be_2024-06-01-2024-06-07_1.csv")
+        end
+      end
+    end
+  end
 end

spec/services/aws_ses_submission_batch_service_spec.rb

@@ -12,13 +12,13 @@
     let(:date) { Date.new(2024, 6, 1) }
 
     before do
-      allow(SubmissionFilenameGenerator).to receive(:batch_csv_filename).and_return("filename.csv")
+      allow(SubmissionFilenameGenerator).to receive(:daily_batch_csv_filename).and_return("filename.csv")
       allow(CsvGenerator).to receive(:generate_batched_submissions).and_return(%w[csv-content])
       create_list(:submission, 3, form_document:)
     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)
+      expect(SubmissionFilenameGenerator).to receive(:daily_batch_csv_filename).with(form_name: form.name, date:, mode:, csv_version: nil)
       service.send_daily_batch(date:)
     end
 
@@ -46,12 +46,12 @@
     context "when the csv generator returns multiple csv versions" do
       before do
         allow(CsvGenerator).to receive(:generate_batched_submissions).and_return(%w[csv-content csv-content-2])
-        allow(SubmissionFilenameGenerator).to receive(:batch_csv_filename).and_return("filename.csv", "filename-2.csv")
+        allow(SubmissionFilenameGenerator).to receive(:daily_batch_csv_filename).and_return("filename.csv", "filename-2.csv")
       end
 
       it "calls the SubmissionFilenameGenerator to generate a filename for each form version" do
-        expect(SubmissionFilenameGenerator).to receive(:batch_csv_filename).with(form_name: form.name, date:, mode:, form_version: 1)
-        expect(SubmissionFilenameGenerator).to receive(:batch_csv_filename).with(form_name: form.name, date:, mode:, form_version: 2)
+        expect(SubmissionFilenameGenerator).to receive(:daily_batch_csv_filename).with(form_name: form.name, date:, mode:, csv_version: 1)
+        expect(SubmissionFilenameGenerator).to receive(:daily_batch_csv_filename).with(form_name: form.name, date:, mode:, csv_version: 2)
         service.send_daily_batch(date:)
       end
 
@@ -74,13 +74,13 @@
     let(:end_date) { Date.new(2024, 6, 7) }
 
     before do
-      allow(SubmissionFilenameGenerator).to receive(:batch_csv_filename).and_return("filename.csv")
+      allow(SubmissionFilenameGenerator).to receive(:weekly_batch_csv_filename).and_return("filename.csv")
       allow(CsvGenerator).to receive(:generate_batched_submissions).and_return(%w[csv-content])
       create_list(:submission, 3, form_document:)
     end
 
     it "calls the SubmissionFilenameGenerator with a nil form version" do
-      expect(SubmissionFilenameGenerator).to receive(:batch_csv_filename).with(form_name: form.name, date: end_date, mode:, form_version: nil)
+      expect(SubmissionFilenameGenerator).to receive(:weekly_batch_csv_filename).with(form_name: form.name, mode:, csv_version: nil, begin_date:, end_date:)
       service.send_weekly_batch(begin_date:, end_date:)
     end
 
@@ -109,12 +109,12 @@
     context "when the csv generator returns multiple csv versions" do
       before do
         allow(CsvGenerator).to receive(:generate_batched_submissions).and_return(%w[csv-content csv-content-2])
-        allow(SubmissionFilenameGenerator).to receive(:batch_csv_filename).and_return("filename.csv", "filename-2.csv")
+        allow(SubmissionFilenameGenerator).to receive(:weekly_batch_csv_filename).and_return("filename.csv", "filename-2.csv")
       end
 
       it "calls the SubmissionFilenameGenerator to generate a filename for each form version" do
-        expect(SubmissionFilenameGenerator).to receive(:batch_csv_filename).with(form_name: form.name, date: end_date, mode:, form_version: 1)
-        expect(SubmissionFilenameGenerator).to receive(:batch_csv_filename).with(form_name: form.name, date: end_date, mode:, form_version: 2)
+        expect(SubmissionFilenameGenerator).to receive(:weekly_batch_csv_filename).with(form_name: form.name, mode:, csv_version: 1, begin_date:, end_date:)
+        expect(SubmissionFilenameGenerator).to receive(:weekly_batch_csv_filename).with(form_name: form.name, mode:, csv_version: 2, begin_date:, end_date:)
         service.send_weekly_batch(begin_date:, end_date:)
       end