Skip the formats page if no columns are mapped to attributes whose types require formats

Author: alaric-rd

lib/importer/src/dudk/backend.js

@@ -56,6 +56,7 @@ exports.SessionSetFile = (sid, filename) => {
     sheetNames: Array.from(Object.keys(wb.Sheets)),
     jobs: new Map(),
     // State we store for the frontend (we don't do anything with it, just store it and spit it back on demand)
+    attributeDefs: [], // A list of objects with {name:string, required:boolean, type:string} defining the attributes we output
     headerRanges: {}, // A map from sheetname to the header range
     footerRanges: {}, // A map from sheetname to the footer range
     mappingRules: {}, // A map from column index to attribute name
@@ -68,14 +69,9 @@ exports.SessionSetFile = (sid, filename) => {
 /// Storage of UI state for the frontend
 ///
 
-exports.SessionGetMappingRules = (sid) => {
-  let session = sessionStore.get(sid);
-  return session.mappingRules;
-};
-
-exports.SessionSetMappingRules = (sid, rules) => {
-  sessionStore.apply(sid, (s) => { s.mappingRules = rules })
-};
+exports.SessionSetAttributes = (sid, attrDefs) => {
+  sessionStore.apply(sid, (s) => { s.attribudeDefs = attrDefs })
+}
 
 exports.SessionSetHeaderRange = (sid, range) => {
   assert(range != null, "Null range passed to SessionSetHeaderRange");
@@ -100,6 +96,15 @@ exports.SessionGetFooterRange = (sid, sheetName) => {
   return session.footerRanges[sheetName]
 };
 
+exports.SessionGetMappingRules = (sid) => {
+  let session = sessionStore.get(sid);
+  return session.mappingRules;
+};
+
+exports.SessionSetMappingRules = (sid, rules) => {
+  sessionStore.apply(sid, (s) => { s.mappingRules = rules })
+};
+
 exports.SessionGetFormatChoices = (sid) => {
   let session = sessionStore.get(sid);
   return session.formatChoices;
@@ -109,6 +114,35 @@ exports.SessionSetFormatChoices = (sid, choices) => {
   sessionStore.apply(sid, (s) => { s.formatChoices = choices })
 };
 
+///
+/// Frontend helpers
+///
+
+
+// Returns an array of column indexes that need a format to be chosen - requires
+// that SessionSetAttributes and SessionSetMappingRules have both happened so we
+// have the required information.
+exports.SessionGetColumnsNeedingFormats = (sid) => {
+  const session = sessionStore.get(sid);
+  const attributes = session.attribudeDefs;
+  const mappings = session.mappingRules;
+  const supportedTypes = attributeTypes.supportedTypes;
+
+  let columnsNeedingFormats = new Array();
+
+  Object.entries(mappings).forEach((entry) => {
+    const [colIdx, columnAttribute] = entry;
+    const columnDef = attributes.find((attr) => attr.name == columnAttribute);
+    const columnTypeName = columnDef.type;
+    const columnType = supportedTypes.get(columnTypeName);
+    if (columnType.formats) {
+      columnsNeedingFormats.push(colIdx);
+    }
+  });
+
+  return columnsNeedingFormats;
+};
+
 ///
 /// Information about the loaded input file
 ///

lib/importer/src/index.js

@@ -2,6 +2,7 @@ const multer = require("multer");
 const conf = require("./config.js");
 const fs = require("node:fs");
 const path = require("node:path");
+const backend = require("./dudk/backend.js");
 const session_lib = require("./session.js");
 const sheets_lib = require("./dudk/sheets.js");
 const tpl_functions = require("./functions.js")
@@ -434,6 +435,17 @@ exports.Initialise = (config, router, prototypeKit) => {
           delete request.session.data[IMPORTER_ERROR_EXTRA_KEY]
           delete request.session.data[IMPORTER_ERROR_DATA_KEY]
         }
+
+        // If we are processing mappings, AND we are given two next-page paths
+        // to consider, then we should select the other next page if there are
+        // no format choices to be made
+        if ("other" in request.query) {
+          const columnsNeedingFormats = backend.SessionGetColumnsNeedingFormats(session.backendSid);
+          if(columnsNeedingFormats.length == 0) {
+            const otherPage = decodeURIComponent(request.query.other)
+            if (otherPage) { request.query.next = request.query.other }
+          }
+        }
       }
 
       // Ensure the session is persisted. Currently in session, eventually another way

lib/importer/src/session.js

@@ -14,6 +14,7 @@ class Session {
       backend.SessionSetFile(this.backendSid, p.filename);
     }
 
+    backend.SessionSetAttributes(this.backendSid, p.fields);
     this.fields = p.fields;
     this.sheet = p.sheet ?? "";
   }

lib/importer/templates/format.html

@@ -0,0 +1,34 @@
+{% extends "layouts/main.html" %}
+
+{% block pageTitle %} {{ serviceName }} – GOV.UK Prototype Kit {% endblock %}
+
+{% block beforeContent %}
+{{ govukBackLink({ text: "Back", href: "javascript:window.history.back()" }) }}
+{% endblock %}
+
+{% from "importer/macros/format_picker.njk" import dudkFormatPicker %}
+
+{% block content %}
+<div class="govuk-grid-row">
+    <div class="govuk-grid-column-full">
+        <h1 class="govuk-heading-l">Identify columns</h1>
+        <p class="govuk-body">
+            Select a format for any fields that need it. FIXME: Write better text here...
+        </p>
+
+        <h2 class="govuk-heading-m">{{sheet}}</h2>
+
+        <form action="{{ importerMapDataPath('/review') }}" method="post">
+
+            {{ dudkFormatPicker({data: data}) }}
+
+            <div class="govuk-grid-column-two-thirds">
+                <div class="govuk-button-group">
+                    {{ govukButton({ text: "Submit" }) }}
+                </div>
+            </div>
+
+        </form>
+    </div>
+</div>
+{% endblock %}

lib/importer/templates/mapping.html

@@ -20,7 +20,7 @@ <h1 class="govuk-heading-l">Identify columns</h1>
 
         <h2 class="govuk-heading-m">{{sheet}}</h2>
 
-        <form action="{{ importerMapDataPath('/format') }}" method="post">
+        <form action="{{ importerMapDataPath('/format','/review') }}" method="post">
 
             {{ dudkFieldMapper({data: data}) }}
 

prototypes/basic/app/views/format.html

@@ -0,0 +1,67 @@
+{% extends "layouts/main.html" %}
+
+{% block pageTitle %} {{ serviceName }} – GOV.UK Prototype Kit {% endblock %}
+
+{% block beforeContent %}
+{{
+    govukBreadcrumbs({
+      items: [
+        {
+          text: "Home",
+          href: "/"
+        },
+        {
+            text: "Upload spreadsheet",
+            href: "/upload"
+        },
+        {
+          text: "Select sheet",
+          href: "/select_sheet"
+        },
+        {
+            text: "Select header row",
+            href: "/select_header_row"
+        },
+        {
+            text: "Select footer row",
+            href: "/select_footer_row"
+        },
+        {
+            text: "Identify columns",
+            href: "/mapping"
+        },
+        {
+	    text: "Choose formats",
+            href: "/format"
+        }
+      ]
+    })
+  }}
+{% endblock %}
+
+{% from "importer/macros/format_picker.njk" import dudkFormatPicker %}
+
+{% block content %}
+<div class="govuk-grid-row">
+    <div class="govuk-grid-column-full">
+        <h1 class="govuk-heading-l">Choose formats</h1>
+        <p class="govuk-body">
+            Select a format for any fields that need it. FIXME: Write better text here...
+        </p>
+
+        <h2 class="govuk-heading-m">{{sheet}}</h2>
+
+        <form action="{{ importerMapDataPath('/review') }}" method="post">
+
+            {{ dudkFormatPicker({data: data}) }}
+
+            <div class="govuk-grid-column-two-thirds">
+                <div class="govuk-button-group">
+                    {{ govukButton({ text: "Submit" }) }}
+                </div>
+            </div>
+
+        </form>
+    </div>
+</div>
+{% endblock %}

prototypes/basic/app/views/mapping.html

@@ -49,7 +49,7 @@ <h1 class="govuk-heading-l">Identify columns</h1>
 
         <h2 class="govuk-heading-m">{{sheet}}</h2>
 
-        <form action="{{ importerMapDataPath('/format') }}" method="post">
+        <form action="{{ importerMapDataPath('/format','/review') }}" method="post">
 
             {{ dudkFieldMapper({data: data}) }}