feat: analytics support for form-level tracking (#378)

- Update server to dynamically inject analytics on a per-form basis,
  replacing the previous global-only setting.
- Enables each form to have its own tracking analytics configuration.
- Note: This ignores the global server-wide config! Existing forms should
  be updated to include analytics in their form definitions.

Format example:

analytics: {
  gtmId1: string;
  gtmId2: string;
  matomoId: string;
  matomoUrl: string;
}

This object is *optional*.
All items in this object are also *optional*.

Author: SullyK

model/src/data-model/types.ts

@@ -188,6 +188,13 @@ export type ExitOptions = {
   format?: "STATE" | "WEBHOOK";
 };
 
+export type Analytics = {
+  gtmId1: string;
+  gtmId2: string;
+  matomoId: string;
+  matomoUrl: string;
+};
+
 /**
  * `FormDefinition` is a typescript representation of `Schema`
  */
@@ -214,6 +221,7 @@ export type FormDefinition = {
   jwtKey?: string | undefined;
   toggle?: boolean | string | undefined;
   retryTimeoutSeconds?: number | undefined;
+  analytics?: Analytics;
   webhookHmacSharedKey?: string | undefined;
   fullStartPage?: string | undefined;
   serviceName?: string | undefined;

model/src/schema/schema.ts

@@ -209,6 +209,13 @@ const feeSchema = joi.object().keys({
   prefix: joi.string().optional(),
 });
 
+const analyticsSchema = joi.object().keys({
+  gtmId1: joi.string().allow("").optional(),
+  gtmId2: joi.string().allow("").optional(),
+  matomoId: joi.string().allow("").optional(),
+  matomoUrl: joi.string().uri().allow("").optional(),
+});
+
 const multiApiKeySchema = joi.object({
   test: joi.string().optional(),
   smoke: joi.string().optional(),
@@ -346,6 +353,7 @@ export const Schema = joi
     toggle: joi.alternatives().try(joi.boolean(), joi.string()).optional(),
     toggleRedirect: joi.string().optional(),
     retryTimeoutSeconds: joi.number().optional(),
+    analytics: analyticsSchema.optional(),
     webhookHmacSharedKey: joi.string().optional(),
     fullStartPage: joi.string().optional(),
     serviceName: joi.string().optional(),

runner/src/server/forms/ReportAnOutbreak.json

@@ -2,6 +2,9 @@
   "metadata": {},
   "authentication": true,
   "toggle": "${magicLinkToggle}",
+  "analytics": {
+    "gtmId1": "GTM-MM6VPCXX"
+  },
   "startPage": "/start",
   "pages": [
     {

runner/src/server/plugins/views.ts

@@ -61,28 +61,36 @@ export default {
       `${path.dirname(resolve.sync("hmpo-components"))}/components`,
     ],
     isCached: !config.isDev,
-    context: (request: HapiRequest) => ({
-      appVersion: pkg.version,
-      assetPath: "/assets",
-      cookiesPolicy: request?.state?.cookies_policy,
-      serviceName: capitalize(request.server?.app?.forms?.[request.params?.id]?.def?.serviceName || config.serviceName),
-      feedbackLink: config.feedbackLink,
-      pageTitle: (request.server?.app?.forms?.[request.params?.id]?.def?.serviceName || config.serviceName) + " - GOV.UK",
-      analyticsAccount: config.analyticsAccount,
-      gtmId1: config.gtmId1,
-      gtmId2: config.gtmId2,
-      location: request?.app.location,
-      matomoId: config.matomoId,
-      matomoUrl: config.matomoUrl,
-      BROWSER_REFRESH_URL: config.browserRefreshUrl,
-      sessionTimeout: config.sessionTimeout,
-      skipTimeoutWarning: false,
-      serviceStartPage: request.server?.app?.forms?.[request.params?.id]?.def?.fullStartPage || config.serviceName || "#",
-      privacyPolicyUrl: config.privacyPolicyUrl || "/help/privacy",
-      phaseTag: config.phaseTag,
-      navigation: request?.auth.isAuthenticated
-        ? [{ text: "Sign out", href: "/logout" }]
-        : null,
-    }),
+    context: (request: HapiRequest) => {
+      const id = request.params?.id;
+      const forms = request.server?.app?.forms;
+      const model = id && forms?.[id];
+      const analytics = model?.def?.analytics || {};
+
+      return {
+        appVersion: pkg.version,
+        assetPath: "/assets",
+        cookiesPolicy: request?.state?.cookies_policy,
+        serviceName: capitalize(request.server?.app?.forms?.[request.params?.id]?.def?.serviceName || config.serviceName),
+        feedbackLink: config.feedbackLink,
+        pageTitle: (request.server?.app?.forms?.[request.params?.id]?.def?.serviceName || config.serviceName) + " - GOV.UK",
+        analyticsAccount: config.analyticsAccount,
+        gtmId1: analytics.gtmId1 || "",
+        gtmId2: analytics.gtmId2 || "",
+        location: request?.app.location,
+        matomoId: analytics.matomoId || "",
+        matomoUrl: analytics.matomoUrl || "",
+        BROWSER_REFRESH_URL: config.browserRefreshUrl,
+        sessionTimeout: config.sessionTimeout,
+        skipTimeoutWarning: false,
+        serviceStartPage: request.server?.app?.forms?.[request.params?.id]?.def?.fullStartPage || config.serviceName || "#",
+        privacyPolicyUrl: config.privacyPolicyUrl || "/help/privacy",
+        phaseTag: config.phaseTag,
+        navigation: request?.auth.isAuthenticated
+          ? [{ text: "Sign out", href: "/logout" }]
+          : null,
+      };
+    },
+
   },
 };