Merge pull request #1735 from companieshouse/origin/feature/roecct-638-matomo-adding-goals-for-the-pre-registration-page-of-the-s174-journey-in-cidev

Matomo: Adding goals for the Pre-registration page of the S174 journey in CIDEV

Author: rbeaz-ch

src/frontend/analytics/piwik.relevant.period.confirm.goals.ts

@@ -0,0 +1,19 @@
+export function isCiDevEnvironment(hostname: string): boolean {
+  return hostname.includes("cidev");
+}
+
+export type MatomoPaq = {
+  push: (args: [string, number]) => void;
+};
+
+export function trackRelevantPeriodGoal(
+  value: string,
+  paq: MatomoPaq | undefined = (window as any).paq
+): void {
+
+  if (value === "1") {
+    paq.push(["trackGoal", 55]); // User selected YES
+  } else if (value === "0") {
+    paq.push(["trackGoal", 118]); // User selected NO
+  }
+}

test/frontend/analytics/piwik.relevant.period.confirm.goals.spec.ts

@@ -0,0 +1,34 @@
+import {
+  isCiDevEnvironment,
+  trackRelevantPeriodGoal,
+  MatomoPaq,
+} from "../../../src/frontend/analytics/piwik.relevant.period.confirm.goals";
+
+describe("isCiDevEnvironment", () => {
+  it("returns true when hostname includes 'cidev'", () => {
+    expect(isCiDevEnvironment("dev.cidev.internal")).toBe(true);
+  });
+
+  it("returns false when hostname does not include 'cidev'", () => {
+    expect(isCiDevEnvironment("example.gov.uk")).toBe(false);
+  });
+});
+
+describe("trackRelevantPeriodGoal", () => {
+  let mockPaq: MatomoPaq;
+
+  beforeEach(() => {
+    mockPaq = { push: jest.fn() };
+  });
+
+  it("tracks goal 55 for value '1'", () => {
+    trackRelevantPeriodGoal("1", mockPaq);
+    expect(mockPaq.push).toHaveBeenCalledWith(["trackGoal", 55]);
+  });
+
+  it("tracks goal 118 for value '0'", () => {
+    trackRelevantPeriodGoal("0", mockPaq);
+    expect(mockPaq.push).toHaveBeenCalledWith(["trackGoal", 118]);
+  });
+});
+

views/includes/piwik-relevant-period-confirm-goals.html

@@ -0,0 +1,29 @@
+<script type="module">
+  import { trackRelevantPeriodGoal, isCiDevEnvironment } from "../../../../../../../../src/frontend/analytics/piwik.relevant.period.confirm.goals.ts";
+
+  function setupRelevantPeriodTracking() {
+    document.addEventListener("DOMContentLoaded", () => {
+      if (!isCiDevEnvironment(window.location.hostname)) {
+        return;
+      }
+
+      const submitButton = document.getElementById("submit");
+      if (!submitButton) {
+        return;
+      }
+
+      submitButton.addEventListener("click", () => {
+        const selected = document.querySelector(
+          'input[name="relevant-period-required-information"]:checked'
+        );
+        if (!selected) {
+          return;
+        }
+
+        trackRelevantPeriodGoal(selected.value);
+      });
+    });
+  }
+
+  setupRelevantPeriodTracking();
+</script>

views/update/relevant-period-required-information-confirm.html

@@ -86,4 +86,9 @@ <h1 class="govuk-heading-xl">You'll need to tell us about the pre-registration p
     </div>
 </div>
 
+{% endblock %}
+
+{% block scripts %}
+  {{ super() }}
+  {% include "includes/piwik-relevant-period-goals.html" %}
 {% endblock %}