sspBC Bid Adapter: remove dependence on auctionId, improve notifications

modules/sspBCBidAdapter.js

@@ -12,13 +12,14 @@ const SYNC_URL = 'https://ssp.wp.pl/bidder/usersync';
 const NOTIFY_URL = 'https://ssp.wp.pl/bidder/notify';
 const GVLID = 676;
 const TMAX = 450;
-const BIDDER_VERSION = '5.8';
+const BIDDER_VERSION = '5.9';
 const DEFAULT_CURRENCY = 'PLN';
 const W = window;
 const { navigator } = W;
 const oneCodeDetection = {};
 const adUnitsCalled = {};
 const adSizesCalled = {};
+const bidderRequestsMap = {};
 const pageView = {};
 var consentApiVersion;
 
@@ -93,19 +94,17 @@ const getNotificationPayload = bidData => {
     const bids = isArray(bidData) ? bidData : [bidData];
     if (bids.length > 0) {
       let result = {
-        requestId: undefined,
         siteId: [],
         slotId: [],
         tagid: [],
       }
       bids.forEach(bid => {
-        const { adUnitCode, auctionId, cpm, creativeId, meta, params: bidParams, requestId, timeout } = bid;
+        const { adUnitCode, cpm, creativeId, meta, mediaType, params: bidParams, bidderRequestId, requestId, timeout } = bid;
         const params = unpackParams(bidParams);
 
         // basic notification data
         const bidBasicData = {
-          // TODO: fix auctionId leak: https://github.com/prebid/Prebid.js/issues/9781
-          requestId: auctionId || result.requestId,
+          requestId: bidderRequestId || bidderRequestsMap[requestId],
           timeout: timeout || result.timeout,
           pvid: pageView.id,
         }
@@ -127,12 +126,14 @@ const getNotificationPayload = bidData => {
 
         if (cpm) {
           // non-empty bid data
+          const { advertiserDomains = [], networkName, pricepl } = meta;
           const bidNonEmptyData = {
             cpm,
-            cpmpl: meta && meta.pricepl,
+            cpmpl: pricepl,
             creativeId,
-            adomain: meta && meta.advertiserDomains && meta.advertiserDomains[0],
-            networkName: meta && meta.networkName,
+            adomain: advertiserDomains[0],
+            adtype: mediaType,
+            networkName,
           }
           result = { ...result, ...bidNonEmptyData }
         }
@@ -447,10 +448,15 @@ var mapVideo = (slot, videoFromBid) => {
 };
 
 const mapImpression = slot => {
-  const { adUnitCode, bidId, params = {}, ortb2Imp = {} } = slot;
+  const { adUnitCode, bidderRequestId, bidId, params = {}, ortb2Imp = {} } = slot;
   const { id, siteId, video } = params;
   const { ext = {} } = ortb2Imp;
 
+  /*
+    store bidId <-> bidderRequestId mapping for bidWon notification
+  */
+  bidderRequestsMap[bidId] = bidderRequestId;
+
   /*
      check max size for this imp, and check/store number this size was called (for current view)
      send this info as ext.pbsize
@@ -494,15 +500,20 @@ const isNativeAd = bid => {
   return bid.admNative || (bid.adm && bid.adm.match(xmlTester));
 }
 
-const parseNative = (nativeData) => {
+const parseNative = (nativeData, adUnitCode) => {
   const { link = {}, imptrackers: impressionTrackers, jstracker } = nativeData;
   const { url: clickUrl, clicktrackers: clickTrackers = [] } = link;
+  const macroReplacer = tracker => tracker.replace(new RegExp('%native_dom_id%', 'g'), adUnitCode);
+  let javascriptTrackers = isArray(jstracker) ? jstracker : jstracker && [jstracker];
+
+  // replace known macros in js trackers
+  javascriptTrackers = javascriptTrackers && javascriptTrackers.map(macroReplacer);
 
   const result = {
     clickUrl,
     clickTrackers,
     impressionTrackers,
-    javascriptTrackers: isArray(jstracker) ? jstracker : jstracker && [jstracker],
+    javascriptTrackers,
   };
 
   nativeData.assets.forEach(asset => {
@@ -627,6 +638,8 @@ const spec = {
     return true;
   },
   buildRequests(validBidRequests, bidderRequest) {
+    logWarn('DEBUG: buildRequests', bidderRequest.auctionId, bidderRequest.bidderRequestId);
+
     // convert Native ORTB definition to old-style prebid native definition
     validBidRequests = convertOrtbRequestToProprietaryNative(validBidRequests);
 
@@ -644,7 +657,7 @@ const spec = {
     const ref = bidderRequest.refererInfo.ref;
 
     const payload = {
-      id: bidderRequest.auctionId,
+      id: bidderRequest.bidderRequestId,
       site: {
         id: siteId ? `${siteId}` : undefined,
         publisher: publisherId ? { id: publisherId } : undefined,
@@ -725,6 +738,7 @@ const spec = {
 
           if (bidRequest && site.id && !strIncludes(site.id, 'bidid')) {
             // found a matching request; add this bid
+            const { adUnitCode } = bidRequest;
 
             // store site data for future notification
             oneCodeDetection[bidId] = [site.id, site.slot];
@@ -760,7 +774,7 @@ const spec = {
               // check native object
               try {
                 const nativeData = serverBid.admNative || JSON.parse(serverBid.adm).native;
-                bid.native = parseNative(nativeData);
+                bid.native = parseNative(nativeData, adUnitCode);
                 bid.width = 1;
                 bid.height = 1;
               } catch (err) {
@@ -807,6 +821,15 @@ const spec = {
     }
   },
 
+  onBidViewable(bid) {
+    const payload = getNotificationPayload(bid);
+    if (payload) {
+      payload.event = 'bidViewable';
+      sendNotification(payload);
+      return payload;
+    }
+  },
+
   onBidWon(bid) {
     const payload = getNotificationPayload(bid);
     if (payload) {

test/spec/modules/sspBCBidAdapter_spec.js

@@ -38,7 +38,7 @@ describe('SSPBC adapter', function () {
       },
       auctionId,
       bidderRequestId,
-      bidId: auctionId + '1',
+      bidId: bidderRequestId + '1',
       transactionId,
     },
     {
@@ -60,7 +60,7 @@ describe('SSPBC adapter', function () {
       },
       auctionId,
       bidderRequestId,
-      bidId: auctionId + '2',
+      bidId: bidderRequestId + '2',
       transactionId,
     }
     ];
@@ -83,7 +83,7 @@ describe('SSPBC adapter', function () {
       ],
       auctionId,
       bidderRequestId,
-      bidId: auctionId + '1',
+      bidId: bidderRequestId + '1',
       transactionId,
     };
     const bid_native = {
@@ -122,7 +122,7 @@ describe('SSPBC adapter', function () {
       ],
       auctionId,
       bidderRequestId,
-      bidId: auctionId + '1',
+      bidId: bidderRequestId + '1',
       transactionId,
     };
     const bid_video = {
@@ -144,7 +144,7 @@ describe('SSPBC adapter', function () {
       ],
       auctionId,
       bidderRequestId,
-      bidId: auctionId + '1',
+      bidId: bidderRequestId + '1',
       transactionId,
     };
     const bids_timeouted = [{
@@ -155,7 +155,7 @@ describe('SSPBC adapter', function () {
         siteId: '8816',
       }],
       auctionId,
-      bidId: auctionId + '1',
+      bidId: bidderRequestId + '1',
       timeout: 100,
     },
     {
@@ -166,7 +166,7 @@ describe('SSPBC adapter', function () {
         siteId: '8816',
       }],
       auctionId,
-      bidId: auctionId + '2',
+      bidId: bidderRequestId + '2',
       timeout: 100,
     }
     ];
@@ -198,7 +198,7 @@ describe('SSPBC adapter', function () {
       },
       auctionId,
       bidderRequestId,
-      bidId: auctionId + '1',
+      bidId: bidderRequestId + '1',
       transactionId,
     }];
     const bidRequest = {
@@ -293,7 +293,7 @@ describe('SSPBC adapter', function () {
     };
     const serverResponse = {
       'body': {
-        'id': auctionId,
+        'id': bidderRequestId,
         'seatbid': [{
           'bid': [{
             'id': '3347324c-6889-46d2-a800-ae78a5214c06',
@@ -333,7 +333,7 @@ describe('SSPBC adapter', function () {
     };
     const serverResponseSingle = {
       'body': {
-        'id': auctionId,
+        'id': bidderRequestId,
         'seatbid': [{
           'bid': [{
             'id': '3347324c-6889-46d2-a800-ae78a5214c06',
@@ -358,11 +358,11 @@ describe('SSPBC adapter', function () {
     };
     const serverResponseOneCode = {
       'body': {
-        'id': auctionId,
+        'id': bidderRequestId,
         'seatbid': [{
           'bid': [{
             'id': '3347324c-6889-46d2-a800-ae78a5214c06',
-            'impid': 'bidid-' + auctionId + '1',
+            'impid': 'bidid-' + bidderRequestId + '1',
             'price': 1,
             'adid': 'lxHWkB7OnZeso3QiN1N4',
             'nurl': '',
@@ -385,11 +385,11 @@ describe('SSPBC adapter', function () {
     };
     const serverResponseVideo = {
       'body': {
-        'id': auctionId,
+        'id': bidderRequestId,
         'seatbid': [{
           'bid': [{
             'id': '3347324c-6889-46d2-a800-ae78a5214c06',
-            'impid': 'bidid-' + auctionId + '1',
+            'impid': 'bidid-' + bidderRequestId + '1',
             'price': 1,
             'adid': 'lxHWkB7OnZeso3QiN1N4',
             'nurl': '',
@@ -413,11 +413,11 @@ describe('SSPBC adapter', function () {
     };
     const serverResponseNative = {
       'body': {
-        'id': auctionId,
+        'id': bidderRequestId,
         'seatbid': [{
           'bid': [{
             'id': '3347324c-6889-46d2-a800-ae78a5214c06',
-            'impid': 'bidid-' + auctionId + '1',
+            'impid': 'bidid-' + bidderRequestId + '1',
             'price': 1,
             'adid': 'lxHWkB7OnZeso3QiN1N4',
             'nurl': '',
@@ -438,7 +438,7 @@ describe('SSPBC adapter', function () {
     };
     const emptyResponse = {
       'body': {
-        'id': auctionId,
+        'id': bidderRequestId,
       }
     }
     return {
@@ -696,7 +696,7 @@ describe('SSPBC adapter', function () {
 
       let notificationPayload = spec.onBidWon(bid);
       expect(notificationPayload).to.have.property('event').that.equals('bidWon');
-      expect(notificationPayload).to.have.property('requestId').that.equals(bid.auctionId);
+      expect(notificationPayload).to.have.property('requestId').that.equals(bid.bidderRequestId);
       expect(notificationPayload).to.have.property('tagid').that.deep.equals([bid.adUnitCode]);
       expect(notificationPayload).to.have.property('siteId').that.is.an('array');
       expect(notificationPayload).to.have.property('slotId').that.is.an('array');
@@ -717,7 +717,6 @@ describe('SSPBC adapter', function () {
       let notificationPayload = spec.onTimeout(bids_timeouted);
 
       expect(notificationPayload).to.have.property('event').that.equals('timeout');
-      expect(notificationPayload).to.have.property('requestId').that.equals(bids_timeouted[0].auctionId);
       expect(notificationPayload).to.have.property('tagid').that.deep.equals([bids_timeouted[0].adUnitCode, bids_timeouted[1].adUnitCode]);
     });
   });