prebid.js 6.7.0 → 6.11.0

package/test/spec/modules/brandmetricsRtdProvider_spec.js

@@ -0,0 +1,191 @@
+import * as brandmetricsRTD from '../../../modules/brandmetricsRtdProvider.js';
+import {config} from 'src/config.js';
+
+const VALID_CONFIG = {
+  name: 'brandmetrics',
+  waitForIt: true,
+  params: {
+    scriptId: '00000000-0000-0000-0000-000000000000',
+    bidders: ['ozone']
+  }
+};
+
+const NO_BIDDERS_CONFIG = {
+  name: 'brandmetrics',
+  waitForIt: true,
+  params: {
+    scriptId: '00000000-0000-0000-0000-000000000000'
+  }
+};
+
+const NO_SCRIPTID_CONFIG = {
+  name: 'brandmetrics',
+  waitForIt: true
+};
+
+const USER_CONSENT = {
+  gdpr: {
+    vendorData: {
+      vendor: {
+        consents: {
+          422: true
+        }
+      },
+      purpose: {
+        consents: {
+          1: true,
+          7: true
+        }
+      }
+    },
+    gdprApplies: true
+  }
+};
+
+const NO_TCF_CONSENT = {
+  gdpr: {
+    vendorData: {
+      vendor: {
+        consents: {
+          422: false
+        }
+      },
+      purpose: {
+        consents: {
+          1: false,
+          7: false
+        }
+      }
+    },
+    gdprApplies: true
+  }
+};
+
+const NO_USP_CONSENT = {
+  usp: '1NYY'
+};
+
+function mockSurveyLoaded(surveyConf) {
+  const commands = window._brandmetrics || [];
+  commands.forEach(command => {
+    if (command.cmd === '_addeventlistener') {
+      const conf = command.val;
+      if (conf.event === 'surveyloaded') {
+        conf.handler(surveyConf);
+      }
+    }
+  });
+}
+
+function scriptTagExists(url) {
+  const tags = document.getElementsByTagName('script');
+  for (let i = 0; i < tags.length; i++) {
+    if (tags[i].src === url) {
+      return true;
+    }
+  }
+  return false;
+}
+
+describe('BrandmetricsRTD module', () => {
+  beforeEach(function () {
+    const scriptTags = document.getElementsByTagName('script');
+    for (let i = 0; i < scriptTags.length; i++) {
+      if (scriptTags[i].src.indexOf('brandmetrics') !== -1) {
+        scriptTags[i].remove();
+      }
+    }
+  });
+
+  it('should init and return true', () => {
+    expect(brandmetricsRTD.brandmetricsSubmodule.init(VALID_CONFIG, USER_CONSENT)).to.equal(true);
+  });
+
+  it('should init and return true even if bidders is not included', () => {
+    expect(brandmetricsRTD.brandmetricsSubmodule.init(NO_BIDDERS_CONFIG, USER_CONSENT)).to.equal(true);
+  });
+
+  it('should init even if script- id is not configured', () => {
+    expect(brandmetricsRTD.brandmetricsSubmodule.init(NO_SCRIPTID_CONFIG, USER_CONSENT)).to.equal(true);
+  });
+
+  it('should not init when there is no TCF- consent', () => {
+    expect(brandmetricsRTD.brandmetricsSubmodule.init(VALID_CONFIG, NO_TCF_CONSENT)).to.equal(false);
+  });
+
+  it('should not init when there is no usp- consent', () => {
+    expect(brandmetricsRTD.brandmetricsSubmodule.init(VALID_CONFIG, NO_USP_CONSENT)).to.equal(false);
+  });
+});
+
+describe('getBidRequestData', () => {
+  beforeEach(function () {
+    config.resetConfig()
+  })
+
+  it('should set targeting keys for specified bidders', () => {
+    brandmetricsRTD.brandmetricsSubmodule.getBidRequestData({}, () => {
+      const bidderConfig = config.getBidderConfig()
+      const expected = VALID_CONFIG.params.bidders
+
+      expected.forEach(exp => {
+        expect(bidderConfig[exp].ortb2.user.ext.data.mockTargetKey).to.equal('mockMeasurementId')
+      })
+    }, VALID_CONFIG);
+
+    mockSurveyLoaded({
+      available: true,
+      conf: {
+        displayOption: {
+          type: 'pbjs',
+          targetKey: 'mockTargetKey'
+        }
+      },
+      survey: {
+        measurementId: 'mockMeasurementId'
+      }
+    });
+  });
+
+  it('should only set targeting keys when the brandmetrics survey- type is "pbjs"', () => {
+    mockSurveyLoaded({
+      available: true,
+      conf: {
+        displayOption: {
+          type: 'dfp',
+          targetKey: 'mockTargetKey'
+        }
+      },
+      survey: {
+        measurementId: 'mockMeasurementId'
+      }
+    });
+
+    brandmetricsRTD.brandmetricsSubmodule.getBidRequestData({}, () => {}, VALID_CONFIG);
+    const bidderConfig = config.getBidderConfig()
+    expect(Object.keys(bidderConfig).length).to.equal(0)
+  });
+
+  it('should use a default targeting key name if the brandmetrics- configuration does not include one', () => {
+    mockSurveyLoaded({
+      available: true,
+      conf: {
+        displayOption: {
+          type: 'pbjs',
+        }
+      },
+      survey: {
+        measurementId: 'mockMeasurementId'
+      }
+    });
+
+    brandmetricsRTD.brandmetricsSubmodule.getBidRequestData({}, () => {}, VALID_CONFIG);
+
+    const bidderConfig = config.getBidderConfig()
+    const expected = VALID_CONFIG.params.bidders
+
+    expected.forEach(exp => {
+      expect(bidderConfig[exp].ortb2.user.ext.data.brandmetrics_survey).to.equal('mockMeasurementId')
+    })
+  });
+});

