Maintenance/refactor hb deal

src/adapters/sharethrough.js

@@ -16,7 +16,7 @@ var SharethroughAdapter = function SharethroughAdapter() {
     const bids = params.bids;
 
     addEventListener("message", _receiveMessage, false);
-    
+
     // cycle through bids
     for (let i = 0; i < bids.length; i += 1) {
       const bidRequest = bids[i];

src/bidmanager.js

@@ -130,12 +130,8 @@ exports.addBidResponse = function (adUnitCode, bid) {
 
     //if there is any key value pairs to map do here
     var keyValues = {};
-    if (bid.bidderCode && (bid.cpm > 0 || bid.dealId)) {
+    if (bid.bidderCode && bid.cpm > 0) {
       keyValues = getKeyValueTargetingPairs(bid.bidderCode, bid);
-
-      if (bid.dealId) {
-        keyValues[`hb_deal_${bid.bidderCode}`] = bid.dealId;
-      }
     }
 
     bid.adserverTargeting = keyValues;
@@ -204,7 +200,8 @@ function setKeys(keyValues, bidderSettings, custBidObj) {
     }
 
     if (
-      typeof bidderSettings.suppressEmptyKeys !== "undefined" && bidderSettings.suppressEmptyKeys === true &&
+      (typeof bidderSettings.suppressEmptyKeys !== "undefined" && bidderSettings.suppressEmptyKeys === true ||
+      key === "hb_deal") && // hb_deal is suppressed automatically if not set
       (
         utils.isEmptyStr(value) ||
         value === null ||
@@ -404,6 +401,11 @@ function getStandardBidderSettings() {
           val: function (bidResponse) {
             return bidResponse.size;
           }
+        }, {
+          key: 'hb_deal',
+          val: function (bidResponse) {
+            return bidResponse.dealId;
+          }
         }
       ]
     };

src/constants.json

@@ -54,6 +54,7 @@
     "hb_bidder",
     "hb_adid",
     "hb_pb",
-    "hb_size"
+    "hb_size",
+    "hb_deal"
   ]
 }

src/targeting.js

@@ -23,8 +23,7 @@ targeting.getAllTargeting = function(adUnitCode) {
   // `alwaysUseBid=true`. If sending all bids is enabled, add targeting for losing bids.
   var targeting = getWinningBidTargeting(adUnitCodes)
       .concat(getAlwaysUseBidTargeting(adUnitCodes))
-      .concat($$PREBID_GLOBAL$$._sendAllBids ? getBidLandscapeTargeting(adUnitCodes) : [])
-      .concat(getDealTargeting(adUnitCodes));
+      .concat($$PREBID_GLOBAL$$._sendAllBids ? getBidLandscapeTargeting(adUnitCodes) : []);
 
   //store a reference of the targeting keys
   targeting.map(adUnitCode => {
@@ -95,14 +94,8 @@ targeting.setTargetingForAst = function() {
 
 function getWinningBidTargeting() {
   let winners = targeting.getWinningBids();
-
-  // winning bids with deals need an hb_deal targeting key
-  // adding hb_deal to bid.adserverTargeting if it exists in winners array
-  winners
-    .filter(bid => bid.dealId)
-    .map(bid => bid.adserverTargeting.hb_deal = bid.dealId);
-
   let standardKeys = getStandardKeys();
+
   winners = winners.map(winner => {
     return {
       [winner.adUnitCode]: Object.keys(winner.adserverTargeting)
@@ -157,7 +150,10 @@ function getBidLandscapeTargeting(adUnitCodes) {
     .map(bid => {
       if (bid.adserverTargeting) {
         return {
-          [bid.adUnitCode]: getTargetingMap(bid, standardKeys)
+          [bid.adUnitCode]: getTargetingMap(bid, standardKeys.filter(
+            key => typeof bid.adserverTargeting[key] !== 'undefined') // mainly for possibly
+            // unset hb_deal
+          )
         };
       }
     }).filter(bid => bid); // removes empty elements in array
@@ -171,16 +167,6 @@ function getTargetingMap(bid, keys) {
   });
 }
 
-function getDealTargeting() {
-  return $$PREBID_GLOBAL$$._bidsReceived.filter(bid => bid.dealId).map(bid => {
-    const dealKey = `hb_deal_${bid.bidderCode}`;
-    return {
-      [bid.adUnitCode]: getTargetingMap(bid, CONSTANTS.TARGETING_KEYS)
-      .concat({ [dealKey.substring(0, 20)]: [bid.adserverTargeting[dealKey]] })
-    };
-  });
-}
-
 targeting.isApntagDefined = function() {
   if (window.apntag && utils.isFn(window.apntag.setKeywords)) {
     return true;

test/spec/adapters/sharethrough_spec.js

@@ -116,7 +116,7 @@ describe('sharethrough adapter', () => {
                               ],
                               "stxUserId": ""
                             };
-                            
+
       pbjs.strcallback(bidderReponse1);
       pbjs.strcallback(bidderReponse2);
 

test/spec/bidmanager_spec.js

@@ -422,6 +422,9 @@ describe('bidmanager.js', function () {
       bidmanager.adjustBids(bid)
       assert.equal(bid.cpm, 0);
 
+      // reset bidderSettings so we don't mess up further tests
+      $$PREBID_GLOBAL$$.bidderSettings = {};
+
     });
   });
 
@@ -474,7 +477,7 @@ describe('bidmanager.js', function () {
       bid.dealId = "test deal";
       bidmanager.addBidResponse(bid.adUnitCode, bid);
       const addedBid = $$PREBID_GLOBAL$$._bidsReceived.pop();
-      assert.equal(addedBid.adserverTargeting[`hb_deal_${bid.bidderCode}`], bid.dealId, 'dealId placed in adserverTargeting');
+      assert.equal(addedBid.adserverTargeting[`hb_deal`], bid.dealId, 'dealId placed in adserverTargeting');
     });
 
     it('should not alter bid adID', () => {