src/adapters/audienceNetwork.js

/**
 * @file AudienceNetwork adapter.
 */
import { ajax } from '../ajax';
import { createBid } from '../bidfactory';
import { addBidResponse } from '../bidmanager';
import { STATUS } from '../constants.json';
import { format } from '../url';
import { logError } from '../utils';
import { createNew } from './adapter';

const { setBidderCode, getBidderCode } = createNew('audienceNetwork');

/**
 * Does this bid request contain valid parameters?
 * @param {Object} bid
 * @returns {Boolean}
 */
const validateBidRequest = bid =>
  typeof bid.params === 'object' &&
  typeof bid.params.placementId === 'string' &&
  bid.params.placementId.length > 0 &&
  Array.isArray(bid.sizes) && bid.sizes.length > 0;

/**
 * Flattens a 2-element [W, H] array as a 'WxH' string,
 * otherwise passes value through.
 * @param {Array|String} size
 * @returns {String}
 */
const flattenSize = size =>
  (Array.isArray(size) && size.length === 2) ? `${size[0]}x${size[1]}` : size;

/**
 * Is this a valid slot size?
 * @param {String} size
 * @returns {Boolean}
 */
const isValidSize = size => ['300x250', '320x50'].includes(size);

/**
 * Does the search part of the URL contain "anhb_testmode"
 * and therefore indicate testmode should be used?
 * @returns {String} "true" or "false"
 */
const isTestmode = () => Boolean(
  window && window.location &&
  typeof window.location.search === 'string' &&
  window.location.search.indexOf('anhb_testmode') !== -1
).toString();

/**
 * Parse JSON-as-string into an Object, default to empty.
 * @param {String} JSON-as-string
 * @returns {Object}
 */
const parseJson = jsonAsString => {
  let data = {};
  try {
    data = JSON.parse(jsonAsString);
  } catch (err) {}
  return data;
};

/**
 * Generate ad HTML for injection into an iframe
 * @param {String} placementId
 * @param {String} format
 * @param {String} bidId
 * @returns {String} HTML
 */
