Manage collection of usage data (#207)

* Add support for usage measurement where enabled

When a user of the prototype kit creates a new prototype, they are asked
if they would like to allow usage data to be shared with the authors.
This change uses that permission to measure usage unless the user has
explicitly disabled the plugin from collecting metrics, or changes the
prototype kit permission to false.

* Add info when running prototype about stats

This commit adds an explanation to the console when running the
prototype kit, about the data importer's anonymous usage data.

Currently it is set to the following when the user has agreed to allow
usage data, and has not explicitly disabled it.

```
[WebServer] Watching dependency @register-dynamics/importer as it's a symbolic link.
[WebServer]
[WebServer] You are currently sending anonymous usage data to the prototype kit team.
[WebServer] In addition to this, anonymous usage data is also being sent to the authors
[WebServer] of the Data Upload Design Kit.
[WebServer] Should you wish to disable this you can do so by adding
[WebServer]
[WebServer]     disableImporterUsageData: true
[WebServer]
[WebServer] to the usage-data-config.json file in the prototype's directory.
```

We initially discussed doing this during the postinstall step, but this
results in it being output too early (before the user has accepted on
the first npm run dev) and obscured by more following content.

* Refactor to use separate setting for usage data permissions

* Add config option to allow RD to collect usage data

* Fix dodgy acronym

* Clarify use of anonymous ID

* Add hint to contact us on github

* Fix incorrect use of new var name

Author: rossjones

lib/importer/src/index.js

@@ -6,6 +6,7 @@ const session_lib = require("./session.js");
 const sheets_lib = require("./sheets.js");
 const tpl_functions = require("./functions.js")
 const tpl_filters = require("./filters.js")
+const usage = require("./usage.js")
 
 const IMPORTER_SESSION_KEY = "importer.session";
 const IMPORTER_ERROR_KEY = "importer.error";
@@ -36,6 +37,11 @@ exports.Initialise = (config, router, prototypeKit) => {
 
   const plugin_config = new conf.PluginConfig(config);
 
+  const usageRecorder = new usage.UsageCollection(plugin_config)
+
+  // Record initialisation of the plugin
+  usageRecorder.recordEvent("Plugin initialised")
+
   //--------------------------------------------------------------------
   // To be able to add a local views folder, we need to update the
   // nunjucks environment's default loader to include the local folder.
@@ -338,10 +344,16 @@ exports.Initialise = (config, router, prototypeKit) => {
     router.get(
       IMPORTER_ROUTE_MAP.get("importerConfiguration"),
       (request, response) => {
+
+        // Record initialisation of the plugin
+        usageRecorder.recordEvent("Plugin configured")
+
+
         const pc = {
           config: {
             fields: plugin_config.fields
-          }
+          },
+          collectUsageData: usageRecorder.enabled,
         }
 
         // Copy flash message to template object and then remove from memory
@@ -369,6 +381,19 @@ exports.Initialise = (config, router, prototypeKit) => {
       (request, response) => {
         request.session.data['internal-message'] = "Configuration changes have been saved, and the application will restart shortly"
 
+        // Check the collectData value supplied, it'll either be the value or an array
+        // containing the value. The latter case appears to be extra junk submitted by
+        // the design system.
+        if (request.body.collectData == 'true' ||
+          (Array.isArray(request.body.collectData) &&
+            request.body.collectData.includes('true'))
+        ) {
+          usageRecorder.setPermission(true)
+        } else {
+          usageRecorder.setPermission(false)
+        }
+
+
         setTimeout(function () {
           plugin_config.persistConfig()
         }, 2500)

lib/importer/src/usage.js

@@ -0,0 +1,58 @@
+//--------------------------------------------------------------------
+// This class handles the recording of usage data where the user
+// has enabled data collection for the prototype and not explicitly
+// disabled it for the plugin.
+//
+// Once constructed the class can be used to `recordEvent` but
+// will check it is enabled before doing anything to ensure the
+// user's preferences are respected and correctly applied.
+//--------------------------------------------------------------------
+
+
+const fs = require('node:fs');
+const path = require('node:path');
+
+
+exports.UsageCollection = class {
+    constructor() {
+        const settings = prototypeKitUsageCollectionSettings()
+        this.clientId = settings.clientId
+        this.enabled = settings.ddukCollectUsageData
+    }
+
+    setPermission(perm) {
+        updateDUDKPermission(perm)
+        this.enabled = perm
+    }
+
+    recordEvent(eventName) {
+        if (!this.enabled) return false;
+
+        //TODO: Actually record the usage against eventName
+        console.log("EVENT: " + eventName)
+
+        return eventName != ""
+    }
+}
+
+const prototypeKitUsageCollectionSettings = () => {
+    const projectDir = path.resolve(
+        process.env.KIT_PROJECT_DIR || process.cwd(),
+    );
+    const usage_config = path.join(projectDir, "usage-data-config.json")
+    const data = fs.readFileSync(usage_config);
+    return JSON.parse(data)
+}
+
+const updateDUDKPermission = (dudkPermission) => {
+    const projectDir = path.resolve(
+        process.env.KIT_PROJECT_DIR || process.cwd(),
+    );
+    const usage_config = path.join(projectDir, "usage-data-config.json")
+    const data = fs.readFileSync(usage_config);
+
+    const obj = JSON.parse(data)
+    obj.ddukCollectUsageData = dudkPermission
+
+    fs.writeFileSync(usage_config, JSON.stringify(obj))
+}

lib/importer/src/usage.test.js

@@ -0,0 +1,59 @@
+const mock_files = require('mock-fs');
+var usage = require('./usage');
+
+
+describe("Usage recording tests", () => {
+    beforeEach(() => {
+        process.env.KIT_PROJECT_DIR = "./empty"
+    });
+
+    afterEach(() => {
+        mock_files.restore();
+    });
+
+    test('not present', () => {
+        mock_files({
+            './empty/usage-data-config.json': JSON.stringify({ collectUsageData: false })
+        })
+
+        const u = new usage.UsageCollection()
+        expect(u).not.toBeNull()
+        expect(u.recordEvent("test")).toBe(false)
+    });
+
+
+    test('not enabled', () => {
+        mock_files({
+            './empty/usage-data-config.json': JSON.stringify({ collectUsageData: false, ddukCollectUsageData: false })
+        })
+
+        const u = new usage.UsageCollection()
+        expect(u).not.toBeNull()
+        expect(u.recordEvent("test")).toBe(false)
+    });
+
+    test('enabled with prototype kit enabled', () => {
+        mock_files({
+            './empty/usage-data-config.json': JSON.stringify({ collectUsageData: true, ddukCollectUsageData: true, clientId: "1" })
+        })
+
+        const u = new usage.UsageCollection()
+        expect(u).not.toBeNull()
+
+        expect(u.recordEvent("test")).toBe(true)
+        expect(u.clientId).toBe("1")
+    });
+
+    test('enabled with prototype kit disabled', () => {
+        mock_files({
+            './empty/usage-data-config.json': JSON.stringify({ collectUsageData: false, ddukCollectUsageData: true, clientId: "1" })
+        })
+
+        const u = new usage.UsageCollection()
+        expect(u).not.toBeNull()
+
+        expect(u.recordEvent("test")).toBe(true)
+        expect(u.clientId).toBe("1")
+    });
+
+});

lib/importer/views/plugin_config.html

@@ -93,7 +93,50 @@ <h2 class="govuk-heading-l">Column settings</h2>
       </div>
 
     </div>
-  </div>
+      <form action="config" method="post">
+
+    <div class="govuk-grid-column-full govuk-!-padding-top-6" >
+        <h2 class="govuk-heading-l"></h2>
+
+<div class="govuk-form-group">
+  <fieldset class="govuk-fieldset">
+    <legend class="govuk-fieldset__legend govuk-fieldset__legend--l">
+      <h1 class="govuk-fieldset__heading">
+        Report usage data
+      </h1>
+    </legend>
+
+    <p class="govuk-body">
+      Allow Register Dynamics to collect usage data on your use of the Data Upload Design Kit.
+      When enabled, the Data Upload Design Kit will only report the following events with an
+      anonymous identifier specific to this prototype:
+      <ul class="govuk-list govuk-list--bullet">
+       <li>The Plugin was initialised</li>
+       <li>The Plugin was configured</li>
+      </ul>
+    </p>
+
+    <p class="govuk-body">
+      <div class="govuk-checkboxes" data-module="govuk-checkboxes">
+        <div class="govuk-checkboxes__item">
+          <input class="govuk-checkboxes__input" id="collectData" name="collectData" type="checkbox" value="true" {% if collectUsageData == true %}checked{% endif %}>
+          <label class="govuk-label govuk-checkboxes__label" for="collectData">
+            Allow collection of usage data
+          </label>
+        </div>
+      </div>
+    </p>
+
+
+    <p class="govuk-body">
+      If you don't want usage data to be collected, please consider
+      <a href="https://github.com/register-dynamics/data-import/discussions">dropping a note to us on Github</a>
+      to let us know how you're using the Kit. Thanks!
+    </p>
+  </fieldset>
+</div>
+    </div>
+
 
     <div class="govuk-grid-column-full govuk-!-padding-top-6" >
       <h2 class="govuk-heading-l">Save changes</h2>
@@ -105,7 +148,6 @@ <h2 class="govuk-heading-l">Save changes</h2>
         use the new settings.
       </p>
 
-      <form action="config" method="post">
         <div class="govuk-form-group {% if error %}govuk-form-group--error{% endif %}">
           {% if error %}
           <p id="path_err" class="govuk-error-message">