prebid.js 9.4.0 → 9.5.0

package/test/spec/modules/intentIqAnalyticsAdapter_spec.js

@@ -0,0 +1,172 @@
+import { expect } from 'chai';
+import iiqAnalyticsAnalyticsAdapter from 'modules/intentIqAnalyticsAdapter.js';
+import * as utils from 'src/utils.js';
+import { server } from 'test/mocks/xhr.js';
+import { config } from 'src/config.js';
+import { EVENTS } from 'src/constants.js';
+import * as events from 'src/events.js';
+import { getStorageManager } from 'src/storageManager.js';
+import sinon from 'sinon';
+import { FIRST_PARTY_KEY } from '../../../modules/intentIqIdSystem';
+import { REPORTER_ID, getReferrer, preparePayload } from '../../../modules/intentIqAnalyticsAdapter';
+
+const partner = 10;
+const defaultData = '{"pcid":"f961ffb1-a0e1-4696-a9d2-a21d815bd344", "group": "A"}';
+
+const storage = getStorageManager({ moduleType: 'analytics', moduleName: 'iiqAnalytics' });
+
+const USERID_CONFIG = [
+  {
+    'name': 'intentIqId',
+    'params': {
+      'partner': partner,
+      'unpack': null,
+    },
+    'storage': {
+      'type': 'html5',
+      'name': 'intentIqId',
+      'expires': 60,
+      'refreshInSeconds': 14400
+    }
+  }
+];
+
+let wonRequest = {
+  'bidderCode': 'pubmatic',
+  'width': 728,
+  'height': 90,
+  'statusMessage': 'Bid available',
+  'adId': '23caeb34c55da51',
+  'requestId': '87615b45ca4973',
+  'transactionId': '5e69fd76-8c86-496a-85ce-41ae55787a50',
+  'auctionId': '0cbd3a43-ff45-47b8-b002-16d3946b23bf',
+  'mediaType': 'banner',
+  'source': 'client',
+  'cpm': 5,
+  'currency': 'USD',
+  'ttl': 300,
+  'referrer': '',
+  'adapterCode': 'pubmatic',
+  'originalCpm': 5,
+  'originalCurrency': 'USD',
+  'responseTimestamp': 1669644710345,
+  'requestTimestamp': 1669644710109,
+  'bidder': 'testbidder',
+  'adUnitCode': 'addUnitCode',
+  'timeToRespond': 236,
+  'pbLg': '5.00',
+  'pbMg': '5.00',
+  'pbHg': '5.00',
+  'pbAg': '5.00',
+  'pbDg': '5.00',
+  'pbCg': '',
+  'size': '728x90',
+  'status': 'rendered'
+};
+
+describe('IntentIQ tests all', function () {
+  let logErrorStub;
+
+  beforeEach(function () {
+    logErrorStub = sinon.stub(utils, 'logError');
+    sinon.stub(config, 'getConfig').withArgs('userSync.userIds').returns(USERID_CONFIG);
+    sinon.stub(events, 'getEvents').returns([]);
+    iiqAnalyticsAnalyticsAdapter.enableAnalytics({
+      provider: 'iiqAnalytics',
+    });
+    iiqAnalyticsAnalyticsAdapter.initOptions = {
+      lsValueInitialized: false,
+      partner: null,
+      fpid: null,
+      userGroup: null,
+      currentGroup: null,
+      dataInLs: null,
+      eidl: null,
+      lsIdsInitialized: false,
+      manualReport: false
+    };
+    if (iiqAnalyticsAnalyticsAdapter.track.restore) {
+      iiqAnalyticsAnalyticsAdapter.track.restore();
+    }
+    sinon.spy(iiqAnalyticsAnalyticsAdapter, 'track');
+  });
+
+  afterEach(function () {
+    logErrorStub.restore();
+    config.getConfig.restore();
+    events.getEvents.restore();
+    iiqAnalyticsAnalyticsAdapter.disableAnalytics();
+    if (iiqAnalyticsAnalyticsAdapter.track.restore) {
+      iiqAnalyticsAnalyticsAdapter.track.restore();
+    }
+    localStorage.clear();
+    server.reset();
+  });
+
+  it('IIQ Analytical Adapter bid win report', function () {
+    localStorage.setItem(FIRST_PARTY_KEY, defaultData);
+
+    events.emit(EVENTS.BID_WON, wonRequest);
+
+    expect(server.requests.length).to.be.above(0);
+    const request = server.requests[0];
+    expect(request.url).to.contain('https://reports.intentiq.com/report?pid=' + partner + '&mct=1');
+    expect(request.url).to.contain('&jsver=0.1&vrref=http://localhost:9876/');
+    expect(request.url).to.contain('&payload=');
+    expect(request.url).to.contain('iiqid=f961ffb1-a0e1-4696-a9d2-a21d815bd344');
+  });
+
+  it('should initialize with default configurations', function () {
+    expect(iiqAnalyticsAnalyticsAdapter.initOptions.lsValueInitialized).to.be.false;
+  });
+
+  it('should handle BID_WON event with group configuration from local storage', function () {
+    localStorage.setItem(FIRST_PARTY_KEY, '{"pcid":"testpcid", "group": "B"}');
+
+    events.emit(EVENTS.BID_WON, wonRequest);
+
+    expect(server.requests.length).to.be.above(0);
+    const request = server.requests[0];
+    expect(request.url).to.contain('https://reports.intentiq.com/report?pid=' + partner + '&mct=1');
+    expect(request.url).to.contain('&jsver=0.1&vrref=http://localhost:9876/');
+    expect(request.url).to.contain('iiqid=testpcid');
+  });
+
+  it('should handle BID_WON event with default group configuration', function () {
+    localStorage.setItem(FIRST_PARTY_KEY, defaultData);
+
+    events.emit(EVENTS.BID_WON, wonRequest);
+
+    expect(server.requests.length).to.be.above(0);
+    const request = server.requests[0];
+    const data = preparePayload(wonRequest);
+    const base64String = btoa(JSON.stringify(data));
+    const payload = `[%22${base64String}%22]`;
+    expect(request.url).to.equal(
+      `https://reports.intentiq.com/report?pid=${partner}&mct=1&iiqid=f961ffb1-a0e1-4696-a9d2-a21d815bd344&agid=${REPORTER_ID}&jsver=0.1&vrref=${getReferrer()}&source=pbjs&payload=${payload}`
+    );
+  });
+
+  it('should not send request if manualReport is true', function () {
+    iiqAnalyticsAnalyticsAdapter.initOptions.manualReport = true;
+    events.emit(EVENTS.BID_WON, wonRequest);
+    expect(server.requests.length).to.equal(0);
+  });
+
+  it('should read data from local storage', function () {
+    localStorage.setItem(FIRST_PARTY_KEY, '{"group": "A"}');
+    localStorage.setItem(FIRST_PARTY_KEY + '_' + partner, '{"data":"testpcid", "eidl": 10}');
+    events.emit(EVENTS.BID_WON, wonRequest);
+    expect(iiqAnalyticsAnalyticsAdapter.initOptions.dataInLs).to.equal('testpcid');
+    expect(iiqAnalyticsAnalyticsAdapter.initOptions.eidl).to.equal(10);
+    expect(iiqAnalyticsAnalyticsAdapter.initOptions.currentGroup).to.equal('A');
+  });
+
+  it('should handle initialization values from local storage', function () {
+    localStorage.setItem(FIRST_PARTY_KEY, '{"pcid":"testpcid", "group": "B"}');
+    localStorage.setItem(FIRST_PARTY_KEY + '_' + partner, '{"data":"testpcid"}');
+    events.emit(EVENTS.BID_WON, wonRequest);
+    expect(iiqAnalyticsAnalyticsAdapter.initOptions.currentGroup).to.equal('B');
+    expect(iiqAnalyticsAnalyticsAdapter.initOptions.fpid).to.be.not.null;
+  });
+});

