prebid.js 7.18.0 → 7.20.0

package/test/spec/auctionmanager_spec.js

@@ -21,6 +21,7 @@ import {auctionManager} from '../../src/auctionManager.js';
 import 'modules/debugging/index.js' // some tests look for debugging side effects
 import {AuctionIndex} from '../../src/auctionIndex.js';
 import {expect} from 'chai';
+import {deepClone} from '../../src/utils.js';
 
 var assert = require('assert');
 
@@ -57,7 +58,16 @@ function mockBid(opts) {
     'currency': 'USD',
     'netRevenue': true,
     'ttl': 360,
-    getSize: () => '300x250'
+    getSize: () => '300x250',
+    getIdentifiers() {
+      return {
+        src: this.source,
+        bidder: this.bidderCode,
+        bidId: this.requestId,
+        transactionId: this.transactionId,
+        auctionId: this.auctionId
+      }
+    }
   };
 }
 
@@ -1323,6 +1333,7 @@ describe('auctionmanager.js', function () {
       getAdUnits: () => getBidRequests().flatMap(br => br.bids).map(br => ({ code: br.adUnitCode, transactionId: br.transactionId, mediaTypes: br.mediaTypes })),
       getAuctionId: () => '1',
       addBidReceived: () => true,
+      addBidRejected: () => true,
       getTimeout: () => 1000,
       getAuctionStart: () => start,
     }
@@ -1382,26 +1393,32 @@ describe('auctionmanager.js', function () {
       bidRequests = null;
     });
 
-    it('should call auction done after bid is added to auction for mediaType banner', function () {
-      let ADUNIT_CODE2 = 'adUnitCode2';
-      let BIDDER_CODE2 = 'sampleBidder2';
-
-      let bids1 = [mockBid({ bidderCode: BIDDER_CODE1, transactionId: ADUNIT_CODE1 })];
-      let bids2 = [mockBid({ bidderCode: BIDDER_CODE2, transactionId: ADUNIT_CODE2 })];
-      bidRequests = [
-        mockBidRequest(bids[0]),
-        mockBidRequest(bids1[0], { adUnitCode: ADUNIT_CODE1 }),
-        mockBidRequest(bids2[0], { adUnitCode: ADUNIT_CODE2 })
-      ];
-      let cbs = auctionCallbacks(doneSpy, auction);
-      cbs.addBidResponse.call(bidRequests[0], ADUNIT_CODE, bids[0]);
-      cbs.adapterDone.call(bidRequests[0]);
-      cbs.addBidResponse.call(bidRequests[1], ADUNIT_CODE1, bids1[0]);
-      cbs.adapterDone.call(bidRequests[1]);
-      cbs.addBidResponse.call(bidRequests[2], ADUNIT_CODE2, bids2[0]);
-      cbs.adapterDone.call(bidRequests[2]);
-      assert.equal(doneSpy.callCount, 1);
-    });
+    Object.entries({
+      'added to': (cbs) => cbs.addBidResponse,
+      'rejected from': (cbs) => cbs.addBidResponse.reject,
+    }).forEach(([t, getMethod]) => {
+      it(`should call auction done after bid is ${t} auction for mediaType banner`, function () {
+        let ADUNIT_CODE2 = 'adUnitCode2';
+        let BIDDER_CODE2 = 'sampleBidder2';
+
+        let bids1 = [mockBid({ bidderCode: BIDDER_CODE1, transactionId: ADUNIT_CODE1 })];
+        let bids2 = [mockBid({ bidderCode: BIDDER_CODE2, transactionId: ADUNIT_CODE2 })];
+        bidRequests = [
+          mockBidRequest(bids[0]),
+          mockBidRequest(bids1[0], { adUnitCode: ADUNIT_CODE1 }),
+          mockBidRequest(bids2[0], { adUnitCode: ADUNIT_CODE2 })
+        ];
+        let cbs = auctionCallbacks(doneSpy, auction);
+        const method = getMethod(cbs);
+        method(ADUNIT_CODE, bids[0]);
+        cbs.adapterDone.call(bidRequests[0]);
+        method(ADUNIT_CODE1, bids1[0]);
+        cbs.adapterDone.call(bidRequests[1]);
+        method(ADUNIT_CODE2, bids2[0]);
+        cbs.adapterDone.call(bidRequests[2]);
+        assert.equal(doneSpy.callCount, 1);
+      });
+    })
 
     it('should call auction done after prebid cache is complete for mediaType video', function() {
       bids[0].mediaType = 'video';
@@ -1543,6 +1560,77 @@ describe('auctionmanager.js', function () {
         });
       })
     });
