Remove per-country Gandalf pageview counter in favor of global count

The Gandalf sign-in gate counter is now global rather than per-country. Storage keys, function signatures, and tests updated to remove countryCode parameter. Counter still advances once per eligible pageview via idempotent pageview ID tracking.

Author: Juarez Mota

dotcom-rendering/src/components/SignInGate/types.ts

@@ -195,11 +195,9 @@ export interface AuxiaProxyGetTreatmentsPayload {
 // countries via the gandalfSignInGateCountries channel switch.
 //
 // `gandalfPageViewCount` is the 0-based number of eligible pageviews the
-// reader has already completed in the request's country under the active
-// Gandalf rules (see src/lib/gandalf.ts). Counters are per country, because
-// campaigns differ by country group. It is optional so older payloads and
-// traffic outside the Gandalf countries are unaffected; SDC treats a missing
-// value as 0.
+// reader has already completed under the active Gandalf rules (see
+// src/lib/gandalf.ts). It is optional so older payloads and traffic outside
+// the Gandalf countries are unaffected; SDC treats a missing value as 0.
 
 export interface AuxiaProxyGetTreatmentsResponse {
 	status: boolean;

dotcom-rendering/src/components/StickyBottomBanner/SignInGatePortal.test.tsx

@@ -224,7 +224,7 @@ describe('SignInGatePortal', () => {
 	});
 
 	describe('Gandalf (Guardian-managed sign-in gate journey)', () => {
-		it('sends the current per-country pageview count to SDC', async () => {
+		it('sends the current pageview count to SDC', async () => {
 			mockGetElementById.mockReturnValue(document.createElement('div'));
 			(
 				buildAuxiaGateDisplayData as jest.MockedFunction<
@@ -266,7 +266,6 @@ describe('SignInGatePortal', () => {
 				},
 			});
 			expect(mockIncrementGandalfPageViewCount).toHaveBeenCalledWith(
-				'NZ',
 				'test-page-view-id',
 			);
 		});
@@ -290,7 +289,6 @@ describe('SignInGatePortal', () => {
 				meta: { ...auxiaReturn, gandalfCountryCode: 'NZ' },
 			});
 			expect(mockIncrementGandalfPageViewCount).toHaveBeenCalledWith(
-				'NZ',
 				'test-page-view-id',
 			);
 		});

dotcom-rendering/src/components/StickyBottomBanner/SignInGatePortal.tsx

@@ -210,19 +210,19 @@ export const canShowSignInGatePortal = async ({
 			sectionId,
 			tags,
 			retrieveLastGateDismissedCount('AuxiaSignInGate'),
-			// 0-based count of previously completed eligible pageviews for this
-			// country. SDC only consumes this for active Gandalf traffic; the
-			// counter itself is advanced below once SDC confirms the pageview
+			// 0-based count of previously completed eligible pageviews. SDC
+			// only consumes this for active Gandalf traffic; the counter
+			// itself is advanced below once SDC confirms the pageview
 			// counted.
-			getGandalfPageViewCount(countryCode ?? ''),
+			getGandalfPageViewCount(),
 		);
 
 		// Gandalf (the Guardian-managed sign-in gate journey): SDC marks
 		// responses produced by the active Gandalf rules. The pageview counted
-		// towards the country's free allowance even when no gate is displayed,
-		// so record it exactly once per pageview.
+		// towards the free allowance even when no gate is displayed, so record
+		// it exactly once per pageview.
 		if (auxiaData?.auxiaData.gandalfSignInGate === true) {
-			incrementGandalfPageViewCount(countryCode ?? '', ophanPageViewId);
+			incrementGandalfPageViewCount(ophanPageViewId);
 		}
 
 		const meta = (

dotcom-rendering/src/lib/gandalf.test.ts

@@ -4,73 +4,63 @@ import {
 } from './gandalf';
 
 // Mirrors the storage key shape in gandalf.ts
-const countKey = (countryCode: string): string =>
-	`gu.gandalf.pageViewCount.${countryCode.toLowerCase()}`;
+const countKey = 'gu.gandalf.pageViewCount';
 
 describe('gandalf pageview counter', () => {
 	beforeEach(() => {
 		localStorage.clear();
 	});
 
 	describe('getGandalfPageViewCount', () => {
-		it('returns 0 when nothing is stored for the country', () => {
-			expect(getGandalfPageViewCount('NZ')).toBe(0);
+		it('returns 0 when nothing is stored', () => {
+			expect(getGandalfPageViewCount()).toBe(0);
 		});
 
-		it('returns the stored count for the country', () => {
-			localStorage.setItem(countKey('NZ'), '4');
-			expect(getGandalfPageViewCount('NZ')).toBe(4);
+		it('returns the stored count', () => {
+			localStorage.setItem(countKey, '4');
+			expect(getGandalfPageViewCount()).toBe(4);
 		});
 
 		it('fails safe to 0 for malformed values', () => {
-			localStorage.setItem(countKey('NZ'), 'not-a-number');
-			expect(getGandalfPageViewCount('NZ')).toBe(0);
+			localStorage.setItem(countKey, 'not-a-number');
+			expect(getGandalfPageViewCount()).toBe(0);
 		});
 
 		it('fails safe to 0 for negative values', () => {
-			localStorage.setItem(countKey('NZ'), '-3');
-			expect(getGandalfPageViewCount('NZ')).toBe(0);
+			localStorage.setItem(countKey, '-3');
+			expect(getGandalfPageViewCount()).toBe(0);
 		});
 	});
 
 	describe('incrementGandalfPageViewCount', () => {
-		it('increments the country count by one', () => {
-			incrementGandalfPageViewCount('NZ', 'page-view-1');
-			expect(getGandalfPageViewCount('NZ')).toBe(1);
+		it('increments the count by one', () => {
+			incrementGandalfPageViewCount('page-view-1');
+			expect(getGandalfPageViewCount()).toBe(1);
 		});
 
-		it('keeps one counter per country', () => {
-			incrementGandalfPageViewCount('NZ', 'page-view-1');
-			incrementGandalfPageViewCount('NZ', 'page-view-2');
-			incrementGandalfPageViewCount('AU', 'page-view-2');
-			expect(getGandalfPageViewCount('NZ')).toBe(2);
-			expect(getGandalfPageViewCount('AU')).toBe(1);
+		it('is idempotent for the same pageview id', () => {
+			incrementGandalfPageViewCount('page-view-1');
+			incrementGandalfPageViewCount('page-view-1');
+			incrementGandalfPageViewCount('page-view-1');
+			expect(getGandalfPageViewCount()).toBe(1);
 		});
 
-		it('is idempotent for the same pageview id within a country', () => {
-			incrementGandalfPageViewCount('NZ', 'page-view-1');
-			incrementGandalfPageViewCount('NZ', 'page-view-1');
-			incrementGandalfPageViewCount('NZ', 'page-view-1');
-			expect(getGandalfPageViewCount('NZ')).toBe(1);
-		});
-
-		it('counts the same pageview id separately per country', () => {
-			incrementGandalfPageViewCount('NZ', 'page-view-1');
-			incrementGandalfPageViewCount('AU', 'page-view-2');
-			expect(getGandalfPageViewCount('NZ')).toBe(1);
-			expect(getGandalfPageViewCount('AU')).toBe(1);
+		it('counts distinct pageview ids separately', () => {
+			incrementGandalfPageViewCount('page-view-1');
+			incrementGandalfPageViewCount('page-view-2');
+			expect(getGandalfPageViewCount()).toBe(2);
 		});
 
 		it('continues from a pre-existing stored count', () => {
-			localStorage.setItem(countKey('NZ'), '2');
-			incrementGandalfPageViewCount('NZ', 'page-view-1');
-			expect(getGandalfPageViewCount('NZ')).toBe(3);
+			localStorage.setItem(countKey, '2');
+			incrementGandalfPageViewCount('page-view-1');
+			expect(getGandalfPageViewCount()).toBe(3);
 		});
 
 		it('resets a malformed stored value to 1 on increment', () => {
-			localStorage.setItem(countKey('NZ'), 'garbage');
-			incrementGandalfPageViewCount('NZ', 'page-view-1');
-			expect(getGandalfPageViewCount('NZ')).toBe(1);
+			localStorage.setItem(countKey, 'garbage');
+			incrementGandalfPageViewCount('page-view-1');
+			expect(getGandalfPageViewCount()).toBe(1);
 		});
 	});
 });

dotcom-rendering/src/lib/gandalf.ts

@@ -6,55 +6,46 @@ import { storage } from '@guardian/libs';
 // currently live for New Zealand and extendable to further countries via the
 // gandalfSignInGateCountries channel switch.
 //
-// A dedicated, persistent counter of completed eligible pageviews, kept per
-// country because campaigns differ by country group. It is deliberately
-// independent of `gu.history.dailyArticleCount` (which resets daily and only
-// counts a subset of content types) and of `gate_display_count` (which counts
-// gate renders, not pageviews).
+// A dedicated, persistent counter of completed eligible pageviews. It is
+// deliberately independent of `gu.history.dailyArticleCount` (which resets
+// daily and only counts a subset of content types), of `gate_display_count`
+// (which counts gate renders, not pageviews) and of `gu.alreadyVisited`
+// (which counts every consented pageview and is an ad-targeting input).
 //
 // The counter is 0-based: it stores the number of eligible pageviews already
-// completed for the country. The first three eligible pageviews (counts 0, 1,
-// 2 sent to SDC) are free; from the fourth onwards SDC returns the
-// non-dismissible popup.
+// completed. The first three eligible pageviews (counts 0, 1, 2 sent to SDC)
+// are free; from the fourth onwards SDC returns the non-dismissible popup.
 //
 // The counter only advances after SDC confirms the pageview was an active,
 // eligible pageview for a Gandalf country (see the gandalfSignInGate response
 // marker), so unlisted-country traffic and excluded pages never consume the
 // allowance. It is browser-local: clearing storage or using a new/incognito
 // browser resets the allowance. This is accepted for the proof of concept.
 
-const pageViewCountKey = (countryCode: string): string =>
-	`gu.gandalf.pageViewCount.${countryCode.toLowerCase()}`;
+const pageViewCountKey = 'gu.gandalf.pageViewCount';
 
-const lastCountedPageViewIdKey = (countryCode: string): string =>
-	`gu.gandalf.lastCountedPageViewId.${countryCode.toLowerCase()}`;
+const lastCountedPageViewIdKey = 'gu.gandalf.lastCountedPageViewId';
 
 /**
- * Returns the 0-based number of eligible pageviews already completed in the
- * given country. Fails safe to 0 if the stored value is missing or malformed.
+ * Returns the 0-based number of eligible pageviews already completed.
+ * Fails safe to 0 if the stored value is missing or malformed.
  */
-export const getGandalfPageViewCount = (countryCode: string): number => {
-	const raw = storage.local.getRaw(pageViewCountKey(countryCode));
+export const getGandalfPageViewCount = (): number => {
+	const raw = storage.local.getRaw(pageViewCountKey);
 	const count = parseInt(raw ?? '', 10);
 	return Number.isInteger(count) && count >= 0 ? count : 0;
 };
 
 /**
- * Records one completed eligible pageview for the country. Idempotent per
- * pageview ID, so React effect re-runs (e.g. Strict Mode) increment at most
- * once per pageview.
+ * Records one completed eligible pageview. Idempotent per pageview ID, so
+ * React effect re-runs (e.g. Strict Mode) increment at most once per
+ * pageview.
  */
-export const incrementGandalfPageViewCount = (
-	countryCode: string,
-	pageViewId: string,
-): void => {
-	if (
-		storage.local.getRaw(lastCountedPageViewIdKey(countryCode)) ===
-		pageViewId
-	) {
+export const incrementGandalfPageViewCount = (pageViewId: string): void => {
+	if (storage.local.getRaw(lastCountedPageViewIdKey) === pageViewId) {
 		return;
 	}
-	storage.local.setRaw(lastCountedPageViewIdKey(countryCode), pageViewId);
-	const count = getGandalfPageViewCount(countryCode);
-	storage.local.setRaw(pageViewCountKey(countryCode), (count + 1).toString());
+	storage.local.setRaw(lastCountedPageViewIdKey, pageViewId);
+	const count = getGandalfPageViewCount();
+	storage.local.setRaw(pageViewCountKey, (count + 1).toString());
 };