Change submission services to use language

thomasiles · thomasiles · commit f1a5922e0a8d · 2026-01-28T14:29:41.000Z
We change the submission services which call the CSV and JSON generators
to pass the language instead of locale.

This allows us to decide whether to include language, as taken from
submission locale or pass nil to not include it at all.

Only forms which have more than one language, currently only Welsh
forms, will have language set.
diff --git a/app/services/aws_ses_submission_service.rb b/app/services/aws_ses_submission_service.rb
@@ -52,7 +52,7 @@ def generate_csv_submission
       submission_reference: @submission.reference,
       timestamp: @submission.submission_time,
       is_s3_submission: false,
-      submission_locale: @submission.submission_locale,
+      language:,
     )
   end
 
@@ -63,7 +63,7 @@ def generate_json_submission
       submission_reference: @submission.reference,
       timestamp: @submission.submission_time,
       is_s3_submission: false,
-      submission_locale: @submission.submission_locale,
+      language:,
     )
   end
 
@@ -103,4 +103,10 @@ def generate_csv_filename
   def generate_json_filename
     SubmissionFilenameGenerator.json_filename(form_name: @form.name, submission_reference: @submission.reference)
   end
+
+  def language
+    return nil unless @form.multilingual?
+
+    @submission.submission_locale
+  end
 end
diff --git a/app/services/s3_submission_service.rb b/app/services/s3_submission_service.rb
@@ -46,7 +46,7 @@ def generate_csv_submission
       submission_reference: @submission_reference,
       timestamp: @timestamp,
       is_s3_submission: true,
-      submission_locale: @submission_locale,
+      language:,
     )
   end
 
@@ -57,7 +57,7 @@ def generate_json_submission
       submission_reference: @submission_reference,
       timestamp: @timestamp,
       is_s3_submission: true,
-      submission_locale: @submission_locale,
+      language:,
     )
   end
 
@@ -125,4 +125,10 @@ def generate_key(filename)
     formatted_timestamp = @timestamp.utc.strftime("%Y%m%dT%H%M%SZ")
     "#{folder}/#{@form.id}/#{formatted_timestamp}_#{@submission_reference}/#{filename}"
   end
+
+  def language
+    return nil unless @form.multilingual?
+
+    @submission_locale
+  end
 end
diff --git a/spec/services/aws_ses_submission_service_spec.rb b/spec/services/aws_ses_submission_service_spec.rb
@@ -5,20 +5,22 @@
 
   let(:submission) do
     build(:submission, form_document:, reference: submission_reference, is_preview: is_preview,
-                       created_at: Time.utc(2022, 12, 14, 8, 0o0, 0o0))
+                       created_at: Time.utc(2022, 12, 14, 8, 0o0, 0o0), submission_locale:)
   end
-  let(:form_document) { build(:v2_form_document, name: "A great form", submission_type:, submission_format:, submission_email:, payment_url:) }
+  let(:form_document) { build(:v2_form_document, name: "A great form", submission_type:, submission_format:, submission_email:, payment_url:, available_languages:) }
   let(:all_steps) { [step] }
   let(:journey) { instance_double(Flow::Journey, completed_steps: all_steps, all_steps:, completed_file_upload_questions: []) }
   let(:question) { build :text, question_text: "What is the meaning of life?", text: "42" }
   let(:step) { build :step, question: }
   let(:is_preview) { false }
   let(:submission_reference) { Faker::Alphanumeric.alphanumeric(number: 8).upcase }
+  let(:submission_locale) { "en" }
   let(:payment_url) { nil }
   let(:submission_type) { "email" }
   let(:submission_format) { [] }
   let(:submission_email) { "submissions@example.gov.uk" }
   let(:from_email_address) { "govukforms@example.gov.uk" }
+  let(:available_languages) { %i[en] }
 
   let(:output) { StringIO.new }
   let(:logger) do
@@ -158,7 +160,7 @@
         allow(AwsSesFormSubmissionMailer).to receive(:submission_email).and_call_original
 
         service.submit
