prebid.js 5.16.0 → 5.20.0

package/test/spec/modules/nextrollBidAdapter_spec.js

@@ -0,0 +1,290 @@
+import { expect } from 'chai';
+import { spec } from 'modules/nextrollBidAdapter.js';
+import * as utils from 'src/utils.js';
+import { deepClone } from '../../../src/utils';
+
+describe('nextrollBidAdapter', function() {
+  let utilsMock;
+  beforeEach(function () {
+    utilsMock = sinon.mock(utils);
+  });
+
+  afterEach(function() {
+    global.NextRoll = undefined;
+    utilsMock.restore();
+  });
+
+  let validBid = {
+    bidder: 'nextroll',
+    adUnitCode: 'adunit-code',
+    bidId: 'bid_id',
+    sizes: [[300, 200]],
+    params: {
+      bidfloor: 1,
+      zoneId: 'zone1',
+      publisherId: 'publisher_id'
+    }
+  };
+  let bidWithoutValidId = { id: '' };
+  let bidWithoutId = { params: { zoneId: 'zone1' } };
+
+  describe('nativeBidRequest', () => {
+    it('validates native spec', () => {
+      let nativeAdUnit = [{
+        bidder: 'nextroll',
+        adUnitCode: 'adunit-code',
+        bidId: 'bid_id',
+        mediaTypes: {
+          native: {
+            title: {required: true, len: 80},
+            image: {required: true, sizes: [728, 90]},
+            sponsoredBy: {required: false, len: 20},
+            clickUrl: {required: true},
+            body: {required: true, len: 25},
+            icon: {required: true, sizes: [50, 50], aspect_ratios: [{ratio_height: 3, ratio_width: 4}]},
+            someRandomAsset: {required: false, len: 100} // This should be ignored
+          }
+        },
+        params: {
+          bidfloor: 1,
+          zoneId: 'zone1',
+          publisherId: 'publisher_id'
+        }
+      }];
+
+      let request = spec.buildRequests(nativeAdUnit)
+      let assets = request[0].data.imp.native.request.native.assets
+
+      let excptedAssets = [
+        {id: 1, required: 1, title: {len: 80}},
+        {id: 2, required: 1, img: {w: 728, h: 90, wmin: 1, hmin: 1, type: 3}},
+        {id: 3, required: 1, img: {w: 50, h: 50, wmin: 4, hmin: 3, type: 1}},
+        {id: 5, required: 0, data: {len: 20, type: 1}},
+        {id: 6, required: 1, data: {len: 25, type: 2}}
+      ]
+      expect(assets).to.be.deep.equal(excptedAssets)
+    })
+  })
+
+  describe('isBidRequestValid', function() {
+    it('validates the bids correctly when the bid has an id', function() {
+      expect(spec.isBidRequestValid(validBid)).to.be.true;
+    });
+
+    it('validates the bids correcly when the bid does not have an id', function() {
+      expect(spec.isBidRequestValid(bidWithoutValidId)).to.be.false;
+      expect(spec.isBidRequestValid(bidWithoutId)).to.be.false;
+    });
+  });
+
+  describe('buildRequests', function() {
+    it('builds the same amount of requests as valid requests it takes', function() {
+      expect(spec.buildRequests([validBid, validBid], {})).to.be.lengthOf(2);
+    });
+
+    it('doest not build a request when there is no valid requests', function () {
+      expect(spec.buildRequests([], {})).to.be.lengthOf(0);
+    });
+
+    it('builds a request with POST method', function () {
+      expect(spec.buildRequests([validBid], {})[0].method).to.equal('POST');
+    });
+
+    it('builds a request with cookies method', function () {
+      expect(spec.buildRequests([validBid], {})[0].options.withCredentials).to.be.true;
+    });
+
+    it('builds a request with id, url and imp object', function () {
+      const request = spec.buildRequests([validBid], {})[0];
+      expect(request.data.id).to.be.an('string').that.is.not.empty;
+      expect(request.url).to.equal('https://d.adroll.com/bid/prebid/');
+      expect(request.data.imp).to.exist.and.to.be.a('object');
+    });
+
+    it('builds a request with site and device information', function () {
+      const request = spec.buildRequests([validBid], {})[0];
+
+      expect(request.data.site).to.exist.and.to.be.a('object');
+      expect(request.data.device).to.exist.and.to.be.a('object');
+    });
+
+    it('builds a request with a complete imp object', function () {
+      const request = spec.buildRequests([validBid], {})[0];
+
+      expect(request.data.imp.id).to.equal('bid_id');
+      expect(request.data.imp.bidfloor).to.be.equal(1);
+      expect(request.data.imp.banner).to.exist.and.to.be.a('object');
+      expect(request.data.imp.ext.zone.id).to.be.equal('zone1');
+    });
+
+    it('builds a request with the correct floor object', function () {
+      // bidfloor is defined, getFloor isn't
+      let bid = deepClone(validBid);
+      let request = spec.buildRequests([bid], {})[0];
+      expect(request.data.imp.bidfloor).to.be.equal(1);
+
+      // bidfloor not defined, getFloor not defined
+      bid = deepClone(validBid);
+      bid.params.bidfloor = null;
+      request = spec.buildRequests([bid], {})[0];
+      expect(request.data.imp.bidfloor).to.not.exist;
+
+      // bidfloor defined, getFloor defined, use getFloor
+      let getFloorResponse = { currency: 'USD', floor: 3 };
+      bid = deepClone(validBid);
+      bid.getFloor = () => getFloorResponse;
+      request = spec.buildRequests([bid], {})[0];
+
+      expect(request.data.imp.bidfloor).to.exist.and.to.equal(3);
+    });
+
+    it('includes the sizes into the request correctly', function () {
+      const bannerObject = spec.buildRequests([validBid], {})[0].data.imp.banner;
+
+      expect(bannerObject.format).to.exist;
+      expect(bannerObject.format).to.be.lengthOf(1);
+      expect(bannerObject.format[0].w).to.be.equal(300);
+      expect(bannerObject.format[0].h).to.be.equal(200);
+    });
+
+    it('sets the CCPA consent string', function () {
+      const us_privacy = '1YYY';
+      const request = spec.buildRequests([validBid], {'uspConsent': us_privacy})[0];
+
+      expect(request.data.regs.ext.us_privacy).to.be.equal(us_privacy);
+    });
+  });
+
+  describe('interpretResponse', function () {
+    let responseBody = {
+      id: 'bidresponse_id',
+      dealId: 'deal_id',
+      seatbid: [
+        {
+          bid: [
+            {
+              price: 1.2,
+              w: 300,
+              h: 200,
+              crid: 'crid1',
+              adm: 'adm1'
+            }
+          ]
+        },
+        {
+          bid: [
+            {
+              price: 2.1,
+              w: 250,
+              h: 300,
+              crid: 'crid2',
+              adm: 'adm2'
+            }
+          ]
+        }
+      ]
+    };
+
+    it('returns an empty list when there is no response body', function () {
+      expect(spec.interpretResponse({}, {})).to.be.eql([]);
+    });
+
+    it('builds the same amount of responses as server responses it receives', function () {
+      expect(spec.interpretResponse({body: responseBody}, {})).to.be.lengthOf(2);
+    });
+
+    it('builds a response with the expected fields', function () {
+      const response = spec.interpretResponse({body: responseBody}, {})[0];
+
+      expect(response.requestId).to.be.equal('bidresponse_id');
+      expect(response.cpm).to.be.equal(1.2);
+      expect(response.width).to.be.equal(300);
+      expect(response.height).to.be.equal(200);
+      expect(response.creativeId).to.be.equal('crid1');
+      expect(response.dealId).to.be.equal('deal_id');
+      expect(response.currency).to.be.equal('USD');
+      expect(response.netRevenue).to.be.equal(true);
+      expect(response.ttl).to.be.equal(300);
+      expect(response.ad).to.be.equal('adm1');
+    });
+  });
+
+  describe('interpret native response', () => {
+    let clickUrl = 'https://clickurl.com/with/some/path'
+    let titleText = 'Some title'
+    let imgW = 300
+    let imgH = 250
+    let imgUrl = 'https://clickurl.com/img.png'
+    let brandText = 'Some Brand'
+    let impUrl = 'https://clickurl.com/imptracker'
+
+    let responseBody = {
+      body: {
+        id: 'bidresponse_id',
+        seatbid: [{
+          bid: [{
+            price: 1.2,
+            crid: 'crid1',
+            adm: {
+              link: {url: clickUrl},
+              assets: [
+                {id: 1, title: {text: titleText}},
+                {id: 2, img: {w: imgW, h: imgH, url: imgUrl}},
+                {id: 5, data: {value: brandText}}
+              ],
+              imptrackers: [impUrl]
+            }
+          }]
+        }]
+      }
+    };
+
+    it('Should interpret response', () => {
+      let response = spec.interpretResponse(utils.deepClone(responseBody))
+      let expectedResponse = {
+        clickUrl: clickUrl,
+        impressionTrackers: [impUrl],
+        privacyLink: 'https://info.evidon.com/pub_info/573',
+        privacyIcon: 'https://c.betrad.com/pub/icon1.png',
+        title: titleText,
+        image: {url: imgUrl, width: imgW, height: imgH},
+        sponsoredBy: brandText,
+        clickTrackers: [],
+        jstracker: []
+      }
+
+      expect(response[0].native).to.be.deep.equal(expectedResponse)
+    })
+
+    it('Should interpret all assets', () => {
+      let allAssetsResponse = utils.deepClone(responseBody)
+      let iconUrl = imgUrl + '?icon=true', iconW = 10, iconH = 15
+      let logoUrl = imgUrl + '?logo=true', logoW = 20, logoH = 25
+      let bodyText = 'Some body text'
+
+      allAssetsResponse.body.seatbid[0].bid[0].adm.assets.push(...[
+        {id: 3, img: {w: iconW, h: iconH, url: iconUrl}},
+        {id: 4, img: {w: logoW, h: logoH, url: logoUrl}},
+        {id: 6, data: {value: bodyText}}
+      ])
+
+      let response = spec.interpretResponse(allAssetsResponse)
+      let expectedResponse = {
+        clickUrl: clickUrl,
+        impressionTrackers: [impUrl],
+        jstracker: [],
+        clickTrackers: [],
+        privacyLink: 'https://info.evidon.com/pub_info/573',
+        privacyIcon: 'https://c.betrad.com/pub/icon1.png',
+        title: titleText,
+        image: {url: imgUrl, width: imgW, height: imgH},
+        icon: {url: iconUrl, width: iconW, height: iconH},
+        logo: {url: logoUrl, width: logoW, height: logoH},
+        body: bodyText,
+        sponsoredBy: brandText
+      }
+
+      expect(response[0].native).to.be.deep.equal(expectedResponse)
+    })
+  })
+});

