prebid.js 9.2.0 → 9.4.0

package/src/adRendering.js

@@ -1,6 +1,15 @@
-import {createIframe, deepAccess, inIframe, insertElement, logError, logWarn, replaceMacros} from './utils.js';
+import {
+  createIframe,
+  createInvisibleIframe,
+  deepAccess,
+  inIframe,
+  insertElement,
+  logError,
+  logWarn,
+  replaceMacros
+} from './utils.js';
 import * as events from './events.js';
-import { AD_RENDER_FAILED_REASON, BID_STATUS, EVENTS, MESSAGES } from './constants.js';
+import {AD_RENDER_FAILED_REASON, BID_STATUS, EVENTS, MESSAGES, PB_LOCATOR} from './constants.js';
 import {config} from './config.js';
 import {executeRenderer, isRendererRequired} from './Renderer.js';
 import {VIDEO} from './mediaTypes.js';
@@ -235,3 +244,17 @@ export function renderAdDirect(doc, adId, options) {
     fail(EXCEPTION, e.message);
   }
 }
+
+/**
+ * Insert an invisible, named iframe that can be used by creatives to locate the window Prebid is running in
+ * (by looking for one that has `.frames[PB_LOCATOR]` defined).
+ * This is necessary because in some situations creatives may be rendered inside nested iframes - Prebid is not necessarily
+ * in the immediate parent window.
+ */
+export function insertLocatorFrame() {
+  if (!window.frames[PB_LOCATOR]) {
+    const frame = createInvisibleIframe();
+    frame.name = PB_LOCATOR;
+    document.body.appendChild(frame);
+  }
+}

package/src/constants.js

@@ -193,3 +193,5 @@ export const MESSAGES = {
   NATIVE: 'Prebid Native',
   EVENT: 'Prebid Event'
 };
+
+export const PB_LOCATOR = '__pb_locator__';

package/src/prebid.js

@@ -39,7 +39,7 @@ import {newMetrics, useMetrics} from './utils/perfMetrics.js';
 import {defer, GreedyPromise} from './utils/promise.js';
 import {enrichFPD} from './fpd/enrichment.js';
 import {allConsent} from './consentHandler.js';
-import {renderAdDirect} from './adRendering.js';
+import {insertLocatorFrame, renderAdDirect} from './adRendering.js';
 import {getHighestCpm} from './utils/reducers.js';
 import {fillVideoDefaults} from './video.js';
 
