prebid.js 8.7.0 → 8.9.0

package/test/spec/modules/topicsFpdModule_spec.js

@@ -8,9 +8,9 @@ import {
   reset,
   topicStorageName
 } from '../../../modules/topicsFpdModule.js';
+import {config} from 'src/config.js';
 import {deepClone, safeJSONParse} from '../../../src/utils.js';
 import {getCoreStorageManager} from 'src/storageManager.js';
-import {config} from 'src/config.js';
 import * as activities from '../../../src/activities/rules.js';
 import {ACTIVITY_ENRICH_UFPD} from '../../../src/activities/activities.js';
 
@@ -414,3 +414,104 @@ describe('topics', () => {
     });
   });
 });
+
+describe('handles fetch request for topics api headers', () => {
+  let stubbedFetch;
+  const storage = getCoreStorageManager('topicsFpd');
+
+  beforeEach(() => {
+    stubbedFetch = sinon.stub(window, 'fetch');
+  });
+
+  afterEach(() => {
+    stubbedFetch.restore();
+    storage.removeDataFromLocalStorage(topicStorageName);
+  });
+
+  it('should make a fetch call when a fetchUrl is present for a selected bidder', () => {
+    config.setConfig({
+      userSync: {
+        topics: {
+          maxTopicCaller: 3,
+          bidders: [
+            {
+              bidder: 'pubmatic',
+              fetchUrl: 'http://localhost:3000/topics-server.js'
+            }
+          ],
+        },
+      }
+    });
+
+    stubbedFetch.returns(Promise.resolve(true));
+    loadTopicsForBidders({
+      browsingTopics: true,
+      featurePolicy: {
+        allowsFeature() { return true }
+      }
+    });
+    sinon.assert.calledOnce(stubbedFetch);
+    stubbedFetch.calledWith('http://localhost:3000/topics-server.js');
+  });
+
+  it('should not make a fetch call when a fetchUrl is not present for a selected bidder', () => {
+    config.setConfig({
+      userSync: {
+        topics: {
+          maxTopicCaller: 3,
+          bidders: [
+            {
+              bidder: 'pubmatic'
+            }
+          ],
+        },
+      }
+    });
+
+    loadTopicsForBidders({
+      browsingTopics: true,
+      featurePolicy: {
+        allowsFeature() { return true }
+      }
+    });
+    sinon.assert.notCalled(stubbedFetch);
+  });
+
+  it('a fetch request should not be made if the configured fetch rate duration has not yet passed', () => {
+    const storedSegments = JSON.stringify(
+      [['pubmatic', {
+        '2206021246': {
+          'ext': {'segtax': 600, 'segclass': '2206021246'},
+          'segment': [{'id': '243'}, {'id': '265'}],
+          'name': 'ads.pubmatic.com'
+        },
+        'lastUpdated': new Date().getTime()
+      }]]
+    );
+
+    storage.setDataInLocalStorage(topicStorageName, storedSegments);
+
+    config.setConfig({
+      userSync: {
+        topics: {
+          maxTopicCaller: 3,
+          bidders: [
+            {
+              bidder: 'pubmatic',
+              fetchUrl: 'http://localhost:3000/topics-server.js',
+              fetchRate: 1 // in days.  1 fetch per day
+            }
+          ],
+        },
+      }
+    });
+
+    loadTopicsForBidders({
+      browsingTopics: true,
+      featurePolicy: {
+        allowsFeature() { return true }
+      }
+    });
+    sinon.assert.notCalled(stubbedFetch);
+  });
+});

package/test/spec/modules/uid2IdSystem_helpers.js

@@ -1,6 +1,6 @@
-import { setConsentConfig } from 'modules/consentManagement.js';
-import { server } from 'test/mocks/xhr.js';
-import {coreStorage, init, setSubmoduleRegistry, requestBidsHook} from 'modules/userId/index.js';
+import {setConsentConfig} from 'modules/consentManagement.js';
+import {server} from 'test/mocks/xhr.js';
+import {coreStorage, requestBidsHook} from 'modules/userId/index.js';
 
 const msIn12Hours = 60 * 60 * 12 * 1000;
 const expireCookieDate = 'Thu, 01 Jan 1970 00:00:01 GMT';
