Add localHour in page targeting (#2149)

* Add localHour in page targeting

* Fix unit tests for the new localHour page targeting key/value

* Remove unused jest mock set and capitalize Local Hour

* fix prettier

Author: deedeeh

bundle/src/lib/page-targeting.spec.ts

@@ -62,6 +62,7 @@ describe('Build Page Targeting', () => {
 				ab: ['MtMaster-variantName'],
 				at: 'ng101',
 				cc: 'US',
+				lh: '12',
 				pv: 'presetOphanPageViewId',
 				si: 't',
 				bp: 'desktop',

bundle/src/lib/targeting/build-page-targeting-consentless.spec.ts

@@ -37,6 +37,7 @@ describe('buildPageTargetingConsentless', () => {
 			ab: ['MtMaster-variantName'],
 			at: 'ng101',
 			cc: 'US',
+			lh: '12',
 			pv: 'presetOphanPageViewId',
 			si: 't',
 			bp: 'desktop',
@@ -63,6 +64,7 @@ describe('buildPageTargetingConsentless', () => {
 			ab: ['MtMaster-variantName'],
 			at: 'ng101',
 			cc: 'US',
+			lh: '12',
 			si: 't',
 			bp: 'desktop',
 			skinsize: 's',

bundle/src/lib/targeting/build-page-targeting-consentless.ts

@@ -11,6 +11,7 @@ const consentlessTargetingKeys = [
 	'bp',
 	'br',
 	'cc',
+	'lh',
 	'ct',
 	'dcre',
 	'edition',

core/src/targeting/build-page-targeting.spec.ts

@@ -7,6 +7,7 @@ import { cmp as cmp_, setCookie, storage } from '@guardian/libs';
 import { getLocale as getLocale_ } from '../geo/get-locale';
 import type { Edition } from '../types';
 import { buildPageTargeting } from './build-page-targeting';
+import { getLocalHour } from './shared';
 
 const getLocale = getLocale_ as jest.MockedFunction<typeof getLocale_>;
 
@@ -24,6 +25,11 @@ jest.mock('../geo/get-locale', () => ({
 	getLocale: jest.fn(),
 }));
 
+jest.mock('./shared', () => ({
+	...jest.requireActual('./shared'),
+	getLocalHour: jest.fn().mockReturnValue('12'),
+}));
+
 jest.mock('@guardian/libs', () => ({
 	...jest.requireActual<typeof import('@guardian/libs')>('@guardian/libs'),
 	cmp: {
@@ -170,6 +176,8 @@ describe('Build Page Targeting', () => {
 
 		getLocale.mockReturnValue('US');
 
+		jest.mocked(getLocalHour).mockImplementation(() => '12');
+
 		jest.spyOn(global.Math, 'random').mockReturnValue(0.5);
 
 		expect.hasAssertions();
@@ -208,6 +216,7 @@ describe('Build Page Targeting', () => {
 		expect(pageTargeting.pv).toEqual('presetOphanPageViewId');
 		expect(pageTargeting.pa).toEqual('f');
 		expect(pageTargeting.cc).toEqual('US');
+		expect(pageTargeting.lh).toEqual('12');
 		expect(pageTargeting.rp).toEqual('dotcom-platform');
 		expect(pageTargeting.rc).toEqual('7');
 		expect(pageTargeting.allkw).toEqual([
@@ -456,6 +465,7 @@ describe('Build Page Targeting', () => {
 			at: 'ng101',
 			bp: 'mobile',
 			cc: 'US',
+			lh: '12',
 			cmp_interaction: 'na',
 			consent_tcfv2: 'na',
 			dcre: 'f',

core/src/targeting/build-page-targeting.ts

@@ -10,7 +10,7 @@ import { getPersonalisedTargeting } from './personalised';
 import type { SessionTargeting } from './session';
 import { getSessionTargeting } from './session';
 import type { SharedTargeting } from './shared';
-import { getSharedTargeting } from './shared';
+import { getLocalHour, getSharedTargeting } from './shared';
 import type { True, TrueOrFalse } from './types';
 import type { ViewportTargeting } from './viewport';
 import { getViewportTargeting } from './viewport';
@@ -25,6 +25,7 @@ type PageTargeting = PartialWithNulls<
 		at: string; // Ad Test
 		bp: 'mobile' | 'tablet' | 'desktop'; // BreakPoint
 		cc: CountryCode; // Country Code
+		lh: string; // Local Hour
 		cmp_interaction: string;
 		consent_tcfv2: string;
 		dcre: TrueOrFalse; // DotCom-Rendering Eligible
@@ -135,6 +136,7 @@ const buildPageTargeting = ({
 	const sessionTargeting: SessionTargeting = getSessionTargeting({
 		adTest: getCookie({ name: 'adtest', shouldMemoize: true }),
 		countryCode: getLocale(),
+		localHour: getLocalHour(),
 		isSignedIn,
 		pageViewId: window.guardian.config.ophan.pageViewId,
 		participations: {
@@ -186,5 +188,5 @@ const buildPageTargeting = ({
 	return pageTargeting;
 };
 
-export { buildPageTargeting, filterValues };
+export { buildPageTargeting, filterValues, getLocalHour };
 export type { PageTargeting };

core/src/targeting/session.spec.ts

@@ -7,6 +7,7 @@ describe('Session targeting', () => {
 			ab: null,
 			at: null,
 			cc: 'GB',
+			lh: '12',
 			pv: '1234567',
 			ref: null,
 			si: 'f',
@@ -21,6 +22,7 @@ describe('Session targeting', () => {
 			adTest: null,
 			pageViewId: '1234567',
 			countryCode: 'GB',
+			localHour: '12',
 			isSignedIn: false,
 		});
 		expect(targeting).toMatchObject(expected);
@@ -48,6 +50,7 @@ describe('Session targeting', () => {
 			],
 			at: null,
 			cc: 'GB',
+			lh: '12',
 			pv: '1234567',
 			ref: null,
 			si: 'f',
@@ -59,6 +62,7 @@ describe('Session targeting', () => {
 			adTest: null,
 			pageViewId: '1234567',
 			countryCode: 'GB',
+			localHour: '12',
 			isSignedIn: false,
 		});
 		expect(targeting).toMatchObject(expected);
@@ -77,6 +81,7 @@ describe('Session targeting', () => {
 			ab: null,
 			at: null,
 			cc: 'GB',
+			lh: '12',
 			pv: '1234567',
 			si: 'f',
 			ref,
@@ -91,6 +96,7 @@ describe('Session targeting', () => {
 			adTest: null,
 			pageViewId: '1234567',
 			countryCode: 'GB',
+			localHour: '12',
 			isSignedIn: false,
 		});
 		expect(targeting).toMatchObject(expected);
@@ -117,6 +123,7 @@ describe('Session targeting', () => {
 				adTest: null,
 				pageViewId: '1234567',
 				countryCode: 'GB',
+				localHour: '12',
 				isSignedIn,
 			});
 			expect(targeting).toMatchObject(expected);

core/src/targeting/session.ts

@@ -66,6 +66,15 @@ type SessionTargeting = {
 	 */
 	cc: CountryCode;
 
+	/**
+	 * **L**ocal **H**our - [see on Ad Manager][gam]
+	 *
+	 * Type: _Dynamic_
+	 *
+	 * [gam]: https://admanager.google.com/59666047#inventory/custom_targeting/detail/custom_key_id=17299564
+	 */
+	lh: string;
+
 	/**
 	 * Ophan **P**age **V**iew id – [see on Ad Manager][gam]
 	 *
@@ -161,6 +170,7 @@ const experimentsTargeting = ({
 type Session = {
 	adTest: SessionTargeting['at'];
 	countryCode: CountryCode;
+	localHour: string;
 	isSignedIn: boolean;
 	pageViewId: SessionTargeting['pv'];
 	participations: AllParticipations;
@@ -170,6 +180,7 @@ type Session = {
 const getSessionTargeting = ({
 	adTest,
 	countryCode,
+	localHour,
 	isSignedIn,
 	pageViewId,
 	participations,
@@ -178,6 +189,7 @@ const getSessionTargeting = ({
 	ab: experimentsTargeting(participations),
 	at: adTest,
 	cc: countryCode,
+	lh: localHour,
 	pv: pageViewId,
 	ref: getReferrer(referrer),
 	si: isSignedIn ? 't' : 'f',

core/src/targeting/shared.ts

@@ -178,6 +178,10 @@ const getSurgingParam = (surging: number): SharedTargeting['su'] => {
 
 /* -- Targeting -- */
 
+const getLocalHour = (): string => {
+	return new Date().getHours().toString();
+};
+
 /**
  * What goes in comes out
  */
@@ -190,4 +194,4 @@ export const _ = {
 };
 
 export type { SharedTargeting };
-export { getSharedTargeting };
+export { getSharedTargeting, getLocalHour };