Provide sample files for trying out the prototype (#325)

The prototype requires users to have a file to upload, in order to try it out. To make this easier, we now provide two sample files (from the fixtures) which can be used by the user instead of having to build their own.

The files (pension data and tribbles) are included in the prototypes samples folder, and an endpoint was added to the demo to facilitate the download of these files, should the user wish to see them. The prototype itself has had changes to the index page giving the user a link to download, or a button to use that sample without needing to download it.

This functionality required changes in the plugin, which only exports an initialise function, using it to then set up multiple routes. The new route added is for using samples and requires a POST request with a parameter called samplefile. This parameter should be the name of a file in the samples folder of the prototype. Once submitted the user is directed to select a sheet as if they had manually uploaded a file.

Author: rossjones

lib/importer/src/index.js

@@ -6,7 +6,7 @@ const session_lib = require("./session.js");
 const sheets_lib = require("./dudk/sheets.js");
 const tpl_functions = require("./functions.js")
 const tpl_filters = require("./filters.js")
-const usage = require("./usage.js")
+const usage = require("./usage.js");
 
 const IMPORTER_SESSION_KEY = "importer.session";
 const IMPORTER_ERROR_KEY = "importer.error";
@@ -21,6 +21,7 @@ const IMPORTER_ERROR_EXTRA_KEY = "importer.error.extra";
 const IMPORTER_ROUTE_MAP = new Map([
   ["importerStartPath", "/importer/start"],
   ["importerUploadPath", "/importer/upload"],
+  ["importerSamplePath", "/importer/sample"],
   ["importerSelectSheetPath", "/importer/sheets"],
   ["importerMapDataPath", "/importer/mapping"],
   ["importerReviewDataPath", "/importer/review"],
@@ -161,16 +162,60 @@ exports.Initialise = (config, router, prototypeKit) => {
   //--------------------------------------------------------------------
   const uploader = getUploader(plugin_config);
 
+  // Actual upload endpoint
   router.post(
     IMPORTER_ROUTE_MAP.get("importerUploadPath"),
     uploader.single("file"),
     (request, response) => {
-      let createResponse = session_lib.CreateSession(plugin_config, request);
-      if (createResponse.error) {
-        request.session.data[IMPORTER_ERROR_KEY] = createResponse.error;
+      const error = uploadFile(request);
+      if (error) {
+        request.session.data[IMPORTER_ERROR_KEY] = error;
+        response.redirect(request.get("Referrer"));
+        return;
+      }
+
+      redirectOnwards(request, response);
+    },
+  );
+
+  // A samples endpoint that uses a prototype-provided sample file
+  // rather than expecting the user to upload one themselves.  Samples
+  // are restricted to XLSX files present in a 'samples' directory.
+  router.post(
+    IMPORTER_ROUTE_MAP.get("importerSamplePath"),
+    (request, response) => {
+
+      const filename = `${request.body.samplefile}`;
+
+      // Copy file to upload folder if not already present there
+      const destFile = path.join(plugin_config.uploadPath, filename)
+      if (!fs.existsSync(destFile)) {
+        const sourceFile = path.join(path.resolve(process.cwd(), './samples'), filename)
+        fs.copyFileSync(sourceFile, destFile)
+      }
+
+      request.file = {
+        mimetype: 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet',
+        filename: filename
+      }
+
+      const error = uploadFile(request);
+      if (error) {
+        request.session.data[IMPORTER_ERROR_KEY] = error;
         response.redirect(request.get("Referrer"));
         return;
       }
+
+      redirectOnwards(request, response);
+    },
+  );
+
+
+  const uploadFile = (request) => {
+      let createResponse = session_lib.CreateSession(plugin_config, request);
+      if (createResponse.error) {
+        return createResponse.error;
+      }
       let session = createResponse.session;
 
       if (session.sheets.length == 1) {
@@ -187,9 +232,8 @@ exports.Initialise = (config, router, prototypeKit) => {
 
       // Ensure the session is persisted. Currently in session, eventually another way
       request.session.data[IMPORTER_SESSION_KEY] = session;
-      redirectOnwards(request, response);
-    },
-  );
+  };
+
 
   //--------------------------------------------------------------------
   // When the user has chosen a sheet to use, this route stores the sheet

prototypes/basic/app/routes.js

@@ -4,10 +4,17 @@
 //
 const govukPrototypeKit = require("govuk-prototype-kit");
 const router = govukPrototypeKit.requests.setupRouter();
-
+const path = require("path");
 
 // Below 3 lines added by the Data Upload Design Kit plugin.
 // If you uninstall the plugin, remove the 3 lines below.
 const importer = require("@register-dynamics/importer");
 const cfg = require("govuk-prototype-kit/lib/config");
 importer.Initialise(cfg.getConfig(), router, govukPrototypeKit);
+
+// This custom route handles file downloads from the samples folder.
+// To use it, link to /download/filename.ext
+// where filename.ext is the name of the file in the samples folder.
+router.get("/download/:filename", function (req, res) {
+    res.sendFile(req.params.filename, { root: path.join(process.cwd(), "samples") });
+});

prototypes/basic/app/views/index.html

@@ -53,6 +53,34 @@ <h1 class="govuk-heading-xl">
       You can then correct the error and re-upload the file.
     </p>
 
+    <p class="govuk-body">
+      The following sample files are provided to demonstrate the upload process.
+      You can use these files to explore the service without needing to create your own data.
+    </p>
+
+    <p class="govuk-body">
+      <strong>Sample file 1:</strong> <a href="/download/pensions-data-sample.xlsx" class="govuk-link">pensions-data-sample.xlsx</a>
+      - an Excel spreadsheet containing 10 records with no errors.
+
+      <form action="{{ importerSamplePath('/select_sheet') }}" method="post">
+        <input type="hidden" name="samplefile" value="pensions-data-sample.xlsx">
+        <input type="submit" class="govuk-button govuk-button--secondary" value="Use pensions-data-sample.xlsx" name="submit">
+      </form>
+
+    </p>
+
+    <p class="govuk-body">
+      <strong>Sample file 2:</strong> <a href="/download/tribbles.xlsx" class="govuk-link">tribbles.xlsx</a>
+      - an Excel spreadsheet containing my favourite Star Trek aliens.
+
+      <form action="{{ importerSamplePath('/select_sheet') }}" method="post">
+        <input type="hidden" name="samplefile" value="tribbles.xlsx">
+        <input type="submit" class="govuk-button govuk-button--secondary" value="Use tribbles.xlsx" name="submit">
+      </form>
+
+    </p>
+
+
     <p class="govuk-body">
       On completion, you will be provided with a reference number for the upload which should be quoted
       in any correspondence about this process.