Clean up errors on each request

Author: rossjones

lib/importer/index.js

@@ -30,28 +30,38 @@ exports.Initialise = (config, router, prototypeKit) => {
   // one created by us.
   config.uploadPath ??= path.join(os.tmpdir(), 'reg-dyn-importer'); ;
 
+
   //--------------------------------------------------------------------
   // Removes any previous importer error from the session. When we set
   // an error we redirect to the referer and we expect that page to show
   // the error. Calling this in each POST endpoint ensures that we don't
   // remember errors after they have been shown,
   //--------------------------------------------------------------------
-  const cleanRequest = (request) => {
+  router.all("*", (request, res, next) => {
     delete request.session.data[IMPORTER_ERROR_KEY]
-  }
+    next();
+  });
+
 
   //--------------------------------------------------------------------
   // Make the route functions available in the templates. These functions
   // allow users to find the path that they should use to submit data,
   // and also allows them to specify which url to redirect to after
-  // the POST data has been processed.
+  // the POST data has been processed. Where an extra error url is provided
+  // it will be used if the POST request does not succeed (e.g. when
+  // mapping the data this can be used to redirect to the review page
+  // to view warnings)
   //--------------------------------------------------------------------
   for ([key, value] of IMPORTER_ROUTE_MAP) {
     const k = key;
     const v = value;
 
-    prototypeKit.views.addFunction(k, (next)=>{
-      return `${v}?next=${encodeURIComponent(next)}`;
+    prototypeKit.views.addFunction(k, (next, errorPage=null)=>{
+      let url = `${v}?next=${encodeURIComponent(next)}`;
+      if (errorPage) {
+        url = url + `&error=${encodeURIComponent(errorPage)}`
+      }
+      return url
     }, {})
   }
 
@@ -169,8 +179,13 @@ exports.Initialise = (config, router, prototypeKit) => {
   // Redirects the current request to the 'next' URL after decoding the
   // encoded URI.
   //--------------------------------------------------------------------
-  const redirectOnwards = (request, response) => {
-    response.redirect(decodeURIComponent(request.query.next));
+  const redirectOnwards = (request, response, failed=false) => {
+    console.log(request.query)
+    if (failed && request.query.error) {
+      response.redirect(decodeURIComponent(request.query.error));
+    } else {
+      response.redirect(decodeURIComponent(request.query.next));
+    }
   }
 
   //--------------------------------------------------------------------
@@ -181,7 +196,6 @@ exports.Initialise = (config, router, prototypeKit) => {
   // time we run through the process.
   //--------------------------------------------------------------------
   router.all(IMPORTER_ROUTE_MAP.get("importerStartPath"),(request, response) => {
-    cleanRequest(request);
     redirectOnwards(request, response);
   });
 
@@ -192,8 +206,6 @@ exports.Initialise = (config, router, prototypeKit) => {
   const uploader = getUploader(config);
 
   router.post(IMPORTER_ROUTE_MAP.get("importerUploadPath"), uploader.single("file"), (request, response) => {
-      cleanRequest(request);
-
       let createResponse = session_lib.CreateSession(config, request);
 
       if (createResponse.error) {
@@ -320,6 +332,15 @@ exports.Initialise = (config, router, prototypeKit) => {
     }
 
     session.mapping = request.body;
+    if (Object.values(session.mapping).every((v) => v=='') ) {
+      request.session.data[IMPORTER_ERROR_KEY] = "No columns were mapped to the expected fields"
+      if (!request.query.error) {
+        response.redirect(request.get('Referrer'))
+      } else {
+        redirectOnwards(request, response, failed=true);
+      }
+      return;
+    }
 
     // Ensure the session is persisted. Currently in session, eventually another way
     request.session.data[IMPORTER_SESSION_KEY] = session;

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

@@ -17,13 +17,25 @@
 {% 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 error = importerError(data) %}
 
-    {% if error %}
-    <p id="mapping-error" class="govuk-error-message">
-      <span class="govuk-visually-hidden">Error:</span> {{ error.text }}
-    </p>
-    {% endif %}
+
+  {% if error %}
+  <div class="govuk-error-summary" data-module="govuk-error-summary">
+    <div role="alert">
+      <h2 class="govuk-error-summary__title">
+        There was a problem submitting this data
+      </h2>
+      <div class="govuk-error-summary__body">
+        <ul class="govuk-list govuk-error-summary__list">
+          <li>
+            {{ error.text }}
+          </li>
+        </ul>
+      </div>
+    </div>
+  </div>
+  {% endif %}
 
 
 <table class="govuk-table">

prototypes/basic/app/views/mapping.html

@@ -14,7 +14,7 @@ <h1 class="govuk-heading-l">Map columns</h1>
 
         <h2 class="govuk-heading-m">{{sheet}}</h2>
 
-        <form action="{{ importerMapDataPath('/success') }}" method="post">
+        <form action="{{ importerMapDataPath('/success', '/review') }}" method="post">
 
             {{ importerFieldMapper(data) }}