feat/df-1064: Prevents go-live if translations missing or out-of-sync

src/api/forms/constants.js

@@ -14,7 +14,11 @@ export const makeFormLiveErrorMessages = {
   missingTermsAndConditions:
     'You must confirm you meet the terms and conditions before you make this form live.',
   missingLivePaymentApiKey:
-    'You must add a valid live payment API key before you make this form live.'
+    'You must add a valid live payment API key before you make this form live.',
+  missingTranslations:
+    'You must finish translating the whole form into Welsh before making this form live.',
+  outOfSyncTranslations:
+    'You have made changes to the form that have affected Welsh translations. You must re-save the Welsh translations.'
 }
 
 export const removeFormErrorMessages = {

src/api/forms/service/definition.js

@@ -2,6 +2,7 @@ import {
   Engine,
   FormDefinitionRequestType,
   FormStatus,
+  buildTranslationDataRows,
   getErrorMessage,
   isPaymentPage
 } from '@defra/forms-model'
@@ -192,6 +193,43 @@ function missingTermsAndConditions(form) {
   return !form.termsAndConditionsAgreed
 }
 
+/**
+ * @param {FormMetadata} form
+ * @param {FormDefinition} definition
+ */
+function checkForMissingTranslations(form, definition) {
+  // Ignore if no translations
+  // @ts-expect-error - dynamic language name
+  if (!definition.metadata?.translations?.cy) {
+    return
+  }
+
+  // @ts-expect-error - dynamic language name
+  const cy = definition.metadata.translations.cy
+
+  // Check if translation entries are in sync with form definition
+  const translations = buildTranslationDataRows(form, definition)
+  const combinedRows = translations.overviewRows.concat(translations.formRows)
+  const expectedKeys = new Set(combinedRows.map((row) => row.name))
+  const foundKeys = new Set(Object.keys(cy))
+
+  const added = [...foundKeys].filter((v) => !expectedKeys.has(v))
+  const removed = [...expectedKeys].filter((v) => !foundKeys.has(v))
+
+  if (added.length || removed.length || foundKeys.size !== expectedKeys.size) {
+    throw Boom.badRequest(makeFormLiveErrorMessages.outOfSyncTranslations)
+  }
+
+  // Check for any empty translations
+  const hasEmptyValues = Object.entries(
+    // @ts-expect-error - dynamic language name
+    definition.metadata.translations.cy
+  ).some(([, value]) => !value)
+  if (hasEmptyValues) {
+    throw Boom.badRequest(makeFormLiveErrorMessages.missingTranslations)
+  }
+}
+
 /**
  * Validates form and form definition for publishing to live
  * @param {string} formId - ID of the form
@@ -251,6 +289,8 @@ function validateFormForPublishing(
   if (!form.notificationEmail) {
     throw Boom.badRequest(makeFormLiveErrorMessages.missingOutputEmail)
   }
+
+  checkForMissingTranslations(form, draftFormDefinition)
 }
 
 /**

src/api/forms/service/definition.test.js

@@ -424,6 +424,55 @@
       )
     })
 
+    it('should fail to create a live state from existing draft form when the Welsh translations are out of sync', async () => {
+      jest.mocked(formMetadata.get).mockResolvedValue(formMetadataDocument)
+
+      jest.mocked(formDefinition.get).mockResolvedValueOnce(
+        /** @type {FormDefinition} */ ({
+          ...definition,
+          metadata: {
+            translations: {
+              cy: {
+                'form.title': 'Welsh form title'
+              }
+            }
+          }
+        })
+      )
+
+      await expect(createLiveFromDraft(id, author)).rejects.toThrow(
+        Boom.badRequest(makeFormLiveErrorMessages.outOfSyncTranslations)
+      )
+    })
+
+    it('should fail to create a live state from existing draft form when the Welsh translations are not fully completed', async () => {
+      jest.mocked(formMetadata.get).mockResolvedValue(formMetadataDocument)
+
+      jest.mocked(formDefinition.get).mockResolvedValueOnce(
+        /** @type {FormDefinition} */ ({
+          ...definition,
+          metadata: {
+            translations: {
+              cy: {
+                'form.title': 'Welsh form title',
+                'form.contact.email.address': 'my-email@test.com',
+                'form.contact.email.responseTime': 'Welsh response time',
+                'form.contact.online.url': 'https://welsh-contact.org',
+                'form.contact.online.text': 'Welsh contact text',
+                'form.contact.phone': 'Welsh phone',
+                'form.submissionGuidance': 'Welsh submission guidance',
+                'form.privacyNoticeUrl': ''
+              }
+            }
+          }
+        })
+      )
+
+      await expect(createLiveFromDraft(id, author)).rejects.toThrow(
+        Boom.badRequest(makeFormLiveErrorMessages.missingTranslations)
+      )
+    })
+
     it('should succeed to create a live state from existing draft form when there is no start page when engine is V2', async () => {
       const draftV2DefinitionNoStartPage = /** @type {FormDefinition} */ ({
         ...definition,