const createAdHtml = (placementId, format, bidId) => {
  const nativeStyle = format === 'native' ? '<script>window.onload=function(){if(parent){var o=document.getElementsByTagName("head")[0];var s=parent.document.getElementsByTagName("style");for(var i=0;i<s.length;i++)o.appendChild(s[i].cloneNode(true));}}</script>' : '';
  const nativeContainer = format === 'native' ? '<div class="thirdPartyRoot"><a class="fbAdLink"><div class="fbAdMedia thirdPartyMediaClass"></div><div class="fbAdSubtitle thirdPartySubtitleClass"></div><div class="fbDefaultNativeAdWrapper"><div class="fbAdCallToAction thirdPartyCallToActionClass"></div><div class="fbAdTitle thirdPartyTitleClass"></div></div></a></div>' : '';
  return `<html><head>${nativeStyle}</head><body><div style="display:none;position:relative;">
<script type='text/javascript'>var data = {placementid:'${placementId}',format:'${format}',bidid:'${bidId}',onAdLoaded:function(e){console.log('Audience Network [${placementId}] ad loaded');e.style.display = 'block';},onAdError:function(c,m){console.log('Audience Network [${placementId}] error (' + c + ') ' + m);}};
(function(a,b,c){var d='https://www.facebook.com',e='https://connect.facebook.net/en_US/fbadnw55.js',f={iframeLoaded:true,xhrLoaded:true},g=a.data,h=function(){if(Date.now){return Date.now();}else return +new Date();},i=function(aa){var ba=d+'/audience_network/client_event',ca={cb:h(),event_name:'ADNW_ADERROR',ad_pivot_type:'audience_network_mobile_web',sdk_version:'5.5.web',app_id:g.placementid.split('_')[0],publisher_id:g.placementid.split('_')[1],error_message:aa},da=[];for(var ea in ca)da.push(encodeURIComponent(ea)+'='+encodeURIComponent(ca[ea]));var fa=ba+'?'+da.join('&'),ga=new XMLHttpRequest();ga.open('GET',fa,true);ga.send();if(g.onAdError)g.onAdError('1000','Internal error.');},j=function(){if(b.currentScript){return b.currentScript;}else{var aa=b.getElementsByTagName('script');return aa[aa.length-1];}},k=function(aa){try{return aa.document.referrer;}catch(ba){}return '';},l=function(){var aa=a,ba=[aa];try{while(aa!==aa.parent&&aa.parent.document)ba.push(aa=aa.parent);}catch(ca){}return ba.reverse();},m=function(){var aa=l();for(var ba=0;ba<aa.length;ba++){var ca=aa[ba],da=ca.ADNW||{};ca.ADNW=da;if(!ca.ADNW)continue;return da.v55=da.v55||{ads:[],window:ca};}throw new Error('no_writable_global');},n=function(aa){var ba=aa.indexOf('/',aa.indexOf('://')+3);if(ba===-1)return aa;return aa.substring(0,ba);},o=function(aa){return aa.location.href||k(aa);},p=function(aa){if(aa.sdkLoaded)return;var ba=aa.window.document,ca=ba.createElement('iframe');ca.name='fbadnw';ca.style.display='none';ba.body.appendChild(ca);var da=ca.contentDocument.createElement('script');da.src=e;da.async=true;ca.contentDocument.body.appendChild(da);aa.sdkLoaded=true;},q=function(aa){var ba=/^https?:\\/\\/www\\.google(\\.com?)?\\.\\w{2,3}$/;return !!aa.match(ba);},r=function(aa){return !!aa.match(/cdn\\.ampproject\\.org$/);},s=function(){var aa=c.ancestorOrigins||[],ba=aa[aa.length-1]||c.origin,ca=aa[aa.length-2]||c.origin;if(q(ba)&&r(ca)){return n(ca);}else return n(ba);},t=function(aa){try{return JSON.parse(aa);}catch(ba){i(ba.message);throw ba;}},u=function(aa,ba,ca){if(!aa.iframe){var da=ca.createElement('iframe');da.src=d+'/audiencenetwork/iframe/';da.style.display='none';ca.body.appendChild(da);aa.iframe=da;aa.iframeAppendedTime=h();aa.iframeData={};}ba.iframe=aa.iframe;ba.iframeData=aa.iframeData;ba.tagJsIframeAppendedTime=aa.iframeAppendedTime||0;},v=function(aa){var ba=d+'/audiencenetwork/xhr/?sdk=5.5.web';for(var ca in aa)if(typeof aa[ca]!=='function')ba+='&'+ca+'='+encodeURIComponent(aa[ca]);var da=new XMLHttpRequest();da.open('GET',ba,true);da.withCredentials=true;da.onreadystatechange=function(){if(da.readyState===4){var ea=t(da.response);aa.events.push({name:'xhrLoaded',source:aa.iframe.contentWindow,data:ea,postMessageTimestamp:h(),receivedTimestamp:h()});}};da.send();},w=function(aa,ba){var ca=d+'/audiencenetwork/xhriframe/?sdk=5.5.web';for(var da in ba)if(typeof ba[da]!=='function')ca+='&'+da+'='+encodeURIComponent(ba[da]);var ea=b.createElement('iframe');ea.src=ca;ea.style.display='none';b.body.appendChild(ea);ba.iframe=ea;ba.iframeData={};ba.tagJsIframeAppendedTime=h();},x=function(aa){var ba=function(event){try{var da=event.data;if(da.name in f)aa.events.push({name:da.name,source:event.source,data:da.data});}catch(ea){}},ca=aa.iframe.contentWindow.parent;ca.addEventListener('message',ba,false);},y=function(aa){if(aa.context&&aa.context.sourceUrl)return true;try{return !!JSON.parse(decodeURI(aa.name)).ampcontextVersion;}catch(ba){return false;}},z=function(aa){var ba=h(),ca=l()[0],da=j().parentElement,ea=ca!=a.top,fa=ca.$sf&&ca.$sf.ext,ga=o(ca),ha=m();p(ha);var ia={amp:y(ca),events:[],tagJsInitTime:ba,rootElement:da,iframe:null,tagJsIframeAppendedTime:ha.iframeAppendedTime||0,url:ga,domain:s(),channel:n(o(ca)),width:screen.width,height:screen.height,pixelratio:a.devicePixelRatio,placementindex:ha.ads.length,crossdomain:ea,safeframe:!!fa,placementid:g.placementid,format:g.format||'300x250',testmode:!!g.testmode,onAdLoaded:g.onAdLoaded,onAdError:g.onAdError};if(g.bidid)ia.bidid=g.bidid;if(ea){w(ha,ia);}else{u(ha,ia,ca.document);v(ia);}; x(ia);ia.rootElement.dataset.placementid=ia.placementid;ha.ads.push(ia);};try{z();}catch(aa){i(aa.message||aa);throw aa;}})(window,document,location);
</script>
${nativeContainer}</div></body></html>`;
};

