Merge pull request #115 from Financial-Times/ADSDEV-1243-add-privacy-info-request-consent-store

ADSDEV-1243: add privacy info + fetch legislation

Author: sami-ft

.babelrc

@@ -0,0 +1,13 @@
+module.exports = {
+	presets: [
+		[
+			"@babel/preset-env",
+			{
+				targets: {
+					node: 14,
+				},
+			},
+		],
+	],
+	plugins: ["@babel/plugin-transform-react-jsx"],
+};

babel.config.js

@@ -36,9 +36,11 @@
     "npm": "7.x || 8.x"
   },
   "dependencies": {
+    "@financial-times/ads-personalised-consent": "^5.2.3",
     "@financial-times/o-grid": "^5.0.0",
     "@financial-times/o-tracking": "^4.5.0",
     "@financial-times/o-viewport": "^4.0.0",
+    "@financial-times/privacy-us-privacy": "^1.0.0",
     "ready-state": "^2.0.5",
     "web-vitals": "^3.0.0"
   },

package-lock.json

@@ -7,10 +7,12 @@ jest.mock('@financial-times/o-tracking', () => {
 }, { virtual: true });
 jest.mock('@financial-times/o-viewport', () => ({ getOrientation: jest.fn() }), { virtual: true });
 jest.mock('@financial-times/o-grid', () => ({ getCurrentLayout: jest.fn() }), { virtual: true });
+jest.mock('../utils/getConsentData', () => jest.fn());
 
 import oTracking from '@financial-times/o-tracking';
 import oViewport from '@financial-times/o-viewport';
 import oGrid from '@financial-times/o-grid';
