Add language to JSON

Add a language property to the JSON submission.

We add language to our JSON schema or at least the version we keep in
this repository for testing.

JSON

Author: thomasiles

app/lib/json_submission_generator.rb

@@ -1,10 +1,11 @@
 class JsonSubmissionGenerator
-  def self.generate_submission(form:, all_steps:, submission_reference:, timestamp:, is_s3_submission:)
+  def self.generate_submission(form:, all_steps:, submission_reference:, timestamp:, is_s3_submission:, submission_locale:)
     submission = {
       "$schema" => "#{Settings.forms_product_page.base_url}/json-submissions/v1/schema",
       form_name: form.name,
       submission_reference:,
       submitted_at: timestamp.getutc.iso8601(3),
+      language: submission_locale,
       answers: all_steps.flat_map { |step| step.show_answer_in_json(is_s3_submission) },
     }
     JSON.pretty_generate(submission)

app/services/aws_ses_submission_service.rb

@@ -63,6 +63,7 @@ def generate_json_submission
       submission_reference: @submission.reference,
       timestamp: @submission.submission_time,
       is_s3_submission: false,
+      submission_locale: @submission.submission_locale,
     )
   end
 

app/services/s3_submission_service.rb

@@ -57,6 +57,7 @@ def generate_json_submission
       submission_reference: @submission_reference,
       timestamp: @timestamp,
       is_s3_submission: true,
+      submission_locale: @submission_locale,
     )
   end
 

spec/fixtures/json_submission_schema_v1.json

@@ -16,6 +16,10 @@
       "type": "string",
       "format": "date-time"
     },
+    "language": {
+      "enum": ["en", "cy"],
+      "description": "The language the form was submitted. If there is a Welsh version of the form then this will be 'cy', otherwise 'en'."
+    },
     "answers": {
       "description": "An array containing all the answers provided.",
       "type": "array",

spec/lib/json_submission_generator_spec.rb

@@ -14,12 +14,13 @@
   let(:selection_step) { build :step, page: build(:page, :with_selections_settings), question: selection_question }
   let(:all_steps) { [text_step, name_step, file_step, address_step, selection_step] }
   let(:submission_reference) { Faker::Alphanumeric.alphanumeric(number: 8).upcase }
+  let(:submission_locale) { :en }
   let(:timestamp) do
     Time.use_zone("London") { Time.zone.local(2022, 9, 14, 8, 0, 0) }
   end
 
   describe ".generate_submission" do
-    subject(:json_submission) { described_class.generate_submission(form:, all_steps:, submission_reference:, timestamp:, is_s3_submission:) }
+    subject(:json_submission) { described_class.generate_submission(form:, all_steps:, submission_reference:, timestamp:, is_s3_submission:, submission_locale:) }
 
     let(:parsed_json) { JSON.parse(json_submission) }
 
@@ -56,6 +57,7 @@
           "form_name" => form.name,
           "submission_reference" => submission_reference,
           "submitted_at" => "2022-09-14T07:00:00.000Z",
+          "language" => "en",
           "answers" => [
             {
               "question_id" => text_step.page.id,
@@ -108,6 +110,7 @@
             "form_name" => form.name,
             "submission_reference" => submission_reference,
             "submitted_at" => "2022-09-14T07:00:00.000Z",
+            "language" => "en",
             "answers" => [
               {
                 "question_id" => repeatable_step.page.id,