prebid.js 6.8.0 → 6.12.0

package/test/spec/modules/yieldoneBidAdapter_spec.js

@@ -366,6 +366,39 @@ describe('yieldoneBidAdapter', function() {
         expect(request[0].data.lr_env).to.equal('idl_env_sample');
       });
     });
+
+    describe('IMID', function () {
+      it('dont send IMID if undefined', function () {
+        const bidRequests = [
+          {
+            params: {placementId: '0'},
+          },
+          {
+            params: {placementId: '1'},
+            userId: {},
+          },
+          {
+            params: {placementId: '2'},
+            userId: undefined,
+          },
+        ];
+        const request = spec.buildRequests(bidRequests, bidderRequest);
+        expect(request[0].data).to.not.have.property('imuid');
+        expect(request[1].data).to.not.have.property('imuid');
+        expect(request[2].data).to.not.have.property('imuid');
+      });
+
+      it('should send IMID if available', function () {
+        const bidRequests = [
+          {
+            params: {placementId: '0'},
+            userId: {imuid: 'imuid_sample'},
+          },
+        ];
+        const request = spec.buildRequests(bidRequests, bidderRequest);
+        expect(request[0].data.imuid).to.equal('imuid_sample');
+      });
+    });
   });
 
   describe('interpretResponse', function () {

package/test/spec/native_spec.js

@@ -1,10 +1,19 @@
 import { expect } from 'chai';
-import { fireNativeTrackers, getNativeTargeting, nativeBidIsValid, getAssetMessage, getAllAssetsMessage } from 'src/native.js';
+import {
+  fireNativeTrackers,
+  getNativeTargeting,
+  nativeBidIsValid,
+  getAssetMessage,
+  getAllAssetsMessage,
+  decorateAdUnitsWithNativeParams
+} from 'src/native.js';
 import CONSTANTS from 'src/constants.json';
+import {stubAuctionIndex} from '../helpers/indexStub.js';
 const utils = require('src/utils');
 
 const bid = {
   adId: '123',
+  transactionId: 'au',
   native: {
     title: 'Native Creative',
     body: 'Cool description great stuff',
@@ -32,6 +41,7 @@ const bid = {
 };
 
 const bidWithUndefinedFields = {
+  transactionId: 'au',
   native: {
     title: 'Native Creative',
     body: undefined,
@@ -52,6 +62,10 @@ describe('native.js', function () {
   let triggerPixelStub;
   let insertHtmlIntoIframeStub;
 
+  function deps(adUnit) {
+    return { index: stubAuctionIndex({ adUnits: [adUnit] }) };
+  }
+
   beforeEach(function () {
     triggerPixelStub = sinon.stub(utils, 'triggerPixel');
     insertHtmlIntoIframeStub = sinon.stub(utils, 'insertHtmlIntoIframe');
@@ -71,7 +85,8 @@ describe('native.js', function () {
   });
 
   it('sends placeholders for configured assets', function () {
-    const bidRequest = {
+    const adUnit = {
+      transactionId: 'au',
       nativeParams: {
         body: { sendId: true },
         clickUrl: { sendId: true },
@@ -85,7 +100,7 @@ describe('native.js', function () {
         }
       }
     };
-    const targeting = getNativeTargeting(bid, bidRequest);
+    const targeting = getNativeTargeting(bid, deps(adUnit));
 
     expect(targeting[CONSTANTS.NATIVE_KEYS.title]).to.equal(bid.native.title);
     expect(targeting[CONSTANTS.NATIVE_KEYS.body]).to.equal('hb_native_body:123');
@@ -95,7 +110,8 @@ describe('native.js', function () {
   });
 
   it('should only include native targeting keys with values', function () {
-    const bidRequest = {
+    const adUnit = {
+      transactionId: 'au',
       nativeParams: {
         body: { sendId: true },
         clickUrl: { sendId: true },
@@ -110,7 +126,7 @@ describe('native.js', function () {
       }
     };
 
-    const targeting = getNativeTargeting(bidWithUndefinedFields, bidRequest);
+    const targeting = getNativeTargeting(bidWithUndefinedFields, deps(adUnit));
 
     expect(Object.keys(targeting)).to.deep.equal([
       CONSTANTS.NATIVE_KEYS.title,
@@ -121,7 +137,8 @@ describe('native.js', function () {
   });
 
   it('should only include targeting that has sendTargetingKeys set to true', function () {
-    const bidRequest = {
+    const adUnit = {
+      transactionId: 'au',
       nativeParams: {
         image: {
           required: true,
@@ -136,7 +153,7 @@ describe('native.js', function () {
       }
 
     };
-    const targeting = getNativeTargeting(bid, bidRequest);
+    const targeting = getNativeTargeting(bid, deps(adUnit));
 
     expect(Object.keys(targeting)).to.deep.equal([
       CONSTANTS.NATIVE_KEYS.title
@@ -144,7 +161,8 @@ describe('native.js', function () {
   });
 
   it('should only include targeting if sendTargetingKeys not set to false', function () {
-    const bidRequest = {
+    const adUnit = {
+      transactionId: 'au',
       nativeParams: {
         image: {
           required: true,
@@ -181,7 +199,7 @@ describe('native.js', function () {
       }
 
     };
-    const targeting = getNativeTargeting(bid, bidRequest);
+    const targeting = getNativeTargeting(bid, deps(adUnit));
 
     expect(Object.keys(targeting)).to.deep.equal([
       CONSTANTS.NATIVE_KEYS.title,
@@ -193,7 +211,8 @@ describe('native.js', function () {
   });
 
   it('should copy over rendererUrl to bid object and include it in targeting', function () {
-    const bidRequest = {
+    const adUnit = {
+      transactionId: 'au',
       nativeParams: {
         image: {
           required: true,
@@ -209,7 +228,7 @@ describe('native.js', function () {
       }
 
     };
-    const targeting = getNativeTargeting(bid, bidRequest);
+    const targeting = getNativeTargeting(bid, deps(adUnit));
 
     expect(Object.keys(targeting)).to.deep.equal([
       CONSTANTS.NATIVE_KEYS.title,
@@ -227,7 +246,8 @@ describe('native.js', function () {
   });
 
   it('should copy over adTemplate to bid object and include it in targeting', function () {
-    const bidRequest = {
+    const adUnit = {
+      transactionId: 'au',
       nativeParams: {
         image: {
           required: true,
@@ -241,7 +261,7 @@ describe('native.js', function () {
       }
 
     };
-    const targeting = getNativeTargeting(bid, bidRequest);
+    const targeting = getNativeTargeting(bid, deps(adUnit));
 
     expect(Object.keys(targeting)).to.deep.equal([
       CONSTANTS.NATIVE_KEYS.title,
@@ -374,35 +394,33 @@ describe('native.js', function () {
 });
 
 describe('validate native', function () {
-  let bidReq = [{
-    bids: [{
-      bidderCode: 'test_bidder',
-      bidId: 'test_bid_id',
-      mediaTypes: {
-        native: {
-          title: {
-            required: true,
-          },
-          body: {
-            required: true,
-          },
-          image: {
-            required: true,
-            sizes: [150, 50],
-            aspect_ratios: [150, 50]
-          },
-          icon: {
-            required: true,
-            sizes: [50, 50]
-          },
-        }
+  const adUnit = {
+    transactionId: 'test_adunit',
+    mediaTypes: {
+      native: {
+        title: {
+          required: true,
+        },
+        body: {
+          required: true,
+        },
+        image: {
+          required: true,
+          sizes: [150, 50],
+          aspect_ratios: [150, 50]
+        },
+        icon: {
+          required: true,
+          sizes: [50, 50]
+        },
       }
-    }]
-  }];
+    }
+  }
 
   let validBid = {
     adId: 'abc123',
     requestId: 'test_bid_id',
+    transactionId: 'test_adunit',
     adUnitCode: '123/prebid_native_adunit',
     bidder: 'test_bidder',
     native: {
@@ -428,6 +446,7 @@ describe('validate native', function () {
   let noIconDimBid = {
     adId: 'abc234',
     requestId: 'test_bid_id',
+    transactionId: 'test_adunit',
     adUnitCode: '123/prebid_native_adunit',
     bidder: 'test_bidder',
     native: {
@@ -449,6 +468,7 @@ describe('validate native', function () {
   let noImgDimBid = {
     adId: 'abc345',
     requestId: 'test_bid_id',
+    transactionId: 'test_adunit',
     adUnitCode: '123/prebid_native_adunit',
     bidder: 'test_bidder',
     native: {
@@ -472,11 +492,13 @@ describe('validate native', function () {
   afterEach(function () {});
 
   it('should accept bid if no image sizes are defined', function () {
-    let result = nativeBidIsValid(validBid, bidReq);
+    decorateAdUnitsWithNativeParams([adUnit]);
+    const index = stubAuctionIndex({adUnits: [adUnit]})
+    let result = nativeBidIsValid(validBid, {index});
     expect(result).to.be.true;
-    result = nativeBidIsValid(noIconDimBid, bidReq);
+    result = nativeBidIsValid(noIconDimBid, {index});
     expect(result).to.be.true;
-    result = nativeBidIsValid(noImgDimBid, bidReq);
+    result = nativeBidIsValid(noImgDimBid, {index});
     expect(result).to.be.true;
   });
 });

package/test/spec/unit/core/adapterManager_spec.js

@@ -14,6 +14,7 @@ import { setSizeConfig } from 'src/sizeMapping.js';
 import find from 'core-js-pure/features/array/find.js';
 import includes from 'core-js-pure/features/array/includes.js';
 import s2sTesting from 'modules/s2sTesting.js';
+import {hook} from '../../../../src/hook.js';
 var events = require('../../../../src/events');
 
 const CONFIG = {
@@ -90,6 +91,7 @@ describe('adapterManager tests', function () {
   describe('callBids', function () {
     before(function () {
       config.setConfig({s2sConfig: { enabled: false }});
+      hook.ready();
     });
 
     beforeEach(function () {
@@ -1668,6 +1670,26 @@ describe('adapterManager tests', function () {
       })
     });
 
+    it('should add nativeParams to adUnits after BEFORE_REQUEST_BIDS', () => {
+      function beforeReqBids(adUnits) {
+        adUnits.forEach(adUnit => {
+          adUnit.mediaTypes.native = {
+            type: 'image',
+          }
+        })
+      }
+      events.on(CONSTANTS.EVENTS.BEFORE_REQUEST_BIDS, beforeReqBids);
+      adapterManager.makeBidRequests(
+        adUnits,
+        Date.now(),
+        utils.getUniqueIdentifierStr(),
+        function callback() {},
+        []
+      );
+      events.off(CONSTANTS.EVENTS.BEFORE_REQUEST_BIDS, beforeReqBids);
+      expect(adUnits.map((u) => u.nativeParams).some(i => i == null)).to.be.false;
+    });
+
     it('should make separate bidder request objects for each bidder', () => {
       adUnits = [utils.deepClone(getAdUnits()[0])];
 

package/test/spec/unit/core/auctionIndex_spec.js

@@ -0,0 +1,129 @@
+import {AuctionIndex} from '../../../../src/auctionIndex.js';
+
+describe('auction index', () => {
+  let index, auctions;
+
+  function mockAuction(id, adUnits, bidderRequests) {
+    return {
+      getAuctionId() { return id },
+      getAdUnits() { return adUnits; },
+      getBidRequests() { return bidderRequests; }
+    }
+  }
+
+  beforeEach(() => {
+    auctions = [];
+    index = new AuctionIndex(() => auctions);
+  })
+
+  describe('getAuction', () => {
+    beforeEach(() => {
+      auctions = [mockAuction('a1'), mockAuction('a2')];
+    });
+
+    it('should find auctions by auctionId', () => {
+      expect(index.getAuction({auctionId: 'a1'})).to.equal(auctions[0]);
+    });
+
+    it('should return undef if auction is missing', () => {
+      expect(index.getAuction({auctionId: 'missing'})).to.be.undefined;
+    });
+
+    it('should return undef if no auctionId is provided', () => {
+      expect(index.getAuction({})).to.be.undefined;
+    });
+  });
+
+  describe('getAdUnit', () => {
+    let adUnits;
+
+    beforeEach(() => {
+      adUnits = [{transactionId: 'au1'}, {transactionId: 'au2'}];
+      auctions = [
+        mockAuction('a1', [adUnits[0], {}]),
+        mockAuction('a2', [adUnits[1]])
+      ];
+    });
+
+    it('should find adUnits by transactionId', () => {
+      expect(index.getAdUnit({transactionId: 'au2'})).to.equal(adUnits[1]);
+    });
+
+    it('should return undefined if adunit is missing', () => {
+      expect(index.getAdUnit({transactionId: 'missing'})).to.be.undefined;
+    });
+
+    it('should return undefined if no transactionId is provided', () => {
+      expect(index.getAdUnit({})).to.be.undefined;
+    });
+  });
+
+  describe('getBidRequest', () => {
+    let bidRequests;
+    beforeEach(() => {
+      bidRequests = [{bidId: 'b1'}, {bidId: 'b2'}];
+      auctions = [
+        mockAuction('a1', [], [{bids: [bidRequests[0], {}]}]),
+        mockAuction('a2', [], [{bids: [bidRequests[1]]}])
+      ]
+    });
+
+    it('should find bidRequests by requestId', () => {
+      expect(index.getBidRequest({requestId: 'b2'})).to.equal(bidRequests[1]);
+    });
+
+    it('should return undef if bidRequest is missing', () => {
+      expect(index.getBidRequest({requestId: 'missing'})).to.be.undefined;
+    });
+
+    it('should return undef if no requestId is provided', () => {
+      expect(index.getBidRequest({})).to.be.undefined;
+    });
+  });
+
+  describe('getMediaTypes', () => {
+    let bidderRequests, mediaTypes, adUnits;
+
+    beforeEach(() => {
+      mediaTypes = [{mockMT: '1'}, {mockMT: '2'}, {mockMT: '3'}, {mockMT: '4'}]
+      adUnits = [
+        {transactionId: 'au1', mediaTypes: mediaTypes[0]},
+        {transactionId: 'au2', mediaTypes: mediaTypes[1]}
+      ]
+      bidderRequests = [
+        {bidderRequestId: 'ber1', bids: [{bidId: 'b1', mediaTypes: mediaTypes[2], transactionId: 'au1'}, {}]},
+        {bidderRequestId: 'ber2', bids: [{bidId: 'b2', mediaTypes: mediaTypes[3], transactionId: 'au2'}]}
+      ]
+      auctions = [
+        mockAuction('a1', [adUnits[0]], [bidderRequests[0], {}]),
+        mockAuction('a2', [adUnits[1]], [bidderRequests[1]])
+      ]
+    });
+
+    it('should find mediaTypes by transactionId', () => {
+      expect(index.getMediaTypes({transactionId: 'au2'})).to.equal(mediaTypes[1]);
+    });
+
+    it('should find mediaTypes by requestId', () => {
+      expect(index.getMediaTypes({requestId: 'b1'})).to.equal(mediaTypes[2]);
+    });
+
+    it('should give precedence to request.mediaTypes over adUnit.mediaTypes', () => {
+      expect(index.getMediaTypes({requestId: 'b2', transactionId: 'au2'})).to.equal(mediaTypes[3]);
+    });
+
+    it('should return undef if requestId and transactionId do not match', () => {
+      expect(index.getMediaTypes({requestId: 'b1', transactionId: 'au2'})).to.be.undefined;
+    });
+
+    it('should return undef if no params are provided', () => {
+      expect(index.getMediaTypes({})).to.be.undefined;
+    });
+
+    ['requestId', 'transactionId'].forEach(param => {
+      it(`should return undef if ${param} is missing`, () => {
+        expect(index.getMediaTypes({[param]: 'missing'})).to.be.undefined;
+      });
+    })
+  });
+});

package/test/spec/unit/core/bidderFactory_spec.js

@@ -8,6 +8,9 @@ import { config } from 'src/config.js';
 import { server } from 'test/mocks/xhr.js';
 import CONSTANTS from 'src/constants.json';
 import events from 'src/events.js';
+import {hook} from '../../../../src/hook.js';
+import {auctionManager} from '../../../../src/auctionManager.js';
+import {stubAuctionIndex} from '../../../helpers/indexStub.js';
 
 const CODE = 'sampleBidder';
 const MOCK_BIDS_REQUEST = {
@@ -43,6 +46,10 @@ describe('bidders created by newBidder', function () {
   let addBidResponseStub;
   let doneStub;
 
+  before(() => {
+    hook.ready();
+  });
+
   beforeEach(function () {
     spec = {
       code: CODE,
@@ -59,17 +66,22 @@ describe('bidders created by newBidder', function () {
   describe('when the ajax response is irrelevant', function () {
     let ajaxStub;
     let getConfigSpy;
+    let aliasRegistryStub, aliasRegistry;
 
     beforeEach(function () {
       ajaxStub = sinon.stub(ajax, 'ajax');
       addBidResponseStub.reset();
       getConfigSpy = sinon.spy(config, 'getConfig');
       doneStub.reset();
+      aliasRegistry = {};
+      aliasRegistryStub = sinon.stub(adapterManager, 'aliasRegistry');
+      aliasRegistryStub.get(() => aliasRegistry);
     });
 
     afterEach(function () {
       ajaxStub.restore();
       getConfigSpy.restore();
+      aliasRegistryStub.restore();
     });
 
     it('should let registerSyncs run with invalid alias and aliasSync enabled', function () {
@@ -116,6 +128,7 @@ describe('bidders created by newBidder', function () {
       });
       spec.code = 'aliasBidder';
       const bidder = newBidder(spec);
+      aliasRegistry = {[spec.code]: CODE};
       bidder.callBids({ bids: [] }, addBidResponseStub, doneStub, ajaxStub, onTimelyResponseStub, wrappedCallback);
       expect(getConfigSpy.withArgs('userSync.filterSettings').calledOnce).to.equal(false);
     });
@@ -548,6 +561,30 @@ describe('bidders created by newBidder', function () {
 
       expect(logErrorSpy.calledOnce).to.equal(true);
     });
+
+    it('should require requestId from interpretResponse', () => {
+      const bidder = newBidder(spec);
+      const bid = {
+        'ad': 'creative',
+        'cpm': '1.99',
+        'creativeId': 'some-id',
+        'currency': 'USD',
+        'netRevenue': true,
+        'ttl': 360
+      };
+      spec.isBidRequestValid.returns(true);
+      spec.buildRequests.returns({
+        method: 'POST',
+        url: 'test.url.com',
+        data: {}
+      });
+      spec.getUserSyncs.returns([]);
+      spec.interpretResponse.returns(bid);
+
+      bidder.callBids(MOCK_BIDS_REQUEST, addBidResponseStub, doneStub, ajaxStub, onTimelyResponseStub, wrappedCallback);
+
+      expect(addBidResponseStub.called).to.be.false;
+    });
   });
 
   describe('when the ajax call fails', function () {
@@ -783,7 +820,7 @@ describe('registerBidder', function () {
 
 describe('validate bid response: ', function () {
   let spec;
-  let bidder;
+  let indexStub, adUnits, bidderRequests;
   let addBidResponseStub;
   let doneStub;
   let ajaxStub;
@@ -824,25 +861,34 @@ describe('validate bid response: ', function () {
       callbacks.success('response body', { getResponseHeader: fakeResponse });
     });
     logErrorSpy = sinon.spy(utils, 'logError');
+    indexStub = sinon.stub(auctionManager, 'index');
+    adUnits = [];
+    bidderRequests = [];
+    indexStub.get(() => stubAuctionIndex({adUnits: adUnits, bidderRequests: bidderRequests}))
   });
 
   afterEach(function () {
     ajaxStub.restore();
     logErrorSpy.restore();
+    indexStub.restore;
   });
 
   it('should add native bids that do have required assets', function () {
+    adUnits = [{
+      transactionId: 'au',
+      nativeParams: {
+        title: {'required': true},
+      }
+    }]
     let bidRequest = {
       bids: [{
         bidId: '1',
         auctionId: 'first-bid-id',
         adUnitCode: 'mock/placement',
+        transactionId: 'au',
         params: {
           param: 5
         },
-        nativeParams: {
-          title: {'required': true},
-        },
         mediaType: 'native',
       }]
     };
@@ -869,21 +915,24 @@ describe('validate bid response: ', function () {
   });
 
   it('should not add native bids that do not have required assets', function () {
+    adUnits = [{
+      transactionId: 'au',
+      nativeParams: {
+        title: {'required': true},
+      },
+    }];
     let bidRequest = {
       bids: [{
         bidId: '1',
         auctionId: 'first-bid-id',
         adUnitCode: 'mock/placement',
+        transactionId: 'au',
         params: {
           param: 5
         },
-        nativeParams: {
-          title: {'required': true},
-        },
         mediaType: 'native',
       }]
     };
-
     let bids1 = Object.assign({},
       bids[0],
       {
@@ -905,17 +954,21 @@ describe('validate bid response: ', function () {
   });
 
   it('should add bid when renderer is present on outstream bids', function () {
+    adUnits = [{
+      transactionId: 'au',
+      mediaTypes: {
+        video: {context: 'outstream'}
+      }
+    }]
     let bidRequest = {
       bids: [{
         bidId: '1',
         auctionId: 'first-bid-id',
+        transactionId: 'au',
         adUnitCode: 'mock/placement',
         params: {
           param: 5
         },
-        mediaTypes: {
-          video: {context: 'outstream'}
-        }
       }]
     };
 
@@ -951,7 +1004,7 @@ describe('validate bid response: ', function () {
         sizes: [[300, 250]],
       }]
     };
-
+    bidderRequests = [bidRequest];
     let bids1 = Object.assign({},
       bids[0],
       {