@@ -34,8 +34,8 @@ export const apiHelpers = {
     refresh_expires: Date.now() + 24 * 60 * 60 * 1000, // 24 hours
     refresh_response_key: 'wR5t6HKMfJ2r4J7fEGX9Gw==', // Fake data
   }),
-  respondAfterDelay: (delay) => new Promise((resolve) => setTimeout(() => {
-    server.respond();
+  respondAfterDelay: (delay, srv = server) => new Promise((resolve) => setTimeout(() => {
+    srv.respond();
     setTimeout(() => resolve());
   }, delay)),
 }

package/test/spec/modules/uid2IdSystem_spec.js

@@ -7,7 +7,6 @@ import { uid2IdSubmodule } from 'modules/uid2IdSystem.js';
 import 'src/prebid.js';
 import 'modules/consentManagement.js';
 import { getGlobal } from 'src/prebidGlobal.js';
-import { server } from 'test/mocks/xhr.js';
 import { configureTimerInterceptors } from 'test/mocks/timers.js';
 import { cookieHelpers, runAuction, apiHelpers, setGdprApplies } from './uid2IdSystem_helpers.js';
 import {hook} from 'src/hook.js';
@@ -56,22 +55,6 @@ const expectModuleStorageToContain = (initialIdentity, latestIdentity) => {
 const apiUrl = 'https://prod.uidapi.com/v2/token/refresh';
 const headers = { 'Content-Type': 'application/json' };
 const makeSuccessResponseBody = () => btoa(JSON.stringify({ status: 'success', body: { ...apiHelpers.makeTokenResponse(initialToken), advertising_token: refreshedToken } }));
-const configureUid2Response = (httpStatus, response) => server.respondWith('POST', apiUrl, (xhr) => xhr.respond(httpStatus, headers, response));
-const configureUid2ApiSuccessResponse = () => configureUid2Response(200, makeSuccessResponseBody());
-const configureUid2ApiFailResponse = () => configureUid2Response(500, 'Error');
-
-// Runs the provided test twice - once with a successful API mock, once with one which returns a server error
-const testApiSuccessAndFailure = (act, testDescription, failTestDescription, only = false) => {
-  const testFn = only ? it.only : it;
-  testFn(`API responds successfully: ${testDescription}`, async function() {
-    configureUid2ApiSuccessResponse();
-    await act(true);
-  });
-  testFn(`API responds with an error: ${failTestDescription ?? testDescription}`, async function() {
-    configureUid2ApiFailResponse();
-    await act(false);
-  });
-}
 
 const testCookieAndLocalStorage = (description, test, only = false) => {
   const describeFn = only ? describe.only : describe;
@@ -93,7 +76,7 @@ const testCookieAndLocalStorage = (description, test, only = false) => {
 };
 
 describe(`UID2 module`, function () {
-  let suiteSandbox, testSandbox, timerSpy, fullTestTitle, restoreSubtleToUndefined = false;
+  let server, suiteSandbox, testSandbox, timerSpy, fullTestTitle, restoreSubtleToUndefined = false;
   before(function () {
     timerSpy = configureTimerInterceptors(debugOutput);
     hook.ready();
@@ -116,13 +99,31 @@ describe(`UID2 module`, function () {
     if (restoreSubtleToUndefined) window.crypto.subtle = undefined;
   });
 
+  const configureUid2Response = (httpStatus, response) => server.respondWith('POST', apiUrl, (xhr) => xhr.respond(httpStatus, headers, response));
+  const configureUid2ApiSuccessResponse = () => configureUid2Response(200, makeSuccessResponseBody());
+  const configureUid2ApiFailResponse = () => configureUid2Response(500, 'Error');
+  // Runs the provided test twice - once with a successful API mock, once with one which returns a server error
+  const testApiSuccessAndFailure = (act, testDescription, failTestDescription, only = false) => {
+    const testFn = only ? it.only : it;
+    testFn(`API responds successfully: ${testDescription}`, async function() {
+      configureUid2ApiSuccessResponse();
+      await act(true);
+    });
+    testFn(`API responds with an error: ${failTestDescription ?? testDescription}`, async function() {
+      configureUid2ApiFailResponse();
+      await act(false);
+    });
+  }
+
   const getFullTestTitle = (test) => `${test.parent.title ? getFullTestTitle(test.parent) + ' | ' : ''}${test.title}`;
+
   beforeEach(function () {
     debugOutput(`----------------- START TEST ------------------`);
     fullTestTitle = getFullTestTitle(this.test.ctx.currentTest);
     debugOutput(fullTestTitle);
     testSandbox = sinon.sandbox.create();
     testSandbox.stub(utils, 'logWarn');
+    server = sinon.createFakeServer();
 
     init(config);
     setSubmoduleRegistry([uid2IdSubmodule]);
@@ -143,7 +144,6 @@ describe(`UID2 module`, function () {
     }
     cookieHelpers.clearCookies(moduleCookieName, publisherCookieName);
     coreStorage.removeDataFromLocalStorage(moduleCookieName);
-
     debugOutput('----------------- END TEST ------------------');
   });
 
@@ -247,7 +247,7 @@ describe(`UID2 module`, function () {
         describe('When the refresh is available in time', function() {
           testApiSuccessAndFailure(async function(apiSucceeds) {
             scenario.setConfig(apiHelpers.makeTokenResponse(initialToken, true, true));
-            apiHelpers.respondAfterDelay(auctionDelayMs / 10);
+            apiHelpers.respondAfterDelay(auctionDelayMs / 10, server);
             const bid = await runAuction();
 
             if (apiSucceeds) expectToken(bid, refreshedToken);
@@ -256,7 +256,7 @@ describe(`UID2 module`, function () {
 
           testApiSuccessAndFailure(async function(apiSucceeds) {
             scenario.setConfig(apiHelpers.makeTokenResponse(initialToken, true, true));
-            apiHelpers.respondAfterDelay(auctionDelayMs / 10);
+            apiHelpers.respondAfterDelay(auctionDelayMs / 10, server);
 
             await runAuction();
             if (apiSucceeds) {
@@ -275,7 +275,7 @@ describe(`UID2 module`, function () {
 
           testApiSuccessAndFailure(async function(apiSucceeds) {
             scenario.setConfig(apiHelpers.makeTokenResponse(initialToken, true, true));
-            const promise = apiHelpers.respondAfterDelay(auctionDelayMs * 2);
+            const promise = apiHelpers.respondAfterDelay(auctionDelayMs * 2, server);
 
             const bid = await runAuction();
             expectNoIdentity(bid);
@@ -319,13 +319,13 @@ describe(`UID2 module`, function () {
           scenario.setConfig(apiHelpers.makeTokenResponse(initialToken, true), {auctionDelay: 0, syncDelay: 1});
         });
         testApiSuccessAndFailure(async function() {
-          apiHelpers.respondAfterDelay(10);
+          apiHelpers.respondAfterDelay(10, server);
           const bid = await runAuction();
           expectToken(bid, initialToken);
         }, 'it should not be refreshed before the auction runs');
 
         testApiSuccessAndFailure(async function(success) {
-          const promise = apiHelpers.respondAfterDelay(1);
+          const promise = apiHelpers.respondAfterDelay(1, server);
           await runAuction();
           await promise;
           if (success) {

package/test/spec/modules/userId_spec.js

@@ -3005,7 +3005,7 @@ describe('User ID', function () {
           expect(server.requests).to.be.empty;
           return endAuction();
         }).then(() => {
-          expect(server.requests[0].url).to.equal('/any/unifiedid/url');
+          expect(server.requests[0].url).to.match(/\/any\/unifiedid\/url/);
         });
       });
 

package/test/spec/modules/visxBidAdapter_spec.js

@@ -1,5 +1,5 @@
 import { expect } from 'chai';
-import { spec } from 'modules/visxBidAdapter.js';
+import { spec, storage } from 'modules/visxBidAdapter.js';
 import { config } from 'src/config.js';
 import { newBidder } from 'src/adapters/bidderFactory.js';
 import * as utils from 'src/utils.js';
@@ -82,6 +82,9 @@ describe('VisxAdapter', function () {
       });
       return res;
     }
+
+    let cookiesAreEnabledStub, localStorageIsEnabledStub;
+
     const bidderRequest = {
       timeout: 3000,
       refererInfo: {
@@ -180,6 +183,24 @@ describe('VisxAdapter', function () {
       'ext': {'bidder': {'uid': 903537}}
     }];
 
+    before(() => {
+      $$PREBID_GLOBAL$$.bidderSettings = {
+        visx: {
+          storageAllowed: false
+        }
+      };
+      localStorageIsEnabledStub = sinon.stub(storage, 'localStorageIsEnabled');
+      cookiesAreEnabledStub = sinon.stub(storage, 'cookiesAreEnabled');
+      localStorageIsEnabledStub.returns(false);
+      cookiesAreEnabledStub.returns(false);
+    });
+
+    after(() => {
+      localStorageIsEnabledStub.restore();
+      cookiesAreEnabledStub.restore();
+      $$PREBID_GLOBAL$$.bidderSettings = {};
+    });
+
     it('should attach valid params to the tag', function () {
       const firstBid = bidRequests[0];
       const bids = [firstBid];
@@ -422,6 +443,7 @@ describe('VisxAdapter', function () {
       });
       return res;
     }
+    let cookiesAreEnabledStub, localStorageIsEnabledStub;
     const bidderRequest = {
       timeout: 3000,
       refererInfo: {
@@ -449,6 +471,24 @@ describe('VisxAdapter', function () {
       }
     ];
 
+    before(() => {
+      $$PREBID_GLOBAL$$.bidderSettings = {
+        visx: {
+          storageAllowed: false
+        }
+      };
+      localStorageIsEnabledStub = sinon.stub(storage, 'localStorageIsEnabled');
+      cookiesAreEnabledStub = sinon.stub(storage, 'cookiesAreEnabled');
+      localStorageIsEnabledStub.returns(false);
+      cookiesAreEnabledStub.returns(false);
+    });
+
+    after(() => {
+      localStorageIsEnabledStub.restore();
+      cookiesAreEnabledStub.restore();
+      $$PREBID_GLOBAL$$.bidderSettings = {};
+    });
+
     it('should send requst for banner bid', function () {
       const request = spec.buildRequests([bidRequests[0]], bidderRequest);
       const payload = parseRequest(request.url);
@@ -486,6 +526,7 @@ describe('VisxAdapter', function () {
       });
       return res;
     }
+    let cookiesAreEnabledStub, localStorageIsEnabledStub;
     const bidderRequest = {
       timeout: 3000,
       refererInfo: {
@@ -529,10 +570,23 @@ describe('VisxAdapter', function () {
       documentStub.withArgs('visx-adunit-element-2').returns({
         id: 'visx-adunit-element-2'
       });
+
+      $$PREBID_GLOBAL$$.bidderSettings = {
+        visx: {
+          storageAllowed: false
+        }
+      };
+      localStorageIsEnabledStub = sinon.stub(storage, 'localStorageIsEnabled');
+      cookiesAreEnabledStub = sinon.stub(storage, 'cookiesAreEnabled');
+      localStorageIsEnabledStub.returns(false);
+      cookiesAreEnabledStub.returns(false);
     });
 
     after(function() {
       sandbox.restore();
+      localStorageIsEnabledStub.restore();
+      cookiesAreEnabledStub.restore();
+      $$PREBID_GLOBAL$$.bidderSettings = {};
     });
 
     it('should find ad slot by ad unit code as element id', function () {
@@ -1323,4 +1377,100 @@ describe('VisxAdapter', function () {
       expect(query).to.deep.equal({});
     });
   });
+
+  describe('first party user id', function () {
+    const USER_ID_KEY = '__vads';
+    const USER_ID_DUMMY_VALUE_COOKIE = 'dummy_id_cookie';
+    const USER_ID_DUMMY_VALUE_LOCAL_STORAGE = 'dummy_id_local_storage';
+
+    let getDataFromLocalStorageStub, localStorageIsEnabledStub;
+    let getCookieStub, cookiesAreEnabledStub;
+
+    const bidRequests = [
+      {
+        'bidder': 'visx',
+        'params': {
+          'uid': 903535
+        },
+        'adUnitCode': 'adunit-code-1',
+        'sizes': [[300, 250], [300, 600]],
+        'bidId': '30b31c1838de1e',
+        'bidderRequestId': '22edbae2733bf6',
+        'auctionId': '1d1a030790a475',
+      }
+    ];
+    const bidderRequest = {
+      timeout: 3000,
+      refererInfo: {
+        page: 'https://example.com'
+      }
+    };
+
+    beforeEach(() => {
+      $$PREBID_GLOBAL$$.bidderSettings = {
+        visx: {
+          storageAllowed: true
+        }
+      };
+      cookiesAreEnabledStub = sinon.stub(storage, 'cookiesAreEnabled');
+      localStorageIsEnabledStub = sinon.stub(storage, 'localStorageIsEnabled');
+    });
+
+    afterEach(() => {
+      cookiesAreEnabledStub.restore();
+      localStorageIsEnabledStub.restore();
+      getCookieStub && getCookieStub.restore();
+      getDataFromLocalStorageStub && getDataFromLocalStorageStub.restore();
+      $$PREBID_GLOBAL$$.bidderSettings = {};
+    });
+
+    it('should not pass user id if both cookies and local storage are not available', function () {
+      cookiesAreEnabledStub.returns(false);
+      localStorageIsEnabledStub.returns(false);
+
+      const request = spec.buildRequests(bidRequests, bidderRequest);
+
+      expect(request.data.user).to.be.undefined;
+    });
+
+    it('should get user id from cookie if available', function () {
+      cookiesAreEnabledStub.returns(true);
+      localStorageIsEnabledStub.returns(false);
+      getCookieStub = sinon.stub(storage, 'getCookie');
+      getCookieStub.withArgs(USER_ID_KEY).returns(USER_ID_DUMMY_VALUE_COOKIE);
+
+      const request = spec.buildRequests(bidRequests, bidderRequest);
+
+      expect(request.data.user.ext.vads).to.equal(USER_ID_DUMMY_VALUE_COOKIE);
+    });
+
+    it('should get user id from local storage if available', function () {
+      cookiesAreEnabledStub.returns(false);
+      localStorageIsEnabledStub.returns(true);
+      getDataFromLocalStorageStub = sinon.stub(storage, 'getDataFromLocalStorage');
+      getDataFromLocalStorageStub.withArgs(USER_ID_KEY).returns(USER_ID_DUMMY_VALUE_LOCAL_STORAGE);
+
+      const request = spec.buildRequests(bidRequests, bidderRequest);
+
+      expect(request.data.user.ext.vads).to.equal(USER_ID_DUMMY_VALUE_LOCAL_STORAGE);
+    });
+
+    it('should create user id and store it in cookies (if user id does not exist)', function () {
+      cookiesAreEnabledStub.returns(true);
+      localStorageIsEnabledStub.returns(false);
+
+      const request = spec.buildRequests(bidRequests, bidderRequest);
+      expect(storage.getCookie(USER_ID_KEY)).to.be.a('string');
+      expect(request.data.user.ext.vads).to.be.a('string');
+    });
+
+    it('should create user id and store it in local storage (if user id does not exist)', function () {
+      cookiesAreEnabledStub.returns(false);
+      localStorageIsEnabledStub.returns(true);
+
+      const request = spec.buildRequests(bidRequests, bidderRequest);
+      expect(storage.getDataFromLocalStorage(USER_ID_KEY)).to.be.a('string');
+      expect(request.data.user.ext.vads).to.be.a('string');
+    });
+  });
 });

package/test/spec/modules/zeta_global_sspAnalyticsAdapter_spec.js

@@ -1,7 +1,7 @@
 import zetaAnalyticsAdapter from 'modules/zeta_global_sspAnalyticsAdapter.js';
 import {config} from 'src/config';
 import CONSTANTS from 'src/constants.json';
-import {logError} from '../../../src/utils';
+import {server} from '../../mocks/xhr.js';
 
 let utils = require('src/utils');
 let events = require('src/events');
@@ -358,14 +358,11 @@ const MOCK = {
 
 describe('Zeta Global SSP Analytics Adapter', function() {
   let sandbox;
-  let xhr;
   let requests;
 
   beforeEach(function() {
     sandbox = sinon.sandbox.create();
-    requests = [];
-    xhr = sandbox.useFakeXMLHttpRequest();
-    xhr.onCreate = request => requests.push(request);
+    requests = server.requests;
     sandbox.stub(events, 'getEvents').returns([]);
   });
 

package/test/spec/native_spec.js

@@ -631,7 +631,8 @@ describe('native.js', function () {
     eventtrackers: [
       { event: 1, method: 1, url: 'https://sampleurl.com' },
       { event: 1, method: 2, url: 'https://sampleurljs.com' }
-    ]
+    ],
+    imptrackers: [ 'https://sample-imp.com' ]
   }
   describe('toLegacyResponse', () => {
     it('returns assets in legacy format for ortb responses', () => {
@@ -640,8 +641,9 @@ describe('native.js', function () {
       expect(actual.title).to.equal('vtitle');
       expect(actual.clickUrl).to.equal('url');
       expect(actual.javascriptTrackers).to.equal('<script async src="https://sampleurljs.com"></script>');
-      expect(actual.impressionTrackers.length).to.equal(1);
-      expect(actual.impressionTrackers[0]).to.equal('https://sampleurl.com');
+      expect(actual.impressionTrackers.length).to.equal(2);
+      expect(actual.impressionTrackers).to.contain('https://sampleurl.com');
+      expect(actual.impressionTrackers).to.contain('https://sample-imp.com');
     });
   });
 });
@@ -860,6 +862,9 @@ describe('validate native', function () {
             }]
           },
           address: {},
+          privacyLink: {
+            required: true
+          }
         },
       },
     };
@@ -915,6 +920,7 @@ describe('validate native', function () {
         type: 9,
       }
     });
+    expect(ortb.privacy).to.equal(1);
   });
 
   ['bogusKey', 'clickUrl', 'privacyLink'].forEach(nativeKey => {
@@ -1022,11 +1028,14 @@ describe('validate native', function () {
     expect(oldNativeRequest.sponsoredBy).to.include({
       required: true,
       len: 25
-    })
+    });
     expect(oldNativeRequest.body).to.include({
       required: true,
       len: 140
-    })
+    });
+    expect(oldNativeRequest.privacyLink).to.include({
+      required: false
+    });
   });
 
   if (FEATURES.NATIVE) {
@@ -1197,6 +1206,12 @@ describe('legacyPropertiesToOrtbNative', () => {
       expect(native.jstracker).to.eql('some-markupsome-other-markup');
     })
   });
+  describe('privacylink', () => {
+    it('should convert privacyLink to privacy', () => {
+      const native = legacyPropertiesToOrtbNative({privacyLink: 'https:/my-privacy-link.com'});
+      expect(native.privacy).to.eql('https:/my-privacy-link.com');
+    })
+  })
 });
 
 describe('fireImpressionTrackers', () => {