-        expected_csv_content = "Reference,Submitted at,What is the meaning of life?,Language\n#{submission_reference},2022-12-14T08:00:00+00:00,42,en\n"
+        expected_csv_content = "Reference,Submitted at,What is the meaning of life?\n#{submission_reference},2022-12-14T08:00:00+00:00,42\n"
 
         expect(AwsSesFormSubmissionMailer).to have_received(:submission_email).with(
           answer_content_html: "<h3>What is the meaning of life?</h3><p>42</p>",
@@ -187,7 +189,7 @@
 
             service.submit
 
-            expected_csv_content = "Reference,Submitted at,#{question.question_text},Language\n#{submission_reference},2022-12-14T08:00:00+00:00,#{question.email_filename},en\n"
+            expected_csv_content = "Reference,Submitted at,#{question.question_text}\n#{submission_reference},2022-12-14T08:00:00+00:00,#{question.email_filename}\n"
 
             expect(AwsSesFormSubmissionMailer).to have_received(:submission_email).with(
               answer_content_html: "<h3>#{question.question_text}</h3><p>#{I18n.t('mailer.submission.file_attached', filename: question.email_filename)}</p>",
@@ -203,6 +205,22 @@
           end
         end
       end
+
+      context "when the submission is Welsh and the form is multilingual" do
+        let(:submission_locale) { "cy" }
+        let(:available_languages) { %i[en cy] }
+
+        it "calls AwsSesFormSubmissionMailer with a CSV file with language set to 'cy'" do
+          allow(AwsSesFormSubmissionMailer).to receive(:submission_email).and_call_original
+
+          service.submit
+          expected_csv_content = "Reference,Submitted at,What is the meaning of life?,Language\n#{submission_reference},2022-12-14T08:00:00+00:00,42,cy\n"
+
+          expect(AwsSesFormSubmissionMailer).to have_received(:submission_email).with(
+            hash_including(files: { "govuk_forms_a_great_form_#{submission_reference}.csv" => expected_csv_content }),
+          ).once
+        end
+      end
     end
 
     context "when the submission type is email with json" do
@@ -223,6 +241,21 @@
 
         service.submit
       end
+
+      context "when the submission is Welsh" do
+        let(:submission_locale) { "cy" }
+        let(:available_languages) { %i[en cy] }
+
+        it "calls AwsSesFormSubmissionMailer with a JSON file with language set to 'cy'" do
+          allow(AwsSesFormSubmissionMailer).to receive(:submission_email).and_call_original
+
+          service.submit
+
+          expect(AwsSesFormSubmissionMailer).to have_received(:submission_email).with(
+            hash_including(files: { "govuk_forms_a_great_form_#{submission_reference}.json" => satisfy { |json| JSON.parse(json)["language"] == "cy" } }),
+          ).once
+        end
+      end
     end
 
     context "when the submission type is email with csv and json" do
diff --git a/spec/services/s3_submission_service_spec.rb b/spec/services/s3_submission_service_spec.rb
@@ -12,7 +12,8 @@
           submission_format:,
           s3_bucket_name:,
           s3_bucket_aws_account_id:,
-          s3_bucket_region:)
+          s3_bucket_region:,
+          available_languages:)
   end
   let(:submission_type) { "s3" }
   let(:submission_format) { %w[csv] }
@@ -32,6 +33,7 @@
   let(:question) { build :text, question_text: "What is the meaning of life?", text: "42" }
   let(:step) { build :step, question: }
   let(:is_preview) { false }
+  let(:available_languages) { %i[en] }
 
   describe "#submit" do
     let(:mock_credentials) { { foo: "bar" } }
@@ -66,7 +68,7 @@
       context "when the submission format is CSV" do
         it "calls put_object with a CSV file and filename" do
           expected_key_name = "form_submissions/#{form.id}/#{expected_timestamp}_#{submission_reference}/form_submission.csv"
-          expected_csv_content = "Reference,Submitted at,What is the meaning of life?,Language\n#{submission_reference},2022-09-14T08:24:34+01:00,42,en\n"
+          expected_csv_content = "Reference,Submitted at,What is the meaning of life?\n#{submission_reference},2022-09-14T08:24:34+01:00,42\n"
           expect(mock_s3_client).to receive(:put_object).with(
             {
               body: expected_csv_content,
@@ -78,6 +80,18 @@
 
           service.submit
         end
+
+        context "when the submssion is Welsh" do
+          let(:submission_locale) { "cy" }
+          let(:available_languages) { %i[en cy] }
+
+          it "generates the submission CSV with the language field" do
+            expected_csv_content = "Reference,Submitted at,What is the meaning of life?,Language\n#{submission_reference},2022-09-14T08:24:34+01:00,42,cy\n"
+            expect(mock_s3_client).to receive(:put_object).with(hash_including(body: expected_csv_content))
+
+            service.submit
+          end
+        end
       end
 
       context "when the submission format is JSON" do
@@ -97,6 +111,17 @@
 
           service.submit
         end
+
+        context "when the submssion is Welsh" do
+          let(:submission_locale) { "cy" }
+          let(:available_languages) { %i[en cy] }
+
+          it "generates the submission JSON with the language field" do
+            expect(mock_s3_client).to receive(:put_object).with(hash_including(body: satisfy { |args| JSON.parse(args)["language"] == "cy" }))
+
+            service.submit
+          end
+        end
       end
 
       context "when the form has answered file upload questions" do
@@ -113,8 +138,8 @@
         context "when the submission format is CSV" do
           it "creates the CSV file with the expected filenames" do
             expected_key_name = "form_submissions/#{form.id}/#{expected_timestamp}_#{submission_reference}/form_submission.csv"
-            expected_csv_content = "Reference,Submitted at,#{first_file_upload_question.question_text},#{second_file_upload_question.question_text},Language\n" \
-              "#{submission_reference},2022-09-14T08:24:34+01:00,file.txt,file_1.txt,en\n"
+            expected_csv_content = "Reference,Submitted at,#{first_file_upload_question.question_text},#{second_file_upload_question.question_text}\n" \
+              "#{submission_reference},2022-09-14T08:24:34+01:00,file.txt,file_1.txt\n"
             expect(mock_s3_client).to receive(:put_object).with(
               {
                 body: expected_csv_content,
@@ -192,7 +217,7 @@
 
         it "calls put_object with the 'test_form_submissions/' key prefix" do
           expected_key_name = "test_form_submissions/#{form.id}/#{expected_timestamp}_#{submission_reference}/form_submission.csv"
-          expected_csv_content = "Reference,Submitted at,#{question.question_text},Language\n#{submission_reference},2022-09-14T08:24:34+01:00,file.txt,en\n"
+          expected_csv_content = "Reference,Submitted at,#{question.question_text}\n#{submission_reference},2022-09-14T08:24:34+01:00,file.txt\n"
           expect(mock_s3_client).to receive(:put_object).with({
             body: expected_csv_content,
             bucket: s3_bucket_name,
