Infer additional consent flags & gate PS join IG (#161)

Author: zapo

lib/addons/paapi.test.js

@@ -0,0 +1,53 @@
+import OptableSDK from "../sdk";
+import { TEST_HOST, TEST_SITE } from "../test/mocks.ts";
+import "./paapi.ts";
+
+describe("OptableSDK - joinAdInterestGroups", () => {
+  let SDK;
+  const origNavigator = window.navigator;
+
+  beforeEach(() => {
+    SDK = new OptableSDK({ host: TEST_HOST, site: TEST_SITE });
+    window.navigator = { ...origNavigator };
+  });
+
+  afterEach(() => {
+    window.navigator = origNavigator;
+  });
+
+  test("injects joinAdInterestGroups func", () => {
+    expect(SDK.joinAdInterestGroups).toBeDefined();
+  });
+
+  test("joinAdInterestGroups fails when join-ad-interest-group not supported", async () => {
+    expect.assertions(2);
+    const expected = "join-ad-interest-group not supported";
+    await expect(SDK.joinAdInterestGroups()).rejects.toBe(expected);
+
+    window.navigator.joinAdInterestGroup = function () {};
+    await expect(SDK.joinAdInterestGroups()).rejects.not.toBe(expected);
+  });
+
+  test("joinAdInterestGroups fails when consent not granted", async () => {
+    expect.assertions(4);
+    const expected = "consent not granted for joining interest groups";
+
+    window.navigator.joinAdInterestGroup = function () {};
+    SDK.dcn.consent.deviceAccess = false;
+    await expect(SDK.joinAdInterestGroups()).rejects.toBe(expected);
+
+    SDK.dcn.consent.deviceAccess = true;
+    SDK.dcn.consent.createProfilesForAdvertising = false;
+    await expect(SDK.joinAdInterestGroups()).rejects.toBe(expected);
+
+    SDK.dcn.consent.deviceAccess = true;
+    SDK.dcn.consent.createProfilesForAdvertising = true;
+    SDK.dcn.consent.measureAdvertisingPerformance = false;
+    await expect(SDK.joinAdInterestGroups()).rejects.toBe(expected);
+
+    SDK.dcn.consent.deviceAccess = true;
+    SDK.dcn.consent.createProfilesForAdvertising = true;
+    SDK.dcn.consent.measureAdvertisingPerformance = true;
+    await expect(SDK.joinAdInterestGroups()).rejects.not.toBe(expected);
+  });
+});

lib/addons/paapi.ts

@@ -157,6 +157,17 @@ OptableSDK.prototype.joinAdInterestGroups = async function () {
     throw "join-ad-interest-group not supported";
   }
 
+  // For now gate for everything happenning inside the join-ig frame.
+  // Eventually each behavior will be individually gated in the frame itself.
+  const accessGranted =
+    this.dcn.consent.deviceAccess &&
+    this.dcn.consent.createProfilesForAdvertising &&
+    this.dcn.consent.measureAdvertisingPerformance;
+
+  if (!accessGranted) {
+    throw "consent not granted for joining interest groups";
+  }
+
   const siteConfig = await this.site();
   if (!siteConfig.interestGroupPixel) {
     throw "origin not enabled for protected audience apis";

lib/config.test.js

@@ -1,5 +1,6 @@
-import { getConfig } from "./config";
-import globalConsent from "./core/regs/consent";
+import { DCN_DEFAULTS, getConfig } from "./config";
+
+const defaultConsent = DCN_DEFAULTS.consent;
 
 describe("getConfig", () => {
   it("returns the default config when no overrides are provided", () => {
@@ -8,7 +9,7 @@ describe("getConfig", () => {
       site: "site",
       cookies: true,
       initPassport: true,
-      consent: { deviceAccess: true, reg: null },
+      consent: defaultConsent,
     });
   });
 
@@ -19,14 +20,14 @@ describe("getConfig", () => {
         site: "site",
         cookies: false,
         initPassport: false,
-        consent: { static: { deviceAccess: true, reg: "us" } },
+        consent: { static: defaultConsent },
       })
     ).toEqual({
       host: "host",
       site: "site",
       cookies: false,
       initPassport: false,
-      consent: { deviceAccess: true, reg: "us" },
+      consent: defaultConsent,
     });
   });
 
@@ -42,7 +43,10 @@ describe("getConfig", () => {
       site: "site",
       consent: { cmpapi: {} },
     });
-    expect(config.consent).toEqual({ deviceAccess: true, reg: "us" });
+    expect(config.consent).toEqual({
+      ...defaultConsent,
+      reg: "us",
+    });
 
     spy.mockRestore();
   });

lib/config.ts

@@ -1,10 +1,5 @@
-import { getConsent, Consent, inferRegulation } from "./core/regs/consent";
-
-type CMPApiConfig = {
-  // An optional vendor ID from GVL (global vendor list) when interpretting TCF/GPP EU consent,
-  // when not passed, defaults to publisher consent.
-  tcfeuVendorID?: number;
-};
+import { getConsent, inferRegulation } from "./core/regs/consent";
+import type { CMPApiConfig, Consent } from "./core/regs/consent";
 
 type InitConsent = {
   // A "cmpapi" configuration indicating that consent should be gathered from CMP apis.
@@ -28,7 +23,13 @@ type ResolvedConfig = Required<Omit<InitConfig, "consent">> & {
 const DCN_DEFAULTS = {
   cookies: true,
   initPassport: true,
-  consent: { deviceAccess: true, reg: null },
+  consent: {
+    reg: null,
+    deviceAccess: true,
+    createProfilesForAdvertising: true,
+    useProfilesForAdvertising: true,
+    measureAdvertisingPerformance: true,
+  },
 };
 
 function getConfig(init: InitConfig): ResolvedConfig {
@@ -50,4 +51,4 @@ function getConfig(init: InitConfig): ResolvedConfig {
 }
 
 export type { InitConsent, CMPApiConfig, InitConfig, ResolvedConfig };
-export { getConfig };
+export { getConfig, DCN_DEFAULTS };