prebid.js 9.2.0 → 9.3.0

package/test/spec/modules/intentIqIdSystem_spec.js

@@ -2,31 +2,61 @@ import { expect } from 'chai';
 import { intentIqIdSubmodule, storage } from 'modules/intentIqIdSystem.js';
 import * as utils from 'src/utils.js';
 import { server } from 'test/mocks/xhr.js';
-import {clearAllCookies} from '../../helpers/cookies.js';
+import { CLIENT_HINTS_KEY, FIRST_PARTY_KEY, decryptData, detectBrowserFromUserAgent, detectBrowserFromUserAgentData, handleClientHints, handleGPPData, readData } from '../../../modules/intentIqIdSystem';
+import { gppDataHandler, uspDataHandler } from '../../../src/consentHandler';
+import { clearAllCookies } from '../../helpers/cookies';
 
 const partner = 10;
 const pai = '11';
 const pcid = '12';
-const enableCookieStorage = true;
 const defaultConfigParams = { params: { partner: partner } };
 const paiConfigParams = { params: { partner: partner, pai: pai } };
 const pcidConfigParams = { params: { partner: partner, pcid: pcid } };
-const enableCookieConfigParams = { params: { partner: partner, enableCookieStorage: enableCookieStorage } };
-const allConfigParams = { params: { partner: partner, pai: pai, pcid: pcid, enableCookieStorage: enableCookieStorage } };
+const allConfigParams = { params: { partner: partner, pai: pai, pcid: pcid } };
 const responseHeader = { 'Content-Type': 'application/json' }
 
