prebid.js 7.2.0 → 7.5.0

package/test/spec/modules/readpeakBidAdapter_spec.js

@@ -528,6 +528,7 @@ describe('ReadPeakAdapter', function() {
           ad: bannerServerResponse.seatbid[0].bid[0].adm,
           width: bannerServerResponse.seatbid[0].bid[0].w,
           height: bannerServerResponse.seatbid[0].bid[0].h,
+          burl: bannerServerResponse.seatbid[0].bid[0].burl,
         });
         expect(bidResponse.meta).to.deep.equal({
           advertiserDomains: ['readpeak.com'],

package/test/spec/modules/relaidoBidAdapter_spec.js

@@ -81,8 +81,8 @@ describe('RelaidoAdapter', function () {
       data: {
         bids: [{
           bidId: bidRequest.bidId,
-          width: bidRequest.mediaTypes.video.playerSize[0][0],
-          height: bidRequest.mediaTypes.video.playerSize[0][1],
+          width: bidRequest.mediaTypes.video.playerSize[0][0] || bidRequest.mediaTypes.video.playerSize[0],
+          height: bidRequest.mediaTypes.video.playerSize[0][1] || bidRequest.mediaTypes.video.playerSize[1],
           mediaType: 'video'}]
       }
     };
@@ -98,6 +98,33 @@ describe('RelaidoAdapter', function () {
       expect(spec.isBidRequestValid(bidRequest)).to.equal(true);
     });
 
+    it('should return true when not existed mediaTypes.video.playerSize and existed valid params.video.playerSize by video', function () {
+      bidRequest.mediaTypes = {
+        video: {
+          context: 'outstream'
+        }
+      };
+      bidRequest.params = {
+        placementId: '100000',
+        video: {
+          playerSize: [
+            [640, 360]
+          ]
+        }
+      };
+      expect(spec.isBidRequestValid(bidRequest)).to.equal(true);
+    });
+
+    it('should return even true when the playerSize is Array[Number, Number] by video', function () {
+      bidRequest.mediaTypes = {
+        video: {
+          context: 'outstream',
+          playerSize: [640, 360]
+        }
+      };
+      expect(spec.isBidRequestValid(bidRequest)).to.equal(true);
+    });
+
     it('should return true when the required params are passed by banner', function () {
       setUAMobile();
       bidRequest.mediaTypes = {

package/test/spec/modules/riseBidAdapter_spec.js

@@ -53,6 +53,7 @@ describe('riseAdapter', function () {
           'org': 'jdye8weeyirk00000001'
         },
         'bidId': '299ffc8cca0b87',
+        'loop': 1,
         'bidderRequestId': '1144f487e563f9',
         'auctionId': 'bfc420c3-8577-4568-9766-a8a935fb620d',
         'mediaTypes': {
@@ -71,6 +72,7 @@ describe('riseAdapter', function () {
           'org': 'jdye8weeyirk00000001'
         },
         'bidId': '299ffc8cca0b87',
+        'loop': 1,
         'bidderRequestId': '1144f487e563f9',
         'auctionId': 'bfc420c3-8577-4568-9766-a8a935fb620d',
         'mediaTypes': {
@@ -91,6 +93,7 @@ describe('riseAdapter', function () {
           'testMode': true
         },
         'bidId': '299ffc8cca0b87',
+        'loop': 2,
         'bidderRequestId': '1144f487e563f9',
         'auctionId': 'bfc420c3-8577-4568-9766-a8a935fb620d',
       }

package/test/spec/modules/seedtagBidAdapter_spec.js

@@ -223,6 +223,7 @@ describe('Seedtag Adapter', function () {
     });
 
     it('Common data request should be correct', function () {
+      const now = Date.now();
       const request = spec.buildRequests(validBidRequests, bidderRequest);
       const data = JSON.parse(request.data);
       expect(data.url).to.equal('referer');
@@ -231,6 +232,9 @@ describe('Seedtag Adapter', function () {
       expect(
         ['fixed', 'mobile', 'unknown'].indexOf(data.connectionType)
       ).to.be.above(-1);
+      expect(data.auctionStart).to.be.greaterThanOrEqual(now);
+      expect(data.ttfb).to.be.greaterThanOrEqual(0);
+
       expect(data.bidRequests[0].adUnitCode).to.equal('adunit-code');
     });
 

package/test/spec/modules/sharethroughBidAdapter_spec.js

@@ -601,11 +601,11 @@ describe('sharethrough adapter spec', function () {
       const serverResponses = [{ body: { cookieSyncUrls: cookieSyncs } }];
 
       it('returns an array of correctly formatted user syncs', function () {
-        const syncArray = spec.getUserSyncs({ pixelEnabled: true }, serverResponses, null, 'fake-privacy-signal');
+        const syncArray = spec.getUserSyncs({ pixelEnabled: true }, serverResponses);
         expect(syncArray).to.deep.equal([
-          { type: 'image', url: 'cookieUrl1&us_privacy=fake-privacy-signal' },
-          { type: 'image', url: 'cookieUrl2&us_privacy=fake-privacy-signal' },
-          { type: 'image', url: 'cookieUrl3&us_privacy=fake-privacy-signal' }],
+          { type: 'image', url: 'cookieUrl1' },
+          { type: 'image', url: 'cookieUrl2' },
+          { type: 'image', url: 'cookieUrl3' }],
         );
       });
 

package/test/spec/modules/shinezBidAdapter_spec.js

@@ -0,0 +1,479 @@
+import { expect } from 'chai';
+import { spec } from 'modules/shinezBidAdapter.js';
+import { newBidder } from 'src/adapters/bidderFactory.js';
+import { config } from 'src/config.js';
+import { BANNER, VIDEO } from '../../../src/mediaTypes.js';
+import * as utils from 'src/utils.js';
+
+const ENDPOINT = 'https://hb.sweetgum.io/hb-sz-multi';
+const TEST_ENDPOINT = 'https://hb.sweetgum.io/hb-multi-sz-test';
+const TTL = 360;
+/* eslint no-console: ["error", { allow: ["log", "warn", "error"] }] */
+
+describe('shinezAdapter', function () {
+  const adapter = newBidder(spec);
+
+  describe('inherited functions', function () {
+    it('exists and is a function', function () {
+      expect(adapter.callBids).to.exist.and.to.be.a('function');
+    });
+  });
+
+  describe('isBidRequestValid', function () {
+    const bid = {
+      'bidder': spec.code,
+      'adUnitCode': 'adunit-code',
+      'sizes': [['640', '480']],
+      'params': {
+        'org': 'jdye8weeyirk00000001'
+      }
+    };
+
+    it('should return true when required params are passed', function () {
+      expect(spec.isBidRequestValid(bid)).to.equal(true);
+    });
+
+    it('should return false when required params are not found', function () {
+      const newBid = Object.assign({}, bid);
+      delete newBid.params;
+      newBid.params = {
+        'org': null
+      };
+      expect(spec.isBidRequestValid(newBid)).to.equal(false);
+    });
+  });
+
+  describe('buildRequests', function () {
+    const bidRequests = [
+      {
+        'bidder': spec.code,
+        'adUnitCode': 'adunit-code',
+        'sizes': [[640, 480]],
+        'params': {
+          'org': 'jdye8weeyirk00000001'
+        },
+        'bidId': '299ffc8cca0b87',
+        'bidderRequestId': '1144f487e563f9',
+        'auctionId': 'bfc420c3-8577-4568-9766-a8a935fb620d',
+        'mediaTypes': {
+          'video': {
+            'playerSize': [[640, 480]],
+            'context': 'instream'
+          }
+        },
+        'vastXml': '"<VAST version=\\\"2.0\\\">...</VAST>"'
+      },
+      {
+        'bidder': spec.code,
+        'adUnitCode': 'adunit-code',
+        'sizes': [[300, 250]],
+        'params': {
+          'org': 'jdye8weeyirk00000001'
+        },
+        'bidId': '299ffc8cca0b87',
+        'bidderRequestId': '1144f487e563f9',
+        'auctionId': 'bfc420c3-8577-4568-9766-a8a935fb620d',
+        'mediaTypes': {
+          'banner': {
+          }
+        },
+        'ad': '"<img src=\"https://...\"/>"'
+      }
+    ];
+
+    const testModeBidRequests = [
+      {
+        'bidder': spec.code,
+        'adUnitCode': 'adunit-code',
+        'sizes': [[640, 480]],
+        'params': {
+          'org': 'jdye8weeyirk00000001',
+          'testMode': true
+        },
+        'bidId': '299ffc8cca0b87',
+        'bidderRequestId': '1144f487e563f9',
+        'auctionId': 'bfc420c3-8577-4568-9766-a8a935fb620d',
+      }
+    ];
+
+    const bidderRequest = {
+      bidderCode: 'shinez',
+    }
+    const placementId = '12345678';
+
+    it('sends the placementId to ENDPOINT via POST', function () {
+      bidRequests[0].params.placementId = placementId;
+      const request = spec.buildRequests(bidRequests, bidderRequest);
+      expect(request.data.bids[0].placementId).to.equal(placementId);
+    });
+
+    it('sends bid request to ENDPOINT via POST', function () {
+      const request = spec.buildRequests(bidRequests, bidderRequest);
+      expect(request.url).to.equal(ENDPOINT);
+      expect(request.method).to.equal('POST');
+    });
+
+    it('sends bid request to TEST ENDPOINT via POST', function () {
+      const request = spec.buildRequests(testModeBidRequests, bidderRequest);
+      expect(request.url).to.equal(TEST_ENDPOINT);
+      expect(request.method).to.equal('POST');
+    });
+
+    it('should send the correct bid Id', function () {
+      const request = spec.buildRequests(bidRequests, bidderRequest);
+      expect(request.data.bids[0].bidId).to.equal('299ffc8cca0b87');
+    });
+
+    it('should send the correct sizes array', function () {
+      const request = spec.buildRequests(bidRequests, bidderRequest);
+      expect(request.data.bids[0].sizes).to.be.an('array');
+      expect(request.data.bids[0].sizes).to.equal(bidRequests[0].sizes)
+      expect(request.data.bids[1].sizes).to.be.an('array');
+      expect(request.data.bids[1].sizes).to.equal(bidRequests[1].sizes)
+    });
+
+    it('should send the correct media type', function () {
+      const request = spec.buildRequests(bidRequests, bidderRequest);
+      expect(request.data.bids[0].mediaType).to.equal(VIDEO)
+      expect(request.data.bids[1].mediaType).to.equal(BANNER)
+    });
+
+    it('should respect syncEnabled option', function() {
+      config.setConfig({
+        userSync: {
+          syncEnabled: false,
+          filterSettings: {
+            all: {
+              bidders: '*',
+              filter: 'include'
+            }
+          }
+        }
+      });
+      const request = spec.buildRequests(bidRequests, bidderRequest);
+      expect(request.data.params).to.be.an('object');
+      expect(request.data.params).to.not.have.property('cs_method');
+    });
+
+    it('should respect "iframe" filter settings', function () {
+      config.setConfig({
+        userSync: {
+          syncEnabled: true,
+          filterSettings: {
+            iframe: {
+              bidders: [spec.code],
+              filter: 'include'
+            }
+          }
+        }
+      });
+      const request = spec.buildRequests(bidRequests, bidderRequest);
+      expect(request.data.params).to.be.an('object');
+      expect(request.data.params).to.have.property('cs_method', 'iframe');
+    });
+
+    it('should respect "all" filter settings', function () {
+      config.setConfig({
+        userSync: {
+          syncEnabled: true,
+          filterSettings: {
+            all: {
+              bidders: [spec.code],
+              filter: 'include'
+            }
+          }
+        }
+      });
+      const request = spec.buildRequests(bidRequests, bidderRequest);
+      expect(request.data.params).to.be.an('object');
+      expect(request.data.params).to.have.property('cs_method', 'iframe');
+    });
+
+    it('should send the pixel user sync param if userSync is enabled and no "iframe" or "all" configs are present', function () {
+      config.resetConfig();
+      config.setConfig({
+        userSync: {
+          syncEnabled: true,
+        }
+      });
+      const request = spec.buildRequests(bidRequests, bidderRequest);
+      expect(request.data.params).to.be.an('object');
+      expect(request.data.params).to.have.property('cs_method', 'pixel');
+    });
+
+    it('should respect total exclusion', function() {
+      config.setConfig({
+        userSync: {
+          syncEnabled: true,
+          filterSettings: {
+            image: {
+              bidders: [spec.code],
+              filter: 'exclude'
+            },
+            iframe: {
+              bidders: [spec.code],
+              filter: 'exclude'
+            }
+          }
+        }
+      });
+      const request = spec.buildRequests(bidRequests, bidderRequest);
+      expect(request.data.params).to.be.an('object');
+      expect(request.data.params).to.not.have.property('cs_method');
+    });
+
+    it('should have us_privacy param if usPrivacy is available in the bidRequest', function () {
+      const bidderRequestWithUSP = Object.assign({uspConsent: '1YNN'}, bidderRequest);
+      const request = spec.buildRequests(bidRequests, bidderRequestWithUSP);
+      expect(request.data.params).to.be.an('object');
+      expect(request.data.params).to.have.property('us_privacy', '1YNN');
+    });
+
+    it('should have an empty us_privacy param if usPrivacy is missing in the bidRequest', function () {
+      const request = spec.buildRequests(bidRequests, bidderRequest);
+      expect(request.data.params).to.be.an('object');
+      expect(request.data.params).to.not.have.property('us_privacy');
+    });
+
+    it('should not send the gdpr param if gdprApplies is false in the bidRequest', function () {
+      const bidderRequestWithGDPR = Object.assign({gdprConsent: {gdprApplies: false}}, bidderRequest);
+      const request = spec.buildRequests(bidRequests, bidderRequestWithGDPR);
+      expect(request.data.params).to.be.an('object');
+      expect(request.data.params).to.not.have.property('gdpr');
+      expect(request.data.params).to.not.have.property('gdpr_consent');
+    });
+
+    it('should send the gdpr param if gdprApplies is true in the bidRequest', function () {
+      const bidderRequestWithGDPR = Object.assign({gdprConsent: {gdprApplies: true, consentString: 'test-consent-string'}}, bidderRequest);
+      const request = spec.buildRequests(bidRequests, bidderRequestWithGDPR);
+      expect(request.data.params).to.be.an('object');
+      expect(request.data.params).to.have.property('gdpr', true);
+      expect(request.data.params).to.have.property('gdpr_consent', 'test-consent-string');
+    });
+
+    it('should have schain param if it is available in the bidRequest', () => {
+      const schain = {
+        ver: '1.0',
+        complete: 1,
+        nodes: [{ asi: 'indirectseller.com', sid: '00001', hp: 1 }],
+      };
+      bidRequests[0].schain = schain;
+      const request = spec.buildRequests(bidRequests, bidderRequest);
+      expect(request.data.params).to.be.an('object');
+      expect(request.data.params).to.have.property('schain', '1.0,1!indirectseller.com,00001,1,,,');
+    });
+
+    it('should set flooPrice to getFloor.floor value if it is greater than params.floorPrice', function() {
+      const bid = utils.deepClone(bidRequests[0]);
+      bid.getFloor = () => {
+        return {
+          currency: 'USD',
+          floor: 3.32
+        }
+      }
+      bid.params.floorPrice = 0.64;
+      const request = spec.buildRequests([bid], bidderRequest);
+      expect(request.data.bids[0]).to.be.an('object');
+      expect(request.data.bids[0]).to.have.property('floorPrice', 3.32);
+    });
+
+    it('should set floorPrice to params.floorPrice value if it is greater than getFloor.floor', function() {
+      const bid = utils.deepClone(bidRequests[0]);
+      bid.getFloor = () => {
+        return {
+          currency: 'USD',
+          floor: 0.8
+        }
+      }
+      bid.params.floorPrice = 1.5;
+      const request = spec.buildRequests([bid], bidderRequest);
+      expect(request.data.bids[0]).to.be.an('object');
+      expect(request.data.bids[0]).to.have.property('floorPrice', 1.5);
+    });
+  });
+
+  describe('interpretResponse', function () {
+    const response = {
+      params: {
+        currency: 'USD',
+        netRevenue: true,
+      },
+      bids: [{
+        cpm: 12.5,
+        vastXml: '<VAST version="3.0"></VAST>',
+        width: 640,
+        height: 480,
+        requestId: '21e12606d47ba7',
+        adomain: ['abc.com'],
+        mediaType: VIDEO
+      },
+      {
+        cpm: 12.5,
+        ad: '"<img src=\"https://...\"/>"',
+        width: 300,
+        height: 250,
+        requestId: '21e12606d47ba7',
+        adomain: ['abc.com'],
+        mediaType: BANNER
+      }]
+    };
+
+    const expectedVideoResponse = {
+      requestId: '21e12606d47ba7',
+      cpm: 12.5,
+      currency: 'USD',
+      width: 640,
+      height: 480,
+      ttl: TTL,
+      creativeId: '21e12606d47ba7',
+      netRevenue: true,
+      nurl: 'http://example.com/win/1234',
+      mediaType: VIDEO,
+      meta: {
+        mediaType: VIDEO,
+        advertiserDomains: ['abc.com']
+      },
+      vastXml: '<VAST version="3.0"></VAST>',
+    };
+
+    const expectedBannerResponse = {
+      requestId: '21e12606d47ba7',
+      cpm: 12.5,
+      currency: 'USD',
+      width: 640,
+      height: 480,
+      ttl: TTL,
+      creativeId: '21e12606d47ba7',
+      netRevenue: true,
+      nurl: 'http://example.com/win/1234',
+      mediaType: BANNER,
+      meta: {
+        mediaType: BANNER,
+        advertiserDomains: ['abc.com']
+      },
+      ad: '"<img src=\"https://...\"/>"'
+    };
+
+    it('should get correct bid response', function () {
+      const result = spec.interpretResponse({ body: response });
+      expect(Object.keys(result[0])).to.deep.equal(Object.keys(expectedVideoResponse));
+      expect(Object.keys(result[1])).to.deep.equal(Object.keys(expectedBannerResponse));
+    });
+
+    it('video type should have vastXml key', function () {
+      const result = spec.interpretResponse({ body: response });
+      expect(result[0].vastXml).to.equal(expectedVideoResponse.vastXml)
+    });
+
+    it('banner type should have ad key', function () {
+      const result = spec.interpretResponse({ body: response });
+      expect(result[1].ad).to.equal(expectedBannerResponse.ad)
+    });
+  })
+
+  describe('getUserSyncs', function() {
+    const imageSyncResponse = {
+      body: {
+        params: {
+          userSyncPixels: [
+            'https://image-sync-url.test/1',
+            'https://image-sync-url.test/2',
+            'https://image-sync-url.test/3'
+          ]
+        }
+      }
+    };
+
+    const iframeSyncResponse = {
+      body: {
+        params: {
+          userSyncURL: 'https://iframe-sync-url.test'
+        }
+      }
+    };
+
+    it('should register all img urls from the response', function() {
+      const syncs = spec.getUserSyncs({ pixelEnabled: true }, [imageSyncResponse]);
+      expect(syncs).to.deep.equal([
+        {
+          type: 'image',
+          url: 'https://image-sync-url.test/1'
+        },
+        {
+          type: 'image',
+          url: 'https://image-sync-url.test/2'
+        },
+        {
+          type: 'image',
+          url: 'https://image-sync-url.test/3'
+        }
+      ]);
+    });
+
+    it('should register the iframe url from the response', function() {
+      const syncs = spec.getUserSyncs({ iframeEnabled: true }, [iframeSyncResponse]);
+      expect(syncs).to.deep.equal([
+        {
+          type: 'iframe',
+          url: 'https://iframe-sync-url.test'
+        }
+      ]);
+    });
+
+    it('should register both image and iframe urls from the responses', function() {
+      const syncs = spec.getUserSyncs({ pixelEnabled: true, iframeEnabled: true }, [iframeSyncResponse, imageSyncResponse]);
+      expect(syncs).to.deep.equal([
+        {
+          type: 'iframe',
+          url: 'https://iframe-sync-url.test'
+        },
+        {
+          type: 'image',
+          url: 'https://image-sync-url.test/1'
+        },
+        {
+          type: 'image',
+          url: 'https://image-sync-url.test/2'
+        },
+        {
+          type: 'image',
+          url: 'https://image-sync-url.test/3'
+        }
+      ]);
+    });
+
+    it('should handle an empty response', function() {
+      const syncs = spec.getUserSyncs({ iframeEnabled: true }, []);
+      expect(syncs).to.deep.equal([]);
+    });
+
+    it('should handle when user syncs are disabled', function() {
+      const syncs = spec.getUserSyncs({ pixelEnabled: false }, [imageSyncResponse]);
+      expect(syncs).to.deep.equal([]);
+    });
+  })
+
+  describe('onBidWon', function() {
+    beforeEach(function() {
+      sinon.stub(utils, 'triggerPixel');
+    });
+    afterEach(function() {
+      utils.triggerPixel.restore();
+    });
+
+    it('Should trigger pixel if bid nurl', function() {
+      const bid = {
+        'bidder': spec.code,
+        'adUnitCode': 'adunit-code',
+        'sizes': [['640', '480']],
+        'nurl': 'http://example.com/win/1234',
+        'params': {
+          'org': 'jdye8weeyirk00000001'
+        }
+      };
+
+      spec.onBidWon(bid);
+      expect(utils.triggerPixel.callCount).to.equal(1)
+    })
+  })
+});