prebid.js 6.4.0 → 6.8.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/colossussspBidAdapter_spec.js

@@ -7,7 +7,8 @@ describe('ColossussspAdapter', function () {
     bidder: 'colossusssp',
     bidderRequestId: '145e1d6a7837c9',
     params: {
-      placement_id: 0
+      placement_id: 0,
+      group_id: 0
     },
     placementCode: 'placementid_0',
     auctionId: '74f78609-a92d-4cf1-869f-1b244bbfb5d2',
@@ -60,6 +61,7 @@ describe('ColossussspAdapter', function () {
     });
     it('Should return false when placement_id is not a number', function () {
       bid.params.placement_id = 'aaa';
+      delete bid.params.group_id;
       expect(spec.isBidRequestValid(bid)).to.be.false;
     });
   });
@@ -95,9 +97,10 @@ describe('ColossussspAdapter', function () {
       let placements = data['placements'];
       for (let i = 0; i < placements.length; i++) {
         let placement = placements[i];
-        expect(placement).to.have.all.keys('placementId', 'eids', 'bidId', 'traffic', 'sizes', 'schain', 'floor', 'gpid');
+        expect(placement).to.have.all.keys('placementId', 'groupId', 'eids', 'bidId', 'traffic', 'sizes', 'schain', 'floor', 'gpid');
         expect(placement.schain).to.be.an('object')
         expect(placement.placementId).to.be.a('number');
+        expect(placement.groupId).to.be.a('number');
         expect(placement.bidId).to.be.a('string');
         expect(placement.traffic).to.be.a('string');
         expect(placement.sizes).to.be.an('array');

package/test/spec/modules/compassBidAdapter_spec.js

@@ -143,6 +143,7 @@ describe('CompassBidAdapter', function () {
         expect(placement.bidId).to.be.a('string');
         expect(placement.schain).to.be.an('object');
         expect(placement.bidfloor).to.exist.and.to.equal(0);
+        expect(placement.type).to.exist.and.to.equal('publisher');
 
         if (placement.adFormat === BANNER) {
           expect(placement.sizes).to.be.an('array');

package/test/spec/modules/consentManagement_spec.js

@@ -715,6 +715,26 @@ describe('consentManagement', function () {
           expect(consent).to.be.null;
         });
 
+        it('allows the auction when CMP is unresponsive', (done) => {
+          setConsentConfig({
+            cmpApi: 'iab',
+            timeout: 10,
+            defaultGdprScope: true
+          });
+
+          requestBidsHook(() => {
+            didHookReturn = true;
+          }, {});
+
+          setTimeout(() => {
+            expect(didHookReturn).to.be.true;
+            const consent = gdprDataHandler.getConsentData();
+            expect(consent.gdprApplies).to.be.true;
+            expect(consent.consentString).to.be.undefined;
+            done();
+          }, 20);
+        });
+
         it('It still considers it a valid cmp response if gdprApplies is not a boolean', function () {
           // gdprApplies is undefined, should just still store consent response but use whatever defaultGdprScope was
           let testConsentData = {

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/criteoIdSystem_spec.js

@@ -116,16 +116,19 @@ describe('CriteoId module', function () {
         expect(setCookieStub.calledWith('cto_bundle')).to.be.false;
         expect(setLocalStorageStub.calledWith('cto_bundle')).to.be.false;
       } else if (response.bundle) {
-        expect(setCookieStub.calledWith('cto_bundle', response.bundle, expirationTs)).to.be.true;
+        expect(setCookieStub.calledWith('cto_bundle', response.bundle, expirationTs, null, '.com')).to.be.true;
+        expect(setCookieStub.calledWith('cto_bundle', response.bundle, expirationTs, null, '.testdev.com')).to.be.true;
         expect(setLocalStorageStub.calledWith('cto_bundle', response.bundle)).to.be.true;
         expect(triggerPixelStub.called).to.be.false;
       }
 
       if (response.bidId) {
-        expect(setCookieStub.calledWith('cto_bidid', response.bidId, expirationTs)).to.be.true;
+        expect(setCookieStub.calledWith('cto_bidid', response.bidId, expirationTs, null, '.com')).to.be.true;
+        expect(setCookieStub.calledWith('cto_bidid', response.bidId, expirationTs, null, '.testdev.com')).to.be.true;
         expect(setLocalStorageStub.calledWith('cto_bidid', response.bidId)).to.be.true;
       } else {
-        expect(setCookieStub.calledWith('cto_bidid', '', pastDateString)).to.be.true;
+        expect(setCookieStub.calledWith('cto_bidid', '', pastDateString, null, '.com')).to.be.true;
+        expect(setCookieStub.calledWith('cto_bidid', '', pastDateString, null, '.testdev.com')).to.be.true;
         expect(removeFromLocalStorageStub.calledWith('cto_bidid')).to.be.true;
       }
     });

package/test/spec/modules/currency_spec.js

@@ -9,7 +9,8 @@ import {
   setConfig,
   addBidResponseHook,
   currencySupportEnabled,
-  currencyRates
+  currencyRates,
+  ready
 } from 'modules/currency.js';
 
 var assert = require('chai').assert;
@@ -24,6 +25,7 @@ describe('currency', function () {
 
   beforeEach(function () {
     fakeCurrencyFileServer = sinon.fakeServer.create();
+    ready.reset();
   });
 
   afterEach(function () {
@@ -286,7 +288,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,14 +298,27 @@ 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();
+        });
+      });
     });
   });
 

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')
+    })
+  })
+})

