Merge branch 'main' into rosado/712-validation-msg

config/default.yaml

@@ -42,6 +42,10 @@ email: {
 validations: {
     maxFileSize: 100000000
 }
+contact:
+  issues:
+    # description: should be used for general issues, e.g. if user lands on 404 doesn't know how to proceed
+    email: [email protected]
 datasetsConfig:
   article-4-direction:
     guidanceUrl: /guidance/specifications/article-4-direction

config/util.js

@@ -94,7 +94,12 @@ export const ConfigSchema = v.object({
       measurementId: v.string()
     })
   ),
-  tablePageLength: v.number()
+  tablePageLength: v.number(),
+  contact: v.object({
+    issues: v.object({
+      email: v.pipe(v.string(), v.email())
+    })
+  })
 })
 
 const readConfig = (config) => {

package.json

@@ -6,15 +6,15 @@
   "type": "module",
   "scripts": {
     "prepare": "husky",
-    "dev": "docker-compose -f docker-compose-real-backend-minus-frontend.yml up -d && npm run start:local",
+    "dev": "docker compose -f docker-compose-real-backend-minus-frontend.yml up -d && npm run start:local",
     "start": "node index.js",
     "start:watch": "concurrently \"nodemon --exec 'npm run build && npm run start'\" \"npm run scss:watch\"",
     "start:test": "NODE_ENV=test node index.js",
     "start:local": "NODE_ENV=local node index.js",
-    "start:wiremock": "docker-compose up -d --force-recreate --build && NODE_ENV=wiremock node index.js",
+    "start:wiremock": "docker compose up -d --force-recreate --build && NODE_ENV=wiremock node index.js",
     "start:development": "NODE_ENV=development node index.js",
     "start:local:watch": "NODE_ENV=test npm run start:watch",
-    "docker-security-scan": "docker-compose -f docker-compose.security.yml run --rm zap",
+    "docker-security-scan": "docker compose -f docker-compose.security.yml run --rm zap",
     "static-security-scan": "npm audit --json > npm-audit-report.json",
     "scan:zap": "npm run docker-security-scan && npm run static-security-scan",
     "mock:api": "node ./test/mock-api/index.js",

readme.md

@@ -102,11 +102,11 @@ of [package.json](package.json)) for more examples.
     ```
 - Run the application using docker
     ```
-    docker-compose -f docker-compose-real-backend.yml up
+    docker compose -f docker-compose-real-backend.yml up
     ```
 - Run the application (without the frontend) using docker
     ```
-    docker-compose -f docker-compose-real-backend-minus-frontend.yml up
+    docker compose -f docker-compose-real-backend-minus-frontend.yml up
     ```
 - Run external services in containers and start application
     ```

src/assets/scss/index.scss

@@ -215,3 +215,11 @@ code * {
 .app-content__markdown img {
   max-width: 100%;
 }
+
+.schema-issue {
+  display: flex;
+  flex-direction: column;
+  padding-bottom: 1em;
+}
+
+.schema-issue p { padding: 0; margin: 0}

src/filters/filters.js

@@ -8,6 +8,7 @@ import { checkToolDeepLink } from './checkToolDeepLink.js'
 import pluralize from 'pluralize'
 import { datasetSlugToReadableName } from '../utils/datasetSlugToReadableName.js'
 import { getDatasetGuidanceUrl } from './getDatasetConfig.js'
+import { schemaIssues } from './schemaIssues.js'
 
 /** maps dataset status (as returned by `fetchLpaOverview` middleware to a
  * CSS class used by the govuk-tag component
@@ -43,6 +44,7 @@ const addFilters = (nunjucksEnv) => {
   nunjucksEnv.addFilter('pluralise', pluralize)
   nunjucksEnv.addFilter('checkToolDeepLink', checkToolDeepLink)
   nunjucksEnv.addFilter('getDatasetGuidanceUrl', getDatasetGuidanceUrl)
+  nunjucksEnv.addFilter('schemaIssues', schemaIssues)
 }
 
 export default addFilters

src/filters/schemaIssues.js

@@ -0,0 +1,21 @@
+import * as v from 'valibot'
+
+/**
+ * Takes an Error and if it's a ValiError, returns an array of issue summaries (with paths). Empty array otherwise.
+ *
+ * Useful to show the schema issues in a consise way.
+ *
+ * @param {Error} error
+ * @returns { { path: string[], message: string}[] }
+ */
+export function schemaIssues (error) {
+  const issues = []
+  if (v.isValiError(error)) {
+    for (const issue of error.issues) {
+      if (issue.path) {
+        issues.push({ path: issue.path.map(elem => elem.key), message: issue.message })
+      }
+    }
+  }
+  return issues
+}