feat: Implement Google EU Consent

package.json

@@ -12,7 +12,9 @@
     "scripts": {
         "build": "rollup --config rollup.config.js",
         "watch": "rollup --config rollup.config.js -w",
-        "test": "node test/boilerplate/test-karma.js"
+        "test": "node test/boilerplate/test-karma.js",
+        "watch:tests": "ENVIRONMENT=production rollup --config rollup.test.config.js -w",
+        "test:debug": "npm run build && npm run build:test && DEBUG=true karma start test/karma.config.js"
     },
     "devDependencies": {
         "@rollup/plugin-commonjs": "22.0.1",

rollup.test.config.js

@@ -0,0 +1,21 @@
+import resolve from '@rollup/plugin-node-resolve';
+import commonjs from '@rollup/plugin-commonjs';
+
+export default [
+    {
+        input: 'test/tests.js',
+        output: {
+            file: 'test/test-bundle.js',
+            format: 'iife',
+            exports: 'named',
+            name: 'mpBrazeKit',
+            strict: false,
+        },
+        plugins: [
+            resolve({
+                browser: true,
+            }),
+            commonjs(),
+        ],
+    },
+];

src/BrazeKit-dev.js

@@ -43,6 +43,8 @@ var constructor = function () {
         forwarderSettings,
         options = {},
         reportingService,
+        hasConsentMappings,
+        parsedConsentMappings,
         mpCustomFlags;
 
     self.name = name;
@@ -72,6 +74,13 @@ var constructor = function () {
     var bundleCommerceEventData = false;
     var forwardSkuAsProductName = false;
 
+    var brazeConsentKeys = [
+        '$google_ad_user_data',
+        '$google_ad_personalization'
+    ];
+
+    var latestUserBrazeConsentString;
+
     // A purchase event can either log a single event with all products
     // or multiple purchase events (one per product)
     function logPurchaseEvent(event) {
@@ -364,6 +373,7 @@ var constructor = function () {
     /**************************/
     function processEvent(event) {
         var reportEvent = false;
+        maybeSetConsentBeforeEventLogged(event);
 
         if (event.EventDataType == MessageType.Commerce) {
             reportEvent = logCommerceEvent(event);
@@ -709,6 +719,108 @@ var constructor = function () {
         }
     }
 
+    function prepareInitialConsent(user) {
+        var userConsentState = getUserConsentState(user);
+
+        var currentConsentPayload = generateBrazeConsentStatePayload(
+            userConsentState
+        );
+
+        latestUserBrazeConsentString = JSON.stringify(currentConsentPayload);
+
+        if (latestUserBrazeConsentString.length) {
+            setConsentOnBraze(currentConsentPayload);
+        }
+    }
+
+    function setConsentOnBraze(currentConsentPayload) {
+        for (var key in currentConsentPayload) {
+            braze
+                .getUser()
+                .setCustomUserAttribute(key, currentConsentPayload[key]);
+        }
+    }
+
+    function maybeSetConsentBeforeEventLogged(event) {
+        if (latestUserBrazeConsentString && parsedConsentMappings.length) {
+            var eventConsentState = getEventConsentState(event.ConsentState);
+
+            if (!isEmpty(eventConsentState)) {
+                var eventBrazeConsent = generateBrazeConsentStatePayload(
+                    eventConsentState
+                );
+                var eventBrazeConsentAsString = JSON.stringify(
+                    eventBrazeConsent
+                );
+
+                if (
+                    eventBrazeConsentAsString !== latestUserBrazeConsentString
+                ) {
+                    setConsentOnBraze(eventBrazeConsent);
+                    latestUserBrazeConsentString = eventBrazeConsentAsString;
+                }
+            }
+        }
+    }
+
+    function getEventConsentState(eventConsentState) {
+        return eventConsentState && eventConsentState.getGDPRConsentState
+            ? eventConsentState.getGDPRConsentState()
+            : {};
+    }
+
+    function generateBrazeConsentStatePayload(consentState) {
+        if (!parsedConsentMappings) return {};
+
+        var payload = {};
+
+        // These are Braze's consent constants for Braze's Audience Sync to Google
+        // https://www.braze.com/docs/partners/canvas_steps/google_audience_sync
+
+        var googleToBrazeConsentMap = {
+            google_ad_user_data: '$google_ad_user_data',
+            google_ad_personalization: '$google_ad_personalization',
+        };
+
+        for (var i = 0; i <= parsedConsentMappings.length - 1; i++) {
+            var mappingEntry = parsedConsentMappings[i];
+            // Although consent purposes can be inputted into the UI in any casing
+            // the SDK will automatically lowercase them to prevent pseudo-duplicate
+            // consent purposes, so we call `toLowerCase` on the consentMapping purposes here
+            var mpMappedConsentName = mappingEntry.map.toLowerCase();
+            // that mappingEntry.value returned from the server does not have a $ appended, so we have to add it
+            var brazeMappedConsentName =
+                googleToBrazeConsentMap[mappingEntry.value];
+
+            if (
+                consentState[mpMappedConsentName] &&
+                brazeMappedConsentName &&
+                brazeConsentKeys.indexOf(brazeMappedConsentName) !== -1
+            ) {
+                payload[brazeMappedConsentName] =
+                    consentState[mpMappedConsentName].Consented;
+            }
+        }
+
+        return payload;
+    }
+
+    function getUserConsentState(user) {
+        var userConsentState = {};
+
+        var consentState = user.getConsentState();
+
+        if (consentState && consentState.getGDPRConsentState) {
+            userConsentState = consentState.getGDPRConsentState();
+        }
+
+        return userConsentState;
+    }
+
+    function parseConsentSettingsString(consentMappingString) {
+        return JSON.parse(consentMappingString.replace(/&quot;/g, '"'));
+    }
+
     function initForwarder(
         settings,
         service,
@@ -755,6 +867,15 @@ var constructor = function () {
                     forwarderSettings.serviceWorkerLocation;
             }
 
+            if (forwarderSettings.consentMappingSDK) {
+                parsedConsentMappings = parseConsentSettingsString(
+                    forwarderSettings.consentMappingSDK
+                );
+                if (parsedConsentMappings.length) {
+                    hasConsentMappings = true;
+                }
+            }
+
             var cluster =
                 forwarderSettings.cluster ||
                 forwarderSettings.dataCenterLocation;
@@ -804,6 +925,9 @@ var constructor = function () {
 
         if (currentUser && mpid) {
             onUserIdentified(currentUser);
+            if (hasConsentMappings) {
+                prepareInitialConsent(currentUser);
+            }
         }
 
         openSession(forwarderSettings);
@@ -992,6 +1116,10 @@ function isObject(val) {
     );
 }
 
+function isEmpty(value) {
+    return value == null || !(Object.keys(value) || value).length;
+}
+
 module.exports = {
     register: register,
     getVersion: function () {