Adding appnexus debug via cookie/params (prebid#3152)

* adding appnexus debug via cookie/params * removing nested object * added documentation link and removed useless conditional * fix lint error on documentation message
devunrulymedia · Jan 30, 2019 · 6301f52 · 6301f52
1 parent 16e60b1
commit 6301f52
Show file tree

Hide file tree

Showing 2 changed files with 84 additions and 1 deletion.
diff --git a/modules/appnexusBidAdapter.js b/modules/appnexusBidAdapter.js
@@ -11,6 +11,7 @@ const VIDEO_TARGETING = ['id', 'mimes', 'minduration', 'maxduration',
  'startdelay', 'skippable', 'playback_method', 'frameworks'];
 const USER_PARAMS = ['age', 'external_uid', 'segments', 'gender', 'dnt', 'language'];
 const APP_DEVICE_PARAMS = ['geo', 'device_id']; // appid is collected separately
+const DEBUG_PARAMS = ['enabled', 'dongle', 'member_id', 'debug_timeout'];
 const NATIVE_MAPPING = {
  body: 'description',
  cta: 'ctatext',
@@ -77,6 +78,32 @@ export const spec = {
  };
  }
 
+ let debugObj = {};
+ let debugObjParams = {};
+ const debugCookieName = 'apn_prebid_debug';
+ const debugCookie = getCookie(debugCookieName) || null;
+
+ if (debugCookie) {
+ try {
+ debugObj = JSON.parse(debugCookie);
+ } catch (e) {
+ utils.logError('AppNexus Debug Auction Cookie Error:\n\n' + e);
+ }
+ } else {
+ const debugBidRequest = find(bidRequests, hasDebug);
+ if (debugBidRequest && debugBidRequest.debug) {
+ debugObj = debugBidRequest.debug;
+ }
+ }
+
+ if (debugObj && debugObj.enabled) {
+ Object.keys(debugObj)
+ .filter(param => includes(DEBUG_PARAMS, param))
+ .forEach(param => {
+ debugObjParams[param] = debugObj[param];
+ });
+ }
+
  const memberIdBid = find(bidRequests, hasMemberId);
  const member = memberIdBid ? parseInt(memberIdBid.params.member, 10) : 0;
 
@@ -99,6 +126,11 @@ export const spec = {
  payload.app = appIdObj;
  }
 
+ if (debugObjParams.enabled) {
+ payload.debug = debugObjParams;
+ utils.logInfo('AppNexus Debug Auction Settings:\n\n' + JSON.stringify(debugObjParams, null, 4));
+ }
+
  if (bidderRequest && bidderRequest.gdprConsent) {
  // note - objects for impbus use underscore instead of camelCase
  payload.gdpr_consent = {
@@ -154,6 +186,22 @@ export const spec = {
  }
  });
  }
+
+ if (serverResponse.debug && serverResponse.debug.debug_info) {
+ let debugHeader = 'AppNexus Debug Auction for Prebid\n\n';
+ let debugText = debugHeader + serverResponse.debug.debug_info;
+ debugText = debugText
+ .replace(/(<td>|<th>)/gm, '\t') // Tables
+ .replace(/(<\/td>|<\/th>)/gm, '\n') // Tables
+ .replace(/^<br>/gm, '') // Remove leading <br>
+ .replace(/(<br>\n|<br>)/gm, '\n') // <br>
+ .replace(/<h1>(.*)<\/h1>/gm, '\n\n===== $1 =====\n\n') // Header H1
+ .replace(/<h[2-6]>(.*)<\/h[2-6]>/gm, '\n\n*** $1 ***\n\n') // Headers
+ .replace(/(<([^>]+)>)/igm, ''); // Remove any other tags
+ utils.logMessage('AppNexus Debug Auction Glossary: https://wiki.appnexus.com/x/qwmHAg');
+ utils.logMessage(debugText);
+ }
+
  return bids;
  },
 
@@ -429,6 +477,15 @@ function hasAppId(bid) {
  return !!bid.params.app
 }
 
+function hasDebug(bid) {
+ return !!bid.debug
+}
+
+function getCookie(name) {
+ let m = window.document.cookie.match('(^|;)\\s*' + name + '\\s*=\\s*([^;]*)\\s*(;|$)');
+ return m ? decodeURIComponent(m[2]) : null;
+}
+
 function getRtbBid(tag) {
  return tag && tag.ads && tag.ads.length && find(tag.ads, ad => ad.rtb);
 }

diff --git a/test/spec/modules/appnexusBidAdapter_spec.js b/test/spec/modules/appnexusBidAdapter_spec.js
@@ -396,7 +396,33 @@ describe('AppNexusAdapter', function () {
  rd_stk: bidderRequest.refererInfo.stack.map((url) => encodeURIComponent(url)).join(',')
  });
  });
- })
+
+ it('adds debug auction settings to payload', () => {
+ let debugRequest = Object.assign({},
+ bidRequests[0],
+ {
+ params: {
+ placementId: '10433394'
+ },
+ debug: {
+ enabled: true,
+ dongle: 'QWERTY',
+ member_id: 958,
+ debug_timeout: 1000
+ }
+ }
+ );
+ const request = spec.buildRequests([debugRequest]);
+ const payload = JSON.parse(request.data);
+ expect(payload.debug).to.exist;
+ expect(payload.debug).to.deep.equal({
+ enabled: true,
+ dongle: 'QWERTY',
+ member_id: 958,
+ debug_timeout: 1000
+ });
+ });
+ });
 
  describe('interpretResponse', function () {
  let response = {