Remove prebid bid cache code (#2152)

Remove all prebid bid caching related code including grouping slots

Author: deedeeh

bundle/src/define/Advert.ts

@@ -127,21 +127,9 @@ const isSizeMappingEmpty = (sizeMapping: SizeMapping): boolean => {
 		Object.entries(sizeMapping).every(([, mapping]) => mapping.length === 0)
 	);
 };
-
-//We are grouping all fronts-banner slots and subsequent inline slots except inline1 to get the most use of prebid bid caching
-const getPrebidAdUnit = (advertId: string): string => {
-	if (advertId.includes('fronts-banner')) {
-		return 'banner';
-	} else if (advertId.includes('inline') && !advertId.includes('inline1')) {
-		return 'inline';
-	}
-	return advertId;
-};
-
 class Advert implements IAdvert {
 	id: string;
 	node: HTMLElement;
-	prebidAdUnit: string;
 	sizes: SizeMapping;
 	headerBiddingSizes: HeaderBiddingSize[] | null = null;
 	size: AdSize | 'fluid' | null = null;
@@ -165,7 +153,6 @@ class Advert implements IAdvert {
 	) {
 		this.id = adSlotNode.id;
 		this.node = adSlotNode;
-		this.prebidAdUnit = getPrebidAdUnit(adSlotNode.id);
 		this.sizes = this.generateSizeMapping(additionalSizeMapping);
 
 		const slotDefinition = defineSlot(

bundle/src/experiments/ab-tests.ts

@@ -1,6 +1,5 @@
 import type { ABTest } from '@guardian/ab-core';
 import { admiralAdblockRecovery } from './tests/admiral-adblocker-recovery';
-import { prebidAdUnit } from './tests/prebid-ad-unit';
 import { prebid946 } from './tests/prebid946';
 
 /**
@@ -11,6 +10,5 @@ import { prebid946 } from './tests/prebid946';
 export const concurrentTests: ABTest[] = [
 	// one test per line
 	prebid946,
-	prebidAdUnit,
 	admiralAdblockRecovery,
 ];

bundle/src/experiments/tests/prebid-ad-unit.ts

@@ -1,6 +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';
 import { shouldIncludeBidder, shouldIncludePermutive } from '../utils';
@@ -28,10 +27,6 @@ jest.mock('../utils', () => ({
 		.mockReturnValue(jest.fn().mockReturnValue(true)),
 }));
 
-jest.mock('experiments/ab', () => ({
-	isUserInVariant: jest.fn(),
-}));
-
 jest.mock('@guardian/libs', () => ({
 	...jest.requireActual('@guardian/libs'),
 	getConsentFor: jest.fn(),
@@ -77,8 +72,6 @@ describe('initialise', () => {
 		jest.mocked(shouldIncludeBidder).mockReturnValue(
 			jest.fn().mockReturnValue(true),
 		);
-		jest.mocked(isUserInVariant).mockReturnValue(false);
-		window.guardian.config.switches.prebidBidCache = true;
 		mockGetConsentForID5(true);
 
 		prebid.initialise(window, mockConsentState);
@@ -128,7 +121,6 @@ describe('initialise', () => {
 			},
 			priceGranularity: 'custom',
 			timeoutBuffer: 400,
-			useBidCache: true,
 			userSync: {
 				syncDelay: 3000,
 				syncEnabled: true,
@@ -189,7 +181,6 @@ describe('initialise', () => {
 		jest.mocked(shouldIncludeBidder).mockReturnValue(
 			jest.fn().mockReturnValue(true),
 		);
-		jest.mocked(isUserInVariant).mockReturnValue(false);
 
 		mockGetConsentForID5(false);
 		prebid.initialise(window, mockConsentState);
@@ -244,18 +235,6 @@ describe('initialise', () => {
 		expect(window.pbjs?.getConfig('consentManagement')).toBeUndefined();
 	});
 
-	test('should set value of useBidCache correctly in Prebid config when the switch is on', () => {
-		window.guardian.config.switches.prebidBidCache = true;
-		prebid.initialise(window, mockConsentState);
-		expect(window.pbjs?.getConfig('useBidCache')).toBe(true);
-	});
-
-	test('should set value of useBidCache correctly in Prebid config when the switch is off', () => {
-		window.guardian.config.switches.prebidBidCache = false;
-		prebid.initialise(window, mockConsentState);
-		expect(window.pbjs?.getConfig('useBidCache')).toBe(false);
-	});
-
 	test('should not include realTimeData object if permutive should not be included', () => {
 		jest.mocked(shouldIncludePermutive).mockReturnValue(false);
 		prebid.initialise(window, mockConsentState);

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

@@ -28,7 +28,6 @@ import {
 	isSwitchedOn,
 	shouldIncludeBidder,
 	shouldIncludePermutive,
-	shouldIncludePrebidAdUnit,
 	stripDfpAdPrefixFrom,
 } from '../utils';
 import { bids } from './bid-config';
@@ -119,7 +118,6 @@ type PbjsConfig = {
 	};
 	consentManagement?: ConsentManagement;
 	realTimeData?: unknown;
-	useBidCache?: boolean;
 	customPriceBucket?: PrebidPriceGranularity;
 	/**
 	 * This is a custom property that has been added to our fork of prebid.js
@@ -222,7 +220,7 @@ class PrebidAdUnit {
 		pageTargeting: PageTargeting,
 		consentState: ConsentState,
 	) {
-		this.code = shouldIncludePrebidAdUnit ? advert.prebidAdUnit : advert.id;
+		this.code = advert.id;
 		this.mediaTypes = { banner: { sizes: slot.sizes } };
 		this.gpid = this.generateGpid(advert, slot);
 		this.ortb2Imp = {
@@ -235,15 +233,15 @@ class PrebidAdUnit {
 		};
 
 		this.bids = bids(
-			shouldIncludePrebidAdUnit ? advert.prebidAdUnit : advert.id,
+			advert.id,
 			slot.sizes,
 			pageTargeting,
 			this.gpid,
 			consentState,
 		);
 
 		advert.headerBiddingSizes = slot.sizes;
-		log('commercial', `PrebidAdUnit ${advert.id}`, this.bids);
+		log('commercial', `PrebidAdUnit ${this.code}`, this.bids);
 	}
 
 	isEmpty() {
@@ -296,9 +294,7 @@ declare global {
 			onEvent: (event: PbjsEvent, handler: PbjsEventHandler) => void;
 			setTargetingForGPTAsync: (
 				codeArr?: string[],
-				customSlotMatching?: (
-					slot: googletag.Slot,
-				) => (adUnitCode: string) => boolean,
+				customSlotMatching?: (slot: unknown) => unknown,
 			) => void;
 			getEvents: () => PrebidEvent[];
 		};
@@ -430,7 +426,6 @@ const initialise = (window: Window, consentState: ConsentState): void => {
 			timeoutBuffer,
 			priceGranularity,
 			userSync,
-			useBidCache: isSwitchedOn('prebidBidCache'),
 		},
 	);
 
@@ -622,34 +617,14 @@ const initialise = (window: Window, consentState: ConsentState): void => {
 	});
 };
 
-/**
- * Creates a slot matching function for Prebid to match GPT slots with their corresponding ad units
- * @param slot The googletag slot to find a matching advert for
- * @returns A function that takes an adUnitCode and returns true if the slot's corresponding advert has a matching prebidAdUnit
- * @see https://docs.prebid.org/dev-docs/publisher-api-reference/setTargetingForGPTAsync.html#custom-slot-matching
- */
-const customSlotMatching = (slot: googletag.Slot) => {
-	return function (adUnitCode: string) {
-		const advert = getAdvertById(slot.getSlotElementId());
-		return advert?.prebidAdUnit === adUnitCode;
-	};
-};
-
 const bidsBackHandler = (
 	adUnits: PrebidAdUnit[],
 	eventTimer: EventTimer,
 ): Promise<void> =>
 	new Promise((resolve) => {
-		if (shouldIncludePrebidAdUnit) {
-			window.pbjs?.setTargetingForGPTAsync(
-				adUnits.map((u) => u.code).filter(isString),
-				customSlotMatching,
-			);
-		} else {
-			window.pbjs?.setTargetingForGPTAsync(
-				adUnits.map((u) => u.code).filter(isString),
-			);
-		}
+		window.pbjs?.setTargetingForGPTAsync(
+			adUnits.map((u) => u.code).filter(isString),
+		);
 
 		resolve();
 

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

@@ -8,8 +8,6 @@ import {
 } from '@guardian/commercial-core/geo/geo-utils';
 import { type ConsentState, getConsentFor, isString } from '@guardian/libs';
 import { once } from 'lodash-es';
-import { isUserInVariant } from '../../experiments/ab';
-import { prebidAdUnit } from '../../experiments/tests/prebid-ad-unit';
 import {
 	getCurrentTweakpoint,
 	matchesBreakpoints,
@@ -258,6 +256,3 @@ export const containsWS = (sizes: HeaderBiddingSize[]): boolean =>
 	contains(sizes, createAdSize(160, 600));
 
 export const shouldIncludeOnlyA9 = window.location.hash.includes('#only-a9');
-
-export const shouldIncludePrebidAdUnit =
-	isSwitchedOn('prebidBidCache') && isUserInVariant(prebidAdUnit, 'variant');

bundle/src/lib/header-bidding/utils.ts

@@ -8,7 +8,6 @@ type HeaderBiddingSize = AdSize;
 interface Advert {
 	id: string;
 	node: HTMLElement;
-	prebidAdUnit: string;
 	sizes: SizeMapping;
 	headerBiddingSizes: HeaderBiddingSize[] | null;
 	size: AdSize | 'fluid' | null;