package/test/spec/modules/docereeBidAdapter_spec.js

@@ -31,6 +31,8 @@ describe('BidlabBidAdapter', function () {
     bidder: 'doceree',
     params: {
       placementId: 'DOC_7jm9j5eqkl0xvc5w',
+      gdpr: '1',
+      gdprConsent: 'CPQfU1jPQfU1jG0AAAENAwCAAAAAAAAAAAAAAAAAAAAA.IGLtV_T9fb2vj-_Z99_tkeYwf95y3p-wzhheMs-8NyZeH_B4Wv2MyvBX4JiQKGRgksjLBAQdtHGlcTQgBwIlViTLMYk2MjzNKJrJEilsbO2dYGD9Pn8HT3ZCY70-vv__7v3ff_3g'
     }
   };
 
@@ -44,6 +46,12 @@ describe('BidlabBidAdapter', function () {
     });
   });
 
+  describe('isGdprConsentPresent', function () {
+    it('Should return true if gdpr consent is present', function () {
+      expect(spec.isGdprConsentPresent(bid)).to.be.true;
+    });
+  });
+
   describe('buildRequests', function () {
     let serverRequest = spec.buildRequests([bid]);
     serverRequest = serverRequest[0]
@@ -56,7 +64,7 @@ describe('BidlabBidAdapter', function () {
       expect(serverRequest.method).to.equal('GET');
     });
     it('Returns valid URL', function () {
-      expect(serverRequest.url).to.equal('https://bidder.doceree.com/v1/adrequest?id=DOC_7jm9j5eqkl0xvc5w&pubRequestedURL=undefined&loggedInUser=JTdCJTIyZ2VuZGVyJTIyJTNBJTIyJTIyJTJDJTIyZW1haWwlMjIlM0ElMjIlMjIlMkMlMjJoYXNoZWRFbWFpbCUyMiUzQSUyMiUyMiUyQyUyMmZpcnN0TmFtZSUyMiUzQSUyMiUyMiUyQyUyMmxhc3ROYW1lJTIyJTNBJTIyJTIyJTJDJTIybnBpJTIyJTNBJTIyJTIyJTJDJTIyaGFzaGVkTlBJJTIyJTNBJTIyJTIyJTJDJTIyY2l0eSUyMiUzQSUyMiUyMiUyQyUyMnppcENvZGUlMjIlM0ElMjIlMjIlMkMlMjJzcGVjaWFsaXphdGlvbiUyMiUzQSUyMiUyMiU3RA%3D%3D&prebidjs=true&requestId=testing&');
+      expect(serverRequest.url).to.equal('https://bidder.doceree.com/v1/adrequest?id=DOC_7jm9j5eqkl0xvc5w&pubRequestedURL=undefined&loggedInUser=JTdCJTIyZ2VuZGVyJTIyJTNBJTIyJTIyJTJDJTIyZW1haWwlMjIlM0ElMjIlMjIlMkMlMjJoYXNoZWRFbWFpbCUyMiUzQSUyMiUyMiUyQyUyMmZpcnN0TmFtZSUyMiUzQSUyMiUyMiUyQyUyMmxhc3ROYW1lJTIyJTNBJTIyJTIyJTJDJTIybnBpJTIyJTNBJTIyJTIyJTJDJTIyaGFzaGVkTlBJJTIyJTNBJTIyJTIyJTJDJTIyY2l0eSUyMiUzQSUyMiUyMiUyQyUyMnppcENvZGUlMjIlM0ElMjIlMjIlMkMlMjJzcGVjaWFsaXphdGlvbiUyMiUzQSUyMiUyMiU3RA%3D%3D&prebidjs=true&requestId=testing&gdpr=1&gdpr_consent=CPQfU1jPQfU1jG0AAAENAwCAAAAAAAAAAAAAAAAAAAAA.IGLtV_T9fb2vj-_Z99_tkeYwf95y3p-wzhheMs-8NyZeH_B4Wv2MyvBX4JiQKGRgksjLBAQdtHGlcTQgBwIlViTLMYk2MjzNKJrJEilsbO2dYGD9Pn8HT3ZCY70-vv__7v3ff_3g&');
     });
   });
   describe('interpretResponse', function () {