Skip to content

Commit

Permalink
ZetaGlobalSsp AnalyticsAdapter: provide zeta params through cache (#1…
Browse files Browse the repository at this point in the history 
…0402)

* ZetaGlobalSsp Analytics Adapter: save ZetaParams to cache

* bugfix

* test

* fixes by review

---------

Co-authored-by: Surovenko Alexey <surovenko.alexey@gmail.com>
Co-authored-by: Alexey Surovenko <ASurovenko@vdhk6ddf9m.home>
  • Loading branch information
@asurovenko-zeta @surovenko
3 people authored Sep 11, 2023
1 parent b892374 commit 85bb955
Show file tree
Hide file tree
Showing 2 changed files with 83 additions and 44 deletions.
62 changes: 59 additions & 3 deletions modules/zeta_global_sspAnalyticsAdapter.js
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { logInfo, logError } from '../src/utils.js';
import {logInfo, logError, deepClone} from '../src/utils.js';
import { ajax } from '../src/ajax.js';
import adapterManager from '../src/adapterManager.js';
import CONSTANTS from '../src/constants.json';
Expand All @@ -10,6 +10,10 @@ const ADAPTER_CODE = 'zeta_global_ssp';
const BASE_URL = 'https://ssp.disqus.com/prebid/event';
const LOG_PREFIX = 'ZetaGlobalSsp-Analytics: ';

const cache = {
auctions: {}
};

/// /////////// VARIABLES ////////////////////////////////////

let publisherId; // int
Expand All @@ -24,19 +28,71 @@ function sendEvent(eventType, event) {
);
}

function getZetaParams(event) {
if (event.adUnits) {
for (const i in event.adUnits) {
const unit = event.adUnits[i];
if (unit.bids) {
for (const j in unit.bids) {
const bid = unit.bids[j];
if (bid.bidder === ADAPTER_CODE && bid.params) {
return bid.params;
}
}
}
}
}
return null;
}

/// /////////// ADAPTER EVENT HANDLER FUNCTIONS //////////////