+export const testClientHints = {
+  architecture: 'x86',
+  bitness: '64',
+  brands: [
+    {
+      brand: 'Not(A:Brand',
+      version: '24'
+    },
+    {
+      brand: 'Chromium',
+      version: '122'
+    }
+  ],
+  fullVersionList: [
+    {
+      brand: 'Not(A:Brand',
+      version: '24.0.0.0'
+    },
+    {
+      brand: 'Chromium',
+      version: '122.0.6261.128'
+    }
+  ],
+  mobile: false,
+  model: '',
+  platform: 'Linux',
+  platformVersion: '6.5.0',
+  wow64: false
+};
+
 describe('IntentIQ tests', function () {
   let logErrorStub;
   let testLSValue = {
-    'date': 1651945280759,
+    'date': Date.now(),
     'cttl': 2000,
     'rrtt': 123
   }
   let testLSValueWithData = {
-    'date': 1651945280759,
+    'date': Date.now(),
     'cttl': 9999999999999,
     'rrtt': 123,
-    'data': 'previousTestData'
+    'data': 'U2FsdGVkX18AKRyhEPdiL9kuxSigBrlqLaDJWvwSird2O5TdBW67gX+xbL4nYxHDjdS5G5FpdhtpouZiBFw2FBjyUyobZheM857G5q4BapdiA8z3K6j0W+r0im30Ak2SSn2NBfFwxcCgP/UAF5/ddxIIaeWl1yBMZBO+Gic6us2JUg86paAtp3Sk4unCvg1G+4myYYSKgGi/Vrw51ye/jAGn4AdAbFOCojENhV+Ts/XyVK0AQGdC3wqnQUId9MZpB2VoTA9wgXeYEzjpDDJmcKQ18V3WTKnK/H1FBVZa1vovOj13ZUeuMUZbZL83NFE/PkCrzJjRy14orcdnGbDUaxXUBBulDCr21gNnc0mLbYj7b18OQQ75/GhX80HroxbMEyc5tiECBrE/JsW+2sQ4MwoqePPPj/f5Bf4wJ4z3UphjK6maypoWaXsZCZTp2mJYmsf0XsNHLpt1MUrBeAmy6Bewkb+WEAeVe6/b53DQDlo2LQXpSzDPVucMn3CQOWFv1Bvz5cLIZRD8/NtDjgYzWNXHRRAGhhN19yew0ZyeS09x3UBiwER6A6ppv2qQVGs8QNsif3z7pkhkNoETcXQKyv1xa5X87tLvXkO4FYDQQvXEGInyPuNmkFtsZS5FJl+TYrdyaEiCOwRgkshwCU4s93WrfRUtPHtd4zNiA1LWAKGKeBEK6woeFn1YU1YIqsvx9wXfkCbqNkHTi2mD1Eb85a2niSK9BzDdbxwv6EzZ+f9j6esEVdBUIiYmsUuOfTp/ftOHKjBKi1lbeC5imAzZfV/AKvqS5opAVGp7Y9pq976sYblCrPBQ0PYI+Cm2ZNhG1vKc2Pa0rjwJwvusZp2Wvw9zSbnoZUeBi1O+XGYqGhkqYVvH3rXvrFiSmA7pk5Buz6vPd6YV1d55PVahv/4u3jksEI/ZN8QNshrM0foJ4tE/q4x8EKx22txb6433QQybwFfExdmA/XaPqM0rwqTm4qyK0mbX984A8niQka5T5pPkEfL4ALqlIgJ2Fo7X/s6FRU/sZq72JWKcVET4edebD0w5mjeotsjUz5EGT0jRSWRba0yxe4myNaAyY7Y0NTNY9J9Q0JLDFh9Hb05Ejt0Jeoq4Olv8/zFWObBoQtkQyeeRB8L7XIari/xgl191J6euhe5+8vu3ta3tX+XGk+gqdfip1R11tEYpW/XPsV+6DBEfS/8icDHiwK7sPpAgTx7GuJGL1U3Hbg7P/2zUU6xMSR5In/Oa5i1B9FtayGd+utiqrGJsqg8IyFlAt1B9B11k/wJFnWWevMly+y+Ko75ShF7UzfcNR2s41doov+2DEz/YiKH1qHjVOXjslBTYjceB3xqa8sSPDt/vQDDUIX5CPLyVBZj7AeeB/IKDFjZVovBDH92Xl8JTNILRuDHsWmSwNI1DUzgus6ox4u9Mi439caK6KnpNYso+ksLXNEQCm0m15WV2NC+fjkEwLV6hGNbz'
   }
   let testResponseWithValues = {
     'abPercentage': 90,
@@ -40,6 +70,10 @@ describe('IntentIQ tests', function () {
   }
 
   beforeEach(function () {
+    localStorage.clear();
+    const expiredDate = new Date(0).toUTCString();
+    storage.setCookie(FIRST_PARTY_KEY, '', expiredDate, 'Lax');
+    storage.setCookie(FIRST_PARTY_KEY + '_' + partner, '', expiredDate, 'Lax');
     logErrorStub = sinon.stub(utils, 'logError');
   });
 
@@ -67,7 +101,7 @@ describe('IntentIQ tests', function () {
     expect(submodule).to.be.undefined;
   });
 
-  it('should not save data in cookie if enableCookieStorage configParam not set', function () {
+  it('should not save data in cookie if relevant type not set', function () {
     let callBackSpy = sinon.spy();
     let submoduleCallback = intentIqIdSubmodule.getId(defaultConfigParams).callback;
     submoduleCallback(callBackSpy);
@@ -82,9 +116,9 @@ describe('IntentIQ tests', function () {
     expect(storage.getCookie('_iiq_fdata_' + partner)).to.equal(null);
   });
 
-  it('should save data in cookie if enableCookieStorage configParam set to true', function () {
+  it('should save data in cookie if storage type is "cookie"', function () {
     let callBackSpy = sinon.spy();
-    let submoduleCallback = intentIqIdSubmodule.getId(allConfigParams).callback;
+    let submoduleCallback = intentIqIdSubmodule.getId({ ...allConfigParams, enabledStorageTypes: ['cookie'] }).callback;
     submoduleCallback(callBackSpy);
     let request = server.requests[0];
     expect(request.url).to.contain('https://api.intentiq.com/profiles_engine/ProfilesEngineServlet?at=39&mi=10&dpi=10&pt=17&dpn=1&pcid=12&pai=11&iiqidtype=2&iiqpcid=');
@@ -94,9 +128,10 @@ describe('IntentIQ tests', function () {
       JSON.stringify({ pid: 'test_pid', data: 'test_personid', ls: true })
     );
     expect(callBackSpy.calledOnce).to.be.true;
-    const cookieValue = storage.getCookie('_iiq_fdata_' + partner)
-    expect(cookieValue).to.not.equal(null)
-    expect(JSON.parse(cookieValue).data).to.be.equal('test_personid');
+    const cookieValue = storage.getCookie('_iiq_fdata_' + partner);
+    expect(cookieValue).to.not.equal(null);
+    const decryptedData = JSON.parse(decryptData(JSON.parse(cookieValue).data));
+    expect(decryptedData).to.deep.equal(['test_personid']);
   });
 
   it('should call the IntentIQ endpoint with only partner', function () {
@@ -114,8 +149,6 @@ describe('IntentIQ tests', function () {
   });
 
   it('should ignore INVALID_ID and invalid responses in decode', function () {
-    // let resp = JSON.stringify({'RESULT': 'NA'});
-    // expect(intentIqIdSubmodule.decode(resp)).to.equal(undefined);
     expect(intentIqIdSubmodule.decode('INVALID_ID')).to.equal(undefined);
     expect(intentIqIdSubmodule.decode('')).to.equal(undefined);
     expect(intentIqIdSubmodule.decode(undefined)).to.equal(undefined);
@@ -202,7 +235,7 @@ describe('IntentIQ tests', function () {
       JSON.stringify({ pid: 'test_pid', data: 'test_personid', ls: true })
     );
     expect(callBackSpy.calledOnce).to.be.true;
-    expect(callBackSpy.args[0][0]).to.be.eq('test_personid');
+    expect(callBackSpy.args[0][0]).to.deep.equal(['test_personid']);
   });
 
   it('dont save result if ls=false', function () {
@@ -220,21 +253,6 @@ describe('IntentIQ tests', function () {
     expect(callBackSpy.args[0][0]).to.be.undefined;
   });
 
-  it('save result as INVALID_ID on empty data and ls=true ', function () {
-    let callBackSpy = sinon.spy();
-    let submoduleCallback = intentIqIdSubmodule.getId(allConfigParams).callback;
-    submoduleCallback(callBackSpy);
-    let request = server.requests[0];
-    expect(request.url).to.contain('https://api.intentiq.com/profiles_engine/ProfilesEngineServlet?at=39&mi=10&dpi=10&pt=17&dpn=1&pcid=12&pai=11&iiqidtype=2&iiqpcid=');
-    request.respond(
-      200,
-      responseHeader,
-      JSON.stringify({ pid: 'test_pid', data: '', ls: true })
-    );
-    expect(callBackSpy.calledOnce).to.be.true;
-    expect(callBackSpy.args[0][0]).to.be.eq('INVALID_ID');
-  });
-
   it('send addition parameters if were found in localstorage', function () {
     localStorage.setItem('_iiq_fdata_' + partner, JSON.stringify(testLSValue))
     let callBackSpy = sinon.spy();
@@ -251,16 +269,226 @@ describe('IntentIQ tests', function () {
       JSON.stringify(testResponseWithValues)
     );
     expect(callBackSpy.calledOnce).to.be.true;
-    expect(callBackSpy.args[0][0]).to.be.eq(testResponseWithValues.data);
+    expect(callBackSpy.args[0][0]).to.deep.equal([testResponseWithValues.data]);
   });
 
   it('return data stored in local storage ', function () {
-    localStorage.setItem('_iiq_fdata_' + partner, JSON.stringify(testLSValueWithData))
+    localStorage.setItem('_iiq_fdata_' + partner, JSON.stringify(testLSValueWithData));
+    let returnedValue = intentIqIdSubmodule.getId(allConfigParams);
+    expect(JSON.stringify(returnedValue.id)).to.equal(decryptData(testLSValueWithData.data));
+  });
+
+  it('should handle browser blacklisting', function () {
+    let configParamsWithBlacklist = {
+      params: { partner: partner, browserBlackList: 'chrome' }
+    };
+    sinon.stub(navigator, 'userAgent').value('Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/91.0.4472.124 Safari/537.36');
+    let submoduleCallback = intentIqIdSubmodule.getId(configParamsWithBlacklist);
+    expect(logErrorStub.calledOnce).to.be.true;
+    expect(submoduleCallback).to.be.undefined;
+  });
+
+  it('should handle invalid JSON in readData', function () {
+    localStorage.setItem('_iiq_fdata_' + partner, 'invalid_json');
     let callBackSpy = sinon.spy();
-    let submoduleCallback = intentIqIdSubmodule.getId(allConfigParams).callback;
+    let submoduleCallback = intentIqIdSubmodule.getId(defaultConfigParams).callback;
     submoduleCallback(callBackSpy);
-    expect(server.requests.length).to.be.equal(0);
+    let request = server.requests[0];
+    expect(request.url).to.contain('https://api.intentiq.com/profiles_engine/ProfilesEngineServlet?at=39&mi=10&dpi=10&pt=17&dpn=1&iiqidtype=2&iiqpcid=');
+    request.respond(
+      200,
+      responseHeader,
+      JSON.stringify({})
+    );
     expect(callBackSpy.calledOnce).to.be.true;
-    expect(callBackSpy.args[0][0]).to.be.equal(testLSValueWithData.data);
+    expect(logErrorStub.called).to.be.true;
+  });
+
+  describe('handleGPPData', function () {
+    it('should convert array of objects to a single JSON string', function () {
+      const input = [
+        { key1: 'value1' },
+        { key2: 'value2' }
+      ];
+      const expectedOutput = JSON.stringify({ key1: 'value1', key2: 'value2' });
+      const result = handleGPPData(input);
+      expect(result).to.equal(expectedOutput);
+    });
+
+    it('should convert a single object to a JSON string', function () {
+      const input = { key1: 'value1', key2: 'value2' };
+      const expectedOutput = JSON.stringify(input);
+      const result = handleGPPData(input);
+      expect(result).to.equal(expectedOutput);
+    });
+
+    it('should handle empty object', function () {
+      const input = {};
+      const expectedOutput = JSON.stringify(input);
+      const result = handleGPPData(input);
+      expect(result).to.equal(expectedOutput);
+    });
+
+    it('should handle empty array', function () {
+      const input = [];
+      const expectedOutput = JSON.stringify({});
+      const result = handleGPPData(input);
+      expect(result).to.equal(expectedOutput);
+    });
+  });
+
+  describe('detectBrowserFromUserAgent', function () {
+    it('should detect Chrome browser', function () {
+      const userAgent = 'Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/91.0.4472.124 Safari/537.36';
+      const result = detectBrowserFromUserAgent(userAgent);
+      expect(result).to.equal('chrome');
+    });
+
+    it('should detect Safari browser', function () {
+      const userAgent = 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/14.0.3 Safari/605.1.15';
+      const result = detectBrowserFromUserAgent(userAgent);
+      expect(result).to.equal('safari');
+    });
+
+    it('should detect Firefox browser', function () {
+      const userAgent = 'Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:89.0) Gecko/20100101 Firefox/89.0';
+      const result = detectBrowserFromUserAgent(userAgent);
+      expect(result).to.equal('firefox');
+    });
+  });
+
+  describe('detectBrowserFromUserAgentData', function () {
+    it('should detect Microsoft Edge browser', function () {
+      const userAgentData = {
+        brands: [
+          { brand: 'Microsoft Edge', version: '91' },
+          { brand: 'Chromium', version: '91' }
+        ]
+      };
+      const result = detectBrowserFromUserAgentData(userAgentData);
+      expect(result).to.equal('edge');
+    });
+
+    it('should detect Chrome browser', function () {
+      const userAgentData = {
+        brands: [
+          { brand: 'Google Chrome', version: '91' },
+          { brand: 'Chromium', version: '91' }
+        ]
+      };
+      const result = detectBrowserFromUserAgentData(userAgentData);
+      expect(result).to.equal('chrome');
+    });
+
+    it('should return unknown for unrecognized user agent data', function () {
+      const userAgentData = {
+        brands: [
+          { brand: 'Unknown Browser', version: '1.0' }
+        ]
+      };
+      const result = detectBrowserFromUserAgentData(userAgentData);
+      expect(result).to.equal('unknown');
+    });
+  });
+
+  describe('IntentIQ consent management within getId', function () {
+    let uspDataHandlerStub;
+    let gppDataHandlerStub;
+
+    beforeEach(function () {
+      localStorage.clear();
+      const expiredDate = new Date(0).toUTCString();
+      storage.setCookie(FIRST_PARTY_KEY, '', expiredDate, 'Lax');
+      storage.setCookie(FIRST_PARTY_KEY + '_' + partner, '', expiredDate, 'Lax');
+      uspDataHandlerStub = sinon.stub(uspDataHandler, 'getConsentData');
+      gppDataHandlerStub = sinon.stub(gppDataHandler, 'getConsentData');
+    });
+
+    afterEach(function () {
+      uspDataHandlerStub.restore();
+      gppDataHandlerStub.restore();
+    });
+
+    it('should set cmpData.us_privacy if uspData exists', function () {
+      const uspData = '1NYN';
+      uspDataHandlerStub.returns(uspData);
+      let callBackSpy = sinon.spy();
+      let submoduleCallback = intentIqIdSubmodule.getId(defaultConfigParams).callback;
+      submoduleCallback(callBackSpy);
+      let request = server.requests[0];
+      expect(request.url).to.contain('https://api.intentiq.com/profiles_engine/ProfilesEngineServlet?at=39&mi=10&dpi=10&pt=17&dpn=1&iiqidtype=2&iiqpcid=');
+      request.respond(
+        200,
+        responseHeader,
+        JSON.stringify({ pid: 'test_pid', data: 'test_personid', ls: false, isOptedOut: false })
+      );
+      expect(callBackSpy.calledOnce).to.be.true;
+
+      // Check the local storage directly to see if cmpData.us_privacy was set correctly
+      const firstPartyData = JSON.parse(localStorage.getItem(FIRST_PARTY_KEY));
+      expect(firstPartyData.uspapi_value).to.equal(uspData);
+    });
+
+    it('should set cmpData.gpp and cmpData.gpp_sid if gppData exists and has parsedSections with usnat', function () {
+      const gppData = {
+        parsedSections: {
+          usnat: { key1: 'value1', key2: 'value2' }
+        },
+        applicableSections: ['usnat']
+      };
+      gppDataHandlerStub.returns(gppData);
+
+      let callBackSpy = sinon.spy();
+      let submoduleCallback = intentIqIdSubmodule.getId(defaultConfigParams).callback;
+      submoduleCallback(callBackSpy);
+      let request = server.requests[0];
+      expect(request.url).to.contain('https://api.intentiq.com/profiles_engine/ProfilesEngineServlet?at=39&mi=10&dpi=10&pt=17&dpn=1&iiqidtype=2&iiqpcid=');
+      request.respond(
+        200,
+        responseHeader,
+        JSON.stringify({ pid: 'test_pid', data: 'test_personid', ls: false, isOptedOut: false })
+      );
+      expect(callBackSpy.calledOnce).to.be.true;
+
+      const firstPartyData = JSON.parse(localStorage.getItem(FIRST_PARTY_KEY));
+      expect(firstPartyData.gpp_value).to.equal(JSON.stringify({ key1: 'value1', key2: 'value2' }));
+    });
+
+    it('should handle gppData without usnat in parsedSections', function () {
+      const gppData = {
+        parsedSections: {
+          euconsent: { key1: 'value1' }
+        },
+        applicableSections: ['euconsent']
+      };
+      gppDataHandlerStub.returns(gppData);
+
+      let callBackSpy = sinon.spy();
+      let submoduleCallback = intentIqIdSubmodule.getId(defaultConfigParams).callback;
+      submoduleCallback(callBackSpy);
+      let request = server.requests[0];
+      expect(request.url).to.contain('https://api.intentiq.com/profiles_engine/ProfilesEngineServlet?at=39&mi=10&dpi=10&pt=17&dpn=1&iiqidtype=2&iiqpcid=');
+      request.respond(
+        200,
+        responseHeader,
+        JSON.stringify({ pid: 'test_pid', data: 'test_personid', ls: false, isOptedOut: true })
+      );
+      expect(callBackSpy.calledOnce).to.be.true;
+
+      const firstPartyData = JSON.parse(localStorage.getItem(FIRST_PARTY_KEY));
+      expect(firstPartyData.gpp_value).to.equal('');
+    });
+  });
+
+  it('should get and save client hints to storge', async () => {
+    // Client hints are async function, thats why async/await is using
+    localStorage.clear();
+    Object.defineProperty(navigator, 'userAgentData', {
+      value: { getHighEntropyValues: async () => testClientHints },
+      configurable: true
+    });
+    await intentIqIdSubmodule.getId(defaultConfigParams);
+    const savedClientHints = readData(CLIENT_HINTS_KEY, ['html5']);
+    expect(savedClientHints).to.equal(handleClientHints(testClientHints));
   });
 });