forked from prebid/Prebid.js
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Rubicon feature/s2s test module (prebid#1678)
* added new server-to-server testing module * fixed linting errors * s2sTesting module fixes * s2sTesting module fixes * removed "both" option from s2s ab testing module * removed leftover StorageManager reference * s2sTesting module improvements * s2sTesting module improvement * Revert "Merge branch 'bugfix/pbs-adapter-storagemanager' into rubicon-feature/s2s-test-module" This reverts commit be232c6, reversing changes made to 4a3abd7. * minor s2sTesting fixes
- Loading branch information
1 parent
55a2db1
commit 9044c27
Showing
4 changed files
with
788 additions
and
12 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,126 @@ | ||
| import { config } from 'src/config'; | ||
| import { setS2STestingModule } from 'src/adaptermanager'; | ||
|
|
||
| var CONSTANTS = require('src/constants.json'); | ||
| const AST = CONSTANTS.JSON_MAPPING.ADSERVER_TARGETING; | ||
| export const SERVER = 'server'; | ||
| export const CLIENT = 'client'; | ||
|
|
||
| var testing = false; // whether testing is turned on | ||
| var bidSource = {}; // store bidder sources determined from s2sConfing bidderControl | ||
|
|
||
| // load s2sConfig | ||
| config.getConfig('s2sConfig', config => { | ||
| testing = config.s2sConfig && config.s2sConfig.testing; | ||
| addBidderSourceTargeting(config.s2sConfig) | ||
| calculateBidSources(config.s2sConfig); | ||
| }); | ||
|
|
||
| // function to add hb_source_<bidder> adServerTargeting (AST) kvp to bidder settings | ||
| function addBidderSourceTargeting(s2sConfig = {}) { | ||
| // bail if testing is not turned on | ||
| if (!testing) { | ||
| return; | ||
| } | ||
| var bidderSettings = $$PREBID_GLOBAL$$.bidderSettings || {}; | ||
| var bidderControl = s2sConfig.bidderControl || {}; | ||
| // for each configured bidder | ||
| (s2sConfig.bidders || []).forEach((bidder) => { | ||
| // remove any existing kvp setting | ||
| if (bidderSettings[bidder] && bidderSettings[bidder][AST]) { | ||
| bidderSettings[bidder][AST] = bidderSettings[bidder][AST].filter((kvp) => { | ||
| return kvp.key !== `hb_source_${bidder}`; | ||
| }); | ||
| } | ||
| // if includeSourceKvp === true add new kvp setting | ||
| if (bidderControl[bidder] && bidderControl[bidder].includeSourceKvp) { | ||
| bidderSettings[bidder] = bidderSettings[bidder] || {}; | ||
| bidderSettings[bidder][AST] = bidderSettings[bidder][AST] || []; | ||
| bidderSettings[bidder][AST].push({ | ||
| key: `hb_source_${bidder}`, | ||
| val: function (bidResponse) { | ||
| // default to client (currently only S2S sets this) | ||
| return bidResponse.source || CLIENT; | ||
| } | ||
| }); | ||
| // make sure "alwaysUseBid" is true so targeting is set | ||
| bidderSettings[bidder].alwaysUseBid = true; | ||
| } | ||
| }); | ||
| } | ||
|
|
||
| export function getSourceBidderMap(adUnits = []) { | ||
| var sourceBidders = {[SERVER]: {}, [CLIENT]: {}}; | ||
|
|
||
| // bail if testing is not turned on | ||
| if (!testing) { | ||
| return {[SERVER]: [], [CLIENT]: []}; | ||
| } | ||
|
|
||
| adUnits.forEach((adUnit) => { | ||
| // if any adUnit bidders specify a bidSource, include them | ||
| (adUnit.bids || []).forEach((bid) => { | ||
| // calculate the source once and store on bid object | ||
| bid.calcSource = bid.calcSource || getSource(bid.bidSource); | ||
| // if no bidSource at bid level, default to bidSource from bidder | ||
| bid.finalSource = bid.calcSource || bidSource[bid.bidder] || CLIENT; // default to client | ||
| // add bidder to sourceBidders data structure | ||
| sourceBidders[bid.finalSource][bid.bidder] = true; | ||
| }); | ||
| }); | ||
|
|
||
| // make sure all bidders in bidSource are in sourceBidders | ||
| Object.keys(bidSource).forEach((bidder) => { | ||
| sourceBidders[bidSource[bidder]][bidder] = true; | ||
| }); | ||
|
|
||
| // return map of source => array of bidders | ||
| return { | ||
| [SERVER]: Object.keys(sourceBidders[SERVER]), | ||
| [CLIENT]: Object.keys(sourceBidders[CLIENT]) | ||
| }; | ||
| } | ||
|
|
||
| /** | ||
| * @function calculateBidSources determines the source for each s2s bidder based on bidderControl weightings. these can be overridden at the adUnit level | ||
| * @param s2sConfig server-to-server configuration | ||
| */ | ||
| function calculateBidSources(s2sConfig = {}) { | ||
| // bail if testing is not turned on | ||
| if (!testing) { | ||
| return; | ||
| } | ||
| bidSource = {}; // reset bid sources | ||
| // calculate bid source (server/client) for each s2s bidder | ||
| var bidderControl = s2sConfig.bidderControl || {}; | ||
| (s2sConfig.bidders || []).forEach((bidder) => { | ||
| bidSource[bidder] = getSource(bidderControl[bidder] && bidderControl[bidder].bidSource) || SERVER; // default to server | ||
| }); | ||
| } | ||
|
|
||
| /** | ||
| * @function getSource() gets a random source based on the given sourceWeights (export just for testing) | ||
| * @param sourceWeights mapping of relative weights of potential sources. for example {server: 1, client: 3} should do a server request 25% of the time and a client request 75% of the time. | ||
| * @param bidSources list of possible bid sources: "server", "client". In theory could get the sources from the sourceWeights keys, but this is publisher config defined, so bidSources let's us constrain that. | ||
| * @return the chosen source ("server" or "client"), or undefined if none chosen | ||
| */ | ||
| export function getSource(sourceWeights = {}, bidSources = [SERVER, CLIENT]) { | ||
| var srcIncWeight = {}; // store incremental weights of each source | ||
| var totWeight = 0; | ||
| bidSources.forEach((source) => { | ||
| totWeight += (sourceWeights[source] || 0); | ||
| srcIncWeight[source] = totWeight; | ||
| }); | ||
| if (!totWeight) return; // bail if no source weights | ||
| // choose a source randomly based on weights | ||
| var rndWeight = Math.random() * totWeight; | ||
| for (var i = 0; i < bidSources.length; i++) { | ||
| let source = bidSources[i]; | ||
| // choose the first source with an incremental weight > random weight | ||
| if (rndWeight < srcIncWeight[source]) return source; | ||
| } | ||
| } | ||
|
|
||
| // inject the s2sTesting module into the adaptermanager rather than importing it | ||
| // importing it causes the packager to include it even when it's not explicitly included in the build | ||
| setS2STestingModule(exports); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.