package/test/spec/modules/nobidBidAdapter_spec.js

@@ -2,6 +2,7 @@ import { expect } from 'chai';
 import * as utils from 'src/utils.js';
 import { spec } from 'modules/nobidBidAdapter.js';
 import { newBidder } from 'src/adapters/bidderFactory.js';
+import { config } from 'src/config.js';
 import * as bidderFactory from 'src/adapters/bidderFactory.js';
 
 describe('Nobid Adapter', function () {
@@ -50,6 +51,70 @@ describe('Nobid Adapter', function () {
     });
   });
 
+  describe('Request with ORTB2', function () {
+    const SITE_ID = 2;
+    const REFERER = 'https://www.examplereferer.com';
+    const BIDDER_CODE = 'duration';
+    let bidRequests = [
+      {
+        'bidder': BIDDER_CODE,
+        'params': {
+          'siteId': SITE_ID
+        },
+        'adUnitCode': 'adunit-code',
+        'sizes': [[300, 250]],
+        'bidId': '30b31c1838de1e',
+        'bidderRequestId': '22edbae2733bf6',
+        'auctionId': '1d1a030790a475',
+      }
+    ];
+
+    let bidderRequest = {
+      refererInfo: {referer: REFERER}, bidderCode: BIDDER_CODE
+    }
+
+    const siteName = 'example';
+    const siteDomain = 'page.example.com';
+    const sitePage = 'https://page.example.com/here.html';
+    const siteRef = 'https://ref.example.com';
+    const siteKeywords = 'power tools, drills';
+    const siteSearch = 'drill';
+    const siteCat = 'IAB2';
+    const siteSectionCat = 'IAB2-2';
+    const sitePageCat = 'IAB2-12';
+
+    it('ortb2 should exist', function () {
+      config.setConfig({
+        ortb2: {
+          site: {
+            name: siteName,
+            domain: siteDomain,
+            cat: [ siteCat ],
+            sectioncat: [ siteSectionCat ],
+            pagecat: [ sitePageCat ],
+            page: sitePage,
+            ref: siteRef,
+            keywords: siteKeywords,
+            search: siteSearch
+          }
+        }
+      });
+      const request = spec.buildRequests(bidRequests, bidderRequest);
+      let payload = JSON.parse(request.data);
+      payload = JSON.parse(JSON.stringify(payload));
+      expect(payload.sid).to.equal(SITE_ID);
+      expect(payload.ortb2.site.name).to.equal(siteName);
+      expect(payload.ortb2.site.domain).to.equal(siteDomain);
+      expect(payload.ortb2.site.page).to.equal(sitePage);
+      expect(payload.ortb2.site.ref).to.equal(siteRef);
+      expect(payload.ortb2.site.keywords).to.equal(siteKeywords);
+      expect(payload.ortb2.site.search).to.equal(siteSearch);
+      expect(payload.ortb2.site.cat[0]).to.equal(siteCat);
+      expect(payload.ortb2.site.sectioncat[0]).to.equal(siteSectionCat);
+      expect(payload.ortb2.site.pagecat[0]).to.equal(sitePageCat);
+    });
+  });
+
   describe('isDurationBidRequestValid', function () {
     const SITE_ID = 2;
     const REFERER = 'https://www.examplereferer.com';
@@ -255,7 +320,6 @@ describe('Nobid Adapter', function () {
       expect(payload.a).to.exist;
       expect(payload.t).to.exist;
       expect(payload.tz).to.exist;
-      expect(payload.r).to.exist.and.to.equal('100x100');
       expect(payload.lang).to.exist;
       expect(payload.ref).to.exist;
       expect(payload.a[0].d).to.exist.and.to.equal('adunit-code');