WSTEAM1-1514: Add click tracking at top level

src/app/components/ATIAnalytics/canonical/sendBeaconLite.ts

@@ -1,8 +1,12 @@
 const sendBeaconLite = (atiPageViewUrlString: string) => `
-    var xhr = new XMLHttpRequest();
-    xhr.open("GET", "${atiPageViewUrlString}", true);
-    xhr.withCredentials = true;
-    xhr.send();
+    function sendBeaconLite (atiPageViewUrlString) {
+        var xhr = new XMLHttpRequest();
+        xhr.open("GET", atiPageViewUrlString, true);
+        xhr.withCredentials = true;
+        xhr.send();
+    }
+
+    sendBeaconLite("${atiPageViewUrlString}");
 `;
 
 export default sendBeaconLite;

src/app/components/MostRead/Canonical/Item/index.tsx

@@ -1,7 +1,10 @@
 /** @jsx jsx */
-import React, { PropsWithChildren } from 'react';
+import React, { PropsWithChildren, useContext } from 'react';
 import { jsx } from '@emotion/react';
-import useClickTrackerHandler from '#hooks/useClickTrackerHandler';
+import useClickTrackerHandler, {
+  LITE_TRACKER_PARAM,
+  useConstructLiteSiteUrl,
+} from '#hooks/useClickTrackerHandler';
 import styles from './index.styles';
 import {
   mostReadListGridProps,
@@ -15,6 +18,7 @@
 } from '../../types';
 import { Direction } from '../../../../models/types/global';
 import Grid from '../../../../legacy/components/Grid';
