Medianet Bid Adapter: passing uidsAsEids in adapter and log refactor (prebid#11924)

* passing uidsAsEids in adapter and log refactor

* Changes: removed sendBeacon() and added keepalive = true option for ajax.

---------

Co-authored-by: adish.r <[email protected]>
Co-authored-by: akshat.v <[email protected]>

Author: 3 people

modules/medianetBidAdapter.js

@@ -1,14 +1,16 @@
 import {
-  buildUrl,
   deepAccess,
+  formatQS,
   getWindowTop,
   isArray,
   isEmpty,
   isEmptyStr,
   isStr,
   logError,
   logInfo,
-  triggerPixel
+  safeJSONEncode,
+  deepClone,
+  deepSetValue
 } from '../src/utils.js';
 import {registerBidder} from '../src/adapters/bidderFactory.js';
 import {config} from '../src/config.js';
@@ -18,6 +20,7 @@ import {Renderer} from '../src/Renderer.js';
 import { convertOrtbRequestToProprietaryNative } from '../src/native.js';
 import {getGlobal} from '../src/prebidGlobal.js';
 import {getGptSlotInfoForAdUnitCode} from '../libraries/gptUtils/gptUtils.js';
+import {ajax} from '../src/ajax.js';
 
 /**
  * @typedef {import('../src/adapters/bidderFactory.js').BidRequest} BidRequest
@@ -35,27 +38,20 @@ const SLOT_VISIBILITY = {
   ABOVE_THE_FOLD: 1,
   BELOW_THE_FOLD: 2
 };
-const EVENTS = {
+export const EVENTS = {
   TIMEOUT_EVENT_NAME: 'client_timeout',
-  BID_WON_EVENT_NAME: 'client_bid_won'
+  BID_WON_EVENT_NAME: 'client_bid_won',
+  SET_TARGETING: 'client_set_targeting',
+  BIDDER_ERROR: 'client_bidder_error'
 };
-const EVENT_PIXEL_URL = 'qsearch-a.akamaihd.net/log';
+export const EVENT_PIXEL_URL = 'https://navvy.media.net/log';
 const OUTSTREAM = 'outstream';
 
-// TODO: this should be picked from bidderRequest
-let refererInfo = getRefererInfo();
-
-let mnData = {};
+let pageMeta;
 
 window.mnet = window.mnet || {};
 window.mnet.queue = window.mnet.queue || [];
 
-mnData.urlData = {
-  domain: refererInfo.domain,
-  page: refererInfo.page,
-  isTop: refererInfo.reachedTop
-};
-
 const aliases = [
   { code: TRUSTEDSTACK_CODE, gvlid: 1288 },
 ];
@@ -85,20 +81,20 @@ function siteDetails(site, bidderRequest) {
 }
 
 function getPageMeta() {
-  if (mnData.pageMeta) {
-    return mnData.pageMeta;
+  if (pageMeta) {
+    return pageMeta;
   }
   let canonicalUrl = getUrlFromSelector('link[rel="canonical"]', 'href');
   let ogUrl = getUrlFromSelector('meta[property="og:url"]', 'content');
   let twitterUrl = getUrlFromSelector('meta[name="twitter:url"]', 'content');
 
-  mnData.pageMeta = Object.assign({},
+  pageMeta = Object.assign({},
     canonicalUrl && { 'canonical_url': canonicalUrl },
     ogUrl && { 'og_url': ogUrl },
     twitterUrl && { 'twitter_url': twitterUrl }
   );
 
-  return mnData.pageMeta;
+  return pageMeta;
 }
 
 function getUrlFromSelector(selector, attribute) {
@@ -338,14 +334,23 @@ function getBidderURL(bidderCode, cid) {
   return url + '?cid=' + encodeURIComponent(cid);
 }
 
+function ortb2Data(ortb2, bidRequests) {
+  const ortb2Object = deepClone(ortb2);
+  const eids = deepAccess(bidRequests, '0.userIdAsEids');
+  if (eids) {
+    deepSetValue(ortb2Object, 'user.ext.eids', eids)
+  }
+  return ortb2Object;
+}
+
 function generatePayload(bidRequests, bidderRequests) {
   return {
     site: siteDetails(bidRequests[0].params.site, bidderRequests),
     ext: extParams(bidRequests[0], bidderRequests),
     // TODO: fix auctionId leak: https://github.com/prebid/Prebid.js/issues/9781
     id: bidRequests[0].auctionId,
     imp: bidRequests.map(request => slotParams(request, bidderRequests)),
-    ortb2: bidderRequests.ortb2,
+    ortb2: ortb2Data(bidderRequests.ortb2, bidRequests),
     tmax: bidderRequests.timeout
   }
 }
@@ -363,38 +368,71 @@ function fetchCookieSyncUrls(response) {
   return [];
 }
 
-function getLoggingData(event, data) {
-  data = (isArray(data) && data) || [];
-
-  let params = {};
+function getEventData(event) {
+  const params = {};
+  const referrerInfo = getRefererInfo();
   params.logid = 'kfk';
   params.evtid = 'projectevents';
   params.project = 'prebid';
-  params.acid = deepAccess(data, '0.auctionId') || '';
+  params.pbver = '$prebid.version$';
   params.cid = getGlobal().medianetGlobals.cid || '';
-  params.crid = data.map((adunit) => deepAccess(adunit, 'params.0.crid') || adunit.adUnitCode).join('|');
-  params.adunit_count = data.length || 0;
-  params.dn = mnData.urlData.domain || '';
-  params.requrl = mnData.urlData.page || '';
-  params.istop = mnData.urlData.isTop || '';
+  params.dn = encodeURIComponent(referrerInfo.domain || '');
+  params.requrl = encodeURIComponent(referrerInfo.page || '');
   params.event = event.name || '';
   params.value = event.value || '';
   params.rd = event.related_data || '';
+  return params;
+}
 
+function getBidData(bid) {
+  const params = {};
+  params.acid = bid.auctionId || '';
+  params.crid = deepAccess(bid, 'params.crid') || deepAccess(bid, 'params.0.crid') || bid.adUnitCode || '';
+  params.ext = safeJSONEncode(bid.ext) || '';
+
+  const rawobj = deepClone(bid);
+  delete rawobj.ad;
+  delete rawobj.vastXml;
+  params.rawobj = safeJSONEncode(rawobj);
   return params;
 }
 
-function logEvent (event, data) {
-  let getParams = {
-    protocol: 'https',
-    hostname: EVENT_PIXEL_URL,
-    search: getLoggingData(event, data)
-  };
-  triggerPixel(buildUrl(getParams));
+function getLoggingData(event, bids) {
+  const logData = {};
+  if (!isArray(bids)) {
+    bids = [];
+  }
+  bids.forEach((bid) => {
+    let bidData = getBidData(bid);
+    Object.keys(bidData).forEach((key) => {
+      logData[key] = logData[key] || [];
+      logData[key].push(encodeURIComponent(bidData[key]));
+    });
+  });
+  return Object.assign({}, getEventData(event), logData)
+}
+
+function fireAjaxLog(url, payload) {
+  ajax(url,
+    {
+      success: () => undefined,
+      error: () => undefined
+    },
+    payload,
+    {
+      method: 'POST',
+      keepalive: true
+    }
+  );
 }
 
-function clearMnData() {
-  mnData = {};
+function logEvent(event, data) {
+  const logData = getLoggingData(event, data);
+  fireAjaxLog(EVENT_PIXEL_URL, formatQS(logData));
+}
+
+function clearPageMeta() {
+  pageMeta = undefined;
 }
 
 function addRenderer(bid) {
@@ -550,7 +588,30 @@ export const spec = {
     } catch (e) {}
   },
 
-  clearMnData,
+  onSetTargeting: (bid) => {
+    try {
+      let eventData = {
+        name: EVENTS.SET_TARGETING,
+        value: bid.cpm
+      };
+      const enableSendAllBids = config.getConfig('enableSendAllBids');
+      if (!enableSendAllBids) {
+        logEvent(eventData, [bid]);
+      }
+    } catch (e) {}
+  },
+
+  onBidderError: ({error, bidderRequest}) => {
+    try {
+      let eventData = {
+        name: EVENTS.BIDDER_ERROR,
+        related_data: `timedOut:${error.timedOut}|status:${error.status}|message:${error.reason.message}`
+      };
+      logEvent(eventData, bidderRequest.bids);
+    } catch (e) {}
+  },
+
+  clearPageMeta,
 
   getWindowSize,
 };

src/utils.js

@@ -1110,6 +1110,14 @@ export function safeJSONParse(data) {
   } catch (e) {}
 }
 
+export function safeJSONEncode(data) {
+  try {
+    return JSON.stringify(data);
+  } catch (e) {
+    return '';
+  }
+}
+
 /**
  * Returns a memoized version of `fn`.
  *