package/test/spec/modules/conversantBidAdapter_spec.js

@@ -2,6 +2,7 @@ import {expect} from 'chai';
 import {spec, storage} from 'modules/conversantBidAdapter.js';
 import * as utils from 'src/utils.js';
 import {createEidsArray} from 'modules/userId/eids.js';
+import { config } from '../../../src/config.js';
 
 describe('Conversant adapter tests', function() {
   const siteId = '108060';
@@ -119,7 +120,34 @@ describe('Conversant adapter tests', function() {
       bidId: 'bid005',
       bidderRequestId: '117d765b87bed38',
       auctionId: 'req000'
-    }];
+    },
+    // video with first party data
+    {
+      bidder: 'conversant',
+      params: {
+        site_id: siteId
+      },
+      mediaTypes: {
+        video: {
+          context: 'instream',
+          mimes: ['video/mp4', 'video/x-flv']
+        }
+      },
+      ortb2Imp: {
+        instl: 1,
+        ext: {
+          data: {
+            pbadslot: 'homepage-top-rect'
+          }
+        }
+      },
+      placementCode: 'pcode006',
+      transactionId: 'tx006',
+      bidId: 'bid006',
+      bidderRequestId: '117d765b87bed38',
+      auctionId: 'req000'
+    }
+  ];
 
   const bidResponses = {
     body: {
@@ -216,7 +244,7 @@ describe('Conversant adapter tests', function() {
     expect(payload).to.have.property('id', 'req000');
     expect(payload).to.have.property('at', 1);
     expect(payload).to.have.property('imp');
-    expect(payload.imp).to.be.an('array').with.lengthOf(6);
+    expect(payload.imp).to.be.an('array').with.lengthOf(7);
 
     expect(payload.imp[0]).to.have.property('id', 'bid000');
     expect(payload.imp[0]).to.have.property('secure', 1);
@@ -306,6 +334,16 @@ describe('Conversant adapter tests', function() {
     expect(payload.imp[5].video).to.not.have.property('maxduration');
     expect(payload.imp[5]).to.not.have.property('banner');
 
+    expect(payload.imp[6]).to.have.property('id', 'bid006');
+    expect(payload.imp[6]).to.have.property('video');
+    expect(payload.imp[6].video).to.have.property('mimes');
+    expect(payload.imp[6].video.mimes).to.deep.equal(['video/mp4', 'video/x-flv']);
+    expect(payload.imp[6]).to.not.have.property('banner');
+    expect(payload.imp[6]).to.have.property('instl');
+    expect(payload.imp[6]).to.have.property('ext');
+    expect(payload.imp[6].ext).to.have.property('data');
+    expect(payload.imp[6].ext.data).to.have.property('pbadslot');
+
     expect(payload).to.have.property('site');
     expect(payload.site).to.have.property('id', siteId);
     expect(payload.site).to.have.property('mobile').that.is.oneOf([0, 1]);
@@ -321,6 +359,20 @@ describe('Conversant adapter tests', function() {
     expect(payload).to.not.have.property('user'); // there should be no user by default
   });
 
+  it('Verify first party data', () => {
+    const bidderRequest = {refererInfo: {referer: 'http://test.com?a=b&c=123'}};
+    const cfg = {ortb2: {site: {content: {series: 'MySeries', season: 'MySeason', episode: 3, title: 'MyTitle'}}}};
+    config.setConfig(cfg);
+    const request = spec.buildRequests(bidRequests, bidderRequest);
+    const payload = request.data;
+    expect(payload.site).to.have.property('content');
+    expect(payload.site.content).to.have.property('series');
+    expect(payload.site.content).to.have.property('season');
+    expect(payload.site.content).to.have.property('episode');
+    expect(payload.site.content).to.have.property('title');
+    config.resetConfig();
+  });
+
   it('Verify override url', function() {
     const testUrl = 'https://someurl?name=value';
     const request = spec.buildRequests([{params: {white_label_url: testUrl}}]);

package/test/spec/modules/criteoBidAdapter_spec.js

@@ -663,6 +663,27 @@ describe('The Criteo bidding adapter', function () {
       expect(request.data.user.uspIab).to.equal('1YNY');
     });
 
+    it('should properly build a request with schain object', function () {
+      const expectedSchain = {
+        someProperty: 'someValue'
+      };
+      const bidRequests = [
+        {
+          bidder: 'criteo',
+          schain: expectedSchain,
+          adUnitCode: 'bid-123',
+          transactionId: 'transaction-123',
+          sizes: [[728, 90]],
+          params: {
+            zoneId: 123,
+          },
+        },
+      ];
+
+      const request = spec.buildRequests(bidRequests, bidderRequest);
+      expect(request.data.source.ext.schain).to.equal(expectedSchain);
+    });
+
     it('should properly build a request with if ccpa consent field is not provided', function () {
       const bidRequests = [
         {

package/test/spec/modules/currency_spec.js

@@ -9,8 +9,11 @@ import {
   setConfig,
   addBidResponseHook,
   currencySupportEnabled,
-  currencyRates
+  currencyRates,
+  ready
 } from 'modules/currency.js';
+import {createBid} from '../../../src/bidfactory.js';
+import CONSTANTS from '../../../src/constants.json';
 
 var assert = require('chai').assert;
 var expect = require('chai').expect;
@@ -22,8 +25,13 @@ describe('currency', function () {
 
   let fn = sinon.spy();
 
+  function makeBid(bidProps) {
+    return Object.assign(createBid(CONSTANTS.STATUS.GOOD), bidProps);
+  }
+
   beforeEach(function () {
     fakeCurrencyFileServer = sinon.fakeServer.create();
+    ready.reset();
   });
 
   afterEach(function () {
@@ -286,7 +294,7 @@ describe('currency', function () {
   });
 
   describe('currency.addBidResponseDecorator bidResponseQueue', function () {
-    it('not run until currency rates file is loaded', function () {
+    it('not run until currency rates file is loaded', function (done) {
       setConfig({});
 
       fakeCurrencyFileServer.respondWith(JSON.stringify(getCurrencyRates()));
@@ -296,21 +304,34 @@ describe('currency', function () {
       setConfig({ 'adServerCurrency': 'JPY' });
 
       var marker = false;
-      addBidResponseHook(function() {
+      let promiseResolved = false;
+      addBidResponseHook(Object.assign(function() {
         marker = true;
-      }, 'elementId', bid);
+      }, {
+        bail: function (promise) {
+          promise.then(() => promiseResolved = true);
+        }
+      }), 'elementId', bid);
 
       expect(marker).to.equal(false);
 
-      fakeCurrencyFileServer.respond();
-      expect(marker).to.equal(true);
+      setTimeout(() => {
+        expect(promiseResolved).to.be.false;
+        fakeCurrencyFileServer.respond();
+
+        setTimeout(() => {
+          expect(marker).to.equal(true);
+          expect(promiseResolved).to.be.true;
+          done();
+        });
+      });
     });
   });
 
   describe('currency.addBidResponseDecorator', function () {
     it('should leave bid at 1 when currency support is not enabled and fromCurrency is USD', function () {
       setConfig({});
-      var bid = { 'cpm': 1, 'currency': 'USD' };
+      var bid = makeBid({ 'cpm': 1, 'currency': 'USD' });
       var innerBid;
       addBidResponseHook(function(adCodeId, bid) {
         innerBid = bid;
@@ -321,7 +342,7 @@ describe('currency', function () {
     it('should result in NO_BID when currency support is not enabled and fromCurrency is not USD', function () {
       setConfig({});
 
-      var bid = { 'cpm': 1, 'currency': 'GBP' };
+      var bid = makeBid({ 'cpm': 1, 'currency': 'GBP' });
       var innerBid;
       addBidResponseHook(function(adCodeId, bid) {
         innerBid = bid;
@@ -333,7 +354,7 @@ describe('currency', function () {
       setConfig({
         'adServerCurrency': 'USD'
       });
-      var bid = { 'cpm': 1, 'currency': 'USD' };
+      var bid = makeBid({ 'cpm': 1, 'currency': 'USD' });
       var innerBid;
       addBidResponseHook(function(adCodeId, bid) {
         innerBid = bid;
@@ -348,7 +369,7 @@ describe('currency', function () {
       fakeCurrencyFileServer.respondWith(JSON.stringify(getCurrencyRates()));
       setConfig({ 'adServerCurrency': 'JPY' });
       fakeCurrencyFileServer.respond();
-      var bid = { 'cpm': 1, 'currency': 'ABC' };
+      var bid = makeBid({ 'cpm': 1, 'currency': 'ABC' });
       var innerBid;
       addBidResponseHook(function(adCodeId, bid) {
         innerBid = bid;
@@ -360,7 +381,7 @@ describe('currency', function () {
       fakeCurrencyFileServer.respondWith(JSON.stringify(getCurrencyRates()));
       setConfig({ 'adServerCurrency': 'ABC' });
       fakeCurrencyFileServer.respond();
-      var bid = { 'cpm': 1, 'currency': 'GBP' };
+      var bid = makeBid({ 'cpm': 1, 'currency': 'GBP' });
       var innerBid;
       addBidResponseHook(function(adCodeId, bid) {
         innerBid = bid;
@@ -372,7 +393,7 @@ describe('currency', function () {
       fakeCurrencyFileServer.respondWith(JSON.stringify(getCurrencyRates()));
       setConfig({ 'adServerCurrency': 'JPY' });
       fakeCurrencyFileServer.respond();
-      var bid = { 'cpm': 1, 'currency': 'JPY' };
+      var bid = makeBid({ 'cpm': 1, 'currency': 'JPY' });
       var innerBid;
       addBidResponseHook(function(adCodeId, bid) {
         innerBid = bid;
@@ -385,7 +406,7 @@ describe('currency', function () {
       fakeCurrencyFileServer.respondWith(JSON.stringify(getCurrencyRates()));
       setConfig({ 'adServerCurrency': 'GBP' });
       fakeCurrencyFileServer.respond();
-      var bid = { 'cpm': 1, 'currency': 'USD' };
+      var bid = makeBid({ 'cpm': 1, 'currency': 'USD' });
       var innerBid;
       addBidResponseHook(function(adCodeId, bid) {
         innerBid = bid;
@@ -398,7 +419,7 @@ describe('currency', function () {
       fakeCurrencyFileServer.respondWith(JSON.stringify(getCurrencyRates()));
       setConfig({ 'adServerCurrency': 'GBP' });
       fakeCurrencyFileServer.respond();
-      var bid = { 'cpm': 1, 'currency': 'CNY' };
+      var bid = makeBid({ 'cpm': 1, 'currency': 'CNY' });
       var innerBid;
       addBidResponseHook(function(adCodeId, bid) {
         innerBid = bid;
@@ -411,7 +432,7 @@ describe('currency', function () {
       fakeCurrencyFileServer.respondWith(JSON.stringify(getCurrencyRates()));
       setConfig({ 'adServerCurrency': 'CNY' });
       fakeCurrencyFileServer.respond();
-      var bid = { 'cpm': 1, 'currency': 'JPY' };
+      var bid = makeBid({ 'cpm': 1, 'currency': 'JPY' });
       var innerBid;
       addBidResponseHook(function(adCodeId, bid) {
         innerBid = bid;

package/test/spec/modules/displayioBidAdapter_spec.js

@@ -0,0 +1,239 @@
+import { expect } from 'chai'
+import {spec} from 'modules/displayioBidAdapter.js'
+
+describe('Displayio adapter', function () {
+  const BIDDER = 'displayio'
+  const bidRequests = [{
+    bidId: 'bidId_001',
+    bidder: BIDDER,
+    adUnitCode: 'adUnit_001',
+    auctionId: 'auctionId_001',
+    bidderRequestId: 'bidderRequestId_001',
+    mediaTypes: {
+      banner: {
+        sizes: [[320, 480]]
+      },
+      video: {
+        sizes: [[360, 640]]
+      },
+    },
+    params: {
+      siteId: 1,
+      placementId: 1,
+      adsSrvDomain: 'adsSrvDomain',
+      cdnDomain: 'cdnDomain',
+    }
+  }]
+  const bidderRequest = {
+    refererInfo: {
+      referer: 'testprebid.com'
+    }
+  }
+
+  describe('isBidRequestValid', function () {
+    it('should return true when required params found', function() {
+      const validBid = spec.isBidRequestValid(bidRequests[0])
+      expect(validBid).to.be.true
+    })
+
+    const bidRequestsNoParams = [{
+      bidder: BIDDER,
+    }]
+    it('should not validate without params', function () {
+      const request = spec.isBidRequestValid(bidRequestsNoParams, bidderRequest)
+      expect(request).to.be.false
+    })
+
+    const noSiteId = {
+      bidder: BIDDER,
+      params: {
+        placementId: 1,
+        adsSrvDomain: 'adsSrvDomain',
+        cdnDomain: 'cdnDomain',
+      }
+    }
+    it('should not validate without siteId', function() {
+      const invalidBid = spec.isBidRequestValid(noSiteId)
+      expect(invalidBid).to.be.false
+    })
+
+    const noPlacementId = {
+      bidder: BIDDER,
+      params: {
+        siteId: 1,
+        adsSrvDomain: 'adsSrvDomain',
+        cdnDomain: 'cdnDomain',
+      }
+    }
+    it('should not validate without placementId', function() {
+      const invalidBid = spec.isBidRequestValid(noPlacementId)
+      expect(invalidBid).to.be.false
+    })
+
+    const noAdsSrvDomain = {
+      bidder: BIDDER,
+      params: {
+        siteId: 1,
+        placementId: 1,
+        cdnDomain: 'cdnDomain',
+      }
+    }
+    it('should not validate without adsSrvDomain', function() {
+      const invalidBid = spec.isBidRequestValid(noAdsSrvDomain)
+      expect(invalidBid).to.be.false
+    })
+
+    const noCdnDomain = {
+      bidder: BIDDER,
+      params: {
+        siteId: 1,
+        placementId: 1,
+        adsSrvDomain: 'adsSrvDomain',
+      }
+    }
+    it('should not validate without cdnDomain', function() {
+      const invalidBid = spec.isBidRequestValid(noCdnDomain)
+      expect(invalidBid).to.be.false
+    })
+  })
+
+  describe('buildRequests', function () {
+    it('should build request', function() {
+      const request = spec.buildRequests(bidRequests, bidderRequest)
+      expect(request).to.not.be.empty
+    })
+
+    it('sends bid request to the endpoint via POST', function () {
+      const request = spec.buildRequests(bidRequests, bidderRequest)
+      expect(request[0].method).to.equal('POST')
+    })
+
+    it('sends all bid parameters', function () {
+      const request = spec.buildRequests(bidRequests, bidderRequest)
+      expect(request[0]).to.have.keys(['headers', 'data', 'method', 'url'])
+    })
+
+    it('should not crash when there is no media types', function () {
+      const bidRequestsNoMediaTypes = [{
+        bidder: BIDDER,
+        params: {
+          siteId: 1,
+          placementId: 1,
+          adsSrvDomain: 'adsSrvDomain',
+          cdnDomain: 'cdnDomain',
+        }
+      }]
+      const request = spec.buildRequests(bidRequestsNoMediaTypes, bidderRequest)
+      expect(request[0]).to.have.keys(['headers', 'data', 'method', 'url'])
+    })
+  })
+
+  describe('_getPayload', function () {
+    const payload = spec._getPayload(bidRequests[0], bidderRequest)
+    it('should not be empty', function() {
+      expect(payload).to.not.be.empty
+    })
+
+    it('should have userSession', function() {
+      expect(payload.userSession).to.be.a('string')
+    })
+
+    it('should have data object', function() {
+      expect(payload.data).to.be.a('object')
+    })
+
+    it('should have complianceData object', function() {
+      expect(payload.data.complianceData).to.be.a('object')
+    })
+
+    it('should have device object', function() {
+      expect(payload.data.device).to.be.a('object')
+    })
+
+    it('should have omidpn', function() {
+      expect(payload.data.omidpn).to.be.a('string')
+    })
+
+    it('should have integration', function() {
+      expect(payload.data.integration).to.be.a('string')
+    })
+
+    it('should have bidId', function() {
+      expect(payload.data.id).to.not.be.empty
+    })
+
+    it('should have action getPlacement', function() {
+      expect(payload.data.action).to.be.equal('getPlacement')
+    })
+
+    it('should have app parameter', function() {
+      expect(payload.data.app).to.be.a('number')
+    })
+
+    it('should have placement parameter', function() {
+      expect(payload.data.placement).to.be.a('number')
+    })
+  })
+
+  describe('interpretResponse', function () {
+    const response = {
+      body: {
+        status: 'ok',
+        data: {
+          ads: [{
+            ad: {
+              data: {
+                id: '001',
+                ecpm: 100,
+                w: 32,
+                h: 480,
+                markup: 'test ad'
+              }
+            },
+            subtype: 'html'
+          }],
+        }
+      }
+    }
+    const serverRequest = {
+      data: {
+        data: {
+          id: 'id_001',
+          data: {
+            ref: 'testprebid.com'
+          }
+        }
+      }
+    }
+
+    let ir = spec.interpretResponse(response, serverRequest)
+
+    expect(ir.length).to.equal(1)
+
+    ir = ir[0]
+
+    it('should have requestId', function() {
+      expect(ir.requestId).to.be.a('string')
+    })
+
+    it('should have cpm', function() {
+      expect(ir.cpm).to.be.a('number')
+    })
+
+    it('should have width', function() {
+      expect(ir.width).to.be.a('number')
+    })
+
+    it('should have height', function() {
+      expect(ir.height).to.be.a('number')
+    })
+
+    it('should have creativeId', function() {
+      expect(ir.creativeId).to.be.a('number')
+    })
+
+    it('should have ad', function() {
+      expect(ir.ad).to.be.a('string')
+    })
+  })
+})