/**
 * Creates a "good" Bid object with the given bid ID and CPM.
 * @param {String} placementId
 * @param {String} bidId
 * @param {String} size
 * @param {Number} cpmCents
 * @returns {Object} Bid
 */
const createSuccessBidResponse = (placementId, size, format, bidId, cpmCents) => {
  const bid = createBid(STATUS.GOOD, { bidId });
  // Prebid attributes
  bid.bidderCode = getBidderCode();
  bid.cpm = cpmCents / 100;
  bid.ad = createAdHtml(placementId, format, bidId);
  [bid.width, bid.height] = size.split('x').map(Number);

  // Audience Network attributes
  bid.hb_bidder = 'fan';
  bid.fb_bidid = bidId;
  bid.fb_format = format;
  bid.fb_placementid = placementId;
  return bid;
};

/**
 * Creates a "no bid" Bid object.
 * @returns {Object} Bid
 */
const createFailureBidResponse = () => {
  const bid = createBid(STATUS.NO_BID);
  bid.bidderCode = getBidderCode();
  return bid;
};

/**
 * Fetch bids for given parameters.
 * @param {Object} bidRequest
 * @param {Array} params.bids - list of bids
 * @param {String} params.bids[].placementCode - Prebid placement identifier
 * @param {Object} params.bids[].params
 * @param {String} params.bids[].params.placementId - Audience Network placement identifier
 * @param {String} params.bids[].params.format - Optional format, one of 'native' or 'fullwidth' if set
 * @param {Array} params.bids[].sizes - list of desired advert sizes
 * @param {Array} params.bids[].sizes[] - Size arrays [h,w]: should include one of [300, 250], [320, 50]: first matched size is used
 * @returns {void}
 */
const callBids = bidRequest => {
  // Build lists of adUnitCodes, placementids, adformats and sizes
  const adUnitCodes = [];
  const placementids = [];
  const adformats = [];
  const sizes = [];
  bidRequest.bids
    .filter(validateBidRequest)
    .forEach(bid => bid.sizes
      .map(flattenSize)
      .filter(isValidSize)
      .slice(0, 1)
      .forEach(size => {
        adUnitCodes.push(bid.placementCode);
        placementids.push(bid.params.placementId);
        adformats.push(bid.params.format || size);
        sizes.push(size);
      })
    );

  if (placementids.length) {
    // Build URL
    const testmode = isTestmode();
    const url = format({
      protocol: 'https',
      host: 'an.facebook.com',
      pathname: '/v2/placementbid.json',
      search: {
        sdk: '5.5.web',
        testmode,
        placementids,
        adformats
      }
    });
    // Request
    ajax(url, res => {
      // Handle response
      const data = parseJson(res);
      if (data.errors && data.errors.length) {
        const noBid = createFailureBidResponse();
        adUnitCodes.forEach(adUnitCode => addBidResponse(adUnitCode, noBid));
        data.errors.forEach(logError);
      } else {
        // For each placementId in bids Object
        Object.keys(data.bids)
          // extract Array of bid responses
          .map(placementId => data.bids[placementId])
          // flatten
          .reduce((a, b) => a.concat(b), [])
          // call addBidResponse
          .forEach((bid, i) =>
            addBidResponse(adUnitCodes[i], createSuccessBidResponse(
              bid.placement_id,
              sizes[i],
              adformats[i],
              bid.bid_id,
              bid.bid_price_cents
            ))
          );
      }
    }, null, { withCredentials: true });
  } else {
    // No valid bids
    logError('No valid bids requested');
  }
};

/**
 * @class AudienceNetwork
 * @type {Object}
 * @property {Function} callBids - fetch bids for given parameters
 * @property {Function} setBidderCode - used for bidder aliasing
 * @property {Function} getBidderCode - unique 'audienceNetwork' identifier
 */
const AudienceNetwork = () => ({ callBids, setBidderCode, getBidderCode });

module.exports = AudienceNetwork;