+import getConsentData from '../utils/getConsentData';
 import { init, SPOOR_API_INGEST_URL } from '..';
 
 const appContext = {
@@ -23,7 +25,16 @@ const appContext = {
 };
 
 describe('src/index', () => {
-	afterEach(() => jest.clearAllMocks());
+	beforeAll(() => {
+		getConsentData.mockResolvedValue({});
+		window.console.warn = jest.fn()
+	})
+
+	afterEach(() => {
+		jest.clearAllMocks();
+		// Clean global instance left on the window after each init() call
+		delete window.oTracking
+	});
 
 	describe('.init()', () => {
 		it('initialises o-tracking', () => {
@@ -39,6 +50,24 @@ describe('src/index', () => {
 			);
 		});
 
+		it('attaches the o-tracking instance to the window', () => {
+			const oTrackingInstance = init({ appContext });
+			expect(window.oTracking).toBe(oTrackingInstance);
+		});
+
+		it("warns the user in case an instance of o-tracking is already attached to the window without overriding the value", () => {
+			window.oTracking = "initialValue";
+			const ourInstance = init({ appContext });
+			expect(window.console.warn).toHaveBeenCalledWith(
+				"An oTracking instance already exists on window, skipping",
+				{
+					currentInstance: 'initialValue',
+					ourInstance,
+				}
+			);
+			expect(window.oTracking).toBe("initialValue");
+		});
+
 		it('configures o-tracking with context data', () => {
 			init({ appContext });
 
@@ -74,14 +103,35 @@ describe('src/index', () => {
 			);
 		});
 
-		it('triggers a page view with page view context', () => {
+		it('triggers a page view with page view context and consents', async () => {
+			getConsentData.mockResolvedValue({ some: 'consentData' });
+
 			init({ appContext, pageViewContext: { foo: 'bar' } });
 
+			// We don't await the promise returned while getting consent data.
+			// The line below lets us wait for the mocked getConsentData promise to resolve.
+			await new Promise(process.nextTick);
+
 			expect(oTracking.page).toHaveBeenCalledTimes(1);
+			expect(oTracking.page).toHaveBeenCalledWith(
+				expect.objectContaining({
+					foo: 'bar',
+					consents: {
+						some: 'consentData'
+					},
+				})
+			);
+		});
+
+		it('Does not pass consents down if getting consents fails', async () => {
+			getConsentData.mockRejectedValueOnce(new Error('no consent data'));
+			init({ appContext, pageViewContext: { foo: 'bar' } });
+			await new Promise(process.nextTick);
 
+			expect(oTracking.page).toHaveBeenCalledTimes(1);
 			expect(oTracking.page).toHaveBeenCalledWith(
 				expect.objectContaining({
-					foo: 'bar'
+					foo: 'bar',
 				})
 			);
 		});

package.json

@@ -3,6 +3,7 @@ import getUserData from './tracking/getUserData';
 import getQueryParams from './tracking/getQueryParams';
 import getErrorPageParams from './tracking/getErrorPageParams';
 import transformContextData from './utils/transformContextData';
+import getConsentData from './utils/getConsentData';
 
 export const SPOOR_API_INGEST_URL = 'https://spoor-api.ft.com/ingest';
 
@@ -15,7 +16,7 @@ export function init ({ appContext, extraContext, pageViewContext }) {
 		context: transformContextData({
 			...queryParams,
 			...appContext,
-			...extraContext
+			...extraContext,
 		}),
 		user: getUserData(),
 		// Using the Beacon API ensures that no tracking event data is lost
@@ -30,10 +31,23 @@ export function init ({ appContext, extraContext, pageViewContext }) {
 	if (window === window.top || window.location.hostname === 'errors-next.ft.com') {
 		const errorPageParams = getErrorPageParams();
 
-		oTracking.page({
+		const pageViewEventParams = {
 			...errorPageParams,
 			...pageViewContext,
-		});
+		};
+
+		getConsentData()
+			.then((consents) => {
+				oTracking.page({
+					...pageViewEventParams,
+					consents,
+				});
+			})
+			.catch((err) => {
+				// eslint-disable-next-line no-console
+				console.warn("Could not get consent data", err);
+				oTracking.page(pageViewEventParams);
+			});
 	}
 
 	//  Initialise click event tracking for interactive elements

src/client/__test__/index.spec.js

@@ -0,0 +1,53 @@
+jest.mock("@financial-times/privacy-us-privacy", () => ({
+	getUsPrivacyForTracking: jest.fn(),
+}));
+
+jest.mock("@financial-times/ads-personalised-consent", () => ({
+	getPersonalisedConsent: jest.fn(),
+}));
+
+import { getUsPrivacyForTracking } from "@financial-times/privacy-us-privacy";
+import { getPersonalisedConsent } from "@financial-times/ads-personalised-consent";
+
+import getConsentData from "../getConsentData";
+
+describe("getConsentData", () => {
+
+	beforeEach(() => {
+		getPersonalisedConsent.mockResolvedValue({
+			isAllowed: jest.fn().mockReturnValue({
+				consent1: true,
+				consent2: false,
+			}),
+		});
+		getUsPrivacyForTracking.mockReturnValue("usprivacy");
+	})
+	afterEach(() => {
+		jest.clearAllMocks();
+	});
+
+
+	it("returns the consent data and awaits for getPersonalisedConsent.isAllowed()", async () => {
+		const consentData = await getConsentData();
+
+		expect(consentData).toEqual({
+			consent1: true,
+			consent2: false,
+			usprivacy: "usprivacy",
+		});
+	});
+
+	it("Errors if getPersonalisedConsent.isAllowed() rejects", async () => {
+		getPersonalisedConsent.mockRejectedValue(new Error("no consent"));
+
+		await expect(getConsentData()).rejects.toThrow("no consent");
+	});
+
+	it("Errors if getUsPrivacyForTracking rejects", async () => {
+		getUsPrivacyForTracking.mockImplementation(() => {
+			throw new Error("us privacy error");
+		});
+
+		await expect(getConsentData()).rejects.toThrow("us privacy error");
+	});
+});

src/client/index.js

@@ -0,0 +1,11 @@
+import { getUsPrivacyForTracking } from "@financial-times/privacy-us-privacy";
+import { getPersonalisedConsent } from "@financial-times/ads-personalised-consent";
+
+export default async function getConsentData() {
+	const consentValues = (await getPersonalisedConsent()).isAllowed();
+	const usprivacy = getUsPrivacyForTracking();
+	return {
+		...consentValues,
+		usprivacy,
+	};
+}