use new 'serviceNames' configuration object

Seems like we're passing 'serviceName' to nunjucks in a lot of places
for no reason - we already use `getFullServiceName()` to map a
short service name (called 'serviceType' in the templates) to a full
service name. Switching to a map of service names allows us to skip
passing the service name explicitly.

config/default.yaml

@@ -16,7 +16,14 @@ aws: {
 }
 # ToDo: url and name might need updating
 url: 'https://check-planning.data.gov.uk'
-serviceName: 'Provide planning and housing data for England'
+# NOTE: this property is deprecated, use serviceNames instead
+serviceName: 'Submit and update your planning data'
+# NOTE: the keys in this map are sometimes referred to as "serviceType" in the templates
+serviceNames: {
+    submit: 'Submit and update your planning data',
+    check: 'Check planning and housing data for England',
+    manage: 'Manage planning and housing data for England'
+}
 feedbackLink: 'https://docs.google.com/forms/d/e/1FAIpQLSdYXqY0Aaket9XJBiGDhSL_CD_cxHZxgvQCFZZtdURdvvIY5A/viewform'
 email: {
     templates: {

config/util.js

@@ -3,17 +3,19 @@ import _ from 'lodash'
 import yaml from 'js-yaml'
 import * as v from 'valibot'
 
+const NonEmptyString = v.pipe(v.string(), v.nonEmpty())
+
 export const ConfigSchema = v.object({
   port: v.pipe(v.integer(), v.minValue(1)),
   asyncRequestApi: v.object({
     url: v.url(),
     port: v.pipe(v.integer(), v.minValue(1)),
-    requestsEndpoint: v.pipe(v.string(), v.nonEmpty()),
+    requestsEndpoint: NonEmptyString,
     requestTimeout: v.number()
   }),
   maintenance: v.object({
     serviceUnavailable: v.boolean(),
-    upTime: v.pipe(v.string(), v.nonEmpty())
+    upTime: NonEmptyString
   }),
   aws: v.object({
     region: v.string(),
@@ -23,12 +25,17 @@ export const ConfigSchema = v.object({
   redis: v.optional(
     v.object({
       secure: v.boolean(),
-      host: v.pipe(v.string(), v.nonEmpty()),
+      host: NonEmptyString,
       port: v.number()
     })
   ),
   url: v.url(),
-  serviceName: v.pipe(v.string(), v.nonEmpty()),
+  serviceName: NonEmptyString,
+  serviceNames: v.object({
+    provide: NonEmptyString,
+    submit: NonEmptyString,
+    manage: NonEmptyString,
+  }),
   feedbackLink: v.url(),
   email: v.object({
     templates: v.object({

src/filters/getFullServiceName.js

@@ -1,7 +1,17 @@
+import { type } from 'os'
 import config from '../../config/index.js'
 
+/*
+  * Get the full service name from the short service name.
+  * 
+  * The names should be specified in the config under 'serviceNames'.
+  * 
+  * @param {string} service
+  * @returns {string}
+  */
 export default (service) => {
-  const serviceName = config.serviceName
-
-  return serviceName.replace('Provide', service)
+  if (typeof service !== 'string') {
+    throw new TypeError('Service must be a string')
+  }
+  return config.serviceNames[service.toLowerCase()] || service
 }

src/routes/health.js

@@ -31,7 +31,7 @@ router.get('/', async (req, res) => {
   }
 
   const toReturn = {
-    name: config.serviceName,
+    name: config.serviceNames['submit'],
     environment: config.environment,
     version: process.env.GIT_COMMIT || 'unknown',
     maintenance: config.maintenance.serviceUnavailable,

src/serverSetup/nunjucks.js

@@ -21,7 +21,7 @@ export function setupNunjucks ({ app, dataSubjects }) {
   })
 
   const globalValues = {
-    serviceName: config.serviceName,
+    serviceName: config.serviceNames['submit'],
     feedbackLink: config.feedbackLink
   }
 

test/unit/check-answers.test.js

@@ -24,7 +24,6 @@ describe('check-answers View', async () => {
 
   runGenericPageTests(html, {
     pageTitle: 'Check your answers - Check planning and housing data for England',
-    serviceName: config.serviceName
   })
 
   it('should render the lpa selected', () => {

test/unit/check/confirmationPage.test.js

@@ -19,7 +19,6 @@ describe('Check confirmation View', () => {
 
   runGenericPageTests(html, {
     pageTitle: 'A Mock dataset submitted - Submit and update your planning data',
-    serviceName: config.serviceName
   })
 
   it('should render the gov uk panel', () => {

test/unit/choose-datasetPage.test.js

@@ -14,7 +14,6 @@ describe('choose dataset View', () => {
 
   runGenericPageTests(html, {
     pageTitle: 'Choose dataset - Submit and update your planning data',
-    serviceName: config.serviceName
   })
 
   it('should display an error message when the dataset field is empty', () => {

test/unit/dataset-details.test.js

@@ -44,7 +44,7 @@ describe('dataset details View', () => {
   const datasetName = mockDataSubjects.mockDataset.dataSets[0].text
   runGenericPageTests(html, {
     pageTitle: `Enter ${datasetName.toLowerCase()} details - Submit and update your planning data`,
-    serviceName: config.serviceName
+    serviceName: config.serviceNames['submit']
   })
 
   it('should render the correct header', () => {

test/unit/endpointSubmissionForm/confirmationPage.test.js

@@ -19,7 +19,6 @@ describe('Submit confirmation View', () => {
 
   runGenericPageTests(html, {
     pageTitle: 'A Mock dataset submitted - Submit and update your planning data',
-    serviceName: config.serviceName
   })
 
   it('should render the gov uk panel', () => {

test/unit/lpa-detailsPage.test.js

@@ -15,7 +15,6 @@ describe('Lpa-details View', () => {
 
   runGenericPageTests(htmlNoErrors, {
     pageTitle: 'Enter LPA details - Submit and update your planning data',
-    serviceName: config.serviceName
   })
 
   describe('validation errors', () => {

test/unit/lpaOverviewPage.test.js

@@ -26,7 +26,6 @@ describe('LPA Overview Page', () => {
     organisation: {
       name: 'mock org'
     },
-    serviceName: config.serviceName,
     datasetsWithEndpoints: 2,
     totalDatasets: 8,
     datasetsWithErrors: 2,
@@ -85,7 +84,6 @@ describe('LPA Overview Page', () => {
 
   runGenericPageTests(html, {
     pageTitle: 'mock org overview - Manage planning and housing data for England',
-    serviceName: config.serviceName
   })
 
   const statsBoxes = document.querySelector('.dataset-status').children

test/unit/startPage.test.js

@@ -14,6 +14,5 @@ describe('Start View', () => {
 
   runGenericPageTests(html, {
     // we skip pageTitle since this is the main page, and service name alone is sufficient
-    serviceName: config.serviceName
   })
 })