ParrableIdSystem: cache request filter status in first-party cookie

modules/parrableIdSystem.js

@@ -5,6 +5,8 @@
  * @requires module:modules/userId
  */
 
+// ci trigger: 1
+
 import * as utils from '../src/utils.js'
 import find from 'core-js-pure/features/array/find.js';
 import { ajax } from '../src/ajax.js';
@@ -34,7 +36,7 @@ function deserializeParrableId(parrableIdStr) {
 
   values.forEach(function(value) {
     const pair = value.split(':');
-    if (+pair[1] === 1 || (pair[1] !== null && +pair[1] === 0)) { // unpack a value of 0 or 1 as boolean
+    if (pair[0] === 'ccpaOptout' || pair[0] === 'ibaOptout') { // unpack a value of 0 or 1 as boolean
       parrableId[pair[0]] = Boolean(+pair[1]);
     } else if (!isNaN(pair[1])) { // convert to number if is a number
       parrableId[pair[0]] = +pair[1]
@@ -64,6 +66,10 @@ function serializeParrableId(parrableIdAndParams) {
     components.push(tpcSupportComponent);
     components.push(tpcUntil);
   }
+  if (parrableIdAndParams.filteredUntil) {
+    components.push(`filteredUntil:${parrableIdAndParams.filteredUntil}`);
+    components.push(`filterHits:${parrableIdAndParams.filterHits}`);
+  }
 
   return components.join(',');
 }
@@ -96,12 +102,20 @@ function readCookie() {
   const parrableIdStr = storage.getCookie(PARRABLE_COOKIE_NAME);
   if (parrableIdStr) {
     const parsedCookie = deserializeParrableId(decodeURIComponent(parrableIdStr));
-    const { tpc, tpcUntil, ...parrableId } = parsedCookie;
+    const { tpc, tpcUntil, filteredUntil, filterHits, ...parrableId } = parsedCookie;
     let { eid, ibaOptout, ccpaOptout, ...params } = parsedCookie;
 
     if ((Date.now() / 1000) >= tpcUntil) {
       params.tpc = undefined;
     }
+
+    if ((Date.now() / 1000) < filteredUntil) {
+      params.shouldFilter = true;
+      params.filteredUntil = filteredUntil;
+    } else {
+      params.shouldFilter = false;
+      params.filterHits = filterHits;
+    }
     return { parrableId, params };
   }
   return null;
@@ -197,6 +211,11 @@ function epochFromTtl(ttl) {
   return Math.floor((Date.now() / 1000) + ttl);
 }
 
+function incrementFilterHits(parrableId, params) {
+  params.filterHits += 1;
+  writeCookie({ ...parrableId, ...params })
+}
+
 function fetchId(configParams, gdprConsentData) {
   if (!isValidConfig(configParams)) return;
 
@@ -212,7 +231,8 @@ function fetchId(configParams, gdprConsentData) {
 
   const eid = parrableId ? parrableId.eid : null;
   const refererInfo = getRefererInfo();
-  const tpcSupport = params ? params.tpc : null
+  const tpcSupport = params ? params.tpc : null;
+  const shouldFilter = params ? params.shouldFilter : null;
   const uspString = uspDataHandler.getConsentData();
   const gdprApplies = (gdprConsentData && typeof gdprConsentData.gdprApplies === 'boolean' && gdprConsentData.gdprApplies);
   const gdprConsentString = (gdprConsentData && gdprApplies && gdprConsentData.consentString) || '';
@@ -230,6 +250,10 @@ function fetchId(configParams, gdprConsentData) {
     tpcSupport
   };
 
+  if (shouldFilter === false) {
+    data.filterHits = params.filterHits;
+  }
+
   const searchParams = {
     data: encodeBase64UrlSafe(btoa(JSON.stringify(data))),
     gdpr: gdprApplies ? 1 : 0,
@@ -271,6 +295,10 @@ function fetchId(configParams, gdprConsentData) {
                 newParams.tpcSupport = responseObj.tpcSupport;
                 newParams.tpcUntil = epochFromTtl(responseObj.tpcSupportTtl);
               }
+              if (responseObj.filterTtl) {
+                newParams.filteredUntil = epochFromTtl(responseObj.filterTtl);
+                newParams.filterHits = 0;
+              }
             }
           } catch (error) {
             utils.logError(error);
@@ -288,7 +316,12 @@ function fetchId(configParams, gdprConsentData) {
         cb();
       }
     };
-    ajax(PARRABLE_URL, callbacks, searchParams, options);
+
+    if (shouldFilter) {
+      incrementFilterHits(parrableId, params);
+    } else {
+      ajax(PARRABLE_URL, callbacks, searchParams, options);
+    }
   };
 
   return {

test/spec/modules/parrableIdSystem_spec.js

@@ -64,6 +64,10 @@ function serializeParrableId(parrableId) {
     str += `,${tpcSupportComponent}`;
     str += `,tpcUntil:${parrableId.tpcUntil}`;
   }
+  if (parrableId.filteredUntil) {
+    str += `,filteredUntil:${parrableId.filteredUntil}`;
+    str += `,filterHits:${parrableId.filterHits}`;
+  }
   return str;
 }
 
@@ -249,7 +253,7 @@ describe('Parrable ID System', function() {
       });
     });
 
-    describe('third party cookie support status', function () {
+    describe('third party cookie support', function () {
       let logErrorStub;
       let callbackSpy = sinon.spy();
 
@@ -327,13 +331,30 @@ describe('Parrable ID System', function() {
           );
         });
       });
+    });
+
+    describe('request-filter status', function () {
+      let logErrorStub;
+      let callbackSpy = sinon.spy();
+
+      beforeEach(function() {
+        logErrorStub = sinon.stub(utils, 'logError');
+      });
+
+      afterEach(function () {
+        callbackSpy.resetHistory();
+        removeParrableCookie();
+      });
 
-      describe('when getting tpcSupport from cookie', function () {
+      afterEach(function() {
+        logErrorStub.restore();
+      });
+
+      describe('when getting filterTtl from XHR response', function () {
         let request;
         let dateNowStub;
         const dateNowMock = Date.now();
-        const tpcSupportTtl = dateNowMock;
-        const tpcUntilExpired = 1;
+        const filterTtl = 1000;
 
         before(() => {
           dateNowStub = sinon.stub(Date, 'now').returns(dateNowMock);
@@ -343,45 +364,57 @@ describe('Parrable ID System', function() {
           dateNowStub.restore();
         });
 
-        it('should send tpcSupport in the XHR', function () {
-          writeParrableCookie({
-            eid: P_COOKIE_EID,
-            tpc: true,
-            tpcUntil: (dateNowMock / 1000) + 1
-          });
+        it('should set filteredUntil in the cookie', function () {
           let { callback } = parrableIdSubmodule.getId(P_CONFIG_MOCK);
           callback(callbackSpy);
           request = server.requests[0];
 
-          let queryParams = utils.parseQS(request.url.split('?')[1]);
-          let data = JSON.parse(atob(decodeBase64UrlSafe(queryParams.data)));
+          request.respond(
+            200,
+            RESPONSE_HEADERS,
+            JSON.stringify({ eid: P_XHR_EID, filterTtl })
+          );
 
-          expect(data.tpcSupport).to.equal(true);
+          expect(storage.getCookie(P_COOKIE_NAME)).to.equal(
+            encodeURIComponent(
+              'eid:' + P_XHR_EID +
+              ',filteredUntil:' + Math.floor((dateNowMock / 1000) + filterTtl) +
+              ',filterHits:0')
+          );
         });
 
-        it('should unset tpcSupport from cookie when tpcUntil reached', function () {
+        it('should increment filterHits in the cookie', function () {
           writeParrableCookie({
-            eid: P_COOKIE_EID,
-            tpcSupport: true,
-            tpcUntil: tpcUntilExpired
+            eid: P_XHR_EID,
+            filteredUntil: Math.floor((dateNowMock / 1000) + filterTtl),
+            filterHits: 0
           });
           let { callback } = parrableIdSubmodule.getId(P_CONFIG_MOCK);
           callback(callbackSpy);
-          request = server.requests[0];
 
-          request.respond(
-            200,
-            RESPONSE_HEADERS,
-            JSON.stringify({ eid: P_XHR_EID, tpcSupport: false, tpcSupportTtl })
+          expect(storage.getCookie(P_COOKIE_NAME)).to.equal(
+            encodeURIComponent(
+              'eid:' + P_XHR_EID +
+              ',filteredUntil:' + Math.floor((dateNowMock / 1000) + filterTtl) +
+              ',filterHits:1')
           );
+        });
+
+        it('should send filterHits in the XHR', function () {
+          const filterHits = 1;
+          writeParrableCookie({
+            eid: P_XHR_EID,
+            filteredUntil: Math.floor(dateNowMock / 1000),
+            filterHits
+          });
+          let { callback } = parrableIdSubmodule.getId(P_CONFIG_MOCK);
+          callback(callbackSpy);
+          request = server.requests[0];
 
           let queryParams = utils.parseQS(request.url.split('?')[1]);
           let data = JSON.parse(atob(decodeBase64UrlSafe(queryParams.data)));
 
-          expect(data.tpcSupport).to.equal(undefined);
-          expect(storage.getCookie(P_COOKIE_NAME)).to.equal(
-            encodeURIComponent('eid:' + P_XHR_EID + ',tpc:0,tpcUntil:' + Math.floor((dateNowMock / 1000) + tpcSupportTtl))
-          );
+          expect(data.filterHits).to.equal(filterHits);
         });
       });
     });