[ParrableIdSystem] Add GVLID and handle TC Consent data (#6283)

* Added GDPR support * Remove forgotten .only Co-authored-by: Victor <[email protected]>
prebid · Feb 10, 2021 · 4a7b465 · 4a7b465
1 parent fae47aa
commit 4a7b465
Show file tree

Hide file tree

Showing 2 changed files with 50 additions and 4 deletions.
diff --git a/modules/parrableIdSystem.js b/modules/parrableIdSystem.js
@@ -14,12 +14,13 @@ import { getStorageManager } from '../src/storageManager.js';
 
 const PARRABLE_URL = 'https://h.parrable.com/prebid';
 const PARRABLE_COOKIE_NAME = '_parrable_id';
+const PARRABLE_GVLID = 928;
 const LEGACY_ID_COOKIE_NAME = '_parrable_eid';
 const LEGACY_OPTOUT_COOKIE_NAME = '_parrable_optout';
 const ONE_YEAR_MS = 364 * 24 * 60 * 60 * 1000;
 const EXPIRE_COOKIE_DATE = 'Thu, 01 Jan 1970 00:00:00 GMT';
 
-const storage = getStorageManager();
+const storage = getStorageManager(PARRABLE_GVLID);
 
 function getExpirationDate() {
   const oneYearFromNow = new Date(utils.timestamp() + ONE_YEAR_MS);
@@ -167,7 +168,7 @@ function shouldFilterImpression(configParams, parrableId) {
   return !isAllowed() || isBlocked();
 }
 
-function fetchId(configParams) {
+function fetchId(configParams, gdprConsentData) {
   if (!isValidConfig(configParams)) return;
 
   let parrableId = readCookie();
@@ -183,6 +184,8 @@ function fetchId(configParams) {
   const eid = (parrableId) ? parrableId.eid : null;
   const refererInfo = getRefererInfo();
   const uspString = uspDataHandler.getConsentData();
+  const gdprApplies = (gdprConsentData && typeof gdprConsentData.gdprApplies === 'boolean' && gdprConsentData.gdprApplies);
+  const gdprConsentString = (gdprConsentData && gdprApplies && gdprConsentData.consentString) || '';
   const partners = configParams.partners || configParams.partner
   const trackers = typeof partners === 'string'
     ? partners.split(',')
@@ -198,13 +201,18 @@ function fetchId(configParams) {
 
   const searchParams = {
     data: encodeBase64UrlSafe(btoa(JSON.stringify(data))),
+    gdpr: gdprApplies ? 1 : 0,
     _rand: Math.random()
   };
 
   if (uspString) {
     searchParams.us_privacy = uspString;
   }
 
+  if (gdprApplies) {
+    searchParams.gdpr_consent = gdprConsentString;
+  }
+
   const options = {
     method: 'GET',
     withCredentials: true
@@ -251,7 +259,7 @@ function fetchId(configParams) {
     callback,
     id: parrableId
   };
-};
+}
 
 /** @type {Submodule} */
 export const parrableIdSubmodule = {
@@ -260,6 +268,12 @@ export const parrableIdSubmodule = {
    * @type {string}
    */
   name: 'parrableId',
+  /**
+   * Global Vendor List ID
+   * @type {number}
+   */
+  gvlid: PARRABLE_GVLID,
+
   /**
    * decode the stored id value for passing to bid requests
    * @function
@@ -282,7 +296,7 @@ export const parrableIdSubmodule = {
    */
   getId(config, gdprConsentData, currentStoredId) {
     const configParams = (config && config.params) || {};
-    return fetchId(configParams);
+    return fetchId(configParams, gdprConsentData);
   }
 };
 

diff --git a/test/spec/modules/parrableIdSystem_spec.js b/test/spec/modules/parrableIdSystem_spec.js
@@ -210,6 +210,38 @@ describe('Parrable ID System', function() {
         removeParrableCookie();
       });
     });
+
+    describe('GDPR consent', () => {
+      let callbackSpy = sinon.spy();
+
+      const config = {
+        params: {
+          partner: 'partner'
+        }
+      };
+
+      const gdprConsentTestCases = [
+        { consentData: { gdprApplies: true, consentString: 'expectedConsentString' }, expected: { gdpr: 1, gdpr_consent: 'expectedConsentString' } },
+        { consentData: { gdprApplies: false, consentString: 'expectedConsentString' }, expected: { gdpr: 0 } },
+        { consentData: { gdprApplies: true, consentString: undefined }, expected: { gdpr: 1, gdpr_consent: '' } },
+        { consentData: { gdprApplies: 'yes', consentString: 'expectedConsentString' }, expected: { gdpr: 0 } },
+        { consentData: undefined, expected: { gdpr: 0 } }
+      ];
+
+      gdprConsentTestCases.forEach((testCase, index) => {
+        it(`should call user sync url with the gdprConsent - case ${index}`, () => {
+          parrableIdSubmodule.getId(config, testCase.consentData).callback(callbackSpy);
+
+          if (testCase.expected.gdpr === 1) {
+            expect(server.requests[0].url).to.contain('gdpr=' + testCase.expected.gdpr);
+            expect(server.requests[0].url).to.contain('gdpr_consent=' + testCase.expected.gdpr_consent);
+          } else {
+            expect(server.requests[0].url).to.contain('gdpr=' + testCase.expected.gdpr);
+            expect(server.requests[0].url).to.not.contain('gdpr_consent');
+          }
+        })
+      });
+    });
   });
 
   describe('parrableIdSystem.decode()', function() {