+
+    describe('when bids are rejected', () => {
+      let cbs, bid, expectedRejection;
+      const onBidRejected = sinon.stub();
+      const REJECTION_REASON = 'Bid rejected';
+      const AU_CODE = 'au';
+
+      function rejectHook(fn, adUnitCode, bid, reject) {
+        reject(REJECTION_REASON);
+        reject(REJECTION_REASON); // second call should do nothing
+      }
+
+      before(() => {
+        addBidResponse.before(rejectHook, 999);
+        events.on(CONSTANTS.EVENTS.BID_REJECTED, onBidRejected);
+      });
+
+      after(() => {
+        addBidResponse.getHooks({hook: rejectHook}).remove();
+        events.off(CONSTANTS.EVENTS.BID_REJECTED, onBidRejected);
+      });
+
+      beforeEach(() => {
+        onBidRejected.reset();
+        bid = mockBid({bidderCode: BIDDER_CODE});
+        bidRequests = [
+          mockBidRequest(bid),
+        ];
+        cbs = auctionCallbacks(doneSpy, auction);
+        expectedRejection = sinon.match(Object.assign({}, bid, {
+          rejectionReason: REJECTION_REASON,
+          adUnitCode: AU_CODE
+        }));
+        auction.addBidRejected = sinon.stub();
+      });
+
+      Object.entries({
+        'with addBidResponse.reject': () => cbs.addBidResponse.reject(AU_CODE, deepClone(bid), REJECTION_REASON),
+        'from addBidResponse hooks': () => cbs.addBidResponse(AU_CODE, deepClone(bid))
+      }).forEach(([t, rejectBid]) => {
+        describe(t, () => {
+          it('should emit a BID_REJECTED event', () => {
+            rejectBid();
+            sinon.assert.calledWith(onBidRejected, expectedRejection);
+          });
+
+          it('should pass bid to auction.addBidRejected', () => {
+            rejectBid();
+            sinon.assert.calledWith(auction.addBidRejected, expectedRejection);
+          });
+        })
+      });
+
+      it('should return a NO_BID replacement', () => {
+        const noBid = cbs.addBidResponse.reject(AU_CODE, {...bid, statusMessage: 'Bid available', status: CONSTANTS.BID_STATUS.RENDERED}, 'Rejected');
+        sinon.assert.match(noBid, {
+          status: CONSTANTS.BID_STATUS.BID_REJECTED,
+          statusMessage: 'Bid returned empty or error response',
+          cpm: 0,
+          requestId: bid.requestId,
+          auctionId: bid.auctionId,
+          adUnitCode: AU_CODE,
+          rejectionReason: undefined,
+        });
+      });
+
+      it('addBidResponse hooks should not be able to reject the same bid twice', () => {
+        cbs.addBidResponse(AU_CODE, bid);
+        expect(auction.addBidRejected.calledOnce).to.be.true;
+      });
+    })
   });
 
   describe('auctionOptions', function() {

package/test/spec/cpmBucketManager_spec.js

@@ -1,195 +1,257 @@
 import { expect } from 'chai';
-import {getPriceBucketString, isValidPriceConfig} from 'src/cpmBucketManager.js';
+import { getPriceBucketString, isValidPriceConfig } from 'src/cpmBucketManager.js';
+import { config } from 'src/config.js';
+
 let cpmFixtures = require('test/fixtures/cpmInputsOutputs.json');
 
 describe('cpmBucketManager', function () {
-  it('getPriceBucketString function generates the correct price strings', function () {
-    let input = cpmFixtures.cpmInputs;
-    for (let i = 0; i < input.length; i++) {
-      let output = getPriceBucketString(input[i]);
-      let jsonOutput = JSON.stringify(output);
-      expect(jsonOutput).to.deep.equal(JSON.stringify(cpmFixtures.priceStringOutputs[i]));
-    }
-  });
-
-  it('gets the correct custom bucket strings', function () {
-    let cpm = 16.50908;
-    let customConfig = {
-      'buckets': [{
-        'precision': 4,
-        'max': 3,
-        'increment': 0.01,
-      },
-      {
-        'precision': 4,
-        'max': 18,
-        'increment': 0.05,
-        'cap': true
+  describe('getPriceBucketString', function () {
+    it('getPriceBucketString function generates the correct price strings', function () {
+      let input = cpmFixtures.cpmInputs;
+      for (let i = 0; i < input.length; i++) {
+        let output = getPriceBucketString(input[i]);
+        let jsonOutput = JSON.stringify(output);
+        expect(jsonOutput).to.deep.equal(JSON.stringify(cpmFixtures.priceStringOutputs[i]));
       }
-      ]
-    };
-    let expected = '{"low":"5.00","med":"16.50","high":"16.50","auto":"16.50","dense":"16.50","custom":"16.5000"}';
-    let output = getPriceBucketString(cpm, customConfig);
-    expect(JSON.stringify(output)).to.deep.equal(expected);
-  });
+    });
 
-  it('gets the correct custom bucket strings with irregular increment', function () {
-    let cpm = 14.50908;
-    let customConfig = {
-      'buckets': [{
-        'precision': 4,
-        'max': 4,
-        'increment': 0.01,
-      },
-      {
-        'precision': 4,
-        'max': 18,
-        'increment': 0.3,
-        'cap': true
-      }
-      ]
-    };
-    let expected = '{"low":"5.00","med":"14.50","high":"14.50","auto":"14.50","dense":"14.50","custom":"14.5000"}';
-    let output = getPriceBucketString(cpm, customConfig);
-    expect(JSON.stringify(output)).to.deep.equal(expected);
-  });
-
-  it('gets the correct custom bucket strings in non-USD currency', function () {
-    let cpm = 16.50908 * 110.49;
-    let customConfig = {
-      'buckets': [{
-        'precision': 4,
-        'max': 3,
-        'increment': 0.01,
-      },
-      {
-        'precision': 4,
-        'max': 18,
-        'increment': 0.05,
-        'cap': true
-      }
-      ]
-    };
-    let expected = '{"low":"552.45","med":"1823.09","high":"1823.09","auto":"1823.09","dense":"1823.09","custom":"1823.0850"}';
-    let output = getPriceBucketString(cpm, customConfig, 110.49);
-    expect(JSON.stringify(output)).to.deep.equal(expected);
-  });
-
-  it('gets the correct custom bucket strings with specific cpms that round oddly with certain increments', function () {
-    let customConfig = {
-      'buckets': [{
-        'precision': 4,
-        'max': 4,
-        'increment': 0.10,
-      }]
-    };
-    let cpm = 2.21;
-    let expected = '{"low":"2.00","med":"2.20","high":"2.21","auto":"2.20","dense":"2.21","custom":"2.2000"}';
-    let output = getPriceBucketString(cpm, customConfig);
-    expect(JSON.stringify(output)).to.deep.equal(expected);
-
-    cpm = 3.15;
-    expected = '{"low":"3.00","med":"3.10","high":"3.15","auto":"3.15","dense":"3.15","custom":"3.1000"}';
-    output = getPriceBucketString(cpm, customConfig);
-    expect(JSON.stringify(output)).to.deep.equal(expected);
-
-    customConfig = {
-      'buckets': [{
-        'precision': 3,
-        'max': 6,
-        'increment': 0.08,
-      }]
-    };
-    cpm = 4.89;
-    expected = '{"low":"4.50","med":"4.80","high":"4.89","auto":"4.85","dense":"4.85","custom":"4.880"}';
-    output = getPriceBucketString(cpm, customConfig);
-    expect(JSON.stringify(output)).to.deep.equal(expected);
-
-    customConfig = {
-      'buckets': [{
-        'precision': 3,
-        'max': 6,
-        'increment': 0.05,
-      }]
-    };
-    cpm = 2.98;
-    expected = '{"low":"2.50","med":"2.90","high":"2.98","auto":"2.95","dense":"2.98","custom":"2.950"}';
-    output = getPriceBucketString(cpm, customConfig);
-    expect(JSON.stringify(output)).to.deep.equal(expected);
-
-    cpm = 2.99;
-    expected = '{"low":"2.50","med":"2.90","high":"2.99","auto":"2.95","dense":"2.99","custom":"2.950"}';
-    output = getPriceBucketString(cpm, customConfig);
-    expect(JSON.stringify(output)).to.deep.equal(expected);
-
-    customConfig = {
-      'buckets': [{
-        'precision': 2,
-        'max': 6,
-        'increment': 0.01,
-      }]
-    };
-    cpm = 4.01;
-    expected = '{"low":"4.00","med":"4.00","high":"4.01","auto":"4.00","dense":"4.00","custom":"4.01"}';
-    output = getPriceBucketString(cpm, customConfig);
-    expect(JSON.stringify(output)).to.deep.equal(expected);
-
-    cpm = 4.68;
-    expected = '{"low":"4.50","med":"4.60","high":"4.68","auto":"4.65","dense":"4.65","custom":"4.68"}';
-    output = getPriceBucketString(cpm, customConfig);
-    expect(JSON.stringify(output)).to.deep.equal(expected);
-
-    cpm = 4.69;
-    expected = '{"low":"4.50","med":"4.60","high":"4.69","auto":"4.65","dense":"4.65","custom":"4.69"}';
-    output = getPriceBucketString(cpm, customConfig);
-    expect(JSON.stringify(output)).to.deep.equal(expected);
-  });
-
-  it('gets custom bucket strings and it should honor 0', function () {
-    let cpm = 16.50908;
-    let customConfig = {
-      'buckets': [
+    it('gets the correct custom bucket strings', function () {
+      let cpm = 16.50908;
+      let customConfig = {
+        'buckets': [{
+          'precision': 4,
+          'max': 3,
+          'increment': 0.01,
+        },
         {
-          'precision': 0,
+          'precision': 4,
           'max': 18,
           'increment': 0.05,
-        }
-      ]
-    };
-    let expected = '{"low":"5.00","med":"16.50","high":"16.50","auto":"16.50","dense":"16.50","custom":"17"}';
-    let output = getPriceBucketString(cpm, customConfig);
-    expect(JSON.stringify(output)).to.deep.equal(expected);
-  });
+          'cap': true
+        }]
+      };
+      let expected = '{"low":"5.00","med":"16.50","high":"16.50","auto":"16.50","dense":"16.50","custom":"16.5000"}';
+      let output = getPriceBucketString(cpm, customConfig);
+      expect(JSON.stringify(output)).to.deep.equal(expected);
+    });
 
-  it('gets the custom bucket strings without passing precision and it should honor the default precision', function () {
-    let cpm = 16.50908;
-    let customConfig = {
-      'buckets': [
+    it('gets the correct custom bucket strings with irregular increment', function () {
+      let cpm = 14.50908;
+      let customConfig = {
+        'buckets': [{
+          'precision': 4,
+          'max': 4,
+          'increment': 0.01,
+        },
         {
+          'precision': 4,
+          'max': 18,
+          'increment': 0.3,
+          'cap': true
+        }]
+      };
+      let expected = '{"low":"5.00","med":"14.50","high":"14.50","auto":"14.50","dense":"14.50","custom":"14.5000"}';
+      let output = getPriceBucketString(cpm, customConfig);
+      expect(JSON.stringify(output)).to.deep.equal(expected);
+    });
+
+    it('gets the correct custom bucket strings in non-USD currency', function () {
+      let cpm = 16.50908 * 110.49;
+      let customConfig = {
+        'buckets': [{
+          'precision': 4,
+          'max': 3,
+          'increment': 0.01,
+        },
+        {
+          'precision': 4,
           'max': 18,
           'increment': 0.05,
-        }
-      ]
-    };
-    let expected = '{"low":"5.00","med":"16.50","high":"16.50","auto":"16.50","dense":"16.50","custom":"16.50"}';
-    let output = getPriceBucketString(cpm, customConfig);
-    expect(JSON.stringify(output)).to.deep.equal(expected);
+          'cap': true
+        }]
+      };
+      let expected = '{"low":"552.45","med":"1823.09","high":"1823.09","auto":"1823.09","dense":"1823.09","custom":"1823.0850"}';
+      let output = getPriceBucketString(cpm, customConfig, 110.49);
+      expect(JSON.stringify(output)).to.deep.equal(expected);
+    });
+
+    it('gets the correct custom bucket strings with specific cpms that round oddly with certain increments', function () {
+      let customConfig = {
+        'buckets': [{
+          'precision': 4,
+          'max': 4,
+          'increment': 0.10,
+        }]
+      };
+      let cpm = 2.21;
+      let expected = '{"low":"2.00","med":"2.20","high":"2.21","auto":"2.20","dense":"2.21","custom":"2.2000"}';
+      let output = getPriceBucketString(cpm, customConfig);
+      expect(JSON.stringify(output)).to.deep.equal(expected);
+
+      cpm = 3.15;
+      expected = '{"low":"3.00","med":"3.10","high":"3.15","auto":"3.15","dense":"3.15","custom":"3.1000"}';
+      output = getPriceBucketString(cpm, customConfig);
+      expect(JSON.stringify(output)).to.deep.equal(expected);
+
+      customConfig = {
+        'buckets': [{
+          'precision': 3,
+          'max': 6,
+          'increment': 0.08,
+        }]
+      };
+      cpm = 4.89;
+      expected = '{"low":"4.50","med":"4.80","high":"4.89","auto":"4.85","dense":"4.85","custom":"4.880"}';
+      output = getPriceBucketString(cpm, customConfig);
+      expect(JSON.stringify(output)).to.deep.equal(expected);
+
+      customConfig = {
+        'buckets': [{
+          'precision': 3,
+          'max': 6,
+          'increment': 0.05,
+        }]
+      };
+      cpm = 2.98;
+      expected = '{"low":"2.50","med":"2.90","high":"2.98","auto":"2.95","dense":"2.98","custom":"2.950"}';
+      output = getPriceBucketString(cpm, customConfig);
+      expect(JSON.stringify(output)).to.deep.equal(expected);
+
+      cpm = 2.99;
+      expected = '{"low":"2.50","med":"2.90","high":"2.99","auto":"2.95","dense":"2.99","custom":"2.950"}';
+      output = getPriceBucketString(cpm, customConfig);
+      expect(JSON.stringify(output)).to.deep.equal(expected);
+
+      customConfig = {
+        'buckets': [{
+          'precision': 2,
+          'max': 6,
+          'increment': 0.01,
+        }]
+      };
+      cpm = 4.01;
+      expected = '{"low":"4.00","med":"4.00","high":"4.01","auto":"4.00","dense":"4.00","custom":"4.01"}';
+      output = getPriceBucketString(cpm, customConfig);
+      expect(JSON.stringify(output)).to.deep.equal(expected);
+
+      cpm = 4.68;
+      expected = '{"low":"4.50","med":"4.60","high":"4.68","auto":"4.65","dense":"4.65","custom":"4.68"}';
+      output = getPriceBucketString(cpm, customConfig);
+      expect(JSON.stringify(output)).to.deep.equal(expected);
+
+      cpm = 4.69;
+      expected = '{"low":"4.50","med":"4.60","high":"4.69","auto":"4.65","dense":"4.65","custom":"4.69"}';
+      output = getPriceBucketString(cpm, customConfig);
+      expect(JSON.stringify(output)).to.deep.equal(expected);
+    });
+
+    it('gets custom bucket strings and it should honor 0', function () {
+      let cpm = 16.50908;
+      let customConfig = {
+        'buckets': [
+          {
+            'precision': 0,
+            'max': 18,
+            'increment': 0.05,
+          }
+        ]
+      };
+      let expected = '{"low":"5.00","med":"16.50","high":"16.50","auto":"16.50","dense":"16.50","custom":"17"}';
+      let output = getPriceBucketString(cpm, customConfig);
+      expect(JSON.stringify(output)).to.deep.equal(expected);
+    });
+
+    it('gets the custom bucket strings without passing precision and it should honor the default precision', function () {
+      let cpm = 16.50908;
+      let customConfig = {
+        'buckets': [
+          {
+            'max': 18,
+            'increment': 0.05,
+          }
+        ]
+      };
+      let expected = '{"low":"5.00","med":"16.50","high":"16.50","auto":"16.50","dense":"16.50","custom":"16.50"}';
+      let output = getPriceBucketString(cpm, customConfig);
+      expect(JSON.stringify(output)).to.deep.equal(expected);
+    });
+
+    it('defaults to Math.floor if no rounding function is provided', function () {
+      let cpm = 6.516;
+      let customConfig = {
+        'buckets': [
+          {
+            'max': 18,
+            'increment': 0.05,
+          }
+        ]
+      };
+      let expected = '{"low":"5.00","med":"6.50","high":"6.51","auto":"6.50","dense":"6.50","custom":"6.50"}';
+      let output = getPriceBucketString(cpm, customConfig);
+      expect(JSON.stringify(output)).to.deep.equal(expected);
+    });
+
+    it('accepts custom rounding functions', function () {
+      let cpm = 6.516;
+      let customConfig = {
+        'buckets': [
+          {
+            'max': 18,
+            'increment': 0.05,
+          }
+        ]
+      };
+      let getConfig = config.getConfig;
+      config.getConfig = () => Math.ceil;
+      let expected = '{"low":"5.00","med":"6.60","high":"6.52","auto":"6.60","dense":"6.55","custom":"6.55"}';
+      let output = getPriceBucketString(cpm, customConfig);
+      config.getConfig = getConfig;
+      expect(JSON.stringify(output)).to.deep.equal(expected);
+    });
+
+    it('will default to Math.floor if passed an invalid rounding function', function () {
+      let cpm = 6.516;
+      let customConfig = {
+        'buckets': [
+          {
+            'max': 18,
+            'increment': 0.05,
+          }
+        ]
+      };
+      let getConfig = config.getConfig;
+      config.getConfig = () => Math.ceil(5.3);
+      let expected = '{"low":"5.00","med":"6.50","high":"6.51","auto":"6.50","dense":"6.50","custom":"6.50"}';
+      let output = getPriceBucketString(cpm, customConfig);
+      config.getConfig = getConfig;
+      expect(JSON.stringify(output)).to.deep.equal(expected);
+    });
   });
 
-  it('checks whether custom config is valid', function () {
-    let badConfig = {
-      'buckets': [{
-        'max': 3,
-        'increment': 0.01,
-      },
-      {
-        'max': 18,
-        // missing increment prop
-        'cap': true
-      }
-      ]
-    };
+  describe('isValidPriceConfig', function () {
+    it('checks whether custom config is valid', function () {
+      let badConfig = {
+        'buckets': [{
+          'max': 3,
+          'increment': 0.01,
+        },
+        {
+          'max': 18,
+          // missing increment prop
+          'cap': true
+        }]
+      };
+      expect(isValidPriceConfig(badConfig)).to.be.false;
 
-    expect(isValidPriceConfig(badConfig)).to.be.false;
+      let customConfig = {
+        'buckets': [
+          {
+            'max': 18,
+            'increment': 0.05,
+          }
+        ]
+      };
+      expect(isValidPriceConfig(customConfig)).to.be.true;
+    });
   });
 });