prebid.js 7.52.0 → 7.53.0

package/test/spec/modules/1plusXRtdProvider_spec.js

@@ -1,16 +1,16 @@
+import assert from 'assert';
 import { config } from 'src/config';
 import {
   onePlusXSubmodule,
-  segtaxes,
-  extractConfig,
   buildOrtb2Updates,
-  updateBidderConfig,
-  setTargetingDataToConfig,
+  extractConfig,
   extractConsent,
-  getPapiUrl
+  extractFpid,
+  getPapiUrl,
+  segtaxes,
+  setTargetingDataToConfig,
+  updateBidderConfig,
 } from 'modules/1plusXRtdProvider';
-import assert from 'assert';
-import { extractFpid } from '../../../modules/1plusXRtdProvider';
 
 describe('1plusXRtdProvider', () => {
   // Fake server config
@@ -35,47 +35,37 @@ describe('1plusXRtdProvider', () => {
 
   // Bidder configs
   const bidderConfigInitial = {
-    ortb2: {
-      user: { keywords: '' },
-      site: { ext: {} }
-    }
+    user: { keywords: '' },
+    site: { ext: {} }
   }
   const bidderConfigInitialWith1plusXUserData = {
-    ortb2: {
-      user: {
-        data: [{ name: '1plusX.com', segment: [{ id: 'initial' }] }]
-      },
-      site: { content: { data: [] } }
-    }
+    user: {
+      data: [{ name: '1plusX.com', segment: [{ id: 'initial' }] }]
+    },
+    site: { content: { data: [] } }
   }
   const bidderConfigInitialWithUserData = {
-    ortb2: {
-      user: {
-        data: [{ name: 'hello.world', segment: [{ id: 'initial' }] }]
-      },
-      site: { content: { data: [] } }
-    }
+    user: {
+      data: [{ name: 'hello.world', segment: [{ id: 'initial' }] }]
+    },
+    site: { content: { data: [] } }
   }
   const bidderConfigInitialWith1plusXSiteContent = {
-    ortb2: {
-      user: { data: [] },
-      site: {
-        content: {
-          data: [{
-            name: '1plusX.com', segment: [{ id: 'initial' }], ext: { segtax: 525 }
-          }]
-        }
-      },
+    user: { data: [] },
+    site: {
+      content: {
+        data: [{
+          name: '1plusX.com', segment: [{ id: 'initial' }], ext: { segtax: 525 }
+        }]
+      }
     }
   }
   const bidderConfigInitialWithSiteContent = {
-    ortb2: {
-      user: { data: [] },
-      site: {
-        content: {
-          data: [{ name: 'hello.world', segment: [{ id: 'initial' }] }]
-        }
-      },
+    user: { data: [] },
+    site: {
+      content: {
+        data: [{ name: 'hello.world', segment: [{ id: 'initial' }] }]
+      }
     }
   }
   // Util functions
@@ -178,7 +168,7 @@ describe('1plusXRtdProvider', () => {
   })
 
   describe('buildOrtb2Updates', () => {
-    it('fills site.content.data & user.data in the ortb2 config', () => {
+    it('fills site.content.data, user.data & site.keywords in the ortb2 config', () => {
       const rtdData = { segments: fakeResponse.s, topics: fakeResponse.t };
       const ortb2Updates = buildOrtb2Updates(rtdData, randomBidder());
 
@@ -191,18 +181,8 @@ describe('1plusXRtdProvider', () => {
         userData: {
           name: '1plusX.com',
           segment: rtdData.segments.map((segmentId) => ({ id: segmentId }))
-        }
-      }
-      expect([ortb2Updates]).to.deep.include.members([expectedOutput]);
-    });
-    it('fills site.keywords in the ortb2 config (appnexus specific)', () => {
-      const rtdData = { segments: fakeResponse.s, topics: fakeResponse.t };
-      const ortb2Updates = buildOrtb2Updates(rtdData, 'appnexus');
-
-      const expectedOutput = {
-        site: {
-          keywords: rtdData.topics.join(','),
-        }
+        },
+        siteKeywords: rtdData.topics.map(topic => `1plusX=${topic}`).join(','),
       }
       expect([ortb2Updates]).to.deep.include.members([expectedOutput]);
     });
@@ -220,7 +200,8 @@ describe('1plusXRtdProvider', () => {
         userData: {
           name: '1plusX.com',
           segment: []
-        }
+        },
+        siteKeywords: rtdData.topics.map(topic => `1plusX=${topic}`).join(','),
       }
       expect(ortb2Updates).to.deep.include(expectedOutput);
     })
@@ -238,20 +219,10 @@ describe('1plusXRtdProvider', () => {
         userData: {
           name: '1plusX.com',
           segment: rtdData.segments.map((segmentId) => ({ id: segmentId }))
-        }
-      }
-      expect(ortb2Updates).to.deep.include(expectedOutput);
-    })
-    it('defaults to empty string if no topic is given (appnexus specific)', () => {
-      const rtdData = { segments: fakeResponse.s };
-      const ortb2Updates = buildOrtb2Updates(rtdData, 'appnexus');
-
-      const expectedOutput = {
-        site: {
-          keywords: '',
-        }
+        },
+        siteKeywords: '',
       }
-      expect(ortb2Updates).to.deep.include(expectedOutput);
+      expect(ortb2Updates, `${JSON.stringify(ortb2Updates, null, 2)}`).to.deep.include(expectedOutput);
     })
   })
 
@@ -271,6 +242,7 @@ describe('1plusXRtdProvider', () => {
       expect(expectedOutput).to.deep.include(output)
       expect(output).to.deep.include(expectedOutput)
     })
+
     it('extracts null if consent object is empty', () => {
       const consent1 = {}
       expect(extractConsent(consent1)).to.equal(null)
@@ -345,15 +317,6 @@ describe('1plusXRtdProvider', () => {
   })
 
   describe('updateBidderConfig', () => {
-    const ortb2UpdatesAppNexus = {
-      site: {
-        keywords: fakeResponse.t.join(','),
-      },
-      userData: {
-        name: '1plusX.com',
-        segment: fakeResponse.s.map((segmentId) => ({ id: segmentId }))
-      }
-    }
     const ortb2Updates = {
       siteContentData: {
         name: '1plusX.com',
@@ -363,114 +326,98 @@ describe('1plusXRtdProvider', () => {
       userData: {
         name: '1plusX.com',
         segment: fakeResponse.s.map((segmentId) => ({ id: segmentId }))
-      }
+      },
+      siteKeywords: fakeResponse.t.map(topic => `1plusX=${topic}`).join(','),
     }
 
     it('merges fetched data in bidderConfig for configured bidders', () => {
-      const bidder = randomBidder();
-      // Set initial config
-      config.setBidderConfig({
-        bidders: [bidder],
-        config: bidderConfigInitial
-      });
-      // Call submodule's setBidderConfig
-      const newBidderConfig = updateBidderConfig(bidder, ortb2Updates, config.getBidderConfig());
-      // Check that the targeting data has been set in the config
-      expect(newBidderConfig).not.to.be.null;
-      expect(newBidderConfig.ortb2.site.content.data).to.deep.include(ortb2Updates.siteContentData);
-      expect(newBidderConfig.ortb2.user.data).to.deep.include(ortb2Updates.userData);
-      // Check that existing config didn't get erased
-      expect(newBidderConfig.ortb2.site).to.deep.include(bidderConfigInitial.ortb2.site);
-      expect(newBidderConfig.ortb2.user).to.deep.include(bidderConfigInitial.ortb2.user);
-    })
-
-    it('merges fetched data in bidderConfig for configured bidders (appnexus specific)', () => {
-      const bidder = 'appnexus';
       // Set initial config
-      config.setBidderConfig({
-        bidders: [bidder],
-        config: bidderConfigInitial
-      });
+      const bidder = randomBidder();
+      const ortb2Fragments = { [bidder]: { ...bidderConfigInitial } }
       // Call submodule's setBidderConfig
-      const newBidderConfig = updateBidderConfig(bidder, ortb2UpdatesAppNexus, config.getBidderConfig());
-
+      updateBidderConfig(bidder, ortb2Updates, ortb2Fragments);
+      const newBidderConfig = ortb2Fragments[bidder];
       // Check that the targeting data has been set in the config
-      expect(newBidderConfig).not.to.be.null;
-      expect(newBidderConfig.ortb2.site).to.deep.include(ortb2UpdatesAppNexus.site);
+      expect(newBidderConfig).not.to.be.null.and.not.to.be.undefined;
+      expect(newBidderConfig.user).not.to.be.null.and.not.to.be.undefined;
+      expect(newBidderConfig.site).not.to.be.null.and.not.to.be.undefined;
+      expect(newBidderConfig.user.data).to.deep.include(ortb2Updates.userData);
+      expect(newBidderConfig.site.keywords).to.deep.include(ortb2Updates.siteKeywords);
+      expect(newBidderConfig.site.content.data).to.deep.include(ortb2Updates.siteContentData);
       // Check that existing config didn't get erased
-      expect(newBidderConfig.ortb2.site).to.deep.include(bidderConfigInitial.ortb2.site);
-      expect(newBidderConfig.ortb2.user).to.deep.include(bidderConfigInitial.ortb2.user);
+      expect(newBidderConfig.site).to.deep.include(bidderConfigInitial.site);
+      expect(newBidderConfig.user).to.deep.include(bidderConfigInitial.user);
     })
 
     it('overwrites an existing 1plus.com entry in ortb2.user.data', () => {
-      const bidder = randomBidder();
       // Set initial config
-      config.setBidderConfig({
-        bidders: [bidder],
-        config: bidderConfigInitialWith1plusXUserData
-      });
+      const bidder = randomBidder();
+      const ortb2Fragments = { [bidder]: { ...bidderConfigInitialWith1plusXUserData } }
       // Save previous user.data entry
-      const previousUserData = bidderConfigInitialWith1plusXUserData.ortb2.user.data[0];
+      const previousUserData = bidderConfigInitialWith1plusXUserData.user.data[0];
       // Call submodule's setBidderConfig
-      const newBidderConfig = updateBidderConfig(bidder, ortb2Updates, config.getBidderConfig());
+      updateBidderConfig(bidder, ortb2Updates, ortb2Fragments);
+      const newBidderConfig = ortb2Fragments[bidder];
       // Check that the targeting data has been set in the config
       expect(newBidderConfig).not.to.be.null;
-      expect(newBidderConfig.ortb2.user.data).to.deep.include(ortb2Updates.userData);
-      expect(newBidderConfig.ortb2.user.data).not.to.include(previousUserData);
+      expect(newBidderConfig.site).not.to.be.null;
+      expect(newBidderConfig.user).not.to.be.null;
+      expect(newBidderConfig.user.data).to.deep.include(ortb2Updates.userData);
+      expect(newBidderConfig.user.data).not.to.include(previousUserData);
     })
     it("doesn't overwrite entries in ortb2.user.data that aren't 1plusx.com", () => {
-      const bidder = randomBidder();
       // Set initial config
-      config.setBidderConfig({
-        bidders: [bidder],
-        config: bidderConfigInitialWithUserData
-      });
+      const bidder = randomBidder();
+      const ortb2Fragments = { [bidder]: { ...bidderConfigInitialWithUserData } }
       // Save previous user.data entry
-      const previousUserData = bidderConfigInitialWithUserData.ortb2.user.data[0];
+      const previousUserData = bidderConfigInitialWithUserData.user.data[0];
       // Call submodule's setBidderConfig
-      const newBidderConfig = updateBidderConfig(bidder, ortb2Updates, config.getBidderConfig());
+      updateBidderConfig(bidder, ortb2Updates, ortb2Fragments);
+      const newBidderConfig = ortb2Fragments[bidder];
       // Check that the targeting data has been set in the config
       expect(newBidderConfig).not.to.be.null;
-      expect(newBidderConfig.ortb2.user.data).to.deep.include(ortb2Updates.userData);
-      expect(newBidderConfig.ortb2.user.data).to.deep.include(previousUserData);
+      expect(newBidderConfig.site).not.to.be.null;
+      expect(newBidderConfig.user).not.to.be.null;
+      expect(newBidderConfig.user.data).to.deep.include(ortb2Updates.userData);
+      expect(newBidderConfig.user.data).to.deep.include(previousUserData);
     })
 
     it('overwrites an existing 1plus.com entry in ortb2.site.content.data', () => {
-      const bidder = randomBidder();
       // Set initial config
-      config.setBidderConfig({
-        bidders: [bidder],
-        config: bidderConfigInitialWith1plusXSiteContent
-      });
+      const bidder = randomBidder();
+      const ortb2Fragments = { [bidder]: { ...bidderConfigInitialWith1plusXSiteContent } }
       // Save previous user.data entry
-      const previousSiteContent = bidderConfigInitialWith1plusXSiteContent.ortb2.site.content.data[0];
+      const previousSiteContent = bidderConfigInitialWith1plusXSiteContent.site.content.data[0];
       // Call submodule's setBidderConfig
-      const newBidderConfig = updateBidderConfig(bidder, ortb2Updates, config.getBidderConfig());
+      updateBidderConfig(bidder, ortb2Updates, ortb2Fragments);
+      const newBidderConfig = ortb2Fragments[bidder];
       // Check that the targeting data has been set in the config
       expect(newBidderConfig).not.to.be.null;
-      expect(newBidderConfig.ortb2.site.content.data).to.deep.include(ortb2Updates.siteContentData);
-      expect(newBidderConfig.ortb2.site.content.data).not.to.include(previousSiteContent);
+      expect(newBidderConfig.site).not.to.be.null;
+      expect(newBidderConfig.user).not.to.be.null;
+      expect(newBidderConfig.site.content.data).to.deep.include(ortb2Updates.siteContentData);
+      expect(newBidderConfig.site.content.data).not.to.include(previousSiteContent);
     })
     it("doesn't overwrite entries in ortb2.site.content.data that aren't 1plusx.com", () => {
-      const bidder = randomBidder();
       // Set initial config
-      config.setBidderConfig({
-        bidders: [bidder],
-        config: bidderConfigInitialWithSiteContent
-      });
+      const bidder = randomBidder();
+      const ortb2Fragments = { [bidder]: { ...bidderConfigInitialWithSiteContent } }
       // Save previous user.data entry
-      const previousSiteContent = bidderConfigInitialWithSiteContent.ortb2.site.content.data[0];
+      const previousSiteContent = bidderConfigInitialWithSiteContent.site.content.data[0];
       // Call submodule's setBidderConfig
-      const newBidderConfig = updateBidderConfig(bidder, ortb2Updates, config.getBidderConfig());
+      updateBidderConfig(bidder, ortb2Updates, ortb2Fragments);
+      const newBidderConfig = ortb2Fragments[bidder];
       // Check that the targeting data has been set in the config
       expect(newBidderConfig).not.to.be.null;
-      expect(newBidderConfig.ortb2.site.content.data).to.deep.include(ortb2Updates.siteContentData);
-      expect(newBidderConfig.ortb2.site.content.data).to.deep.include(previousSiteContent);
+      expect(newBidderConfig.site).not.to.be.null;
+      expect(newBidderConfig.user).not.to.be.null;
+      expect(newBidderConfig.site.content.data).to.deep.include(ortb2Updates.siteContentData);
+      expect(newBidderConfig.site.content.data).to.deep.include(previousSiteContent);
     })
   })
 
   describe('setTargetingDataToConfig', () => {
-    const expectedKeywords = fakeResponse.t.join(',');
+    const expectedKeywords = fakeResponse.t.map(topic => `1plusX=${topic}`).join(',');
     const expectedSiteContentObj = {
       data: [{
         name: '1plusX.com',
@@ -486,10 +433,11 @@ describe('1plusXRtdProvider', () => {
     }
     const expectedOrtb2 = {
       appnexus: {
-        site: { keywords: expectedKeywords }
+        site: { content: expectedSiteContentObj, keywords: expectedKeywords },
+        user: expectedUserObj
       },
       rubicon: {
-        site: { content: expectedSiteContentObj },
+        site: { content: expectedSiteContentObj, keywords: expectedKeywords },
         user: expectedUserObj
       }
     }
@@ -501,22 +449,23 @@ describe('1plusXRtdProvider', () => {
         bidders,
         config: bidderConfigInitial
       })
+      const biddersOrtb2 = config.getBidderConfig();
       // call setTargetingDataToConfig
-      setTargetingDataToConfig(fakeResponse, { bidders });
+      setTargetingDataToConfig(fakeResponse, { bidders, biddersOrtb2 });
 
       // Check that the targeting data has been set in both configs
       for (const bidder of bidders) {
         const newConfig = config.getBidderConfig()[bidder];
         // Check that we got what we expect
         const expectedConfErr = (prop) => `New config for ${bidder} doesn't comply with expected at ${prop}`;
-        expect(newConfig.ortb2.site, expectedConfErr('site')).to.deep.include(expectedOrtb2[bidder].site);
+        expect(newConfig.site, expectedConfErr('site')).to.deep.include(expectedOrtb2[bidder].site);
         if (expectedOrtb2[bidder].user) {
-          expect(newConfig.ortb2.user, expectedConfErr('user')).to.deep.include(expectedOrtb2[bidder].user);
+          expect(newConfig.user, expectedConfErr('user')).to.deep.include(expectedOrtb2[bidder].user);
         }
         // Check that existing config didn't get erased
         const existingConfErr = (prop) => `Existing config for ${bidder} got unlawfully overwritten at ${prop}`;
-        expect(newConfig.ortb2.site, existingConfErr('site')).to.deep.include(bidderConfigInitial.ortb2.site);
-        expect(newConfig.ortb2.user, existingConfErr('user')).to.deep.include(bidderConfigInitial.ortb2.user);
+        expect(newConfig.site, existingConfErr('site')).to.deep.include(bidderConfigInitial.site);
+        expect(newConfig.user, existingConfErr('user')).to.deep.include(bidderConfigInitial.user);
       }
     })
   })

package/test/spec/modules/adagioBidAdapter_spec.js

@@ -9,7 +9,7 @@ import {
   spec,
   ENDPOINT,
   VERSION,
-  RENDERER_URL,
+  BB_RENDERER_URL,
   GlobalExchange
 } from '../../../modules/adagioBidAdapter.js';
 import { loadExternalScript } from '../../../src/adloader.js';
@@ -76,6 +76,7 @@ describe('Adagio bid adapter', () => {
   let adagioMock;
   let utilsMock;
   let sandbox;
+  let fakeRenderer;
 
   const fixtures = {
     getElementById(width, height, x, y) {
@@ -1000,42 +1001,70 @@ describe('Adagio bid adapter', () => {
         context: 'outstream',
         playerSize: [[300, 250]],
         mimes: ['video/mp4'],
-        skip: true
+        skip: 1,
+        skipafter: 3
       };
 
       const serverResponseWithOutstream = utils.deepClone(serverResponse);
       serverResponseWithOutstream.body.bids[0].vastXml = '<VAST version="4.0"><Ad></Ad></VAST>';
       serverResponseWithOutstream.body.bids[0].mediaType = 'video';
-      serverResponseWithOutstream.body.bids[0].outstream = {
-        bvwUrl: 'https://foo.baz',
-        impUrl: 'https://foo.bar'
-      };
 
-      it('should set a renderer in video outstream context', function() {
+      const defaultRendererUrl = BB_RENDERER_URL.replace('$RENDERER', 'renderer');
+
+      it('should set related properties for video outstream context', function() {
         const bidResponse = spec.interpretResponse(serverResponseWithOutstream, bidRequestWithOutstream)[0];
-        expect(bidResponse).to.have.any.keys('outstream', 'renderer', 'mediaType');
+        expect(bidResponse).to.have.any.keys('renderer', 'mediaType');
         expect(bidResponse.renderer).to.be.a('object');
-        expect(bidResponse.renderer.url).to.equal(RENDERER_URL);
-        expect(bidResponse.renderer.config.bvwUrl).to.be.ok;
-        expect(bidResponse.renderer.config.impUrl).to.be.ok;
+        expect(bidResponse.renderer.url).to.equal(defaultRendererUrl);
         expect(bidResponse.renderer.loaded).to.not.be.ok;
         expect(bidResponse.width).to.equal(300);
         expect(bidResponse.height).to.equal(250);
         expect(bidResponse.vastUrl).to.match(/^data:text\/xml;/)
       });
 
-      it('should execute Adagio outstreamPlayer if defined', function() {
-        window.ADAGIO.outstreamPlayer = sinon.stub();
+      it('should execute Blue Billywig VAST Renderer bootstrap if defined', function() {
+        window.bluebillywig = {
+          renderers: [{ bootstrap: sinon.stub(), _id: 'adagio-renderer' }]
+        };
+
+        const bidResponse = spec.interpretResponse(serverResponseWithOutstream, bidRequestWithOutstream)[0];
+        executeRenderer(bidResponse.renderer, bidResponse)
+        sinon.assert.calledOnce(window.bluebillywig.renderers[0].bootstrap);
+
+        delete window.bluebillywig;
+      });
+
+      it('Should logError if response does not have a vastXml or vastUrl', function() {
+        utilsMock.expects('logError').withExactArgs('Adagio: no vastXml or vastUrl on bid').once();
+
+        const localServerResponseWithOutstream = utils.deepClone(serverResponse);
+        localServerResponseWithOutstream.body.bids[0].mediaType = 'video';
+
+        const bidResponse = spec.interpretResponse(localServerResponseWithOutstream, bidRequestWithOutstream)[0];
+        executeRenderer(bidResponse.renderer, bidResponse)
+
+        utilsMock.verify();
+      })
+
+      it('should logError if Blue Billywig API is not defined', function() {
+        utilsMock.expects('logError').withExactArgs('Adagio: no BlueBillywig renderers found!').once();
+
         const bidResponse = spec.interpretResponse(serverResponseWithOutstream, bidRequestWithOutstream)[0];
         executeRenderer(bidResponse.renderer, bidResponse)
-        sinon.assert.calledOnce(window.ADAGIO.outstreamPlayer);
-        delete window.ADAGIO.outstreamPlayer;
+
+        utilsMock.verify();
       });
 
-      it('should logError if Adagio outstreamPlayer is not defined', function() {
+      it('should logError if correct renderer is not defined', function() {
+        window.bluebillywig = { renderers: [ { _id: 'adagio-another_renderer' } ] };
+
+        utilsMock.expects('logError').withExactArgs('Adagio: couldn\'t find a renderer with ID adagio-renderer').once();
+
         const bidResponse = spec.interpretResponse(serverResponseWithOutstream, bidRequestWithOutstream)[0];
         executeRenderer(bidResponse.renderer, bidResponse)
-        utilsMock.expects('logError').withExactArgs('Adagio: Adagio outstream player is not defined').once();
+
+        delete window.bluebillywig;
+        utilsMock.verify();
       });
     });
 

package/test/spec/modules/airgridRtdProvider_spec.js

@@ -2,6 +2,7 @@ import { config } from 'src/config.js';
 import { deepAccess } from 'src/utils.js';
 import { getAdUnits } from '../../fixtures/fixtures.js';
 import * as agRTD from 'modules/airgridRtdProvider.js';
+import { loadExternalScript } from '../../../src/adloader.js';
 
 const MATCHED_AUDIENCES = ['travel', 'sport'];
 const RTD_CONFIG = {
@@ -40,6 +41,7 @@ describe('airgrid RTD Submodule', function () {
       expect(agRTD.airgridSubmodule.init(RTD_CONFIG.dataProviders[0])).to.equal(
         true
       );
+      expect(loadExternalScript.called).to.be.true
     });
 
     it('should attach script to DOM with correct config', function () {

package/test/spec/modules/beopBidAdapter_spec.js

@@ -130,6 +130,30 @@ describe('BeOp Bid Adapter tests', () => {
       expect(payload.url).to.exist;
       // check that the protocol is added correctly
       expect(payload.url).to.equal('http://test.te');
+      expect(payload.psegs).to.not.exist;
+    });
+
+    it('should call the endpoint with psegs data if any', function () {
+      let bidderRequest =
+      {
+        'ortb2': {
+          'user': {
+            'ext': {
+              'data': {
+                'permutive': [1234, 5678, 910]
+              }
+            }
+          }
+        }
+      };
+
+      const request = spec.buildRequests(bidRequests, bidderRequest);
+      const payload = JSON.parse(request.data);
+      expect(payload.psegs).to.exist;
+      expect(payload.psegs).to.include(1234);
+      expect(payload.psegs).to.include(5678);
+      expect(payload.psegs).to.include(910);
+      expect(payload.psegs).to.not.include(1);
     });
 
     it('should not prepend the protocol in page url if already present', function () {