package/test/spec/modules/jwplayerRtdProvider_spec.js

@@ -12,6 +12,7 @@ import {
   getVatFromCache,
   getVatFromPlayer,
   setOverrides,
+  getPlayer,
   jwplayerSubmodule
 } from 'modules/jwplayerRtdProvider.js';
 import {server} from 'test/mocks/xhr.js';
@@ -1603,6 +1604,66 @@ describe('jwplayerRtdProvider', function() {
     });
   });
 
+  describe('Player detection', function () {
+    const playerInstanceMock = {
+      getPlaylist: () => [],
+      getPlaylistItem: () => ({})
+    };
+
+    beforeEach(function () {
+      window.jwplayer = sinon.stub();
+    });
+
+    afterEach(function () {
+      delete window.jwplayer;
+    });
+
+    it('should fail if jwplayer global does not exist', function () {
+      delete window.jwplayer;
+      expect(getPlayer('divId')).to.be.undefined;
+    });
+
+    it('should return the player instance for the specified div id', function () {
+      window.jwplayer.returns(playerInstanceMock);
+      const player = getPlayer('divId');
+      expect(player).to.deep.equal(playerInstanceMock);
+    });
+
+    it('should request a player when the div id does not match a player on the page and only 1 player is in the DOM', function () {
+      const playerDomElement = document.createElement('div');
+      playerDomElement.className = 'jwplayer';
+      document.body.appendChild(playerDomElement);
+
+      window.jwplayer.withArgs('invalidDivId').returns(undefined);
+      window.jwplayer.returns(playerInstanceMock);
+
+      const playerInstance = getPlayer('invalidDivId');
+
+      expect(playerInstance).to.deep.equal(playerInstanceMock);
+
+      document.body.removeChild(playerDomElement);
+    });
+
+    it('should fail when the div id does not match a player on the page, and multiple players are instantiated', function () {
+      const firstPlayerDomElement = document.createElement('div');
+      const secondPlayerDomElement = document.createElement('div');
+      firstPlayerDomElement.className = 'jwplayer';
+      secondPlayerDomElement.className = 'jwplayer';
+      document.body.appendChild(firstPlayerDomElement);
+      document.body.appendChild(secondPlayerDomElement);
+
+      window.jwplayer.withArgs('invalidDivId').returns(undefined);
+      window.jwplayer.returns(playerInstanceMock);
+
+      const playerInstance = getPlayer('invalidDivId');
+
+      expect(playerInstance).to.be.undefined;
+
+      document.body.removeChild(firstPlayerDomElement);
+      document.body.removeChild(secondPlayerDomElement);
+    });
+  });
+
   describe('jwplayerSubmodule', function () {
     it('successfully instantiates', function () {
       expect(jwplayerSubmodule.init()).to.equal(true);

package/test/spec/modules/mediagoBidAdapter_spec.js

@@ -3,14 +3,11 @@ import {
   spec,
   getPmgUID,
   storage,
-  getPageTitle,
-  getPageDescription,
-  getPageKeywords,
-  getConnectionDownLink,
   THIRD_PARTY_COOKIE_ORIGIN,
   COOKIE_KEY_MGUID,
   getCurrentTimeToUTCString
 } from 'modules/mediagoBidAdapter.js';
+import { getPageTitle, getPageDescription, getPageKeywords, getConnectionDownLink } from '../../../libraries/fpdUtils/pageInfo.js';
 import * as utils from 'src/utils.js';
 
 describe('mediago:BidAdapterTests', function () {
@@ -260,43 +257,43 @@ describe('mediago:BidAdapterTests', function () {
     expect(bid.height).to.equal(250);
     expect(bid.currency).to.equal('USD');
   });
+});
 
-  describe('mediago: getUserSyncs', function() {
-    const COOKY_SYNC_IFRAME_URL = 'https://cdn.mediago.io/js/cookieSync.html';
-    const IFRAME_ENABLED = {
-      iframeEnabled: true,
-      pixelEnabled: false,
-    };
-    const IFRAME_DISABLED = {
-      iframeEnabled: false,
-      pixelEnabled: false,
-    };
-    const GDPR_CONSENT = {
-      consentString: 'gdprConsentString',
-      gdprApplies: true
-    };
-    const USP_CONSENT = {
-      consentString: 'uspConsentString'
+describe('mediago: getUserSyncs', function() {
+  const COOKY_SYNC_IFRAME_URL = 'https://cdn.mediago.io/js/cookieSync.html';
+  const IFRAME_ENABLED = {
+    iframeEnabled: true,
+    pixelEnabled: false,
+  };
+  const IFRAME_DISABLED = {
+    iframeEnabled: false,
+    pixelEnabled: false,
+  };
+  const GDPR_CONSENT = {
+    consentString: 'gdprConsentString',
+    gdprApplies: true
+  };
+  const USP_CONSENT = {
+    consentString: 'uspConsentString'
+  }
+
+  let syncParamUrl = `dm=${encodeURIComponent(location.origin || `https://${location.host}`)}`;
+  syncParamUrl += '&gdpr=1&gdpr_consent=gdprConsentString&ccpa_consent=uspConsentString';
+  const expectedIframeSyncs = [
+    {
+      type: 'iframe',
+      url: `${COOKY_SYNC_IFRAME_URL}?${syncParamUrl}`
     }
+  ];
 
-    let syncParamUrl = `dm=${encodeURIComponent(location.origin || `https://${location.host}`)}`;
-    syncParamUrl += '&gdpr=1&gdpr_consent=gdprConsentString&ccpa_consent=uspConsentString';
-    const expectedIframeSyncs = [
-      {
-        type: 'iframe',
-        url: `${COOKY_SYNC_IFRAME_URL}?${syncParamUrl}`
-      }
-    ];
-
-    it('should return nothing if iframe is disabled', () => {
-      const userSyncs = spec.getUserSyncs(IFRAME_DISABLED, undefined, GDPR_CONSENT, USP_CONSENT, undefined);
-      expect(userSyncs).to.be.undefined;
-    });
+  it('should return nothing if iframe is disabled', () => {
+    const userSyncs = spec.getUserSyncs(IFRAME_DISABLED, undefined, GDPR_CONSENT, USP_CONSENT, undefined);
+    expect(userSyncs).to.be.undefined;
+  });
 
-    it('should do userSyncs if iframe is enabled', () => {
-      const userSyncs = spec.getUserSyncs(IFRAME_ENABLED, undefined, GDPR_CONSENT, USP_CONSENT, undefined);
-      expect(userSyncs).to.deep.equal(expectedIframeSyncs);
-    });
+  it('should do userSyncs if iframe is enabled', () => {
+    const userSyncs = spec.getUserSyncs(IFRAME_ENABLED, undefined, GDPR_CONSENT, USP_CONSENT, undefined);
+    expect(userSyncs).to.deep.equal(expectedIframeSyncs);
   });
 });