+import { RequestContext } from '#app/contexts/RequestContext';
 
 export const getParentColumns = (columnLayout: ColumnLayout) => {
   return columnLayout !== 'oneColumn'
@@ -46,14 +50,17 @@
   size,
   eventTrackingData,
 }: PropsWithChildren<MostReadLinkProps>) => {
+  const { isLite } = useContext(RequestContext);
   const clickTrackerHandler = useClickTrackerHandler(eventTrackingData);
+  const liteUrl = useConstructLiteSiteUrl(eventTrackingData);
 
   return (
     <div css={getItemCss({ dir, size })} dir={dir}>
       <a
         css={[styles.link, size === 'default' && styles.defaultLink]}
         href={href}
         onClick={clickTrackerHandler}
+        {...(isLite && { [LITE_TRACKER_PARAM]: liteUrl })}
       >
         {title}
       </a>

src/app/hooks/useClickTrackerHandler/index.jsx

@@ -1,6 +1,7 @@
 /* eslint-disable no-console */
 import { useContext, useCallback, useState } from 'react';
 
+import { buildATIEventTrackUrl } from '#app/components/ATIAnalytics/atiUrl';
 import { EventTrackingContext } from '../../contexts/EventTrackingContext';
 import useTrackingToggle from '../useTrackingToggle';
 import OPTIMIZELY_CONFIG from '../../lib/config/optimizely';
@@ -9,6 +10,7 @@ import { ServiceContext } from '../../contexts/ServiceContext';
 import { isValidClick } from './clickTypes';
 
 const EVENT_TYPE = 'click';
+export const LITE_TRACKER_PARAM = 'data-ati-tracking';
 
 const useClickTrackerHandler = (props = {}) => {
   const preventNavigation = props?.preventNavigation;
@@ -136,4 +138,35 @@ const useClickTrackerHandler = (props = {}) => {
   );
 };
 
+export const useConstructLiteSiteUrl = (props = {}) => {
+  const eventTrackingContext = useContext(EventTrackingContext);
+
+  const componentName = props?.componentName;
+  const url = props?.url;
+  const advertiserID = props?.advertiserID;
+  const format = props?.format;
+  const detailedPlacement = props?.detailedPlacement;
+
+  const { pageIdentifier, platform, producerId, statsDestination } =
+    eventTrackingContext;
+
+  const campaignID = props?.campaignID || eventTrackingContext?.campaignID;
+
+  const atiClickTrackingUrl = buildATIEventTrackUrl({
+    pageIdentifier,
+    producerId,
+    platform,
+    statsDestination,
+    componentName,
+    campaignID,
+    format,
+    type: EVENT_TYPE,
+    advertiserID,
+    url,
+    detailedPlacement,
+  });
+
+  return atiClickTrackingUrl;
+};
+
 export default useClickTrackerHandler;

src/app/hooks/useClickTrackerHandler/index.test.jsx

@@ -16,7 +16,7 @@ import {
 import * as serviceContextModule from '../../contexts/ServiceContext';
 
 import pidginData from './fixtureData/tori-51745682.json';
-import useClickTrackerHandler from '.';
+import useClickTrackerHandler, { useConstructLiteSiteUrl } from '.';
 
 const trackingToggleSpy = jest.spyOn(trackingToggle, 'default');
 
@@ -588,3 +588,22 @@ describe('Error handling', () => {
     expect(global.fetch).not.toHaveBeenCalled();
   });
 });
+
+describe('Lite Site - Click tracking', () => {
+  it('Returns a valid ati tracking url given the input props', () => {
+    const { result } = renderHook(
+      () =>
+        useConstructLiteSiteUrl({
+          ...defaultProps,
+          campaignID: 'custom-campaign',
+        }),
+      {
+        wrapper,
+      },
+    );
+
+    expect(result.current).toContain(
+      'atc=PUB-[custom-campaign]-[brand]-[]-[CHD=promo::2]-[]-[]-[]-[]&type=AT',
+    );
+  });
+});

src/server/Document/Renderers/LiteRenderer.tsx

@@ -1,5 +1,6 @@
 /* eslint-disable react/no-danger */
 import React, { ReactElement, PropsWithChildren } from 'react';
+import trackingScript from '#src/server/utilities/clickTrackingScript/clickTracking';
 import { BaseRendererProps } from './types';
 
 interface Props extends BaseRendererProps {
@@ -24,6 +25,11 @@ export default function LitePageRenderer({
         {helmetLinkTags}
         {helmetScriptTags}
         <style dangerouslySetInnerHTML={{ __html: styles }} />
+        <script
+          dangerouslySetInnerHTML={{
+            __html: `(${trackingScript.toString()})()`,
+          }}
+        />
       </head>
       <body>{bodyContent}</body>
     </html>

src/server/utilities/clickTrackingScript/clickTracking.js

@@ -0,0 +1,92 @@
+export default function trackingScript() {
+  window.addEventListener('load', () => {
+    document.addEventListener('click', event => {
+      // eslint-disable-next-line no-undef
+      if (event.target.tagName === 'A') {
+        event.stopPropagation();
+        event.preventDefault();
+
+        const atiURL = event.target.getAttribute('data-ati-tracking');
+
+        if (atiURL == null) {
+          return;
+        }
+
+        const nextPageUrl = event.currentTarget.href;
+
+        const {
+          screen: { width, height, colorDepth, pixelDepth },
+          innerWidth,
+          innerHeight,
+        } = window;
+        const now = new Date();
+        const hours = now.getHours();
+        const mins = now.getMinutes();
+        const secs = now.getSeconds();
+
+        // COOKIE SETTINGS
+        const cookieName = 'atuserid';
+        const expires = 397; // expires in 13 months
+        const cookiesForPage = `; ${document.cookie}`;
+        const atUserIdCookie = cookiesForPage.split(`; ${cookieName}=`);
+        let atUserIdValue = null;
+
+        if (atUserIdCookie.length === 2) {
+          const cookieInfo = atUserIdCookie.pop().split(';').shift();
+
+          if (cookieInfo) {
+            const decodedCookie = decodeURI(cookieInfo);
+            const user = JSON.parse(decodedCookie);
+            atUserIdValue = user.val;
+          }
+        }
+
+        if (!atUserIdValue && crypto.randomUUID) {
+          atUserIdValue = crypto.randomUUID();
+        }
+
+        const stringifiedCookieValue = JSON.stringify({ val: atUserIdValue });
+        if (atUserIdValue) {
+          document.cookie = `${cookieName}=${stringifiedCookieValue}; path=/; max-age=${expires};`;
+        }
+
+        const rValue = [
+          width || 0,
+          height || 0,
+          colorDepth || 0,
+          pixelDepth || 0,
+        ].join('x');
+
+        const reValue = [innerWidth || 0, innerHeight || 0].join('x');
+
+        const hlValue = [hours, mins, secs].join('x');
+
+        let clientSideAtiURL = atiURL
+          .concat('&', 'r=', rValue)
+          .concat('&', 're=', reValue)
+          .concat('&', 'hl=', hlValue);
+
+        if (navigator.language) {
+          clientSideAtiURL = clientSideAtiURL.concat(
+            '&',
+            'lng=',
+            navigator.language,
+          );
+        }
+
+        if (atUserIdValue) {
+          clientSideAtiURL = clientSideAtiURL.concat(
+            '&',
+            'idclient=',
+            atUserIdValue,
+          );
+        }
+
+        // eslint-disable-next-line no-undef -- This is provided in a helmet script
+        sendBeaconLite(clientSideAtiURL);
+
+        window.location.assign(nextPageUrl);
+      }
+    });
+  });
+}

src/server/utilities/clickTrackingScript/clickTracking.test.js

@@ -0,0 +1,100 @@
+import trackingScript from './clickTracking';
+
+const dispatchClick = targetElement => {
+  document.body.appendChild(targetElement);
+  const event = new MouseEvent('click', {
+    view: window,
+    bubbles: true,
+    cancelable: true,
+  });
+  targetElement.dispatchEvent(event);
+};
+
+describe('Click tracking script', () => {
+  const randomUUIDMock = jest.fn();
+  beforeEach(() => {
+    jest.clearAllMocks();
+    jest.useFakeTimers().setSystemTime(new Date(1731515402000));
+
+    trackingScript();
+
+    document.cookie =
+      'atuserid=; expires=Thu, 01 Jan 1970 00:00:00 UTC; path=/;';
+
+    delete window.location;
+    window.location = {
+      assign: jest.fn(),
+    };
+    window.sendBeaconLite = jest.fn();
+
+    Object.defineProperty(global, 'crypto', {
+      value: {
+        randomUUID: randomUUIDMock,
+      },
+    });
+
+    window.dispatchEvent(new Event('load'));
+  });
+
+  it('Sets a new cookie if there is no atuserid cookie on the user browser', () => {
+    const anchorElement = document.createElement('a');
+    anchorElement.setAttribute(
+      'data-ati-tracking',
+      'https://logws1363.ati-host.net/?',
+    );
+
+    randomUUIDMock.mockReturnValueOnce('randomUniqueId');
+    dispatchClick(anchorElement);
+
+    expect(document.cookie).toBe('atuserid={"val":"randomUniqueId"}');
+  });
+
+  it('Reuses the atuserid cookie if there is a atuserid cookie on the user browser', () => {
+    const anchorElement = document.createElement('a');
+    anchorElement.setAttribute(
+      'data-ati-tracking',
+      'https://logws1363.ati-host.net/?',
+    );
+
+    document.cookie = 'atuserid={"val":"oldCookieId"}';
+    randomUUIDMock.mockReturnValueOnce('newCookieId');
+    dispatchClick(anchorElement);
+
+    const callParam = window.sendBeaconLite.mock.calls[0][0];
+
+    expect(callParam).toContain('idclient=oldCookieId');
+  });
+
+  it('Calls sendBeaconLite() with the correct url', () => {
+    const anchorElement = document.createElement('a');
+    anchorElement.setAttribute(
+      'data-ati-tracking',
+      'https://logws1363.ati-host.net/?',
+    );
+
+    window.screen = { width: 100, height: 400, colorDepth: 24, pixelDepth: 24 };
+    window.innerWidth = 4060;
+    window.innerHeight = 1080;
+    Object.defineProperty(navigator, 'language', {
+      get() {
+        return 'en-GB';
+      },
+    });
+
+    dispatchClick(anchorElement);
+
+    const callParam = window.sendBeaconLite.mock.calls[0][0];
+
+    expect(callParam).toContain(
+      'r=0x0x24x24&re=4060x1080&hl=16x30x2&lng=en-GB',
+    );
+  });
+
+  it('Does not call sendBeacon if the event has no data-ati-tracking parameter', () => {
+    const anchorElement = document.createElement('a');
+
+    dispatchClick(anchorElement);
+
+    expect(window.sendBeaconLite).toHaveBeenCalledTimes(0);
+  });
+});