@@ -976,6 +976,7 @@ function processQueue(queue) {
  * @alias module:pbjs.processQueue
  */
 pbjsInstance.processQueue = function () {
+  insertLocatorFrame();
   hook.ready();
   processQueue(pbjsInstance.que);
   processQueue(pbjsInstance.cmd);

package/src/utils.js

@@ -4,8 +4,9 @@ import {includes} from './polyfill.js';
 import { EVENTS, S2S } from './constants.js';
 import {GreedyPromise} from './utils/promise.js';
 import {getGlobal} from './prebidGlobal.js';
+import { default as deepAccess } from 'dlv/index.js';
 
-export { default as deepAccess } from 'dlv/index.js';
+export { deepAccess };
 export { dset as deepSetValue } from 'dset';
 
 var tStr = 'String';
@@ -1231,3 +1232,20 @@ export function hasNonSerializableProperty(obj, checkedObjects = new Set()) {
   }
   return false;
 }
+
+/**
+ * Returns the value of a nested property in an array of objects.
+ *
+ * @param {Array} collection - Array of objects.
+ * @param {String} key - Key of nested property.
+ * @returns {any, undefined} - Value of nested property.
+ */
+export function setOnAny(collection, key) {
+  for (let i = 0, result; i < collection.length; i++) {
+    result = deepAccess(collection[i], key);
+    if (result) {
+      return result;
+    }
+  }
+  return undefined;
+}

package/test/spec/creative/crossDomainCreative_spec.js

@@ -9,12 +9,18 @@ import {
 
 describe('cross-domain creative', () => {
   const ORIGIN = 'https://example.com';
-  let win, renderAd, messages, mkIframe;
+  let win, top, renderAd, messages, mkIframe;
 
   beforeEach(() => {
     messages = [];
     mkIframe = sinon.stub();
+    top = {
+      frames: {}
+    };
+    top.top = top;
     win = {
+      top,
+      frames: {},
       document: {
         body: {
           appendChild: sinon.stub(),
@@ -30,12 +36,14 @@ describe('cross-domain creative', () => {
         })
       },
       parent: {
+        parent: top,
+        frames: {'__pb_locator__': {}},
         postMessage: sinon.stub().callsFake((payload, targetOrigin, transfer) => {
           messages.push({payload: JSON.parse(payload), targetOrigin, transfer});
         })
       }
     };
-    renderAd = renderer(win);
+    renderAd = (...args) => renderer(win)(...args);
   })
 
   function waitFor(predicate, timeout = 1000) {
@@ -64,6 +72,34 @@ describe('cross-domain creative', () => {
     expect(messages[0].targetOrigin).to.eql('https://domain.com:123')
   });
 
+  it('posts to first parent if no __pb_locator__ can be found', () => {
+    delete win.parent.frames['__pb_locator__'];
+    renderAd({pubUrl: 'https://www.example.com'});
+    expect(messages.length).to.eql(1);
+  })
+
+  describe('when there are multiple ancestors', () => {
+    let target;
+    beforeEach(() => {
+      target = win.parent;
+      win.parent = {
+        top,
+        frames: {},
+        parent: {
+          ...target,
+          parent: {
+            frames: {'__pb_locator__': {}},
+            top
+          }
+        }
+      }
+    })
+    it('posts message to the first ancestor with __pb_locator__ child', () => {
+      renderAd({pubUrl: 'https://www.example.com'});
+      expect(messages.length).to.eql(1);
+    });
+  })
+
   it('generates request message with adId and clickUrl', () => {
     renderAd({adId: '123', clickUrl: 'https://click-url.com', pubUrl: ORIGIN});
     expect(messages[0].payload).to.eql({

package/test/spec/fpd/gdpr_spec.js

@@ -1,5 +1,7 @@
 import {gdprDataHandler} from '../../../src/adapterManager.js';
 import {enrichFPDHook} from '../../../modules/consentManagementTcf.js';
+import {config} from 'src/config.js';
+import 'src/prebid.js';
 
 describe('GDPR FPD enrichment', () => {
   let sandbox, consent;
@@ -12,9 +14,9 @@ describe('GDPR FPD enrichment', () => {
     sandbox.restore();
   })
 
-  function callHook() {
+  function callHook(ortb2 = {}) {
     let result;
-    enrichFPDHook((res) => { result = res }, Promise.resolve({}));
+    enrichFPDHook((res) => { result = res }, Promise.resolve(ortb2));
     return result;
   }
 
@@ -44,4 +46,24 @@ describe('GDPR FPD enrichment', () => {
       })
     })
   });
+
+  describe('dsa', () => {
+    describe('when dsaPlaform is set', () => {
+      beforeEach(() => {
+        config.setConfig({
+          consentManagement: {
+            gdpr: {
+              dsaPlatform: true
+            }
+          }
+        });
+      });
+
+      it('sets dsarequired', () => {
+        return callHook().then(ortb2 => {
+          expect(ortb2.regs.ext.dsa.dsarequired).to.equal(3);
+        });
+      });
+    });
+  });
 });

package/test/spec/libraries/processResponse_spec.js

@@ -0,0 +1,60 @@
+import { getBidFromResponse } from '../../../libraries/processResponse/index.js';
+import {expect} from 'chai/index.js';
+
+describe('processResponse', function () {
+  const respItem = {
+    'bid': [
+      {
+        'price': 0.504,
+        'ext': {
+          'visx': {
+            'events': {
+              'runtime': '//t.visx.net/track/status/RFTFjZflStSUyuXuyT2IKOZMVPUIiPkzebpPWYwKvNkE_IybYfFxk2P5feBnt9LhiR7291KTG11JjrnyHyhVKfolH_VRCmGppbnHXHfHJ9AgNqjhFB_yTg3m18wGO9k4LOddGAg3mk8qc5zYEIzNsPFnZzos1EkHh5WNs0EjrBpwCgTERUqM3PJD_Zy60nMDA-LCuq-Z4JNBGC_GHx4LwvwXipQsjdGHS-HkqHHf9sES45OlRrW4wMf69dsmey1gvwqFAhJwii2lzo9wfOohLCMRa3Vxd-zvzx-uw71maWOyKnJXWiP6c5xkyrfV4gukNYaDUgrHc0mA0yhqyiHxe8KzEl32rxQXJRCg4FoJcJ1g9jmpZQBnIh2QrKm5iC159elwzwf31_v3Uw97Zpek8j0CCLa8FjxSjvXm1Mq8x4jcwlt0ngfWU6WwyyKwX_GMbKWuAL_nrfxSvs1hZCb4eunEFyXb2lN2olWo8ezMEzZ8YRxF_mx0hDB3NXyV0Tb4b6KXQq7tvxV-1rKPRt7DySRTbLPht0hO3mjTHxutfihnuL6ROEr372gSAiDodnbdCq_lPsCsUSEpG7DmN-4In10uSp2MemjfbqI6tllOCO-j6Pm9mhdl_rT4anHmRG2DG_dLsfD7pLaAsgf2zl2bpawhxxLVjTxikoWjNKAvr_GNh4adHGj5EHbqaBaHovB573Yk-koHkyBNrebeiy-1-Knc28MWOpFi9XKjNsXx756jAXLx2H098ptaXF3mFiuT2Iv6sTVjqOI/{STATUS_CODE}'
+            }
+          },
+          'prebid': {
+            'events': {
+              'pending': '//t.visx.net/track/pending/RFTFjZflStSUyuXuyT2IKOZMVPUIiPkzebpPWYwKvNkE_IybYfFxk2P5feBnt9LhiR7291KTG11JjrnyHyhVKfolH_VRCmGppbnHXHfHJ9AgNqjhFB_yTg3m18wGO9k4LOddGAg3mk8qc5zYEIzNsPFnZzos1EkHh5WNs0EjrBpwCgTERUqM3PJD_Zy60nMDA-LCuq-Z4JNBGC_GHx4LwvwXipQsjdGHS-HkqHHf9sES45OlRrW4wMf69dsmey1gvwqFAhJwii2lzo9wfOohLCMRa3Vxd-zvzx-uw71maWOyKnJXWiP6c5xkyrfV4gukNYaDUgrHc0mA0yhqyiHxe8KzEl32rxQXJRCg4FoJcJ1g9jmpZQBnIh2QrKm5iC159elwzwf31_v3Uw97Zpek8j0CCLa8FjxSjvXm1Mq8x4jcwlt0ngfWU6WwyyKwX_GMbKWuAL_nrfxSvs1hZCb4eunEFyXb2lN2olWo8ezMEzZ8YRxF_mx0hDB3NXyV0Tb4b6KXQq7tvxV-1rKPRt7DySRTbLPht0hO3mjTHxutfihnuL6ROEr372gSAiDodnbdCq_lPsCsUSEpG7DmN-4In10uSp2MemjfbqI6tllOCO-j6Pm9mhdl_rT4anHmRG2DG_dLsfD7pLaAsgf2zl2bpawhxxLVjTxikoWjNKAvr_GNh4adHGj5EHbqaBaHovB573Yk-koHkyBNrebeiy-1-Knc28MWOpFi9XKjNsXx756jAXLx2H098ptaXF3mFiuT2Iv6sTVjqOI/',
+              'win': '//t.visx.net/track/win/RFTFjZflStSUyuXuyT2IKOZMVPUIiPkzebpPWYwKvNkE_IybYfFxk2P5feBnt9LhiR7291KTG11JjrnyHyhVKfolH_VRCmGppbnHXHfHJ9AgNqjhFB_yTg3m18wGO9k4LOddGAg3mk8qc5zYEIzNsPFnZzos1EkHh5WNs0EjrBpwCgTERUqM3PJD_Zy60nMDA-LCuq-Z4JNBGC_GHx4LwvwXipQsjdGHS-HkqHHf9sES45OlRrW4wMf69dsmey1gvwqFAhJwii2lzo9wfOohLCMRa3Vxd-zvzx-uw71maWOyKnJXWiP6c5xkyrfV4gukNYaDUgrHc0mA0yhqyiHxe8KzEl32rxQXJRCg4FoJcJ1g9jmpZQBnIh2QrKm5iC159elwzwf31_v3Uw97Zpek8j0CCLa8FjxSjvXm1Mq8x4jcwlt0ngfWU6WwyyKwX_GMbKWuAL_nrfxSvs1hZCb4eunEFyXb2lN2olWo8ezMEzZ8YRxF_mx0hDB3NXyV0Tb4b6KXQq7tvxV-1rKPRt7DySRTbLPht0hO3mjTHxutfihnuL6ROEr372gSAiDodnbdCq_lPsCsUSEpG7DmN-4In10uSp2MemjfbqI6tllOCO-j6Pm9mhdl_rT4anHmRG2DG_dLsfD7pLaAsgf2zl2bpawhxxLVjTxikoWjNKAvr_GNh4adHGj5EHbqaBaHovB573Yk-koHkyBNrebeiy-1-Knc28MWOpFi9XKjNsXx756jAXLx2H098ptaXF3mFiuT2Iv6sTVjqOI/',
+              'bid_timeout': '//t.visx.net/track/bid_timeout/RFTFjZflStSUyuXuyT2IKOZMVPUIiPkzebpPWYwKvNkE_IybYfFxk2P5feBnt9LhiR7291KTG11JjrnyHyhVKfolH_VRCmGppbnHXHfHJ9AgNqjhFB_yTg3m18wGO9k4LOddGAg3mk8qc5zYEIzNsPFnZzos1EkHh5WNs0EjrBpwCgTERUqM3PJD_Zy60nMDA-LCuq-Z4JNBGC_GHx4LwvwXipQsjdGHS-HkqHHf9sES45OlRrW4wMf69dsmey1gvwqFAhJwii2lzo9wfOohLCMRa3Vxd-zvzx-uw71maWOyKnJXWiP6c5xkyrfV4gukNYaDUgrHc0mA0yhqyiHxe8KzEl32rxQXJRCg4FoJcJ1g9jmpZQBnIh2QrKm5iC159elwzwf31_v3Uw97Zpek8j0CCLa8FjxSjvXm1Mq8x4jcwlt0ngfWU6WwyyKwX_GMbKWuAL_nrfxSvs1hZCb4eunEFyXb2lN2olWo8ezMEzZ8YRxF_mx0hDB3NXyV0Tb4b6KXQq7tvxV-1rKPRt7DySRTbLPht0hO3mjTHxutfihnuL6ROEr372gSAiDodnbdCq_lPsCsUSEpG7DmN-4In10uSp2MemjfbqI6tllOCO-j6Pm9mhdl_rT4anHmRG2DG_dLsfD7pLaAsgf2zl2bpawhxxLVjTxikoWjNKAvr_GNh4adHGj5EHbqaBaHovB573Yk-koHkyBNrebeiy-1-Knc28MWOpFi9XKjNsXx756jAXLx2H098ptaXF3mFiuT2Iv6sTVjqOI/',
+              'runtime': '//t.visx.net/track/status/RFTFjZflStSUyuXuyT2IKOZMVPUIiPkzebpPWYwKvNkE_IybYfFxk2P5feBnt9LhiR7291KTG11JjrnyHyhVKfolH_VRCmGppbnHXHfHJ9AgNqjhFB_yTg3m18wGO9k4LOddGAg3mk8qc5zYEIzNsPFnZzos1EkHh5WNs0EjrBpwCgTERUqM3PJD_Zy60nMDA-LCuq-Z4JNBGC_GHx4LwvwXipQsjdGHS-HkqHHf9sES45OlRrW4wMf69dsmey1gvwqFAhJwii2lzo9wfOohLCMRa3Vxd-zvzx-uw71maWOyKnJXWiP6c5xkyrfV4gukNYaDUgrHc0mA0yhqyiHxe8KzEl32rxQXJRCg4FoJcJ1g9jmpZQBnIh2QrKm5iC159elwzwf31_v3Uw97Zpek8j0CCLa8FjxSjvXm1Mq8x4jcwlt0ngfWU6WwyyKwX_GMbKWuAL_nrfxSvs1hZCb4eunEFyXb2lN2olWo8ezMEzZ8YRxF_mx0hDB3NXyV0Tb4b6KXQq7tvxV-1rKPRt7DySRTbLPht0hO3mjTHxutfihnuL6ROEr372gSAiDodnbdCq_lPsCsUSEpG7DmN-4In10uSp2MemjfbqI6tllOCO-j6Pm9mhdl_rT4anHmRG2DG_dLsfD7pLaAsgf2zl2bpawhxxLVjTxikoWjNKAvr_GNh4adHGj5EHbqaBaHovB573Yk-koHkyBNrebeiy-1-Knc28MWOpFi9XKjNsXx756jAXLx2H098ptaXF3mFiuT2Iv6sTVjqOI/{STATUS_CODE}'
+            },
+            'meta': {
+              'mediaType': 'banner'
+            }
+          }
+        },
+        'impid': '2b642c27bdcf8f',
+        'auid': 929004,
+        'h': 250,
+        'cur': 'EUR',
+        'adomain': [
+          ''
+        ],
+        'w': 300,
+        'id': '9b6c7e04-0a09-4add-8ba9-0c8b98304de3'
+      }
+    ],
+    'seat': '1429601'
+  };
+  const LOG_ERROR_MESS = {
+    'noAuid': 'Bid from response has no auid parameter - ',
+    'noAdm': 'Bid from response has no adm parameter - ',
+    'noBid': 'Array of bid objects is empty',
+    'noImpId': 'Bid from response has no impid parameter - ',
+    'noPlacementCode': 'Can\'t find in requested bids the bid with auid - ',
+    'emptyUids': 'Uids should not be empty',
+    'emptySeatbid': 'Seatbid array from response has an empty item',
+    'emptyResponse': 'Response is empty',
+    'hasEmptySeatbidArray': 'Response has empty seatbid array',
+    'hasNoArrayOfBids': 'Seatbid from response has no array of bid objects - ',
+    'notAllowedCurrency': 'Currency is not supported - ',
+    'currencyMismatch': 'Currency from the request is not match currency from the response - ',
+    'onlyVideoInstream': 'Only video instream supported',
+    'videoMissing': 'Bid request videoType property is missing - '
+  };
+  it('returns bid when respItem and LOG_ERROR_MESS is passed', function () {
+    let response = getBidFromResponse(respItem, LOG_ERROR_MESS);
+    expect(response).not.include.any.keys('emptyResponse', 'hasNoArrayOfBids', 'emptySeatbid');
+  });
+});

package/test/spec/modules/adagioRtdProvider_spec.js

@@ -436,6 +436,18 @@ describe('Adagio Rtd Provider', function () {
         expect(bidRequest.adUnits[0]).to.have.property('ortb2Imp');
         expect(bidRequest.adUnits[0].ortb2Imp.ext.data.placement).to.not.exist;
       });
+
+      it('ensure we create the `ortb2Imp` object if it does not exist', function() {
+        const configCopy = utils.deepClone(config);
+        configCopy.params.placementSource = PLACEMENT_SOURCES.ADUNITCODE;
+
+        const bidRequest = utils.deepClone(bidReqConfig);
+        delete bidRequest.adUnits[0].ortb2Imp;
+
+        adagioRtdSubmodule.getBidRequestData(bidRequest, cb, configCopy);
+        expect(bidRequest.adUnits[0]).to.have.property('ortb2Imp');
+        expect(bidRequest.adUnits[0].ortb2Imp.ext.data.placement).to.equal('div-gpt-ad-1460505748561-0');
+      });
     });
   });
 

package/test/spec/modules/adnuntiusBidAdapter_spec.js

@@ -876,14 +876,15 @@ describe('adnuntiusBidAdapter', function () {
       config.setBidderConfig({
         bidders: ['adnuntius'],
         config: {
-          useCookie: false
+          useCookie: false,
+          advertiserTransparency: true
         }
       });
 
       const request = config.runWithBidder('adnuntius', () => spec.buildRequests(bidderRequests, {}));
       expect(request.length).to.equal(1);
       expect(request[0]).to.have.property('url')
-      expect(request[0].url).to.equal(ENDPOINT_URL_NOCOOKIE);
+      expect(request[0].url).to.equal(ENDPOINT_URL_NOCOOKIE + '&advertiserTransparency=true');
     });
   });
 
@@ -981,7 +982,9 @@ describe('adnuntiusBidAdapter', function () {
       config.setBidderConfig({
         bidders: ['adnuntius'],
         config: {
-          maxDeals: 2
+          maxDeals: 2,
+          useCookie: 'ignore-this',
+          advertiserTransparency: 'ignore-this-as-well'
         }
       });
 

package/test/spec/modules/conversantAnalyticsAdapter_spec.js

@@ -14,7 +14,7 @@ describe('Conversant analytics adapter tests', function() {
   let clock; // clock stub from sinon to mock our cache cleanup interval
   let logInfoStub;
 
-  const PREBID_VERSION = '1.2';
+  const PREBID_VERSION = '$prebid.version$';
   const SITE_ID = 108060;
 
   let requests;