prebid.js 7.8.0 → 7.11.0

package/test/spec/modules/showheroes-bsBidAdapter_spec.js

@@ -48,6 +48,18 @@ const bidRequestCommonParams = {
   'auctionId': '43aa080090a47f',
 }
 
+const bidRequestCommonParamsV2 = {
+  'bidder': 'showheroes-bs',
+  'params': {
+    'unitId': 'AACBWAcof-611K4U',
+  },
+  'adUnitCode': 'adunit-code-1',
+  'sizes': [[640, 480]],
+  'bidId': '38b373e1e31c18',
+  'bidderRequestId': '12e3ade2543ba6',
+  'auctionId': '43aa080090a47f',
+}
+
 const bidRequestVideo = {
   ...bidRequestCommonParams,
   ...{
@@ -72,6 +84,30 @@ const bidRequestOutstream = {
   }
 }
 
+const bidRequestVideoV2 = {
+  ...bidRequestCommonParamsV2,
+  ...{
+    'mediaTypes': {
+      'video': {
+        'playerSize': [640, 480],
+        'context': 'instream',
+      }
+    }
+  }
+}
+
+const bidRequestOutstreamV2 = {
+  ...bidRequestCommonParamsV2,
+  ...{
+    'mediaTypes': {
+      'video': {
+        'playerSize': [640, 480],
+        'context': 'outstream'
+      }
+    }
+  }
+}
+
 const bidRequestVideoVpaid = {
   ...bidRequestCommonParams,
   ...{
@@ -129,12 +165,19 @@ describe('shBidAdapter', function () {
 
   describe('isBidRequestValid', function () {
     it('should return true when required params found', function () {
-      const request = {
+      const requestV1 = {
         'params': {
           'playerId': '47427aa0-f11a-4d24-abca-1295a46a46cd',
         }
       }
-      expect(spec.isBidRequestValid(request)).to.equal(true)
+      expect(spec.isBidRequestValid(requestV1)).to.equal(true)
+
+      const requestV2 = {
+        'params': {
+          'unitId': 'AACBTwsZVANd9NlB',
+        }
+      }
+      expect(spec.isBidRequestValid(requestV2)).to.equal(true)
     })
 
     it('should return false when required params are not passed', function () {
@@ -149,6 +192,9 @@ describe('shBidAdapter', function () {
     it('sends bid request to ENDPOINT via POST', function () {
       const request = spec.buildRequests([bidRequestVideo], bidderRequest)
       expect(request.method).to.equal('POST')
+
+      const requestV2 = spec.buildRequests([bidRequestVideoV2], bidderRequest)
+      expect(requestV2.method).to.equal('POST')
     })
 
     it('check sizes formats', function () {
@@ -268,6 +314,30 @@ describe('shBidAdapter', function () {
       expect(payload2).to.have.property('type', 5);
     })
 
+    it('should attach valid params to the payload when type is video (instream V2)', function () {
+      const request = spec.buildRequests([bidRequestVideoV2], bidderRequest)
+      const payload = request.data.bidRequests[0];
+      expect(payload).to.be.an('object');
+      expect(payload).to.have.property('unitId', 'AACBWAcof-611K4U');
+      expect(payload.mediaTypes).to.eql({
+        [VIDEO]: {
+          'context': 'instream'
+        }
+      });
+    })
+
+    it('should attach valid params to the payload when type is video (outstream V2)', function () {
+      const request = spec.buildRequests([bidRequestOutstreamV2], bidderRequest)
+      const payload = request.data.bidRequests[0];
+      expect(payload).to.be.an('object');
+      expect(payload).to.have.property('unitId', 'AACBWAcof-611K4U');
+      expect(payload.mediaTypes).to.eql({
+        [VIDEO]: {
+          'context': 'outstream'
+        }
+      });
+    })
+
     it('passes gdpr if present', function () {
       const request = spec.buildRequests([bidRequestVideo], {...bidderRequest, ...gdpr})
       const payload = request.data.requests[0];
@@ -275,6 +345,13 @@ describe('shBidAdapter', function () {
       expect(payload.gdprConsent).to.eql(gdpr.gdprConsent)
     })
 
+    it('passes gdpr if present (V2)', function () {
+      const request = spec.buildRequests([bidRequestVideoV2], {...bidderRequest, ...gdpr})
+      const context = request.data.context;
+      expect(context).to.be.an('object');
+      expect(context.gdprConsent).to.eql(gdpr.gdprConsent)
+    })
+
     it('passes schain object if present', function() {
       const request = spec.buildRequests([{
         ...bidRequestVideo,
@@ -284,6 +361,16 @@ describe('shBidAdapter', function () {
       expect(payload).to.be.an('object');
       expect(payload.schain).to.eql(schain.schain);
     })
+
+    it('passes schain object if present (V2)', function() {
+      const request = spec.buildRequests([{
+        ...bidRequestVideoV2,
+        ...schain
+      }], bidderRequest)
+      const context = request.data.context;
+      expect(context).to.be.an('object');
+      expect(context.schain).to.eql(schain.schain);
+    })
   })
 
   describe('interpretResponse', function () {
@@ -327,6 +414,39 @@ describe('shBidAdapter', function () {
       }],
     };
 
+    const basicResponseV2 = {
+      'requestId': '38b373e1e31c18',
+      'adUnitCode': 'adunit-code-1',
+      'cpm': 1,
+      'currency': 'EUR',
+      'width': 640,
+      'height': 480,
+      'advertiserDomain': [],
+      'callbacks': {
+        'won': ['https://api-n729.qa.viralize.com/track/?ver=15&session_id=01ecd03ce381505ccdeb88e555b05001&category=request_session&type=event&request_session_id=01ecd03ce381505ccdeb88e555b05001&label=prebid_won&reason=ok']
+      },
+      'mediaType': 'video',
+      'adomain': adomain,
+    };
+
+    const vastUrl = 'https://api-n729.qa.viralize.com/vast/?zid=AACBWAcof-611K4U&u=https://example.org/?foo=bar&gdpr=0&cs=XXXXXXXXXXXXXXXXXXXX&sid=01ecd03ce381505ccdeb88e555b05001&width=300&height=200&prebidmode=1'
+
+    const responseVideoV2 = {
+      'bidResponses': [{
+        ...basicResponseV2,
+        'context': 'instream',
+        'vastUrl': vastUrl,
+      }],
+    };
+
+    const responseVideoOutstreamV2 = {
+      'bidResponses': [{
+        ...basicResponseV2,
+        'context': 'outstream',
+        'ad': '<script id="testScript" data-wid="auto" type="text/javascript" src="https://ads.viralize.tv/display/?zid=AACBTwsZVANd9NlB&u=https%3A%2F%2Fexample.org%2F%3Ffoo%3Dbar&gdpr=0&cs=XXXXXXXXXXXXXXXXXXXX&sid=01ececb3b4c19270d6a77ccf75433001&width=300&height=200&prebidmode=1"></script>',
+      }],
+    };
+
     it('should get correct bid response when type is video', function () {
       const request = spec.buildRequests([bidRequestVideo], bidderRequest)
       const expectedResponse = [
@@ -356,6 +476,31 @@ describe('shBidAdapter', function () {
       expect(result).to.deep.equal(expectedResponse)
     })
 
+    it('should get correct bid response when type is video (V2)', function () {
+      const request = spec.buildRequests([bidRequestVideoV2], bidderRequest)
+      const expectedResponse = [
+        {
+          'cpm': 1,
+          'creativeId': 'c_38b373e1e31c18',
+          'adUnitCode': 'adunit-code-1',
+          'currency': 'EUR',
+          'width': 640,
+          'height': 480,
+          'mediaType': 'video',
+          'netRevenue': true,
+          'vastUrl': vastUrl,
+          'requestId': '38b373e1e31c18',
+          'ttl': 300,
+          'meta': {
+            'advertiserDomains': adomain
+          }
+        }
+      ]
+
+      const result = spec.interpretResponse({'body': responseVideoV2}, request)
+      expect(result).to.deep.equal(expectedResponse)
+    })
+
     it('should get correct bid response when type is banner', function () {
       const request = spec.buildRequests([bidRequestBanner], bidderRequest)
 
@@ -396,6 +541,32 @@ describe('shBidAdapter', function () {
       expect(spots.length).to.equal(1)
     })
 
+    it('should get correct bid response when type is outstream (slot V2)', function () {
+      const bidRequestV2 = JSON.parse(JSON.stringify(bidRequestOutstreamV2));
+      const slotId = 'testSlot2'
+      bidRequestV2.params.outstreamOptions = {
+        slot: slotId
+      }
+
+      const container = document.createElement('div')
+      container.setAttribute('id', slotId)
+      document.body.appendChild(container)
+
+      const request = spec.buildRequests([bidRequestV2], bidderRequest)
+
+      const result = spec.interpretResponse({'body': responseVideoOutstreamV2}, request)
+      const bid = result[0]
+      expect(bid).to.have.property('mediaType', VIDEO);
+
+      const renderer = bid.renderer
+      expect(renderer).to.be.an('object')
+      expect(renderer.id).to.equal(bidRequestV2.bidId)
+      renderer.render(bid)
+
+      const scripts = container.querySelectorAll('#testScript')
+      expect(scripts.length).to.equal(1)
+    })
+
     it('should get correct bid response when type is outstream (iframe)', function () {
       const bidRequest = JSON.parse(JSON.stringify(bidRequestOutstream));
       const slotId = 'testIframe'

package/test/spec/modules/sigmoidAnalyticsAdapter_spec.js

@@ -38,7 +38,7 @@ describe('sigmoid Prebid Analytic', function () {
       events.emit(constants.EVENTS.BID_RESPONSE, {});
       events.emit(constants.EVENTS.BID_WON, {});
 
-      sinon.assert.callCount(sigmoidAnalytic.track, 7);
+      sinon.assert.callCount(sigmoidAnalytic.track, 8);
     });
   });
   describe('build utm tag data', function () {

package/test/spec/modules/snigelBidAdapter_spec.js

@@ -0,0 +1,296 @@
+import {expect} from 'chai';
+import {spec} from 'modules/snigelBidAdapter.js';
+import {config} from 'src/config.js';
+import {isValid} from 'src/adapters/bidderFactory.js';
+
+const BASE_BID_REQUEST = {
+  adUnitCode: 'top_leaderboard',
+  bidId: 'bid_test',
+  sizes: [
+    [970, 90],
+    [728, 90],
+  ],
+  bidder: 'snigel',
+  params: {},
+  requestId: 'req_test',
+  transactionId: 'trans_test',
+};
+const makeBidRequest = function (overrides) {
+  return {...BASE_BID_REQUEST, ...overrides};
+};
+
+const BASE_BIDDER_REQUEST = {
+  bidderRequestId: 'test',
+  refererInfo: {
+    canonicalUrl: 'https://localhost',
+  },
+};
+const makeBidderRequest = function (overrides) {
+  return {...BASE_BIDDER_REQUEST, ...overrides};
+};
+
+const DUMMY_USP_CONSENT = '1YYN';
+const DUMMY_GDPR_CONSENT_STRING =
+  'BOSSotLOSSotLAPABAENBc-AAAAgR7_______9______9uz_Gv_v_f__33e8__9v_l_7_-___u_-33d4-_1vX99yfm1-7ftr3tp_86ues2_XqK_9oIiA';
+
+describe('snigelBidAdapter', function () {
+  describe('isBidRequestValid', function () {
+    it('should return false if no placement provided', function () {
+      expect(spec.isBidRequestValid(BASE_BID_REQUEST)).to.equal(false);
+    });
+
+    it('should return true if placement provided', function () {
+      const bidRequest = makeBidRequest({params: {placement: 'top_leaderboard'}});
+      expect(spec.isBidRequestValid(bidRequest)).to.equal(true);
+    });
+  });
+
+  describe('buildRequests', function () {
+    afterEach(function () {
+      config.resetConfig();
+    });
+
+    it('should build a single request for every impression and its placement', function () {
+      const bidderRequest = Object.assign({}, BASE_BIDDER_REQUEST);
+      const bidRequests = [
+        makeBidRequest({bidId: 'a', params: {placement: 'top_leaderboard'}}),
+        makeBidRequest({bidId: 'b', params: {placement: 'bottom_leaderboard'}}),
+      ];
+
+      const request = spec.buildRequests(bidRequests, bidderRequest);
+      expect(request).to.be.an('object');
+      expect(request).to.have.property('url').and.to.equal('https://adserv.snigelweb.com/bp/v1/prebid');
+      expect(request).to.have.property('method').and.to.equal('POST');
+
+      expect(request).to.have.property('data');
+      const data = JSON.parse(request.data);
+      expect(data).to.have.property('id').and.to.equal('test');
+      expect(data).to.have.property('cur').and.to.deep.equal(['USD']);
+      expect(data).to.have.property('test').and.to.equal(false);
+      expect(data).to.have.property('page').and.to.equal('https://localhost');
+      expect(data).to.have.property('placements');
+      expect(data.placements.length).to.equal(2);
+      expect(data.placements[0].uuid).to.equal('a');
+      expect(data.placements[0].name).to.equal('top_leaderboard');
+      expect(data.placements[1].uuid).to.equal('b');
+      expect(data.placements[1].name).to.equal('bottom_leaderboard');
+    });
+
+    it('should forward GDPR flag and GDPR consent string if enabled', function () {
+      const bidderRequest = makeBidderRequest({
+        gdprConsent: {
+          gdprApplies: true,
+          consentString: DUMMY_GDPR_CONSENT_STRING,
+        },
+      });
+
+      const request = spec.buildRequests([], bidderRequest);
+      expect(request).to.have.property('data');
+      const data = JSON.parse(request.data);
+      expect(data).to.have.property('gdprApplies').and.to.equal(true);
+      expect(data).to.have.property('gdprConsentString').and.to.equal(DUMMY_GDPR_CONSENT_STRING);
+    });
+
+    it('should forward GDPR flag and no GDPR consent string if disabled', function () {
+      const bidderRequest = makeBidderRequest({
+        gdprConsent: {
+          gdprApplies: false,
+          consentString: DUMMY_GDPR_CONSENT_STRING,
+        },
+      });
+
+      const request = spec.buildRequests([], bidderRequest);
+      expect(request).to.have.property('data');
+      const data = JSON.parse(request.data);
+      expect(data).to.have.property('gdprApplies').and.to.equal(false);
+      expect(data).to.not.have.property('gdprConsentString');
+    });
+
+    it('should forward USP consent if set', function () {
+      const bidderRequest = makeBidderRequest({
+        uspConsent: DUMMY_USP_CONSENT,
+      });
+
+      const request = spec.buildRequests([], bidderRequest);
+      expect(request).to.have.property('data');
+      const data = JSON.parse(request.data);
+      expect(data).to.have.property('uspConsent').and.to.equal(DUMMY_USP_CONSENT);
+    });
+
+    it('should forward whether or not COPPA applies', function () {
+      config.setConfig({
+        'coppa': true,
+      });
+
+      const request = spec.buildRequests([], BASE_BIDDER_REQUEST);
+      expect(request).to.have.property('data');
+      const data = JSON.parse(request.data);
+      expect(data).to.have.property('coppa').and.to.equal(true);
+    });
+  });
+
+  describe('interpretResponse', function () {
+    it('should not return any bids if the request failed', function () {
+      expect(spec.interpretResponse({}, {})).to.be.empty;
+      expect(spec.interpretResponse({body: 'Some error message'}, {})).to.be.empty;
+    });
+
+    it('should not return any bids if the request did not return any bids either', function () {
+      expect(spec.interpretResponse({body: {bids: []}})).to.be.empty;
+    });
+
+    it('should return valid bids with additional meta information', function () {
+      const serverResponse = {
+        body: {
+          id: BASE_BIDDER_REQUEST.bidderRequestId,
+          cur: 'USD',
+          bids: [
+            {
+              uuid: BASE_BID_REQUEST.bidId,
+              price: 0.0575,
+              ad: '<html><body><h1>Test Ad</h1></body></html>',
+              width: 728,
+              height: 90,
+              crid: 'test',
+              meta: {
+                advertiserDomains: ['addomain.com'],
+              },
+            },
+          ],
+        },
+      };
+
+      const bids = spec.interpretResponse(serverResponse, {});
+      expect(bids.length).to.equal(1);
+      const bid = bids[0];
+      expect(isValid(BASE_BID_REQUEST.adUnitCode, bid)).to.be.true;
+      expect(bid).to.have.property('meta');
+      expect(bid.meta).to.have.property('advertiserDomains');
+      expect(bid.meta.advertiserDomains).to.be.an('array');
+      expect(bid.meta.advertiserDomains.length).to.equal(1);
+      expect(bid.meta.advertiserDomains[0]).to.equal('addomain.com');
+    });
+  });
+
+  describe('getUserSyncs', function () {
+    it('should not return any user syncs if sync url does not exist in response', function () {
+      const response = {
+        body: {
+          id: BASE_BIDDER_REQUEST.bidderRequestId,
+          cur: 'USD',
+          bids: [],
+        },
+      };
+      const syncOptions = {
+        iframeEnabled: true,
+      };
+      const gdprConsent = {
+        gdprApplies: false,
+      };
+
+      const syncs = spec.getUserSyncs(syncOptions, [response], gdprConsent);
+      expect(syncs).to.be.undefined;
+    });
+
+    it('should not return any user syncs if publisher disabled iframe-based sync', function () {
+      const response = {
+        body: {
+          id: BASE_BIDDER_REQUEST.bidderRequestId,
+          cur: 'USD',
+          syncUrl: 'https://somesyncurl',
+          bids: [],
+        },
+      };
+      const syncOptions = {
+        iframeEnabled: false,
+      };
+      const gdprConsent = {
+        gdprApplies: false,
+      };
+
+      const syncs = spec.getUserSyncs(syncOptions, [response], gdprConsent);
+      expect(syncs).to.be.undefined;
+    });
+
+    it('should not return any user syncs if GDPR applies and the user did not consent to purpose one', function () {
+      const response = {
+        body: {
+          id: BASE_BIDDER_REQUEST.bidderRequestId,
+          cur: 'USD',
+          syncUrl: 'https://somesyncurl',
+          bids: [],
+        },
+      };
+      const syncOptions = {
+        iframeEnabled: true,
+      };
+      const gdprConsent = {
+        gdprApplies: true,
+        vendorData: {
+          purpose: {
+            consents: {1: false},
+          },
+        },
+      };
+
+      const syncs = spec.getUserSyncs(syncOptions, [response], gdprConsent);
+      expect(syncs).to.be.undefined;
+    });
+
+    it("should return an iframe specific to the publisher's property if all conditions are met", function () {
+      const response = {
+        body: {
+          id: BASE_BIDDER_REQUEST.bidderRequestId,
+          cur: 'USD',
+          syncUrl: 'https://somesyncurl',
+          bids: [],
+        },
+      };
+      const syncOptions = {
+        iframeEnabled: true,
+      };
+      const gdprConsent = {
+        gdprApplies: false,
+      };
+
+      const syncs = spec.getUserSyncs(syncOptions, [response], gdprConsent);
+      expect(syncs).to.be.an('array').and.of.length(1);
+      const sync = syncs[0];
+      expect(sync).to.have.property('type');
+      expect(sync.type).to.equal('iframe');
+      expect(sync).to.have.property('url');
+      expect(sync.url).to.equal('https://somesyncurl?gdpr=0&gdpr_consent=');
+    });
+
+    it('should pass GDPR applicability and consent string as query parameters', function () {
+      const response = {
+        body: {
+          id: BASE_BIDDER_REQUEST.bidderRequestId,
+          cur: 'USD',
+          syncUrl: 'https://somesyncurl',
+          bids: [],
+        },
+      };
+      const syncOptions = {
+        iframeEnabled: true,
+      };
+      const gdprConsent = {
+        gdprApplies: true,
+        consentString: DUMMY_GDPR_CONSENT_STRING,
+        vendorData: {
+          purpose: {
+            consents: {1: true},
+          },
+        },
+      };
+
+      const syncs = spec.getUserSyncs(syncOptions, [response], gdprConsent);
+      expect(syncs).to.be.an('array').and.of.length(1);
+      const sync = syncs[0];
+      expect(sync).to.have.property('type');
+      expect(sync.type).to.equal('iframe');
+      expect(sync).to.have.property('url');
+      expect(sync.url).to.equal(`https://somesyncurl?gdpr=1&gdpr_consent=${DUMMY_GDPR_CONSENT_STRING}`);
+    });
+  });
+});

package/test/spec/modules/sovrnAnalyticsAdapter_spec.js

@@ -202,7 +202,8 @@ describe('Sovrn Analytics Adapter', function () {
       events.emit(constants.EVENTS.BID_RESPONSE, {});
       events.emit(constants.EVENTS.BID_WON, {});
 
-      sinon.assert.callCount(sovrnAnalyticsAdapter.track, 5);
+      // 5 SovrnAnalytics events + 1 Clean.io event
+      sinon.assert.callCount(sovrnAnalyticsAdapter.track, 6);
     });
 
     it('should catch no events if no affiliate id', function () {

package/test/spec/modules/sspBCBidAdapter_spec.js

@@ -678,8 +678,8 @@ describe('SSPBC adapter', function () {
     });
 
     it('should send no syncs, if frame sync is not allowed', function () {
-      expect(syncResultImage).to.have.length(0); ;
-      expect(syncResultNone).to.have.length(0); ;
+      expect(syncResultImage).to.have.length(0);
+      expect(syncResultNone).to.have.length(0);
     });
   });