Ensure required fields are included in mapping

Author: rossjones

lib/importer/nunjucks/importer/macros/field_mapper.njk

@@ -17,14 +17,35 @@
 {% macro importerFieldMapper(data, caption='', columnTitle='Column', examplesTitle='Example values', fieldsTitle='Fields') %}
     {% set fields = data['importer.session']['fields'] %}
     {% set headings = importerGetHeaders(data) %}
-    {% set error = headings.error %}
+    {% set headingError = headings.error %}
+    {% set error = importerError(data) %}
 
-    {% if error %}
+    {% if headingError %}
     <p id="mapping-error" class="govuk-error-message">
-      <span class="govuk-visually-hidden">Error:</span> {{ error.text }}
+      <span class="govuk-visually-hidden">Error:</span> {{ headingError.text }}
     </p>
     {% endif %}
 
+    {% if error %}
+<div class="govuk-error-summary" data-module="govuk-error-summary">
+  <div role="alert">
+    <h2 class="govuk-error-summary__title">
+      {{ error.text }}
+    </h2>
+    <div class="govuk-error-summary__body">
+      <ul class="govuk-list govuk-error-summary__list">
+        {% for e in error.extra %}
+        <li>
+          <a href="#">{{ e }}</a>
+        </li>
+        {% endfor %}
+      </ul>
+    </div>
+  </div>
+</div>
+
+    {% endif %}
+
 
 <table class="govuk-table">
   {% if caption %}

lib/importer/src/index.js

@@ -7,6 +7,7 @@ const sheets_lib = require("./sheets.js");
 
 const IMPORTER_SESSION_KEY = "importer.session";
 const IMPORTER_ERROR_KEY = "importer.error";
+const IMPORTER_ERROR_EXTRA_KEY = "importer.error.extra";
 
 //--------------------------------------------------------------------
 // The endpoints used to receive POST requests from importer macros,
@@ -73,6 +74,7 @@ exports.Initialise = (config, router, prototypeKit) => {
   const cleanRequest = (request) => {
     delete request.session.data['reference_number'];
     delete request.session.data[IMPORTER_ERROR_KEY];
+    delete request.session.data[IMPORTER_ERROR_EXTRA_KEY];
   };
 
 
@@ -124,7 +126,7 @@ exports.Initialise = (config, router, prototypeKit) => {
     "importerError",
     (data) => {
       if (data[IMPORTER_ERROR_KEY]) {
-        return { text: data[IMPORTER_ERROR_KEY] };
+        return { text: data[IMPORTER_ERROR_KEY], extra: data[IMPORTER_ERROR_EXTRA_KEY] };
       }
 
       return false;
@@ -510,9 +512,33 @@ exports.Initialise = (config, router, prototypeKit) => {
         return;
       }
 
+      request.session.data['reference_number'] = session.id.match(/\d+/g).join("").substring(0, 8);
+
       session.mapping = request.body;
 
-      request.session.data['reference_number'] = session.id.match(/\d+/g).join("").substring(0, 8);
+      const values = new Array();
+
+      for (const [key, value] of Object.entries(session.mapping)) {
+        if (value != '') {
+          values.push(value)
+        }
+      }
+
+      // For each key in the config that is required, we need to ensure that the field name is present
+      // in the values array. If not then we will
+      const required_fields = plugin_config.fields
+        .filter((f) => f.required)
+        .filter((f) => !values.includes(f.name))
+        .map((f) => f.name)
+
+      // If required_fields has any values left, then they are required fields not present in the
+      // mapping. In which case we should return an error for the user.
+      if (required_fields.length > 0) {
+        request.session.data[IMPORTER_ERROR_KEY] = "The following fields are required"
+        request.session.data[IMPORTER_ERROR_EXTRA_KEY] = required_fields
+        response.redirect(request.get('Referrer'));
+        return;
+      }
 
       // Ensure the session is persisted. Currently in session, eventually another way
       request.session.data[IMPORTER_SESSION_KEY] = session;