gppControl_usstates: activity controls for US state consent

libraries/mspa/activityControls.js

@@ -6,6 +6,7 @@ import {
   ACTIVITY_TRANSMIT_PRECISE_GEO
 } from '../../src/activities/activities.js';
 import {gppDataHandler} from '../../src/adapterManager.js';
+import {logInfo} from '../../src/utils.js';
 
 // default interpretation for MSPA consent(s):
 // https://docs.prebid.org/features/mspa-usnat.html
@@ -112,8 +113,10 @@ function flatSection(subsections) {
 
 export function setupRules(api, sids, normalizeConsent = (c) => c, rules = CONSENT_RULES, registerRule = registerActivityControl, getConsentData = () => gppDataHandler.getConsentData()) {
   const unreg = [];
+  const ruleName = `MSPA (GPP '${api}' for section${sids.length > 1 ? 's' : ''} ${sids.join(', ')})`;
+  logInfo(`Enabling activity controls for ${ruleName}`)
   Object.entries(rules).forEach(([activity, denies]) => {
-    unreg.push(registerRule(activity, `MSPA (${api})`, mspaRule(
+    unreg.push(registerRule(activity, ruleName, mspaRule(
       sids,
       () => normalizeConsent(flatSection(getConsentData()?.parsedSections?.[api])),
       denies,

modules/gppControl_usstates.js

@@ -0,0 +1,176 @@
+import {config} from '../src/config.js';
+import {setupRules} from '../libraries/mspa/activityControls.js';
+import {deepSetValue, prefixLog} from '../src/utils.js';
+
+const FIELDS = {
+  Version: 0,
+  Gpc: 0,
+  SharingNotice: 0,
+  SaleOptOutNotice: 0,
+  SharingOptOutNotice: 0,
+  TargetedAdvertisingOptOutNotice: 0,
+  SensitiveDataProcessingOptOutNotice: 0,
+  SensitiveDataLimitUseNotice: 0,
+  SaleOptOut: 0,
+  SharingOptOut: 0,
+  TargetedAdvertisingOptOut: 0,
+  SensitiveDataProcessing: 12,
+  KnownChildSensitiveDataConsents: 2,
+  PersonalDataConsents: 0,
+  MspaCoveredTransaction: 0,
+  MspaOptOutOptionMode: 0,
+  MspaServiceProviderMode: 0,
+};
+
+/**
+ * Generate a normalization function for converting US state strings to the usnat format.
+ *
+ * Scalar fields are copied over if they exist in the input (state) data, or set to null otherwise.
+ * List fields are also copied, but forced to the "correct" length (by truncating or padding with nulls);
+ * additionally, elements within them can be moved around using the `move` argument.
+ *
+ * @param {Array[String]} nullify? list of fields to force to null
+ * @param {{}} move? Map from list field name to an index remapping for elements within that field (using 1 as the first index).
+ *       For example, {SensitiveDataProcessing: {1: 2, 2: [1, 3]}} means "rearrange SensitiveDataProcessing by moving
+ *       the first element to the second position, and the second element to both the first and third position."
+ * @param {({}, {}) => void} fn? an optional function to run once all the processing described above is complete;
+ *       it's passed two arguments, the original (state) data, and its normalized (usnat) version.
+ * @param fields
+ * @returns {function({}): {}}
+ */
+export function normalizer({nullify = [], move = {}, fn}, fields = FIELDS) {
+  move = Object.fromEntries(Object.entries(move).map(([k, map]) => [k,
+    Object.fromEntries(Object.entries(map)
+      .map(([k, v]) => [k, Array.isArray(v) ? v : [v]])
+      .map(([k, v]) => [--k, v.map(el => --el)])
+    )])
+  );
+  return function (cd) {
+    const norm = Object.fromEntries(Object.entries(fields)
+      .map(([field, len]) => {
+        let val = null;
+        if (len > 0) {
+          val = Array(len).fill(null);
+          if (Array.isArray(cd[field])) {
+            const remap = move[field] || {};
+            const done = [];
+            cd[field].forEach((el, i) => {
+              const [dest, moved] = remap.hasOwnProperty(i) ? [remap[i], true] : [[i], false];
+              dest.forEach(d => {
+                if (d < len && !done.includes(d)) {
+                  val[d] = el;
+                  moved && done.push(d);
+                }
+              });
+            });
+          }
+        } else if (cd[field] != null) {
+          val = Array.isArray(cd[field]) ? null : cd[field];
+        }
+        return [field, val];
+      }));
+    nullify.forEach(path => deepSetValue(norm, path, null));
+    fn && fn(cd, norm);
+    return norm;
+  };
+}
+
+function scalarMinorsAreChildren(original, normalized) {
+  normalized.KnownChildSensitiveDataConsents = original.KnownChildSensitiveDataConsents === 0 ? [0, 0] : [1, 1];
+}
+
+export const NORMALIZATIONS = {
+  // normalization rules - convert state consent into usnat consent
+  // https://docs.prebid.org/features/mspa-usnat.html
+  7: (consent) => consent,
+  8: normalizer({
+    move: {
+      SensitiveDataProcessing: {
+        1: 9,
+        2: 10,
+        3: 8,
+        4: [1, 2],
+        5: 12,
+        8: 3,
+        9: 4,
+      }
+    },
+    fn(original, normalized) {
+      if (original.KnownChildSensitiveDataConsents.some(el => el !== 0)) {
+        normalized.KnownChildSensitiveDataConsents = [1, 1];
+      }
+    }
+  }),
+  9: normalizer({fn: scalarMinorsAreChildren}),
+  10: normalizer({fn: scalarMinorsAreChildren}),
+  11: normalizer({
+    move: {
+      SensitiveDataProcessing: {
+        3: 4,
+        4: 5,
+        5: 3,
+      }
+    },
+    fn: scalarMinorsAreChildren
+  }),
+  12: normalizer({
+    fn(original, normalized) {
+      const cc = original.KnownChildSensitiveDataConsents;
+      let repl;
+      if (!cc.some(el => el !== 0)) {
+        repl = [0, 0];
+      } else if (cc[1] === 2 && cc[2] === 2) {
+        repl = [2, 1];
+      } else {
+        repl = [1, 1];
+      }
+      normalized.KnownChildSensitiveDataConsents = repl;
+    }
+  })
+};
+
+export const DEFAULT_SID_MAPPING = {
+  8: 'usca',
+  9: 'usva',
+  10: 'usco',
+  11: 'usut',
+  12: 'usct'
+};
+
+export const getSections = (() => {
+  const allSIDs = Object.keys(DEFAULT_SID_MAPPING).map(Number);
+  return function ({sections = {}, sids = allSIDs} = {}) {
+    return sids.map(sid => {
+      const logger = prefixLog(`Cannot set up MSPA controls for SID ${sid}:`);
+      const ov = sections[sid] || {};
+      const normalizeAs = ov.normalizeAs || sid;
+      if (!NORMALIZATIONS.hasOwnProperty(normalizeAs)) {
+        logger.logError(`no normalization rules are known for SID ${normalizeAs}`)
+        return;
+      }
+      const api = ov.name || DEFAULT_SID_MAPPING[sid];
+      if (typeof api !== 'string') {
+        logger.logError(`cannot determine GPP section name`)
+        return;
+      }
+      return [
+        api,
+        [sid],
+        NORMALIZATIONS[normalizeAs]
+      ]
+    }).filter(el => el != null);
+  }
+})();
+
+const handles = [];
+
+config.getConfig('consentManagement', (cfg) => {
+  const gppConf = cfg.consentManagement?.gpp;
+  if (gppConf) {
+    while (handles.length) {
+      handles.pop()();
+    }
+    getSections(gppConf?.mspa || {})
+      .forEach(([api, sids, normalize]) => handles.push(setupRules(api, sids, normalize)));
+  }
+});