function adRenderSucceededHandler(args) {
function adRenderSucceededHandler(originalArgs) {
const args = deepClone(originalArgs);
let eventType = CONSTANTS.EVENTS.AD_RENDER_SUCCEEDED
logInfo(LOG_PREFIX + 'handle ' + eventType + ' event');

if (args.bid) {
// cleanup object
delete args.bid.metrics;
delete args.bid.ad;

// set zetaParams from cache
if (args.bid.auctionId) {
const zetaParams = cache.auctions[args.bid.auctionId];
if (zetaParams) {
args.bid.params = [ zetaParams ];
}
}
}

sendEvent(eventType, args);
}

function auctionEndHandler(args) {
function auctionEndHandler(originalArgs) {
const args = deepClone(originalArgs);
let eventType = CONSTANTS.EVENTS.AUCTION_END;
logInfo(LOG_PREFIX + 'handle ' + eventType + ' event');

// cleanup object
delete args.metrics;
if (args.bidderRequests) {
args.bidderRequests.forEach(requests => {
delete requests.metrics;
if (requests.bids) {
requests.bids.forEach(bid => {
delete bid.metrics;
})
}
})
}

// save zetaParams to cache
const zetaParams = getZetaParams(args);
if (zetaParams && args.auctionId) {
cache.auctions[args.auctionId] = zetaParams;
}

sendEvent(eventType, args);
}

Expand Down
65 changes: 24 additions & 41 deletions test/spec/modules/zeta_global_sspAnalyticsAdapter_spec.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,19 +2,20 @@ import zetaAnalyticsAdapter from 'modules/zeta_global_sspAnalyticsAdapter.js';
import {config} from 'src/config';
import CONSTANTS from 'src/constants.json';
import {server} from '../../mocks/xhr.js';
import {logError} from '../../../src/utils';

let utils = require('src/utils');
let events = require('src/events');

const MOCK = {
STUB: {
'auctionId': '25c6d7f5-699a-4bfc-87c9-996f915341fa'
},
const EVENTS = {
AUCTION_END: {
'auctionId': '75e394d9-ccce-4978-9238-91e6a1ac88a1',
'timestamp': 1638441234544,
'auctionEnd': 1638441234784,
'auctionStatus': 'completed',
'metrics': {
'someMetric': 1
},
'adUnits': [
{
'code': '/19968336/header-bid-tag-0',
Expand Down Expand Up @@ -74,13 +75,6 @@ const MOCK = {
'bids': [
{
'bidder': 'zeta_global_ssp',
'params': {
'sid': 111,
'tags': {
'shortname': 'prebid_analytics_event_test_shortname',
'position': 'test_position'
}
},
'mediaTypes': {
'banner': {
'sizes': [
Expand Down Expand Up @@ -309,6 +303,9 @@ const MOCK = {
'cpm': 2.258302852806723,
'currency': 'USD',
'ad': 'test_ad',
'metrics': {
'someMetric': 0
},
'ttl': 200,
'creativeId': '456456456',
'netRevenue': true,
Expand Down Expand Up @@ -344,11 +341,7 @@ const MOCK = {
'status': 'rendered',
'params': [
{
'sid': 111,
'tags': {
'shortname': 'prebid_analytics_event_test_shortname',
'position': 'test_position'
}
'nonZetaParam': 'nonZetaValue'
}
]
},
Expand Down Expand Up @@ -392,33 +385,23 @@ describe('Zeta Global SSP Analytics Adapter', function() {
zetaAnalyticsAdapter.disableAnalytics();
});

it('events are sent', function() {
this.timeout(5000);
events.emit(CONSTANTS.EVENTS.AUCTION_INIT, MOCK.STUB);
events.emit(CONSTANTS.EVENTS.AUCTION_END, MOCK.AUCTION_END);
events.emit(CONSTANTS.EVENTS.BID_ADJUSTMENT, MOCK.STUB);
events.emit(CONSTANTS.EVENTS.BID_TIMEOUT, MOCK.STUB);
events.emit(CONSTANTS.EVENTS.BID_REQUESTED, MOCK.STUB);
events.emit(CONSTANTS.EVENTS.BID_RESPONSE, MOCK.STUB);
events.emit(CONSTANTS.EVENTS.NO_BID, MOCK.STUB);
events.emit(CONSTANTS.EVENTS.BID_WON, MOCK.STUB);
events.emit(CONSTANTS.EVENTS.BIDDER_DONE, MOCK.STUB);
events.emit(CONSTANTS.EVENTS.BIDDER_ERROR, MOCK.STUB);
events.emit(CONSTANTS.EVENTS.SET_TARGETING, MOCK.STUB);
events.emit(CONSTANTS.EVENTS.BEFORE_REQUEST_BIDS, MOCK.STUB);
events.emit(CONSTANTS.EVENTS.BEFORE_BIDDER_HTTP, MOCK.STUB);
events.emit(CONSTANTS.EVENTS.REQUEST_BIDS, MOCK.STUB);
events.emit(CONSTANTS.EVENTS.ADD_AD_UNITS, MOCK.STUB);
events.emit(CONSTANTS.EVENTS.AD_RENDER_FAILED, MOCK.STUB);
events.emit(CONSTANTS.EVENTS.AD_RENDER_SUCCEEDED, MOCK.AD_RENDER_SUCCEEDED);
events.emit(CONSTANTS.EVENTS.TCF2_ENFORCEMENT, MOCK.STUB);
events.emit(CONSTANTS.EVENTS.AUCTION_DEBUG, MOCK.STUB);
events.emit(CONSTANTS.EVENTS.BID_VIEWABLE, MOCK.STUB);
events.emit(CONSTANTS.EVENTS.STALE_RENDER, MOCK.STUB);
it('Move ZetaParams through analytics events', function() {
this.timeout(3000);

events.emit(CONSTANTS.EVENTS.AUCTION_END, EVENTS.AUCTION_END);
events.emit(CONSTANTS.EVENTS.AD_RENDER_SUCCEEDED, EVENTS.AD_RENDER_SUCCEEDED);

expect(requests.length).to.equal(2);
expect(JSON.parse(requests[0].requestBody)).to.deep.equal(MOCK.AUCTION_END);
expect(JSON.parse(requests[1].requestBody)).to.deep.equal(MOCK.AD_RENDER_SUCCEEDED);
const auctionEnd = JSON.parse(requests[0].requestBody);
const auctionSucceeded = JSON.parse(requests[1].requestBody);

expect(auctionEnd.metrics).to.be.undefined;

expect(auctionSucceeded.bid.ad).to.be.undefined;
expect(auctionSucceeded.bid.metrics).to.be.undefined;

expect(auctionSucceeded.bid.params[0]).to.be.deep.equal(EVENTS.AUCTION_END.adUnits[0].bids[0].params);
expect(EVENTS.AUCTION_END.adUnits[0].bids[0].bidder).to.be.equal('zeta_global_ssp');
});
});
});

0 comments on commit 85bb955

Please sign in to comment.