prebid.js 7.35.0 → 7.37.0

package/test/spec/modules/appnexusBidAdapter_spec.js

@@ -36,14 +36,31 @@ describe('AppNexusAdapter', function () {
     });
 
     it('should return true when required params found', function () {
-      let bid = Object.assign({}, bid);
-      delete bid.params;
-      bid.params = {
+      let bid1 = deepClone(bid);
+      bid1.params = {
+        'placement_id': 123423
+      }
+      expect(spec.isBidRequestValid(bid1)).to.equal(true);
+    });
+
+    it('should return true when required params found', function () {
+      let bid1 = deepClone(bid);
+      bid1.params = {
         'member': '1234',
         'invCode': 'ABCD'
       };
 
-      expect(spec.isBidRequestValid(bid)).to.equal(true);
+      expect(spec.isBidRequestValid(bid1)).to.equal(true);
+    });
+
+    it('should return true when required params found', function () {
+      let bid1 = deepClone(bid);
+      bid1.params = {
+        'member': '1234',
+        'inv_code': 'ABCD'
+      };
+
+      expect(spec.isBidRequestValid(bid1)).to.equal(true);
     });
 
     it('should return false when required params are not passed', function () {
@@ -54,6 +71,15 @@ describe('AppNexusAdapter', function () {
       };
       expect(spec.isBidRequestValid(bid)).to.equal(false);
     });
+
+    it('should return false when required params are not passed', function () {
+      let bid = Object.assign({}, bid);
+      delete bid.params;
+      bid.params = {
+        'placement_id': 0
+      };
+      expect(spec.isBidRequestValid(bid)).to.equal(false);
+    });
   });
 
   describe('buildRequests', function () {
@@ -101,6 +127,24 @@ describe('AppNexusAdapter', function () {
       expect(payload.tags[0].private_sizes).to.deep.equal([{ width: 300, height: 250 }]);
     });
 
+    it('should parse out private sizes', function () {
+      let bidRequest = Object.assign({},
+        bidRequests[0],
+        {
+          params: {
+            placementId: '10433394',
+            private_sizes: [300, 250]
+          }
+        }
+      );
+
+      const request = spec.buildRequests([bidRequest]);
+      const payload = JSON.parse(request.data);
+
+      expect(payload.tags[0].private_sizes).to.exist;
+      expect(payload.tags[0].private_sizes).to.deep.equal([{ width: 300, height: 250 }]);
+    });
+
     it('should add position in request', function () {
       // set from bid.params
       let bidRequest = deepClone(bidRequests[0]);
@@ -168,6 +212,24 @@ describe('AppNexusAdapter', function () {
       expect(payload.publisher_id).to.deep.equal(1231234);
     });
 
+    it('should add publisher_id in request', function () {
+      let bidRequest = Object.assign({},
+        bidRequests[0],
+        {
+          params: {
+            placement_id: '10433394',
+            publisher_id: '1231234'
+          }
+        });
+      const request = spec.buildRequests([bidRequest]);
+      const payload = JSON.parse(request.data);
+
+      expect(payload.tags[0].publisher_id).to.exist;
+      expect(payload.tags[0].publisher_id).to.deep.equal(1231234);
+      expect(payload.publisher_id).to.exist;
+      expect(payload.publisher_id).to.deep.equal(1231234);
+    });
+
     it('should add source and verison to the tag', function () {
       const request = spec.buildRequests(bidRequests);
       const payload = JSON.parse(request.data);
@@ -189,7 +251,7 @@ describe('AppNexusAdapter', function () {
         bids: [{
           bidder: 'appnexus',
           params: {
-            placementId: '10433394'
+            placement_id: '10433394'
           }
         }],
         transactionId: '04f2659e-c005-4eb1-a57c-fa93145e3843'
@@ -351,7 +413,7 @@ describe('AppNexusAdapter', function () {
         bidRequests[0],
         {
           params: {
-            placementId: '10433394',
+            placement_id: '10433394',
             user: {
               externalUid: '123',
               segments: [123, { id: 987, value: 876 }],
@@ -407,7 +469,7 @@ describe('AppNexusAdapter', function () {
 
       // 2 -> reserve is defined, getFloor not defined > reserve is used
       bidRequest.params = {
-        'placementId': '10433394',
+        'placement_id': '10433394',
         'reserve': 0.5
       };
       request = spec.buildRequests([bidRequest]);
@@ -428,7 +490,7 @@ describe('AppNexusAdapter', function () {
       let bidRequest = Object.assign({},
         bidRequests[0],
         {
-          params: { placementId: '14542875' }
+          params: { placement_id: '14542875' }
         },
         {
           mediaTypes: {
@@ -461,7 +523,7 @@ describe('AppNexusAdapter', function () {
       let bidRequest = Object.assign({},
         bidRequests[0],
         {
-          params: { placementId: '14542875' }
+          params: { placement_id: '14542875' }
         },
         {
           mediaTypes: {
@@ -484,7 +546,7 @@ describe('AppNexusAdapter', function () {
       let bidRequest = Object.assign({},
         bidRequests[0],
         {
-          params: { placementId: '14542875' }
+          params: { placement_id: '14542875' }
         },
         {
           mediaTypes: {
@@ -526,7 +588,7 @@ describe('AppNexusAdapter', function () {
       let bidRequest = Object.assign({},
         bidRequests[0],
         {
-          params: { placementId: '14542875' }
+          params: { placement_id: '14542875' }
         },
         {
           mediaTypes: {
@@ -557,7 +619,7 @@ describe('AppNexusAdapter', function () {
       let bidRequest = Object.assign({},
         bidRequests[0],
         {
-          params: { placementId: '14542875' }
+          params: { placement_id: '14542875' }
         },
         {
           mediaTypes: {
@@ -585,7 +647,7 @@ describe('AppNexusAdapter', function () {
       let bidRequest = Object.assign({},
         bidRequests[0],
         {
-          params: { placementId: '14542875' }
+          params: { placement_id: '14542875' }
         },
         {
           mediaTypes: {
@@ -610,7 +672,7 @@ describe('AppNexusAdapter', function () {
           mediaType: 'banner',
           params: {
             sizes: [[300, 250], [300, 600]],
-            placementId: 13144370
+            placement_id: 13144370
           }
         }
       );
@@ -786,7 +848,7 @@ describe('AppNexusAdapter', function () {
         bidRequests[0],
         {
           params: {
-            placementId: '10433394',
+            placement_id: '10433394',
             keywords: {
               single: 'val',
               singleArr: ['val'],
@@ -931,6 +993,23 @@ describe('AppNexusAdapter', function () {
       expect(payload.tags[0].use_pmt_rule).to.equal(true);
     });
 
+    it('should add payment rules to the request', function () {
+      let bidRequest = Object.assign({},
+        bidRequests[0],
+        {
+          params: {
+            placement_id: '10433394',
+            use_payment_rule: true
+          }
+        }
+      );
+
+      const request = spec.buildRequests([bidRequest]);
+      const payload = JSON.parse(request.data);
+
+      expect(payload.tags[0].use_pmt_rule).to.equal(true);
+    });
+
     it('should add gpid to the request', function () {
       let testGpid = '/12345/my-gpt-tag-0';
       let bidRequest = deepClone(bidRequests[0]);
@@ -1239,9 +1318,33 @@ describe('AppNexusAdapter', function () {
             source: 'puburl2.com',
             uids: [{
               id: 'pubid2'
+            }, {
+              id: 'pubid2-123'
             }]
           }]
-        }
+        },
+        userIdAsEids: [{
+          source: 'adserver.org',
+          uids: [{ id: 'sample-userid' }]
+        }, {
+          source: 'criteo.com',
+          uids: [{ id: 'sample-criteo-userid' }]
+        }, {
+          source: 'netid.de',
+          uids: [{ id: 'sample-netId-userid' }]
+        }, {
+          source: 'liveramp.com',
+          uids: [{ id: 'sample-idl-userid' }]
+        }, {
+          source: 'uidapi.com',
+          uids: [{ id: 'sample-uid2-value' }]
+        }, {
+          source: 'puburl.com',
+          uids: [{ id: 'pubid1' }]
+        }, {
+          source: 'puburl2.com',
+          uids: [{ id: 'pubid2' }, { id: 'pubid2-123' }]
+        }]
       });
 
       const request = spec.buildRequests([bidRequest]);
@@ -1282,6 +1385,10 @@ describe('AppNexusAdapter', function () {
         source: 'puburl2.com',
         id: 'pubid2'
       });
+      expect(payload.eids).to.deep.include({
+        source: 'puburl2.com',
+        id: 'pubid2-123'
+      });
     });
 
     it('should populate iab_support object at the root level if omid support is detected', function () {

package/test/spec/modules/brightcomSSPBidAdapter_spec.js

@@ -0,0 +1,411 @@
+import { expect } from 'chai';
+import * as utils from 'src/utils.js';
+import { spec } from 'modules/brightcomSSPBidAdapter';
+import { newBidder } from 'src/adapters/bidderFactory.js';
+import {config} from '../../../src/config';
+
+const URL = 'https://rt.marphezis.com/hb';
+
+describe('brightcomSSPBidAdapter', function() {
+  const adapter = newBidder(spec);
+  let element, win;
+  let bidRequests;
+  let sandbox;
+
+  beforeEach(function() {
+    element = {
+      x: 0,
+      y: 0,
+
+      width: 0,
+      height: 0,
+
+      getBoundingClientRect: () => {
+        return {
+          width: element.width,
+          height: element.height,
+
+          left: element.x,
+          top: element.y,
+          right: element.x + element.width,
+          bottom: element.y + element.height
+        };
+      }
+    };
+    win = {
+      document: {
+        visibilityState: 'visible'
+      },
+
+      innerWidth: 800,
+      innerHeight: 600
+    };
+    bidRequests = [{
+      'bidder': 'bcmssp',
+      'params': {
+        'publisherId': 1234567
+      },
+      'adUnitCode': 'adunit-code',
+      'mediaTypes': {
+        'banner': {
+          'sizes': [[300, 250], [300, 600]]
+        }
+      },
+      'bidId': '5fb26ac22bde4',
+      'bidderRequestId': '4bf93aeb730cb9',
+      'auctionId': 'ffe9a1f7-7b67-4bda-a8e0-9ee5dc9f442e',
+      'schain': {
+        'ver': '1.0',
+        'complete': 1,
+        'nodes': [
+          {
+            'asi': 'exchange1.com',
+            'sid': '1234',
+            'hp': 1,
+            'rid': 'bid-request-1',
+            'name': 'publisher',
+            'domain': 'publisher.com'
+          }
+        ]
+      },
+    }];
+
+    sandbox = sinon.sandbox.create();
+    sandbox.stub(document, 'getElementById').withArgs('adunit-code').returns(element);
+    sandbox.stub(utils, 'getWindowTop').returns(win);
+    sandbox.stub(utils, 'getWindowSelf').returns(win);
+  });
+
+  afterEach(function() {
+    sandbox.restore();
+  });
+
+  describe('isBidRequestValid', function () {
+    let bid = {
+      'bidder': 'bcmssp',
+      'params': {
+        'publisherId': 1234567
+      },
+      'adUnitCode': 'adunit-code',
+      'mediaTypes': {
+        'banner': {
+          'sizes': [[300, 250], [300, 600]]
+        }
+      },
+      'bidId': '5fb26ac22bde4',
+      'bidderRequestId': '4bf93aeb730cb9',
+      'auctionId': 'ffe9a1f7-7b67-4bda-a8e0-9ee5dc9f442e',
+    };
+
+    it('should return true when required params found', function () {
+      expect(spec.isBidRequestValid(bid)).to.equal(true);
+    });
+
+    it('should return false when publisherId not passed correctly', function () {
+      bid.params.publisherId = undefined;
+      expect(spec.isBidRequestValid(bid)).to.equal(false);
+    });
+
+    it('should return false when require params are not passed', function () {
+      let bid = Object.assign({}, bid);
+      bid.params = {};
+      expect(spec.isBidRequestValid(bid)).to.equal(false);
+    });
+  });
+
+  describe('buildRequests', function () {
+    it('sends bid request to our endpoint via POST', function () {
+      const request = spec.buildRequests(bidRequests);
+      expect(request.method).to.equal('POST');
+    });
+
+    it('request url should match our endpoint url', function () {
+      const request = spec.buildRequests(bidRequests);
+      expect(request.url).to.equal(URL);
+    });
+
+    it('sets the proper banner object', function() {
+      const request = spec.buildRequests(bidRequests);
+      const payload = JSON.parse(request.data);
+      expect(payload.imp[0].banner.format).to.deep.equal([{w: 300, h: 250}, {w: 300, h: 600}]);
+    });
+
+    it('accepts a single array as a size', function() {
+      bidRequests[0].mediaTypes.banner.sizes = [300, 250];
+      const request = spec.buildRequests(bidRequests);
+      const payload = JSON.parse(request.data);
+      expect(payload.imp[0].banner.format).to.deep.equal([{w: 300, h: 250}]);
+    });
+
+    it('sends bidfloor param if present', function () {
+      bidRequests[0].params.bidFloor = 0.05;
+      const request = spec.buildRequests(bidRequests);
+      const payload = JSON.parse(request.data);
+      expect(payload.imp[0].bidfloor).to.equal(0.05);
+    });
+
+    it('sends tagid', function () {
+      const request = spec.buildRequests(bidRequests);
+      const payload = JSON.parse(request.data);
+      expect(payload.imp[0].tagid).to.equal('adunit-code');
+    });
+
+    it('sends publisher id', function () {
+      const request = spec.buildRequests(bidRequests);
+      const payload = JSON.parse(request.data);
+      expect(payload.site.publisher.id).to.equal(1234567);
+    });
+
+    it('sends gdpr info if exists', function () {
+      const consentString = 'BOJ8RZsOJ8RZsABAB8AAAAAZ+A==';
+      const bidderRequest = {
+        'bidderCode': 'bcmssp',
+        'auctionId': '1d1a030790a437',
+        'bidderRequestId': '22edbae2744bf5',
+        'timeout': 3000,
+        gdprConsent: {
+          consentString: consentString,
+          gdprApplies: true
+        },
+        refererInfo: {
+          page: 'http://example.com/page.html',
+          domain: 'example.com',
+        }
+      };
+      bidderRequest.bids = bidRequests;
+
+      const data = JSON.parse(spec.buildRequests(bidRequests, bidderRequest).data);
+
+      expect(data.regs.ext.gdpr).to.exist.and.to.be.a('number');
+      expect(data.regs.ext.gdpr).to.equal(1);
+      expect(data.user.ext.consent).to.exist.and.to.be.a('string');
+      expect(data.user.ext.consent).to.equal(consentString);
+    });
+
+    it('sends us_privacy', function () {
+      const bidderRequest = {
+        uspConsent: '1YYY'
+      };
+      const data = JSON.parse(spec.buildRequests(bidRequests, bidderRequest).data)
+
+      expect(data.regs).to.not.equal(null);
+      expect(data.regs.ext).to.not.equal(null);
+      expect(data.regs.ext.us_privacy).to.equal('1YYY');
+    });
+
+    it('sends coppa', function () {
+      sandbox.stub(config, 'getConfig').withArgs('coppa').returns(true);
+
+      const data = JSON.parse(spec.buildRequests(bidRequests).data)
+      expect(data.regs).to.not.be.undefined;
+      expect(data.regs.coppa).to.equal(1);
+    });
+
+    it('sends schain', function () {
+      const data = JSON.parse(spec.buildRequests(bidRequests).data);
+      expect(data).to.not.be.undefined;
+      expect(data.source).to.not.be.undefined;
+      expect(data.source.ext).to.not.be.undefined;
+      expect(data.source.ext.schain).to.not.be.undefined;
+      expect(data.source.ext.schain.complete).to.equal(1);
+      expect(data.source.ext.schain.ver).to.equal('1.0');
+      expect(data.source.ext.schain.nodes).to.not.be.undefined;
+      expect(data.source.ext.schain.nodes).to.lengthOf(1);
+      expect(data.source.ext.schain.nodes[0].asi).to.equal('exchange1.com');
+      expect(data.source.ext.schain.nodes[0].sid).to.equal('1234');
+      expect(data.source.ext.schain.nodes[0].hp).to.equal(1);
+      expect(data.source.ext.schain.nodes[0].rid).to.equal('bid-request-1');
+      expect(data.source.ext.schain.nodes[0].name).to.equal('publisher');
+      expect(data.source.ext.schain.nodes[0].domain).to.equal('publisher.com');
+    });
+
+    it('sends user eid parameters', function () {
+      bidRequests[0].userIdAsEids = [{
+        source: 'pubcid.org',
+        uids: [{
+          id: 'userid_pubcid'
+        }]
+      }, {
+        source: 'adserver.org',
+        uids: [{
+          id: 'userid_ttd',
+          ext: {
+            rtiPartner: 'TDID'
+          }
+        }]
+      }
+      ];
+
+      const data = JSON.parse(spec.buildRequests(bidRequests).data);
+
+      expect(data.user).to.not.be.undefined;
+      expect(data.user.ext).to.not.be.undefined;
+      expect(data.user.ext.eids).to.not.be.undefined;
+      expect(data.user.ext.eids).to.deep.equal(bidRequests[0].userIdAsEids);
+    });
+
+    it('sends user id parameters', function () {
+      const userId = {
+        sharedid: {
+          id: '01*******',
+          third: '01E*******'
+        }
+      };
+
+      bidRequests[0].userId = userId;
+
+      const data = JSON.parse(spec.buildRequests(bidRequests).data);
+      expect(data.user).to.not.be.undefined;
+      expect(data.user.ext).to.not.be.undefined;
+      expect(data.user.ext.ids).is.deep.equal(userId);
+    });
+
+    context('when element is fully in view', function() {
+      it('returns 100', function() {
+        Object.assign(element, { width: 600, height: 400 });
+        const request = spec.buildRequests(bidRequests);
+        const payload = JSON.parse(request.data);
+        expect(payload.imp[0].banner.ext.viewability).to.equal(100);
+      });
+    });
+
+    context('when element is out of view', function() {
+      it('returns 0', function() {
+        Object.assign(element, { x: -300, y: 0, width: 207, height: 320 });
+        const request = spec.buildRequests(bidRequests);
+        const payload = JSON.parse(request.data);
+        expect(payload.imp[0].banner.ext.viewability).to.equal(0);
+      });
+    });
+
+    context('when element is partially in view', function() {
+      it('returns percentage', function() {
+        Object.assign(element, { width: 800, height: 800 });
+        const request = spec.buildRequests(bidRequests);
+        const payload = JSON.parse(request.data);
+        expect(payload.imp[0].banner.ext.viewability).to.equal(75);
+      });
+    });
+
+    context('when width or height of the element is zero', function() {
+      it('try to use alternative values', function() {
+        Object.assign(element, { width: 0, height: 0 });
+        bidRequests[0].mediaTypes.banner.sizes = [[800, 2400]];
+        const request = spec.buildRequests(bidRequests);
+        const payload = JSON.parse(request.data);
+        expect(payload.imp[0].banner.ext.viewability).to.equal(25);
+      });
+    });
+
+    context('when nested iframes', function() {
+      it('returns \'na\'', function() {
+        Object.assign(element, { width: 600, height: 400 });
+
+        utils.getWindowTop.restore();
+        utils.getWindowSelf.restore();
+        sandbox.stub(utils, 'getWindowTop').returns(win);
+        sandbox.stub(utils, 'getWindowSelf').returns({});
+
+        const request = spec.buildRequests(bidRequests);
+        const payload = JSON.parse(request.data);
+        expect(payload.imp[0].banner.ext.viewability).to.equal('na');
+      });
+    });
+
+    context('when tab is inactive', function() {
+      it('returns 0', function() {
+        Object.assign(element, { width: 600, height: 400 });
+
+        utils.getWindowTop.restore();
+        win.document.visibilityState = 'hidden';
+        sandbox.stub(utils, 'getWindowTop').returns(win);
+
+        const request = spec.buildRequests(bidRequests);
+        const payload = JSON.parse(request.data);
+        expect(payload.imp[0].banner.ext.viewability).to.equal(0);
+      });
+    });
+  });
+
+  describe('interpretResponse', function () {
+    let response;
+    beforeEach(function () {
+      response = {
+        body: {
+          'id': '37386aade21a71',
+          'seatbid': [{
+            'bid': [{
+              'id': '376874781',
+              'impid': '283a9f4cd2415d',
+              'price': 0.35743275,
+              'nurl': '<!-- NURL -->',
+              'adm': '<!-- Creative -->',
+              'w': 300,
+              'h': 250,
+              'adomain': ['example.com']
+            }]
+          }]
+        }
+      };
+    });
+
+    it('should get the correct bid response', function () {
+      let expectedResponse = [{
+        'requestId': '283a9f4cd2415d',
+        'cpm': 0.35743275,
+        'width': 300,
+        'height': 250,
+        'creativeId': '376874781',
+        'currency': 'USD',
+        'netRevenue': true,
+        'mediaType': 'banner',
+        'ad': `<!-- Creative --><div style="position:absolute;left:0px;top:0px;visibility:hidden;"><img src="${encodeURI('<!-- NURL -->')}"></div>`,
+        'ttl': 60,
+        'meta': {
+          'advertiserDomains': ['example.com']
+        }
+      }];
+
+      let result = spec.interpretResponse(response);
+      expect(result[0]).to.deep.equal(expectedResponse[0]);
+    });
+
+    it('crid should default to the bid id if not on the response', function () {
+      let expectedResponse = [{
+        'requestId': '283a9f4cd2415d',
+        'cpm': 0.35743275,
+        'width': 300,
+        'height': 250,
+        'creativeId': response.body.seatbid[0].bid[0].id,
+        'currency': 'USD',
+        'netRevenue': true,
+        'mediaType': 'banner',
+        'ad': `<!-- Creative --><div style="position:absolute;left:0px;top:0px;visibility:hidden;"><img src="${encodeURI('<!-- NURL -->')}"></div>`,
+        'ttl': 60,
+        'meta': {
+          'advertiserDomains': ['example.com']
+        }
+      }];
+
+      let result = spec.interpretResponse(response);
+      expect(result[0]).to.deep.equal(expectedResponse[0]);
+    });
+
+    it('handles empty bid response', function () {
+      let response = {
+        body: ''
+      };
+      let result = spec.interpretResponse(response);
+      expect(result.length).to.equal(0);
+    });
+  });
+
+  describe('getUserSyncs ', () => {
+    let syncOptions = {iframeEnabled: true, pixelEnabled: true};
+
+    it('should not return', () => {
+      let returnStatement = spec.getUserSyncs(syncOptions, []);
+      expect(returnStatement).to.be.empty;
+    });
+  });
+});