Add id5 prebid integration behind test (#1970)

Co-authored-by: GHaberis <george.haberis@guardian.co.uk>
Co-authored-by: Charlotte Emms <43961396+cemms1@users.noreply.github.com>
Co-authored-by: George Haberis <george_haberis@36869_mac.gnm.int>

Author: 4 people

src/experiments/ab-tests.ts

@@ -1,4 +1,5 @@
 import type { ABTest } from '@guardian/ab-core';
+import { prebidId5 } from './tests/prebid-id5';
 
 /**
  * You only need to add tests to this file if the code you are testing is here in
@@ -7,4 +8,5 @@ import type { ABTest } from '@guardian/ab-core';
  */
 export const concurrentTests: ABTest[] = [
 	// one test per line
+	prebidId5,
 ];

src/experiments/tests/prebid-id5.ts

@@ -0,0 +1,28 @@
+import type { ABTest } from '@guardian/ab-core';
+
+export const prebidId5: ABTest = {
+	id: 'PrebidId5',
+	author: '@commercial-dev',
+	start: '2025-05-07',
+	expiry: '2025-05-30',
+	audience: 1 / 100,
+	audienceOffset: 0 / 100,
+	audienceCriteria: '',
+	successMeasure: '',
+	description: 'Test enabling the ID5 module in prebid.js',
+	variants: [
+		{
+			id: 'control',
+			test: (): void => {
+				/* no-op */
+			},
+		},
+		{
+			id: 'variant',
+			test: (): void => {
+				/* no-op */
+			},
+		},
+	],
+	canRun: () => true,
+};

src/lib/header-bidding/prebid/pbjs.ts

@@ -16,6 +16,8 @@ import 'prebid.js/modules/kargoBidAdapter';
 import 'prebid.js/modules/rubiconBidAdapter';
 import 'prebid.js/modules/ttdBidAdapter';
 import 'prebid.js/modules/multibid';
+import 'prebid.js/modules/id5IdSystem';
+import 'prebid.js/modules/userId';
 
 // Guardian specific adapters that we have modified or created
 import './modules/appnexusBidAdapter';

src/lib/header-bidding/prebid/prebid.spec.ts

@@ -1,4 +1,5 @@
 import { type ConsentState } from '@guardian/libs';
+import { getConsentFor } from '@guardian/libs';
 import { isUserInVariant } from '../../../experiments/ab';
 import { pubmatic } from '../../__vendor/pubmatic';
 import { getAdvertById as getAdvertById_ } from '../../dfp/get-advert-by-id';
@@ -36,6 +37,16 @@ jest.mock('experiments/ab', () => ({
 	isUserInVariant: jest.fn(),
 }));
 
+jest.mock('@guardian/libs', () => ({
+	...jest.requireActual('@guardian/libs'),
+	getConsentFor: jest.fn(),
+}));
+
+const mockGetConsentForID5 = (hasConsent: boolean) =>
+	(getConsentFor as jest.Mock).mockImplementation((vendor: string) =>
+		vendor === 'id5' ? hasConsent : undefined,
+	);
+
 const mockConsentState = {
 	tcfv2: {
 		consents: { '': true },
@@ -72,6 +83,8 @@ describe('initialise', () => {
 			jest.fn().mockReturnValue(true),
 		);
 		jest.mocked(isUserInVariant).mockReturnValue(false);
+
+		mockGetConsentForID5(true);
 		prebid.initialise(window, mockConsentState);
 
 		expect(window.pbjs?.getConfig()).toEqual({
@@ -202,6 +215,39 @@ describe('initialise', () => {
 		});
 	});
 
+	test('should generate correct Prebid config when no consent for ID5', () => {
+		jest.mocked(shouldIncludeBidder).mockReturnValue(
+			jest.fn().mockReturnValue(true),
+		);
+		jest.mocked(isUserInVariant).mockReturnValue(false);
+
+		mockGetConsentForID5(false);
+		prebid.initialise(window, mockConsentState);
+
+		expect(window.pbjs?.getConfig('userSync')).toEqual({
+			syncDelay: 3000,
+			syncEnabled: true,
+			syncsPerBidder: 0,
+			userIds: [
+				{
+					name: 'sharedId',
+					storage: {
+						type: 'cookie',
+						name: '_pubcid',
+						expires: 365,
+					},
+				},
+			],
+			auctionDelay: 500,
+			filterSettings: {
+				all: {
+					bidders: '*',
+					filter: 'include',
+				},
+			},
+		});
+	});
+
 	test('should generate correct Prebid config consent management in USNAT', () => {
 		prebid.initialise(window, { ...mockConsentState, framework: 'usnat' });
 		expect(window.pbjs?.getConfig('consentManagement')).toEqual({

src/lib/header-bidding/prebid/prebid.ts

@@ -1,9 +1,10 @@
 import type { ConsentState } from '@guardian/libs';
-import { isString, log, onConsent } from '@guardian/libs';
+import { getConsentFor, isString, log, onConsent } from '@guardian/libs';
 import { flatten } from 'lodash-es';
 import type { PrebidPriceGranularity } from 'prebid.js/src/cpmBucketManager';
 import type { Advert } from '../../../define/Advert';
-import { getParticipations } from '../../../experiments/ab';
+import { getParticipations, isUserInVariant } from '../../../experiments/ab';
+import { prebidId5 } from '../../../experiments/tests/prebid-id5';
 import type { AdSize } from '../../../lib/ad-sizes';
 import { createAdSize } from '../../../lib/ad-sizes';
 import { PREBID_TIMEOUT } from '../../../lib/constants/prebid-timeout';
@@ -64,11 +65,12 @@ type ConsentManagement =
 
 type UserId = {
 	name: string;
-	params?: Record<string, string>;
+	params?: Record<string, string | number>;
 	storage: {
-		type: 'cookie';
+		type: 'cookie' | 'html5';
 		name: string;
 		expires: number;
+		refreshInSeconds?: number;
 	};
 };
 
@@ -347,6 +349,35 @@ const initialise = (window: Window, consentState: ConsentState): void => {
 	}
 	initialised = true;
 
+	const userIds: UserId[] = [
+		{
+			name: 'sharedId',
+			storage: {
+				type: 'cookie',
+				name: '_pubcid',
+				expires: 365,
+			},
+		},
+	];
+
+	if (
+		getConsentFor('id5', consentState) &&
+		isUserInVariant(prebidId5, 'variant')
+	) {
+		userIds.push({
+			name: 'id5Id',
+			params: {
+				partner: 182,
+			},
+			storage: {
+				type: 'html5',
+				name: 'id5id',
+				expires: 90,
+				refreshInSeconds: 7200,
+			},
+		});
+	}
+
 	const userSync: UserSync = isSwitchedOn('prebidUserSync')
 		? {
 				syncsPerBidder: 0, // allow all syncs
@@ -356,16 +387,7 @@ const initialise = (window: Window, consentState: ConsentState): void => {
 						filter: 'include',
 					},
 				},
-				userIds: [
-					{
-						name: 'sharedId',
-						storage: {
-							type: 'cookie',
-							name: '_pubcid',
-							expires: 365,
-						},
-					},
-				],
+				userIds,
 			}
 		: { syncEnabled: false };