From 432c656fb59765702be79eec473052a0b09c3d75 Mon Sep 17 00:00:00 2001 From: AlessandroDG Date: Mon, 5 Nov 2018 16:23:40 +0100 Subject: [PATCH] Rivr Analytics Adapter (#3202) * RVR-1124 Setup initial skeleton analytics adapter that can send something. Approved-by: Alessandro Di Giovanni * Formatted auction/events data to fit needed schema. * RVR-1135 fetched device data. * Applied feedback. * Applied feedback. * Fetched core. * Added click handler for reporting banners click events. * Applied analyzer for reporting displayed impressions. * Applied feedback. * Merged in RVR-1214-invoke-handlers-on-rendering (pull request #7) RVR-1214 Invoke handlers on rendering * RVR-1214 Invoked handlers right after ad is displayed. * Applied feedback. Approved-by: Alessandro Di Giovanni * Merged in RVR-1192-configuration-global-parameters (pull request #8) RVR-1192 Configuration/Global parameters Approved-by: Alessandro Di Giovanni * Merged in RVR-1181-Prebid-js-unit-tests-setup (pull request #6) RVR-1181 Prebid.js Unit tests setup Approved-by: Alessandro Di Giovanni * Merged in RVR-1247-additional-data-to-impression-records (pull request #9) RVR-1247 Additional data to impression records Approved-by: Alessandro Di Giovanni * Merged in RVR-1249-add-requestedbids-to-auction (pull request #10) RVR-1249 Add requested bids to auction object request. Approved-by: Alessandro Di Giovanni * Merged in RVR-1261-fix-tests (pull request #11) RVR-1261 fix tests * RVR-1261 Secured adapter from no containers configuration. And changed fetching URL. * RVR-1261 Added event check for request and changed some names. * Applied feedback. Approved-by: Alessandro Di Giovanni * RVR-1352 analytics adapter bugs Approved-by: Alessandro Di Giovanni * Fixed bug with geolocation notification. * fixed missing bracket. * one more fix. * RVR-1357 Different optimisation responses & tracking into auction event * RVR-1852 - Add content type and hardcoded auth headers (cherry picked from commit 4def881) * RVR-1852 - Change tracker host * RVR-1852 - Override content type instead of adding header * RVR-1914 Consistent data types in events Also removes undefined and null properties in audience events * Merged in RVR-1883-Add-Basic-Access-Authentication (pull request #17) RVR-1883 Add Basic Access Authentication * RVR-1914 - Rename functions * RVR-1914 - Set default total_duration to null in bid response * RVR-1883 - Use RIVR_CLIENT_AUTH_TOKEN global variable for Auth token * RVR-1883 - Restore stub after every test not just at the end * RVR-1883 - Remove commented code * Increase code coverage * Fix for IE 11.0.0 and Safari 8.0.8 - includes() Use core-js includes function for array * Restore pbjs_api_spec.js * Fix API calls for rivr analytics impressions and clicks * Rvr 2005 rvr analytics adapter (#4) * Submitting EMX Digital Adapter (#3173) * Submitting EMX Digital Prebid Adapter Submitting EMX Digital Prebid Adapter code * fixing lint errors. updating our md * updating to const/let variables. adding test spec. * fixed linting on test spec js * TheMediaGrid Bid Adapter (#3204) * Added Grid Bid Adapter * remove priceType from TheMediaGrid Bid Adapter * Adding user sync method for IFRAME and Pixel (#3232) * Submitting EMX Digital Prebid Adapter Submitting EMX Digital Prebid Adapter code * fixing lint errors. updating our md * updating to const/let variables. adding test spec. * fixed linting on test spec js * adding emx usersync methods * updates (#3162) * Only set native targeting if value exists. (#3225) * add nolint command line option, similar to notest (#3234) * add inskin iab vendor id: enables consent via string (#3235) * Added user sync support for undertone bid adapter (#3172) * Added user sync support for undertone bid adapter (new pull request) * Added user sync support for undertone bid adapter * fix indentation * Changed utils.getWindowTop() with the newer prebid utilities * Updating Auction Init Pick for timestamp + Test update (#3223) * Updating Auction Init Pick for timestamp + Test update * Updating Auction Init to include once again + Rubicon Analytics update accordingly * Removing from auction init events in favor of old * Add code, test, and doc for Adikteev adapter (#3229) * Add code, test, and doc for Adikteev adapter * Reflect comments on other PR http://prebid.org/dev-docs/bidder-adaptor.html#referrers https://github.com/prebid/Prebid.js/pull/3230#discussion_r228319752 * 'currency' isn't a bidder-specific param Update PR following this remark on another one: https://github.com/prebid/Prebid.js/pull/3228#discussion_r228317072 * Add integration example, fix bid requestId * Quantcast adapter onTimeout (#3239) * onTimeout WIP * test for onTimeout * some renaming * cleanup * cleanup * trying to fix the test * using ajax instead of fetch * Test cleanup (#3238) * stub pixel call in justpremium tests * properly stub geolocation services to prevent prompts * stub img creation as well to prevent call in justpremium * Appnexus adapter: Added dealPriority and dealCode to bidResponse (#3201) * Added dealPriority and dealCode to appnexus adapter * update failed test * added namespace and did deep merge * keep all properties together * use unit id being sent instead of hard coded auid (#3236) * use unit id being sent instead of hard coded auid * make multiple requests * removes commented out code. adds aus param back * Prebid 1.30.0 Release * increment pre version * fix deal targeting for cpm 0 (#3233) * YIELDONE adapter - support Video (#3227) * added UserSync * added UserSync Unit Test * support for multi sizes * register the adapter as supporting video * supporting video * change requestId acquisition method * fix the parameter name of dealID * update test parameters * support instream video * add test for bidRequest * add test for interpretResponse * add test params * add note to documentaion * clarifying the multi-format support message * rtbhouseBidAdapter changes (#3241) * Add transactionId support * Change site getting method * Add bidfloor param * correct user agent value population (#3248) * RVR-1124 Setup initial skeleton analytics adapter that can send something. Approved-by: Alessandro Di Giovanni * Formatted auction/events data to fit needed schema. * RVR-1135 fetched device data. * Applied feedback. * Applied feedback. * Fetched core. * Added click handler for reporting banners click events. * Applied analyzer for reporting displayed impressions. * Applied feedback. * Merged in RVR-1214-invoke-handlers-on-rendering (pull request #7) RVR-1214 Invoke handlers on rendering * RVR-1214 Invoked handlers right after ad is displayed. * Applied feedback. Approved-by: Alessandro Di Giovanni * Merged in RVR-1192-configuration-global-parameters (pull request #8) RVR-1192 Configuration/Global parameters Approved-by: Alessandro Di Giovanni * Merged in RVR-1181-Prebid-js-unit-tests-setup (pull request #6) RVR-1181 Prebid.js Unit tests setup Approved-by: Alessandro Di Giovanni * Merged in RVR-1247-additional-data-to-impression-records (pull request #9) RVR-1247 Additional data to impression records Approved-by: Alessandro Di Giovanni * Merged in RVR-1249-add-requestedbids-to-auction (pull request #10) RVR-1249 Add requested bids to auction object request. Approved-by: Alessandro Di Giovanni * Merged in RVR-1261-fix-tests (pull request #11) RVR-1261 fix tests * RVR-1261 Secured adapter from no containers configuration. And changed fetching URL. * RVR-1261 Added event check for request and changed some names. * Applied feedback. Approved-by: Alessandro Di Giovanni * RVR-1352 analytics adapter bugs Approved-by: Alessandro Di Giovanni * Fixed bug with geolocation notification. * fixed missing bracket. * one more fix. * RVR-1357 Different optimisation responses & tracking into auction event * RVR-1852 - Add content type and hardcoded auth headers (cherry picked from commit 4def881) * RVR-1852 - Change tracker host * RVR-1852 - Override content type instead of adding header * RVR-1914 Consistent data types in events Also removes undefined and null properties in audience events * Merged in RVR-1883-Add-Basic-Access-Authentication (pull request #17) RVR-1883 Add Basic Access Authentication * RVR-1914 - Rename functions * RVR-1914 - Set default total_duration to null in bid response * RVR-1883 - Use RIVR_CLIENT_AUTH_TOKEN global variable for Auth token * RVR-1883 - Restore stub after every test not just at the end * RVR-1883 - Remove commented code * Increase code coverage * Fix for IE 11.0.0 and Safari 8.0.8 - includes() Use core-js includes function for array * Restore pbjs_api_spec.js * Fix API calls for rivr analytics impressions and clicks * RVR-2005 - Change auction object model * RVR-2005 - Set rvr_usr_id cookie * RVR-2005 - Remove BID_REQUESTED and BID_RESPONSE handlers We have the same infos all collected in AUCTION_END * RVR-2005 - build Bidders Array From Auction End * RVR-2005 - build impressions Array From Auction End * RVR-2005 - set status of winning bid * RVR-2005 - cleanup * RVR-2005 - adapt enableAnalytics() test * RVR-2005 - adapt all tests * RVR-2005 - Add Rivr Analytics adapter md file * RVR-2005 - rewrite connectAllUnits * RVR-2005 - correct typo * RVR-2005 - use IE compatible find() --- modules/rivrAnalyticsAdapter.js | 472 +++++++ modules/rivrAnalyticsAdapter.md | 13 + .../spec/modules/rivrAnalyticsAdapter_spec.js | 1132 +++++++++++++++++ 3 files changed, 1617 insertions(+) create mode 100644 modules/rivrAnalyticsAdapter.js create mode 100644 modules/rivrAnalyticsAdapter.md create mode 100644 test/spec/modules/rivrAnalyticsAdapter_spec.js diff --git a/modules/rivrAnalyticsAdapter.js b/modules/rivrAnalyticsAdapter.js new file mode 100644 index 00000000000..14143f5f21d --- /dev/null +++ b/modules/rivrAnalyticsAdapter.js @@ -0,0 +1,472 @@ +import {ajax} from 'src/ajax'; +import adapter from 'src/AnalyticsAdapter'; +import find from 'core-js/library/fn/array/find'; +import CONSTANTS from 'src/constants.json'; +import adaptermanager from 'src/adaptermanager'; +import { logInfo, generateUUID, timestamp } from 'src/utils'; + +const analyticsType = 'endpoint'; +const rivrUsrIdCookieKey = 'rvr_usr_id'; +const DEFAULT_HOST = 'tracker.rivr.simplaex.com'; +const DEFAULT_QUEUE_TIMEOUT = 4000; + +let rivrAnalytics = Object.assign(adapter({analyticsType}), { + track({ eventType, args }) { + if (!rivrAnalytics.context) { + return; + } + logInfo(`ARGUMENTS FOR TYPE: ============= ${eventType}`, args); + let handler = null; + switch (eventType) { + case CONSTANTS.EVENTS.AUCTION_INIT: + logInfo(`CONSTANTS.EVENTS.AUCTION_INIT rivrAnalytics.context.auctionObject`, rivrAnalytics.context.auctionObject); + if (rivrAnalytics.context.queue) { + rivrAnalytics.context.queue.init(); + } + if (rivrAnalytics.context.auctionObject) { + rivrAnalytics.context.auctionObject = createNewAuctionObject(); + saveUnoptimisedAdUnits(); + fetchLocalization(); + } + handler = trackAuctionInit; + break; + case CONSTANTS.EVENTS.BID_WON: + handler = trackBidWon; + break; + case CONSTANTS.EVENTS.BID_TIMEOUT: + handler = trackBidTimeout; + break; + case CONSTANTS.EVENTS.AUCTION_END: + handler = trackAuctionEnd; + break; + } + if (handler) { + handler(args) + } + } +}); + +export function sendAuction() { + if (rivrAnalytics.context.authToken) { + removeEmptyProperties(rivrAnalytics.context.auctionObject); + let auctionObject = rivrAnalytics.context.auctionObject; + let req = Object.assign({}, {Auction: auctionObject}); + rivrAnalytics.context.auctionObject = createNewAuctionObject(); + logInfo('sending request to analytics => ', req); + ajax( + `http://${rivrAnalytics.context.host}/${rivrAnalytics.context.clientID}/auctions`, + () => {}, + JSON.stringify(req), + { + contentType: 'application/json', + customHeaders: { + 'Authorization': 'Basic ' + rivrAnalytics.context.authToken + } + } + ); + } +}; + +export function sendImpressions() { + if (rivrAnalytics.context.authToken) { + let impressions = rivrAnalytics.context.queue.popAll(); + if (impressions.length !== 0) { + let impressionsReq = Object.assign({}, {impressions}); + logInfo('sending impressions request to analytics => ', impressionsReq); + ajax( + `http://${rivrAnalytics.context.host}/${rivrAnalytics.context.clientID}/impressions`, + () => {}, + JSON.stringify(impressionsReq), + { + contentType: 'application/json', + customHeaders: { + 'Authorization': 'Basic ' + rivrAnalytics.context.authToken + } + } + ); + } + } +}; + +function trackAuctionInit(args) { + rivrAnalytics.context.auctionTimeStart = Date.now(); + rivrAnalytics.context.auctionObject.id = args.auctionId; +}; + +function trackBidWon(args) { + setWinningBidStatus(args); +}; + +function setWinningBidStatus(args) { + let auctionObject = rivrAnalytics.context.auctionObject; + const bidderObjectForThisWonBid = find(auctionObject.bidders, (bidder) => { + return bidder.id === args.bidderCode; + }); + if (bidderObjectForThisWonBid) { + const bidObjectForThisWonBid = find(bidderObjectForThisWonBid.bids, (bid) => { + return bid.impId === args.adUnitCode; + }); + if (bidObjectForThisWonBid) { + bidObjectForThisWonBid.status = 1; + } + } +}; + +export function trackAuctionEnd(args) { + rivrAnalytics.context.auctionTimeEnd = Date.now(); + rivrAnalytics.context.auctionObject.bidders = buildBiddersArrayFromAuctionEnd(args); + rivrAnalytics.context.auctionObject.impressions = buildImpressionsArrayFromAuctionEnd(args); +}; + +function buildImpressionsArrayFromAuctionEnd(auctionEndEvent) { + return auctionEndEvent.adUnits.map((adUnit) => { + const impression = {}; + impression.id = adUnit.code; + impression.adType = 'unknown'; + impression.acceptedSizes = []; + const bidReceivedForThisAdUnit = find(auctionEndEvent.bidsReceived, (bidReceived) => { + return adUnit.code === bidReceived.adUnitCode; + }); + if (adUnit.mediaTypes) { + if (adUnit.mediaTypes.banner) { + buildAdTypeDependentFieldsForImpression(impression, 'banner', adUnit, bidReceivedForThisAdUnit); + } else if (adUnit.mediaTypes.video) { + buildAdTypeDependentFieldsForImpression(impression, 'video', adUnit, bidReceivedForThisAdUnit); + } + } + return impression; + }); +} + +function buildAdTypeDependentFieldsForImpression(impression, adType, adUnit, bidReceivedForThisAdUnit) { + impression.adType = adType; + impression.acceptedSizes = adUnit.mediaTypes[adType].sizes.map((acceptedSize) => { + return { + w: acceptedSize[0], + h: acceptedSize[1] + }; + }); + if (bidReceivedForThisAdUnit) { + impression[adType] = { + w: bidReceivedForThisAdUnit.width, + h: bidReceivedForThisAdUnit.height + }; + } +} + +function buildBiddersArrayFromAuctionEnd(auctionEndEvent) { + return auctionEndEvent.bidderRequests.map((bidderRequest) => { + const bidder = {}; + bidder.id = bidderRequest.bidderCode; + bidder.bids = bidderRequest.bids.map((bid) => { + const bidReceivedForThisRequest = find(auctionEndEvent.bidsReceived, (bidReceived) => { + return bidderRequest.bidderCode === bidReceived.bidderCode && + bid.bidId === bidReceived.adId && + bid.adUnitCode === bidReceived.adUnitCode; + }); + return { + adomain: [''], + clearPrice: 0.0, + impId: bid.adUnitCode, + price: bidReceivedForThisRequest ? bidReceivedForThisRequest.cpm : 0.0, + status: 0 + }; + }); + return bidder; + }); +} + +function trackBidTimeout(args) { + return [args]; +}; + +export function fetchLocalization() { + if (navigator.permissions) { + navigator.permissions.query({ name: 'geolocation' }).then((permission) => { + if (permission.status === 'granted') { + navigator.geolocation.getCurrentPosition((position) => { + setAuctionAbjectPosition(position); + }); + } + }); + } +} + +export function setAuctionAbjectPosition(position) { + rivrAnalytics.context.auctionObject.device.geo.lat = position.coords.latitude; + rivrAnalytics.context.auctionObject.device.geo.long = position.coords.longitude; +} + +function getPlatformType() { + if (navigator.userAgent.match(/mobile/i) || navigator.userAgent.match(/iPad|Android|Touch/i)) { + return 1; + } else { + return 2; + } +}; + +export function reportClickEvent(event) { + let link = event.currentTarget.getElementsByTagName('a')[0]; + let clickUrl; + if (link) { + clickUrl = link.getAttribute('href'); + } + let timestamp = new Date().toISOString(); + let requestId = generateUUID(); + let req = { + timestamp, + 'request_id': requestId, + 'click_url': clickUrl + }; + logInfo('Sending click events with parameters: ', req); + ajax( + `http://${rivrAnalytics.context.host}/${rivrAnalytics.context.clientID}/clicks`, + () => {}, + JSON.stringify(req), + { + contentType: 'application/json', + customHeaders: { + 'Authorization': 'Basic ' + rivrAnalytics.context.authToken + } + } + ); +}; + +function addClickHandler(bannerId) { + pinHandlerToHTMLElement(bannerId, dataLoaderForHandler, addClickListener); +}; + +function addDisplayedImpHandler(bannerId) { + pinHandlerToHTMLElement(bannerId, dataLoaderForHandler, impHandler); +}; + +export function pinHandlerToHTMLElement(elementId, dataLoaderForHandler, specializedHandler) { + function waitForElement() { + let element = document.getElementById(elementId); + if (!element) { + window.requestAnimationFrame(waitForElement); + } else { + dataLoaderForHandler(element, specializedHandler); + } + } + waitForElement(); +} + +export function dataLoaderForHandler(element, specializedHandler) { + function waitForElement() { + let iframe = element.getElementsByTagName('iframe')[0]; + if (!iframe) { + window.requestAnimationFrame(waitForElement); + } else { + let displayedImpression = iframe.contentDocument.getElementsByTagName('img').length > 0; + if (!displayedImpression) { + window.requestAnimationFrame(waitForElement); + } else { + specializedHandler(iframe); + } + } + } + waitForElement(); +}; + +function addClickListener(iframe) { + iframe.contentDocument.addEventListener('click', reportClickEvent); +} + +function impHandler(iframe) { + let timestamp = new Date().toISOString(); + let requestId = generateUUID(); + let adContainerId = iframe.parentElement.parentElement.id; + let impression = { + timestamp, + 'request_id': requestId, + 'tag_id': adContainerId + }; + if (rivrAnalytics.context.queue) { + rivrAnalytics.context.queue.push(impression); + } +} + +function addHandlers(bannersIds) { + bannersIds.forEach((bannerId) => { + addClickHandler(bannerId); + addDisplayedImpHandler(bannerId); + }) +}; + +export function createNewAuctionObject() { + const auction = { + id: '', + publisher: rivrAnalytics.context.clientID, + blockedCategories: [''], + timestamp: timestamp(), + user: { + id: rivrAnalytics.context.userId + }, + site: { + domain: window.location.host, + page: window.location.pathname, + categories: rivrAnalytics.context.siteCategories + }, + impressions: [], + bidders: [], + device: { + userAgent: navigator.userAgent, + browser: '', + deviceType: getPlatformType() + }, + 'ext.rivr.originalvalues': [], + 'ext.rivr.optimiser': localStorage.getItem('rivr_should_optimise') || 'unoptimised', + modelVersion: localStorage.getItem('rivr_model_version') || null, + } + + return auction; +}; + +export function saveUnoptimisedAdUnits() { + let units = rivrAnalytics.context.adUnits; + if (units) { + if (units.length > 0) { + let allUnits = concatAllUnits(units); + allUnits.forEach((adUnit) => { + adUnit.bids.forEach((bid) => { + let configForBidder = fetchConfigForBidder(bid.bidder); + if (configForBidder) { + let unOptimisedParamsField = createUnOptimisedParamsField(bid, configForBidder); + rivrAnalytics.context.auctionObject['ext.rivr.originalvalues'].push(unOptimisedParamsField); + } + }) + }); + } + } +}; + +export function concatAllUnits(units) { + return Array.prototype.concat.apply([], units); +} + +export function createUnOptimisedParamsField(bid, config) { + let floorPriceLabel = config['floorPriceLabel']; + let currencyLabel = config['currencyLabel']; + let pmpLabel = config['pmpLabel']; + return { + 'ext.rivr.demand_source_original': bid.bidder, + 'ext.rivr.bidfloor_original': bid.params[floorPriceLabel], + 'ext.rivr.currency_original': bid.params[currencyLabel], + 'ext.rivr.pmp_original': bid.params[pmpLabel], + } +} + +function fetchConfigForBidder(bidderName) { + let config = localStorage.getItem('rivr_config_string'); + if (config) { + let parsed = JSON.parse(config); + return parsed.demand.map((bidderConfig) => { + if (bidderName === bidderConfig.partner) { + return bidderConfig + }; + })[0]; + } +} +/** + * Expiring queue implementation. Fires callback on elapsed timeout since last last update or creation. + * @param callback + * @param ttl + * @constructor + */ +export function ExpiringQueue(sendImpressions, sendAuction, ttl, log) { + let queue = []; + let timeoutId; + + this.push = (event) => { + if (event instanceof Array) { + queue.push.apply(queue, event); + } else { + queue.push(event); + } + reset(); + }; + + this.popAll = () => { + let result = queue; + queue = []; + reset(); + return result; + }; + /** + * For test/debug purposes only + * @return {Array} + */ + this.peekAll = () => { + return queue; + }; + + this.init = reset; + + function reset() { + if (timeoutId) { + clearTimeout(timeoutId); + } + timeoutId = setTimeout(() => { + sendAuction(); + if (queue.length) { + sendImpressions(); + } + }, ttl); + } +}; + +function removeEmptyProperties(obj) { + Object.keys(obj).forEach(function(key) { + if (obj[key] && typeof obj[key] === 'object') removeEmptyProperties(obj[key]) + else if (obj[key] == null) delete obj[key] + }); +}; + +function getCookie(name) { + var value = '; ' + document.cookie; + var parts = value.split('; ' + name + '='); + if (parts.length == 2) return parts.pop().split(';').shift(); +} + +function storeAndReturnRivrUsrIdCookie() { + return document.cookie = 'rvr_usr_id=' + generateUUID(); +} + +// save the base class function +rivrAnalytics.originEnableAnalytics = rivrAnalytics.enableAnalytics; + +// override enableAnalytics so we can get access to the config passed in from the page +rivrAnalytics.enableAnalytics = (config) => { + let copiedUnits; + if (config.options.adUnits) { + let stringifiedAdUnits = JSON.stringify(config.options.adUnits); + copiedUnits = JSON.parse(stringifiedAdUnits); + } + rivrAnalytics.context = { + userId: getCookie(rivrUsrIdCookieKey) || storeAndReturnRivrUsrIdCookie(), + host: config.options.host || DEFAULT_HOST, + auctionObject: {}, + adUnits: copiedUnits, + siteCategories: config.options.siteCategories || [], + clientID: config.options.clientID, + authToken: config.options.authToken, + queue: new ExpiringQueue(sendImpressions, sendAuction, config.options.queueTimeout || DEFAULT_QUEUE_TIMEOUT) + }; + + let bannersIds = config.options.bannersIds; + if (bannersIds) { + if (bannersIds.length > 0) { + addHandlers(config.options.bannersIds); + } + } + logInfo('Rivr Analytics enabled with config', rivrAnalytics.context); + rivrAnalytics.originEnableAnalytics(config); +}; + +adaptermanager.registerAnalyticsAdapter({ + adapter: rivrAnalytics, + code: 'rivr' +}); + +export default rivrAnalytics diff --git a/modules/rivrAnalyticsAdapter.md b/modules/rivrAnalyticsAdapter.md new file mode 100644 index 00000000000..787034e362e --- /dev/null +++ b/modules/rivrAnalyticsAdapter.md @@ -0,0 +1,13 @@ +# Overview + +Module Name: Rivr Analytics Adapter + +Module Type: Analytics Adapter + +Maintainer: rnd@simplaex.com + +# Description + +Analytics adapter for www.rivr.ai. + +Contact support@simplaex.com for information and support. diff --git a/test/spec/modules/rivrAnalyticsAdapter_spec.js b/test/spec/modules/rivrAnalyticsAdapter_spec.js new file mode 100644 index 00000000000..0fc20171e0a --- /dev/null +++ b/test/spec/modules/rivrAnalyticsAdapter_spec.js @@ -0,0 +1,1132 @@ +import * as utils from 'src/utils'; +import analyticsAdapter from 'modules/rivrAnalyticsAdapter'; +import { + ExpiringQueue, + sendAuction, + sendImpressions, + reportClickEvent, + createUnOptimisedParamsField, + dataLoaderForHandler, + pinHandlerToHTMLElement, + setAuctionAbjectPosition, + createNewAuctionObject, + concatAllUnits, + trackAuctionEnd, +} from 'modules/rivrAnalyticsAdapter'; +import {expect} from 'chai'; +import adaptermanager from 'src/adaptermanager'; +import * as ajax from 'src/ajax'; +import CONSTANTS from 'src/constants.json'; + +const events = require('../../../src/events'); + +describe('RIVR Analytics adapter', () => { + const EXPIRING_QUEUE_TIMEOUT = 4000; + const EXPIRING_QUEUE_TIMEOUT_MOCK = 100; + const RVR_CLIENT_ID_MOCK = 'aCliendId'; + const SITE_CATEGORIES_MOCK = ['cat1', 'cat2']; + const EMITTED_AUCTION_ID = 1; + const TRACKER_BASE_URL_MOCK = 'tracker.rivr.simplaex.com'; + const UUID_REG_EXP = new RegExp('[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}', 'i'); + let sandbox; + let ajaxStub; + let timer; + + before(() => { + sandbox = sinon.sandbox.create(); + }); + + beforeEach(() => { + timer = sandbox.useFakeTimers(0); + ajaxStub = sandbox.stub(ajax, 'ajax'); + sinon.stub(events, 'getEvents').returns([]); + + adaptermanager.registerAnalyticsAdapter({ + code: 'rivr', + adapter: analyticsAdapter + }); + adaptermanager.enableAnalytics({ + provider: 'rivr', + options: { + clientID: RVR_CLIENT_ID_MOCK, + adUnits: [utils.deepClone(BANNER_AD_UNITS_MOCK)], + siteCategories: SITE_CATEGORIES_MOCK, + } + }); + }); + + afterEach(() => { + analyticsAdapter.disableAnalytics(); + events.getEvents.restore(); + ajaxStub.restore(); + timer.restore(); + }); + + after(() => { + sandbox.restore(); + }); + + it('ExpiringQueue should call sendImpression callback after expiring queue timeout is elapsed', (done) => { + const sendImpressionMock = () => { + let elements = queue.popAll(); + expect(elements).to.be.eql([1, 2, 3, 4]); + elements = queue.popAll(); + expect(elements).to.have.lengthOf(0); + expect(Date.now()).to.be.equal(200); + done(); + }; + const sendAuctionMock = () => {}; + + let queue = new ExpiringQueue( + sendImpressionMock, + sendAuctionMock, + EXPIRING_QUEUE_TIMEOUT_MOCK); + + queue.push(1); + + setTimeout(() => { + queue.push([2, 3]); + timer.tick(50); + }, 50); + setTimeout(() => { + queue.push([4]); + timer.tick(100); + }, 100); + timer.tick(50); + }); + + it('enableAnalytics - should configure host and clientID in adapter context', () => { + // adaptermanager.enableAnalytics() is called in beforeEach. If only called here it doesn't seem to work. + + expect(analyticsAdapter.context).to.have.property('host', TRACKER_BASE_URL_MOCK); + expect(analyticsAdapter.context).to.have.property('clientID', RVR_CLIENT_ID_MOCK); + }); + + it('enableAnalytics - should set a cookie containing a user id', () => { + expect(UUID_REG_EXP.test(analyticsAdapter.context.userId)).to.equal(true); + }); + + it('Firing AUCTION_INIT should set auction id of context when AUCTION_INIT event is fired', () => { + events.emit(CONSTANTS.EVENTS.AUCTION_INIT, {auctionId: EMITTED_AUCTION_ID, config: {}, timeout: 3000}); + const auctionId = analyticsAdapter.context.auctionObject.id; + expect(auctionId).to.be.eql(EMITTED_AUCTION_ID); + }); + + it('Firing AUCTION_INIT when rivr_should_optimise and rivr_model_version are in local storage, sets ext.rivr.optimiser and modelVersion of in auction context', () => { + const RIVR_SHOULD_OPTIMISE_VALUE_MOCK = 'optimise'; + const RIVR_MODEL_VERSION_VALUE_MOCK = 'some model version'; + + localStorage.setItem('rivr_should_optimise', RIVR_SHOULD_OPTIMISE_VALUE_MOCK); + localStorage.setItem('rivr_model_version', RIVR_MODEL_VERSION_VALUE_MOCK); + + events.emit(CONSTANTS.EVENTS.AUCTION_INIT, {auctionId: 2, config: {}, timeout: 3000}); + + let auctionObject2 = analyticsAdapter.context.auctionObject; + + expect(auctionObject2['ext.rivr.optimiser']).to.be.eql(RIVR_SHOULD_OPTIMISE_VALUE_MOCK); + expect(auctionObject2['modelVersion']).to.be.eql(RIVR_MODEL_VERSION_VALUE_MOCK); + + localStorage.removeItem('rivr_should_optimise'); + localStorage.removeItem('rivr_model_version'); + }); + + it('Firing AUCTION_INIT , when auction object is already there and rivr_config_string is not in local storage, it does not save unoptimized params in rivr original values', () => { + events.emit(CONSTANTS.EVENTS.AUCTION_INIT, {auctionId: 3, config: {}, timeout: 3000}); + + expect(analyticsAdapter.context.auctionObject['ext.rivr.originalvalues']).to.be.eql([]); + }); + + it('Firing AUCTION_INIT when rivr_should_optimise and rivr_model_version are NOT in local storage, does not set ext.rivr.optimiser and modelVersion of in auction context', () => { + localStorage.removeItem('rivr_should_optimise'); + localStorage.removeItem('rivr_model_version'); + + events.emit(CONSTANTS.EVENTS.AUCTION_INIT, {auctionId: 3, config: {}, timeout: 3000}); + + let auctionObject3 = analyticsAdapter.context.auctionObject; + + expect(auctionObject3['ext.rivr.optimiser']).to.be.eql('unoptimised'); + expect(auctionObject3['modelVersion']).to.be.eql(null); + }); + + it('Firing AUCTION_END it sets auction time end to current time', () => { + analyticsAdapter.context = utils.deepClone(CONTEXT_AFTER_AUCTION_INIT); + + const MILLIS_FROM_EPOCH_TO_NOW_MOCK = 477; + timer.tick(MILLIS_FROM_EPOCH_TO_NOW_MOCK); + + events.emit(CONSTANTS.EVENTS.AUCTION_END, BID_RESPONSE_MOCK); + + const endTime = analyticsAdapter.context.auctionTimeEnd; + expect(endTime).to.be.eql(MILLIS_FROM_EPOCH_TO_NOW_MOCK); + }); + + it('Firing AUCTION_END populates impressions array in auction object', () => { + analyticsAdapter.context = utils.deepClone(CONTEXT_AFTER_AUCTION_INIT); + + events.emit(CONSTANTS.EVENTS.AUCTION_END, AUCTION_END_EVENT_WITH_AD_UNITS_AND_BID_RESPONSES_MOCK); + + const impressions = analyticsAdapter.context.auctionObject.impressions; + expect(impressions.length).to.be.eql(3); + }); + + it('Firing BID_WON should set to 1 the status of the corresponding bid', () => { + analyticsAdapter.context.auctionObject = utils.deepClone(AUCTION_OBJECT_AFTER_AUCTION_END_MOCK); + + events.emit(CONSTANTS.EVENTS.BID_WON, BID_WON_MOCK); + + expect(analyticsAdapter.context.auctionObject.bidders.length).to.be.equal(3); + + expect(analyticsAdapter.context.auctionObject.bidders[0].bids[0].status).to.be.equal(0); + + expect(analyticsAdapter.context.auctionObject.bidders[1].bids[0].status).to.be.equal(0); + + expect(analyticsAdapter.context.auctionObject.bidders[2].bids[0].status).to.be.equal(1); + expect(analyticsAdapter.context.auctionObject.bidders[2].bids[1].status).to.be.equal(0); + }); + + it('when auction is initialized and authToken is defined and ExpiringQueue ttl expires, it sends the auction', () => { + events.emit(CONSTANTS.EVENTS.AUCTION_INIT, {auctionId: EMITTED_AUCTION_ID, config: {}, timeout: 3000}); + analyticsAdapter.context.authToken = 'anAuthToken'; + + expect(ajaxStub.notCalled).to.be.equal(true); + + timer.tick(EXPIRING_QUEUE_TIMEOUT + 500); + + expect(ajaxStub.calledOnce).to.be.equal(true); + }); + + it('when auction is initialized and authToken is defined and ExpiringQueue ttl expires, it resets auctionObject', () => { + events.emit(CONSTANTS.EVENTS.AUCTION_INIT, {auctionId: EMITTED_AUCTION_ID, config: {}, timeout: 3000}); + + analyticsAdapter.context.authToken = 'anAuthToken'; + events.emit(CONSTANTS.EVENTS.AUCTION_END, AUCTION_END_EVENT_WITH_AD_UNITS_AND_BID_RESPONSES_MOCK); + + let impressions = analyticsAdapter.context.auctionObject.impressions; + + expect(impressions.length).to.be.eql(3); + + timer.tick(EXPIRING_QUEUE_TIMEOUT + 500); + + let impressionsAfterSend = analyticsAdapter.context.auctionObject.impressions; + let biddersAfterSend = analyticsAdapter.context.auctionObject.bidders; + + expect(impressionsAfterSend.length).to.be.eql(0); + expect(biddersAfterSend.length).to.be.eql(0); + }); + + it('sendAuction(), when authToken is defined, it fires call clearing empty payload properties', () => { + analyticsAdapter.context = utils.deepClone(CONTEXT_AFTER_AUCTION_INIT); + analyticsAdapter.context.authToken = 'anAuthToken'; + analyticsAdapter.context.auctionObject.nullProperty = null; + analyticsAdapter.context.auctionObject.notNullProperty = 'aValue'; + + sendAuction(); + + expect(ajaxStub.getCall(0).args[0]).to.match(/http:\/\/tracker.rivr.simplaex.com\/(\w+)\/auctions/); + + const payload = JSON.parse(ajaxStub.getCall(0).args[2]); + + expect(payload.Auction.notNullProperty).to.be.equal('aValue'); + expect(payload.nullProperty).to.be.equal(undefined); + + analyticsAdapter.context.authToken = undefined; + }); + + it('sendAuction(), when authToken is not defined, it does not fire call', () => { + analyticsAdapter.context = utils.deepClone(CONTEXT_AFTER_AUCTION_INIT); + analyticsAdapter.context.authToken = undefined; + analyticsAdapter.context.auctionObject.nullProperty = null; + analyticsAdapter.context.auctionObject.notNullProperty = 'aValue'; + + expect(ajaxStub.callCount).to.be.equal(0); + + sendAuction(); + + expect(ajaxStub.callCount).to.be.equal(0); + }); + + it('sendImpressions(), when authToken is not defined, it does not fire call', () => { + analyticsAdapter.context = utils.deepClone(CONTEXT_AFTER_AUCTION_INIT); + analyticsAdapter.context.authToken = undefined; + analyticsAdapter.context.auctionObject.nullProperty = null; + analyticsAdapter.context.auctionObject.notNullProperty = 'aValue'; + + expect(ajaxStub.callCount).to.be.equal(0); + + sendImpressions(); + + expect(ajaxStub.callCount).to.be.equal(0); + }); + + it('sendImpressions(), when authToken is defined and there are impressions, it sends impressions to the tracker', () => { + const aMockString = 'anImpressionPropertyValue'; + const IMPRESSION_MOCK = { anImpressionProperty: aMockString }; + const CLIENT_ID_MOCK = 'aClientID'; + analyticsAdapter.context = utils.deepClone(CONTEXT_AFTER_AUCTION_INIT); + analyticsAdapter.context.authToken = 'anAuthToken'; + analyticsAdapter.context.clientID = CLIENT_ID_MOCK; + analyticsAdapter.context.queue = new ExpiringQueue( + () => {}, + () => {}, + EXPIRING_QUEUE_TIMEOUT_MOCK + ); + + analyticsAdapter.context.queue.push(IMPRESSION_MOCK); + + expect(ajaxStub.callCount).to.be.equal(0); + + sendImpressions(); + + const payload = JSON.parse(ajaxStub.getCall(0).args[2]); + + expect(ajaxStub.callCount).to.be.equal(1); + expect(payload.impressions.length).to.be.equal(1); + expect(ajaxStub.getCall(0).args[0]).to.match(/http:\/\/tracker.rivr.simplaex.com\/aClientID\/impressions/); + expect(payload.impressions[0].anImpressionProperty).to.be.equal(aMockString); + }); + + it('reportClickEvent() calls endpoint', () => { + const CLIENT_ID_MOCK = 'aClientId'; + const AUTH_TOKEN_MOCK = 'aToken'; + const CLICK_URL_MOCK = 'clickURLMock'; + const EVENT_MOCK = { + currentTarget: { + getElementsByTagName: () => { + return [ + { + getAttribute: (attributeName) => { + return CLICK_URL_MOCK; + } + } + ] + } + } + }; + analyticsAdapter.context = utils.deepClone(CONTEXT_AFTER_AUCTION_INIT); + analyticsAdapter.context.authToken = AUTH_TOKEN_MOCK; + analyticsAdapter.context.clientID = CLIENT_ID_MOCK; + analyticsAdapter.context.auctionObject.nullProperty = null; + analyticsAdapter.context.auctionObject.notNullProperty = 'aValue'; + + expect(ajaxStub.callCount).to.be.equal(0); + + reportClickEvent(EVENT_MOCK); + + const payload = JSON.parse(ajaxStub.getCall(0).args[2]); + const options = ajaxStub.getCall(0).args[3]; + + expect(ajaxStub.callCount).to.be.equal(1); + expect(ajaxStub.getCall(0).args[0]).to.match(/http:\/\/tracker.rivr.simplaex.com\/aClientId\/clicks/); + expect(options.customHeaders.Authorization).to.equal('Basic aToken'); + expect(payload.timestamp).to.be.equal('1970-01-01T00:00:00.000Z'); + expect(payload.request_id).to.be.a('string'); + expect(payload.click_url).to.be.equal(CLICK_URL_MOCK); + }); + + it('createUnOptimisedParamsField(), creates object with unoptimized properties', () => { + const CONFIG_FOR_BIDDER_MOCK = { + floorPriceLabel: 'floorPriceLabelForTestBidder', + currencyLabel: 'currencyLabelForTestBidder', + pmpLabel: 'pmpLabelForTestBidder', + }; + const BID_MOCK = { + bidder: 'aBidder', + params: { + floorPriceLabelForTestBidder: 'theOriginalBidFloor', + currencyLabelForTestBidder: 'theOriginalCurrency', + pmpLabelForTestBidder: 'theOriginalPmp', + }, + }; + + const result = createUnOptimisedParamsField(BID_MOCK, CONFIG_FOR_BIDDER_MOCK); + + expect(result['ext.rivr.demand_source_original']).to.be.equal('aBidder'); + expect(result['ext.rivr.bidfloor_original']).to.be.equal('theOriginalBidFloor'); + expect(result['ext.rivr.currency_original']).to.be.equal('theOriginalCurrency'); + expect(result['ext.rivr.pmp_original']).to.be.equal('theOriginalPmp'); + }); + + it('dataLoaderForHandler(), when iframe and the ad image contained in it are there, it calls the specialized handler', () => { + const MOCK_ELEMENT = { + getElementsByTagName: () => { + return [ + { + contentDocument: { + getElementsByTagName: () => { + return ['displayedImpressionMock'] + } + }, + aDummyProperty: 'aDummyPropertyValue' + } + ] + } + }; + + var specializedHandlerSpy = sinon.spy(); + + expect(specializedHandlerSpy.callCount).to.be.equal(0); + + dataLoaderForHandler(MOCK_ELEMENT, specializedHandlerSpy); + + expect(specializedHandlerSpy.callCount).to.be.equal(1); + expect(specializedHandlerSpy.firstCall.args[0].aDummyProperty).to.be.equal('aDummyPropertyValue'); + expect(specializedHandlerSpy.firstCall.args[0].contentDocument.getElementsByTagName()[0]).to.be.equal('displayedImpressionMock'); + }); + + it('dataLoaderForHandler(), when iframe is not there, it requests animation frame', () => { + const MOCK_ELEMENT = { + getElementsByTagName: () => { + return [ + { + contentDocument: { + getElementsByTagName: () => { + return [] + } + }, + } + ] + } + }; + + const specializedHandlerSpy = sinon.spy(); + const requestAnimationFrameStub = sinon.stub(window, 'requestAnimationFrame'); + expect(requestAnimationFrameStub.callCount).to.be.equal(0); + + dataLoaderForHandler(MOCK_ELEMENT, specializedHandlerSpy); + + expect(requestAnimationFrameStub.callCount).to.be.equal(1); + + requestAnimationFrameStub.restore(); + }); + + it('pinHandlerToHTMLElement(), when element is there, it calls dataLoaderForHandler', () => { + const ELEMENT_MOCK = { + anElementProperty: 'aValue' + } + const dataLoaderForHandlerSpy = sinon.spy(); + sinon.stub(window, 'requestAnimationFrame'); + + sinon.stub(document, 'getElementById').returns(ELEMENT_MOCK); + + expect(dataLoaderForHandlerSpy.callCount).to.be.equal(0); + + pinHandlerToHTMLElement('', dataLoaderForHandlerSpy, () => {}); + + expect(dataLoaderForHandlerSpy.callCount).to.be.equal(1); + expect(dataLoaderForHandlerSpy.firstCall.args[0].anElementProperty).to.be.equal('aValue'); + + window.requestAnimationFrame.restore(); + document.getElementById.restore(); + }); + + it('pinHandlerToHTMLElement(), when element is not there, it requests animation frame', () => { + const dataLoaderForHandlerSpy = sinon.spy(); + const requestAnimationFrameStub = sinon.stub(window, 'requestAnimationFrame'); + + sinon.stub(document, 'getElementById').returns(undefined); + + expect(requestAnimationFrameStub.callCount).to.be.equal(0); + + pinHandlerToHTMLElement('', dataLoaderForHandlerSpy, () => {}); + + expect(dataLoaderForHandlerSpy.callCount).to.be.equal(0); + expect(requestAnimationFrameStub.callCount).to.be.equal(1); + + requestAnimationFrameStub.restore(); + document.getElementById.restore(); + }); + + it('setAuctionAbjectPosition(), it sets latitude and longitude in auction object', () => { + const POSITION_MOCK = { + coords: { + latitude: 'aLatitude', + longitude: 'aLongitude', + } + } + analyticsAdapter.context = utils.deepClone(CONTEXT_AFTER_AUCTION_INIT); + + setAuctionAbjectPosition(POSITION_MOCK); + + expect(analyticsAdapter.context.auctionObject.device.geo.lat).to.be.equal('aLatitude'); + }); + + it('createNewAuctionObject(), it creates a new auction object', () => { + const MILLIS_FROM_EPOCH_TO_NOW_MOCK = 123456; + timer.tick(MILLIS_FROM_EPOCH_TO_NOW_MOCK); + + const result = createNewAuctionObject(); + + expect(result.device.deviceType).to.be.equal(2); + expect(result.publisher).to.be.equal(RVR_CLIENT_ID_MOCK); + expect(result.device.userAgent).to.be.equal(navigator.userAgent); + expect(result.timestamp).to.be.equal(MILLIS_FROM_EPOCH_TO_NOW_MOCK); + expect(result.site.domain.substring(0, 9)).to.be.equal('localhost'); + expect(result.site.page).to.be.equal('/context.html'); + expect(result.site.categories).to.be.equal(SITE_CATEGORIES_MOCK); + }); + + it('concatAllUnits(), returns a flattened array with all banner and video adunits', () => { + const allAdUnits = [BANNER_AD_UNITS_MOCK, VIDEO_AD_UNITS_MOCK]; + + const result = concatAllUnits(allAdUnits); + + expect(result.length).to.be.eql(2); + expect(result[0].code).to.be.eql('banner-container1'); + expect(result[1].code).to.be.eql('video'); + }); + + it('trackAuctionEnd(), populates the bidders array from bidderRequests and bidsReceived', () => { + trackAuctionEnd(AUCTION_END_EVENT_WITH_BID_REQUESTS_AND_BID_RESPONSES_MOCK); + + const result = analyticsAdapter.context.auctionObject.bidders; + + expect(result.length).to.be.eql(3); + + expect(result[0].id).to.be.eql('vuble'); + expect(result[0].bids[0].price).to.be.eql(0); + + expect(result[1].id).to.be.eql('vertamedia'); + expect(result[1].bids[0].price).to.be.eql(0); + + expect(result[2].id).to.be.eql('appnexus'); + expect(result[2].bids[0].price).to.be.eql(0.5); + expect(result[2].bids[0].impId).to.be.eql('/19968336/header-bid-tag-0'); + expect(result[2].bids[1].price).to.be.eql(0.7); + expect(result[2].bids[1].impId).to.be.eql('/19968336/header-bid-tag-1'); + }); + + it('trackAuctionEnd(), populates the impressions array from adUnits', () => { + trackAuctionEnd(AUCTION_END_EVENT_WITH_AD_UNITS_AND_BID_RESPONSES_MOCK); + + const result = analyticsAdapter.context.auctionObject.impressions; + + expect(result.length).to.be.eql(3); + + expect(result[0].id).to.be.eql('/19968336/header-bid-tag-0'); + expect(result[0].adType).to.be.eql('banner'); + + expect(result[1].id).to.be.eql('/19968336/header-bid-tag-1'); + expect(result[1].adType).to.be.eql('banner'); + expect(result[1].acceptedSizes).to.be.eql([{w: 728, h: 90}, {w: 970, h: 250}]); + expect(result[1].banner).to.be.eql({w: 300, h: 250}); + + expect(result[2].id).to.be.eql('video'); + expect(result[2].adType).to.be.eql('video'); + expect(result[2].acceptedSizes).to.be.eql([{w: 640, h: 360}, {w: 640, h: 480}]); + }); + + const BANNER_AD_UNITS_MOCK = [ + { + code: 'banner-container1', + mediaTypes: { + banner: { + sizes: [[300, 250], [300, 200], [300, 600]] + } + }, + bids: [ + { + bidder: 'appnexus', + params: { + placementId: '10433394', + reserve: 0.5 + } + }, + { + bidder: 'huddledmasses', + params: { + placement_id: 0 + } + }, + ] + } + ]; + + const VIDEO_AD_UNITS_MOCK = [ + { + code: 'video', + mediaTypes: { + video: { + context: 'outstream', + sizes: [[640, 360], [640, 480]] + } + }, + bids: [ + { + bidder: 'vuble', + params: { + env: 'net', + pubId: '18', + zoneId: '12345', + referrer: 'http://www.vuble.tv/', // optional + floorPrice: 5.00 // optional + } + }, + { + bidder: 'vertamedia', + params: { + aid: 331133 + } + } + ] + }]; + + const REQUEST = { + bidderCode: 'adapter', + auctionId: '5018eb39-f900-4370-b71e-3bb5b48d324f', + bidderRequestId: '1a6fc81528d0f6', + bids: [{ + bidder: 'adapter', + params: {}, + adUnitCode: 'container-1', + transactionId: 'de90df62-7fd0-4fbc-8787-92d133a7dc06', + sizes: [[300, 250]], + bidId: '208750227436c1', + bidderRequestId: '1a6fc81528d0f6', + auctionId: '5018eb39-f900-4370-b71e-3bb5b48d324f' + }], + auctionStart: 1509369418387, + timeout: 3000, + start: 1509369418389 + }; + + const REQUEST2 = { + bidderCode: 'adapter', + auctionId: '5018eb39-f900-4370-b71e-3bb5b48d324f', + bidderRequestId: '1a6fc81528d0f6', + bids: [{ + bidder: 'adapter', + params: {}, + adUnitCode: 'container-1', + transactionId: 'de90df62-7fd0-4fbc-8787-92d133a7dc06', + sizes: [[300, 250]], + bidId: 'request2id', + bidderRequestId: '1a6fc81528d0f6', + auctionId: '5018eb39-f900-4370-b71e-3bb5b48d324f' + }], + auctionStart: 1509369418387, + timeout: 3000, + start: 1509369418389 + }; + + const REQUEST3 = { + bidderCode: 'adapter', + auctionId: '5018eb39-f900-4370-b71e-3bb5b48d324f', + bidderRequestId: '1a6fc81528d0f6', + bids: [{ + bidder: 'adapter', + params: {}, + adUnitCode: 'container-1', + transactionId: 'de90df62-7fd0-4fbc-8787-92d133a7dc06', + sizes: [[300, 250]], + bidId: 'request3id', + bidderRequestId: '1a6fc81528d0f6', + auctionId: '5018eb39-f900-4370-b71e-3bb5b48d324f' + }], + auctionStart: 1509369418387, + timeout: 3000, + start: 1509369418389 + }; + + const BID_RESPONSE_MOCK = { + bidderCode: 'adapter', + width: 300, + height: 250, + statusMessage: 'Bid available', + getStatusCode: () => 1, + adId: '208750227436c1', + mediaType: 'banner', + cpm: 0.015, + creativeId: 999, + ad: '', + auctionId: '5018eb39-f900-4370-b71e-3bb5b48d324f', + responseTimestamp: 1509369418832, + requestTimestamp: 1509369418389, + bidder: 'adapter', + adUnitCode: 'container-1', + timeToRespond: 443, + currency: 'EU', + size: '300x250' + }; + + const BID_WON_MOCK = { + bidderCode: 'appnexus', + width: 300, + height: 600, + statusMessage: 'Bid available', + adId: '63301dc59deb3b', + mediaType: 'banner', + source: 'client', + requestId: '63301dc59deb3b', + cpm: 0.5, + creativeId: 98493581, + currency: 'USD', + netRevenue: true, + ttl: 300, + appnexus: { + buyerMemberId: 9325 + }, + ad: '...HTML CONTAINING THE AD...', + auctionId: '1825871c-b4c2-401a-b219-64549d412495', + responseTimestamp: 1540560447955, + requestTimestamp: 1540560447622, + bidder: 'appnexus', + adUnitCode: '/19968336/header-bid-tag-0', + timeToRespond: 333, + pbLg: '0.50', + pbMg: '0.50', + pbHg: '0.50', + pbAg: '0.50', + pbDg: '0.50', + pbCg: '', + size: '300x600', + adserverTargeting: { + hb_bidder: 'appnexus', + hb_adid: '63301dc59deb3b', + hb_pb: '0.50', + hb_size: '300x600', + hb_source: 'client', + hb_format: 'banner' + }, + status: 'rendered', + params: [ + { + placementId: 13144370 + } + ] + }; + + const CONTEXT_AFTER_AUCTION_INIT = { + host: TRACKER_BASE_URL_MOCK, + clientID: RVR_CLIENT_ID_MOCK, + queue: { + mockProp: 'mockValue' + }, + auctionObject: { + id: null, + timestamp: null, + at: null, + bcat: [], + imp: [], + app: { + id: null, + name: null, + domain: window.location.href, + bundle: null, + cat: [], + publisher: { + id: null, + name: null + } + }, + site: { + id: null, + name: null, + domain: window.location.href, + cat: [], + publisher: { + id: null, + name: null + } + }, + device: { + geo: {} + }, + user: { + id: null, + yob: null, + gender: null, + }, + bidResponses: [], + bidRequests: [], + 'ext.rivr.optimiser': 'unoptimised', + modelVersion: null, + 'ext.rivr.originalvalues': [] + } + }; + + const AUCTION_END_EVENT_WITH_AD_UNITS_AND_BID_RESPONSES_MOCK = { + auctionId: 'f6c1d093-14a3-4ade-bc7d-1de37e7cbdb2', + auctionStart: 1540560217395, + auctionEnd: 1540560217703, + auctionStatus: 'completed', + adUnits: [ + { + code: '/19968336/header-bid-tag-0', + mediaTypes: { + banner: { + sizes: [ + [ + 300, + 250 + ], + [ + 300, + 600 + ] + ] + } + }, + bids: [ + { + bidder: 'appnexus', + params: { + placementId: 13144370 + }, + crumbs: { + pubcid: '87eb6b0e-e1a8-42a9-b58d-e93a382e2d9b' + } + } + ], + transactionId: 'aee9bf8d-6d8f-425b-a42a-52c875371ebc', + sizes: [ + [ + 300, + 250 + ], + [ + 300, + 600 + ] + ] + }, + { + code: '/19968336/header-bid-tag-1', + mediaTypes: { + banner: { + sizes: [ + [ + 728, + 90 + ], + [ + 970, + 250 + ] + ] + } + }, + bids: [ + { + bidder: 'appnexus', + params: { + placementId: 13144370 + }, + crumbs: { + pubcid: '87eb6b0e-e1a8-42a9-b58d-e93a382e2d9b' + } + } + ], + transactionId: '3d5f0f89-e9cd-4714-b314-3f0fb7fcf8e3', + sizes: [ + [ + 728, + 90 + ], + [ + 970, + 250 + ] + ] + }, + { + code: 'video', + mediaTypes: { + video: { + context: 'outstream', + sizes: [ + [ + 640, + 360 + ], + [ + 640, + 480 + ] + ] + } + }, + bids: [ + { + bidder: 'vuble', + params: { + env: 'net', + pubId: '18', + zoneId: '12345', + referrer: 'http: //www.vuble.tv/', + floorPrice: 5 + }, + crumbs: { + pubcid: '87eb6b0e-e1a8-42a9-b58d-e93a382e2d9b' + } + }, + { + bidder: 'vertamedia', + params: { + aid: 331133 + }, + crumbs: { + pubcid: '87eb6b0e-e1a8-42a9-b58d-e93a382e2d9b' + } + } + ], + transactionId: 'df11a105-4eef-4ceb-bbc3-a49224f7c49d' + } + ], + adUnitCodes: [ + '/19968336/header-bid-tag-0', + '/19968336/header-bid-tag-1', + 'video' + ], + bidderRequests: [], + bidsReceived: [ + { + bidderCode: 'appnexus', + width: 300, + height: 250, + statusMessage: 'Bid available', + adId: '6de82e80757293', + mediaType: 'banner', + source: 'client', + requestId: '6de82e80757293', + cpm: 0.5, + creativeId: 96846035, + currency: 'USD', + netRevenue: true, + ttl: 300, + appnexus: { + buyerMemberId: 9325 + }, + ad: '...HTML CONTAINING THE AD...', + auctionId: 'f6c1d093-14a3-4ade-bc7d-1de37e7cbdb2', + responseTimestamp: 1540560217636, + requestTimestamp: 1540560217403, + bidder: 'appnexus', + adUnitCode: '/19968336/header-bid-tag-1', + timeToRespond: 233, + pbLg: '0.50', + pbMg: '0.50', + pbHg: '0.50', + pbAg: '0.50', + pbDg: '0.50', + pbCg: '', + size: '728x90', + adserverTargeting: { + hb_bidder: 'appnexus', + hb_adid: '7e1a45d85bd57c', + hb_pb: '0.50', + hb_size: '728x90', + hb_source: 'client', + hb_format: 'banner' + } + } + ], + winningBids: [], + timeout: 3000 + }; + + const AUCTION_OBJECT_AFTER_AUCTION_END_MOCK = { + bidders: [ + { + id: 'vuble', + bids: [ + { + adomain: [ + '' + ], + clearPrice: 0, + impId: 'video', + price: 0, + status: 0 + } + ] + }, + { + id: 'vertamedia', + bids: [ + { + adomain: [ + '' + ], + clearPrice: 0, + impId: 'video', + price: 0, + status: 0 + } + ] + }, + { + id: 'appnexus', + bids: [ + { + adomain: [ + '' + ], + clearPrice: 0, + impId: '/19968336/header-bid-tag-0', + price: 0.5, + status: 0 + }, + { + adomain: [ + '' + ], + clearPrice: 0, + impId: '/19968336/header-bid-tag-1', + price: 0.7, + status: 0 + } + ] + } + ], + impressions: [] + }; + + const AUCTION_END_EVENT_WITH_BID_REQUESTS_AND_BID_RESPONSES_MOCK = { + auctionId: 'f6c1d093-14a3-4ade-bc7d-1de37e7cbdb2', + auctionStart: 1540560217395, + auctionEnd: 1540560217703, + auctionStatus: 'completed', + adUnits: [], + adUnitCodes: [ + '/19968336/header-bid-tag-0', + '/19968336/header-bid-tag-1', + 'video' + ], + bidderRequests: [ + { + bidderCode: 'vuble', + auctionId: 'f6c1d093-14a3-4ade-bc7d-1de37e7cbdb2', + bidderRequestId: '1bb11e055665bc', + bids: [ + { + bidder: 'vuble', + crumbs: { + pubcid: '87eb6b0e-e1a8-42a9-b58d-e93a382e2d9b' + }, + adUnitCode: 'video', + transactionId: 'df11a105-4eef-4ceb-bbc3-a49224f7c49d', + bidId: '2859b890da7418', + bidderRequestId: '1bb11e055665bc', + auctionId: 'f6c1d093-14a3-4ade-bc7d-1de37e7cbdb2', + src: 'client', + bidRequestsCount: 1 + } + ], + auctionStart: 1540560217395, + timeout: 3000, + refererInfo: { + referer: 'http: //localhost: 8080/', + reachedTop: true, + numIframes: 0, + stack: [ + 'http://localhost:8080/' + ] + }, + start: 1540560217401, + doneCbCallCount: 0 + }, + { + bidderCode: 'vertamedia', + auctionId: 'f6c1d093-14a3-4ade-bc7d-1de37e7cbdb2', + bidderRequestId: '3c2cbf7f1466cb', + bids: [ + { + bidder: 'vertamedia', + params: { + aid: 331133 + }, + crumbs: { + pubcid: '87eb6b0e-e1a8-42a9-b58d-e93a382e2d9b' + }, + adUnitCode: 'video', + transactionId: 'df11a105-4eef-4ceb-bbc3-a49224f7c49d', + bidId: '45b3ad5c2dc794', + bidderRequestId: '3c2cbf7f1466cb', + auctionId: 'f6c1d093-14a3-4ade-bc7d-1de37e7cbdb2', + bidRequestsCount: 1 + } + ], + auctionStart: 1540560217395, + timeout: 3000, + start: 1540560217401 + }, + { + bidderCode: 'appnexus', + auctionId: 'f6c1d093-14a3-4ade-bc7d-1de37e7cbdb2', + bidderRequestId: '5312eef4418cd7', + bids: [ + { + bidder: 'appnexus', + params: { + placementId: 13144370 + }, + crumbs: { + pubcid: '87eb6b0e-e1a8-42a9-b58d-e93a382e2d9b' + }, + adUnitCode: '/19968336/header-bid-tag-0', + transactionId: 'aee9bf8d-6d8f-425b-a42a-52c875371ebc', + bidId: '6de82e80757293', + bidderRequestId: '5312eef4418cd7', + auctionId: 'f6c1d093-14a3-4ade-bc7d-1de37e7cbdb2', + src: 'client', + bidRequestsCount: 1 + }, + { + bidder: 'appnexus', + params: { + placementId: 13144370 + }, + crumbs: { + pubcid: '87eb6b0e-e1a8-42a9-b58d-e93a382e2d9b' + }, + adUnitCode: '/19968336/header-bid-tag-1', + transactionId: '3d5f0f89-e9cd-4714-b314-3f0fb7fcf8e3', + bidId: '7e1a45d85bd57c', + bidderRequestId: '5312eef4418cd7', + auctionId: 'f6c1d093-14a3-4ade-bc7d-1de37e7cbdb2', + src: 'client', + bidRequestsCount: 1 + } + ], + auctionStart: 1540560217395, + timeout: 3000, + start: 1540560217403, + doneCbCallCount: 0 + } + ], + bidsReceived: [ + { + bidderCode: 'appnexus', + adId: '6de82e80757293', + mediaType: 'banner', + source: 'client', + requestId: '6de82e80757293', + cpm: 0.5, + creativeId: 96846035, + appnexus: { + buyerMemberId: 9325 + }, + auctionId: 'f6c1d093-14a3-4ade-bc7d-1de37e7cbdb2', + bidder: 'appnexus', + adUnitCode: '/19968336/header-bid-tag-0', + }, + { + bidderCode: 'appnexus', + adId: '7e1a45d85bd57c', + mediaType: 'banner', + source: 'client', + requestId: '7e1a45d85bd57c', + cpm: 0.7, + creativeId: 96846035, + appnexus: { + buyerMemberId: 9325 + }, + auctionId: 'f6c1d093-14a3-4ade-bc7d-1de37e7cbdb2', + bidder: 'appnexus', + adUnitCode: '/19968336/header-bid-tag-1', + } + ], + winningBids: [], + timeout: 3000 + }; +});