Support Sourcepoint GPP consent for EC generation

crates/integration-tests/tests/common/runtime.rs

@@ -52,7 +52,6 @@ pub enum TestError {
     #[display("Expected HTTP status {expected}, got {actual}")]
     UnexpectedStatusCode { expected: u16, actual: u16 },
 
-
     #[display("JSON field assertion failed: {field}")]
     JsonFieldMismatch { field: String },
 

crates/js/lib/src/integrations/prebid/_user_ids.generated.ts

@@ -0,0 +1,22 @@
+// Auto-generated by build-all.mjs — manual edits will be overwritten at build time.
+//
+// Controls which Prebid.js User ID submodules are included in the bundle.
+// Set the TSJS_PREBID_USER_IDS environment variable to a comma-separated
+// list of submodule filenames without the `.js` extension
+// (e.g. "sharedIdSystem,id5IdSystem,criteoIdSystem") before building.
+// The userId.js core module is always included via a static import in
+// index.ts and is not configurable here.
+
+import 'prebid.js/modules/sharedIdSystem.js';
+import 'prebid.js/modules/criteoIdSystem.js';
+import 'prebid.js/modules/33acrossIdSystem.js';
+import 'prebid.js/modules/pubProvidedIdSystem.js';
+import 'prebid.js/modules/quantcastIdSystem.js';
+import 'prebid.js/modules/id5IdSystem.js';
+import 'prebid.js/modules/identityLinkIdSystem.js';
+import 'prebid.js/modules/uid2IdSystem.js';
+import 'prebid.js/modules/euidIdSystem.js';
+import 'prebid.js/modules/intentIqIdSystem.js';
+import 'prebid.js/modules/lotamePanoramaIdSystem.js';
+import 'prebid.js/modules/connectIdSystem.js';
+import 'prebid.js/modules/merkleIdSystem.js';

crates/js/lib/src/integrations/prebid/index.ts

@@ -466,7 +466,8 @@ function syncPrebidEidsCookie(): void {
       return; // Single EID too large — skip.
     }
 
-    document.cookie = `${EID_COOKIE_NAME}=${encoded}; Path=/; Secure; SameSite=Lax; Max-Age=${EID_COOKIE_MAX_AGE}`;
+    document.cookie =
+      `${EID_COOKIE_NAME}=${encoded}; Path=/; Secure; SameSite=Lax; Max-Age=${EID_COOKIE_MAX_AGE}`;
 
     log.debug(`[tsjs-prebid] synced ${payload.length} EIDs to cookie`);
   } catch (err) {

crates/js/lib/src/integrations/sourcepoint/index.ts

@@ -0,0 +1,95 @@
+import { log } from '../../core/log';
+
+const SP_CONSENT_PREFIX = '_sp_user_consent_';
+const GPP_COOKIE_NAME = '__gpp';
+const GPP_SID_COOKIE_NAME = '__gpp_sid';
+
+interface SourcepointGppData {
+  gppString: string;
+  applicableSections: number[];
+}
+
+interface SourcepointConsentPayload {
+  gppData?: SourcepointGppData;
+}
+
+function findSourcepointConsent(): SourcepointConsentPayload | null {
+  // Sourcepoint stores one consent payload per property under `_sp_user_consent_*`.
+  // We intentionally take the first valid match and mirror that origin-scoped payload.
+  for (let i = 0; i < localStorage.length; i++) {
+    const key = localStorage.key(i);
+    if (!key?.startsWith(SP_CONSENT_PREFIX)) continue;
+
+    const raw = localStorage.getItem(key);
+    if (!raw) continue;
+
+    try {
+      const payload = JSON.parse(raw) as SourcepointConsentPayload;
+      if (payload.gppData?.gppString) {
+        return payload;
+      }
+    } catch {
+      log.debug('sourcepoint: failed to parse localStorage value', { key });
+    }
+  }
+  return null;
+}
+
+function writeCookie(name: string, value: string): void {
+  document.cookie = `${name}=${value}; path=/; Secure; SameSite=Lax`;
+}
+
+function clearCookie(name: string): void {
+  // Trusted Server is the only intended writer for these mirrored cookies, so
+  // clearing the origin-scoped cookie is sufficient for this integration.
+  document.cookie = `${name}=; path=/; Secure; SameSite=Lax; Max-Age=0`;
+}
+
+/**
+ * Reads Sourcepoint consent from localStorage and mirrors it into
+ * `__gpp` and `__gpp_sid` cookies for Trusted Server to read.
+ *
+ * Returns `true` if cookies were written, `false` otherwise.
+ */
+export function mirrorSourcepointConsent(): boolean {
+  if (typeof localStorage === 'undefined' || typeof document === 'undefined') {
+    return false;
+  }
+
+  const payload = findSourcepointConsent();
+  if (!payload?.gppData) {
+    clearCookie(GPP_COOKIE_NAME);
+    clearCookie(GPP_SID_COOKIE_NAME);
+    log.debug('sourcepoint: no GPP data found in localStorage');
+    return false;
+  }
+
+  const { gppString, applicableSections } = payload.gppData;
+  if (!gppString) {
+    clearCookie(GPP_COOKIE_NAME);
+    clearCookie(GPP_SID_COOKIE_NAME);
+    log.debug('sourcepoint: gppString is empty');
+    return false;
+  }
+
+  writeCookie(GPP_COOKIE_NAME, gppString);
+
+  if (Array.isArray(applicableSections) && applicableSections.length > 0) {
+    writeCookie(GPP_SID_COOKIE_NAME, applicableSections.join(','));
+  } else {
+    clearCookie(GPP_SID_COOKIE_NAME);
+  }
+
+  log.info('sourcepoint: mirrored GPP consent to cookies', {
+    gppLength: gppString.length,
+    sections: applicableSections,
+  });
+
+  return true;
+}
+
+if (typeof window !== 'undefined') {
+  mirrorSourcepointConsent();
+}
+
+export default mirrorSourcepointConsent;

crates/js/lib/test/integrations/prebid/index.test.ts

@@ -6,17 +6,19 @@ const {
   mockProcessQueue,
   mockRequestBids,
   mockRegisterBidAdapter,
+  mockGetUserIdsAsEids,
   mockPbjs,
   mockGetBidAdapter,
-  mockGetUserIdsAsEids,
   mockAdapterManager,
 } = vi.hoisted(() => {
   const mockSetConfig = vi.fn();
   const mockProcessQueue = vi.fn();
   const mockRequestBids = vi.fn();
   const mockRegisterBidAdapter = vi.fn();
   const mockGetBidAdapter = vi.fn();
-  const mockGetUserIdsAsEids = vi.fn();
+  const mockGetUserIdsAsEids = vi.fn(
+    () => [] as Array<{ source: string; uids?: Array<{ id: string; atype?: number }> }>
+  );
   const mockPbjs = {
     setConfig: mockSetConfig,
     processQueue: mockProcessQueue,
@@ -33,9 +35,9 @@ const {
     mockProcessQueue,
     mockRequestBids,
     mockRegisterBidAdapter,
+    mockGetUserIdsAsEids,
     mockPbjs,
     mockGetBidAdapter,
-    mockGetUserIdsAsEids,
     mockAdapterManager,
   };
 });

crates/js/lib/test/integrations/sourcepoint/index.test.ts

@@ -0,0 +1,151 @@
+import { afterEach, beforeEach, describe, expect, it } from 'vitest';
+
+import { mirrorSourcepointConsent } from '../../../src/integrations/sourcepoint';
+
+describe('integrations/sourcepoint', () => {
+  function clearAllCookies(): void {
+    document.cookie.split(';').forEach((c) => {
+      const name = c.split('=')[0].trim();
+      if (name) document.cookie = `${name}=; path=/; Max-Age=0`;
+    });
+  }
+
+  function getCookie(name: string): string | undefined {
+    const match = document.cookie.split('; ').find((c) => c.startsWith(`${name}=`));
+    return match ? match.split('=').slice(1).join('=') : undefined;
+  }
+
+  beforeEach(() => {
+    // Clear cookies and localStorage before each test.
+    clearAllCookies();
+    localStorage.clear();
+  });
+
+  afterEach(() => {
+    clearAllCookies();
+    localStorage.clear();
+  });
+
+  it('mirrors __gpp and __gpp_sid from _sp_user_consent_* localStorage as session cookies', () => {
+    const payload = {
+      gppData: {
+        gppString: 'DBABLA~BVQqAAAAAgA.QA',
+        applicableSections: [7],
+      },
+    };
+    localStorage.setItem('_sp_user_consent_36026', JSON.stringify(payload));
+
+    const result = mirrorSourcepointConsent();
+
+    expect(result).toBe(true);
+    expect(document.cookie).toContain('__gpp=DBABLA~BVQqAAAAAgA.QA');
+    expect(document.cookie).toContain('__gpp_sid=7');
+  });
+
+  it('handles multiple applicable sections', () => {
+    const payload = {
+      gppData: {
+        gppString: 'DBABLA~BVQqAAAAAgA.QA',
+        applicableSections: [7, 8],
+      },
+    };
+    localStorage.setItem('_sp_user_consent_99999', JSON.stringify(payload));
+
+    mirrorSourcepointConsent();
+
+    expect(document.cookie).toContain('__gpp_sid=7,8');
+  });
+
+  it('returns false when no _sp_user_consent_* key exists', () => {
+    localStorage.setItem('unrelated_key', 'value');
+
+    const result = mirrorSourcepointConsent();
+
+    expect(result).toBe(false);
+    expect(document.cookie).not.toContain('__gpp=');
+    expect(document.cookie).not.toContain('__gpp_sid=');
+  });
+
+  it('clears stale mirrored cookies when no valid Sourcepoint payload exists', () => {
+    document.cookie = '__gpp=stale-gpp; path=/';
+    document.cookie = '__gpp_sid=7,8; path=/';
+    localStorage.setItem('unrelated_key', 'value');
+
+    const result = mirrorSourcepointConsent();
+
+    expect(result).toBe(false);
+    expect(getCookie('__gpp')).toBeUndefined();
+    expect(getCookie('__gpp_sid')).toBeUndefined();
+  });
+
+  it('returns false for malformed JSON in localStorage', () => {
+    localStorage.setItem('_sp_user_consent_12345', 'not-json!!!');
+
+    const result = mirrorSourcepointConsent();
+
+    expect(result).toBe(false);
+    expect(document.cookie).not.toContain('__gpp=');
+  });
+
+  it('skips malformed entries when a later Sourcepoint key is valid', () => {
+    localStorage.setItem('_sp_user_consent_12345', 'not-json!!!');
+    localStorage.setItem(
+      '_sp_user_consent_67890',
+      JSON.stringify({
+        gppData: {
+          gppString: 'DBABLA~BVQqAAAAAgA.QA',
+          applicableSections: [7],
+        },
+      })
+    );
+
+    const result = mirrorSourcepointConsent();
+
+    expect(result).toBe(true);
+    expect(getCookie('__gpp')).toBe('DBABLA~BVQqAAAAAgA.QA');
+    expect(getCookie('__gpp_sid')).toBe('7');
+  });
+
+  it('returns false when gppData is missing from payload', () => {
+    localStorage.setItem('_sp_user_consent_12345', JSON.stringify({ otherField: true }));
+
+    const result = mirrorSourcepointConsent();
+
+    expect(result).toBe(false);
+    expect(document.cookie).not.toContain('__gpp=');
+  });
+
+  it('returns false when gppString is empty', () => {
+    const payload = {
+      gppData: {
+        gppString: '',
+        applicableSections: [7],
+      },
+    };
+    localStorage.setItem('_sp_user_consent_12345', JSON.stringify(payload));
+
+    const result = mirrorSourcepointConsent();
+
+    expect(result).toBe(false);
+    expect(document.cookie).not.toContain('__gpp=');
+  });
+
+  it('clears stale __gpp_sid when the payload has no applicable sections', () => {
+    document.cookie = '__gpp_sid=7,8; path=/';
+    localStorage.setItem(
+      '_sp_user_consent_12345',
+      JSON.stringify({
+        gppData: {
+          gppString: 'DBABLA~BVQqAAAAAgA.QA',
+          applicableSections: [],
+        },
+      })
+    );
+
+    const result = mirrorSourcepointConsent();
+
+    expect(result).toBe(true);
+    expect(getCookie('__gpp')).toBe('DBABLA~BVQqAAAAAgA.QA');
+    expect(getCookie('__gpp_sid')).toBeUndefined();
+  });
+});