diff --git a/PR_REVIEW.md b/PR_REVIEW.md
index d7703cf20ae..a8b68c7ab45 100644
--- a/PR_REVIEW.md
+++ b/PR_REVIEW.md
@@ -6,38 +6,28 @@ If the PR is for a standard bid adapter or a standard analytics adapter, just th
For modules and core platform updates, the initial reviewer should request an additional team member to review as a sanity check. Merge should only happen when the PR has 2 `LGTM` from the core team and a documentation PR if required.
### General PR review Process
+- All required global and bidder-adapter rules defined in the [Module Rules](https://docs.prebid.org/dev-docs/module-rules.html) must be followed. Please review these rules often - we depend on reviewers to enforce them.
- Checkout the branch (these instructions are available on the github PR page as well).
- Verify PR is a single change type. Example, refactor OR bugfix. If more than 1 type, ask submitter to break out requests.
-- Verify code under review has at least 80% unit test coverage. If legacy code has no unit test coverage, ask for unit tests to be included in the PR.
+- Verify code under review has at least 80% unit test coverage. If legacy code doesn't have enough unit test coverage, require that additional unit tests to be included in the PR.
- Verify tests are green in Travis-ci + local build by running `gulp serve` | `gulp test`
- Verify no code quality violations are present from linting (should be reported in terminal)
+- Make sure the code is not setting cookies or localstorage directly -- it must use the `StorageManager`.
- Review for obvious errors or bad coding practice / use best judgement here.
- If the change is a new feature / change to core prebid.js - review the change with a Tech Lead on the project and make sure they agree with the nature of change.
- If the change results in needing updates to docs (such as public API change, module interface etc), add a label for "needs docs" and inform the submitter they must submit a docs PR to update the appropriate area of Prebid.org **before the PR can merge**. Help them with finding where the docs are located on prebid.org if needed.
- - Below are some examples of bidder specific updates that should require docs update (in their dev-docs/bidders/BIDDER.md file):
- - If they support the GDPR consentManagement module and TCF1, add `gdpr_supported: true`
- - If they support the GDPR consentManagement module and TCF2, add `tcf2_supported: true`
- - If they support the US Privacy consentManagementUsp module, add `usp_supported: true`
- - If they support one or more userId modules, add `userId: (list of supported vendors)`
- - If they support video and/or native mediaTypes add `media_types: video, native`. Note that display is added by default. If you don't support display, add "no-display" as the first entry, e.g. `media_types: no-display, native`
- - If they support COPPA, add `coppa_supported: true`
- - If they support SChain, add `schain_supported: true`
- - If their bidder doesn't work well with safeframed creatives, add `safeframes_ok: false`. This will alert publishers to not use safeframed creatives when creating the ad server entries for their bidder.
- - If they're setting a deal ID in some scenarios, add `bidder_supports_deals: true`
- - If they have an IAB Global Vendor List ID, add `gvl_id: ID`. There's no default.
-- If all above is good, add a `LGTM` comment and request 1 additional core member to review.
-- Once there is 2 `LGTM` on the PR, merge to master
-- Ask the submitter to add a PR for documentation if applicable.
+- If all above is good, add a `LGTM` comment and, if the change is in PBS-core or is an important module like the prebidServerBidAdapter, request 1 additional core member to review.
+- Once there are 2 `LGTM` on the PR, merge to master
- Add a line into the [draft release](https://github.com/prebid/Prebid.js/releases) notes for this submission. If no draft release is available, create one using [this template]( https://gist.github.com/mkendall07/c3af6f4691bed8a46738b3675cb5a479)
-- Add the PR to the appropriate project board (I.E. 1.23.0 Release) for the week, [see](https://github.com/prebid/Prebid.js/projects)
-### New Adapter or updates to adapter process
-- Follow steps above for general review process. In addition, please verify the following:
+### Reviewing a New or Updated Bid Adapter
+Documentation they're supposed to be following is https://docs.prebid.org/dev-docs/bidder-adaptor.html
+
+Follow steps above for general review process. In addition, please verify the following:
- Verify that bidder has submitted valid bid params and that bids are being received.
- Verify that bidder is not manipulating the prebid.js auction in any way or doing things that go against the principles of the project. If unsure check with the Tech Lead.
- Verify that code re-use is being done properly and that changes introduced by a bidder don't impact other bidders.
- If the adapter being submitted is an alias type, check with the bidder contact that is being aliased to make sure it's allowed.
-- All required global and bidder-adapter rules defined in the [Module Rules](https://docs.prebid.org/dev-docs/module-rules.html) must be followed. Please review these rules often - we depend on reviewers to enforce them.
- All bidder parameter conventions must be followed:
- Video params must be read from AdUnit.mediaTypes.video when available; however bidder config can override the ad unit.
- First party data must be read from [`fpd.context` and `fpd.user`](https://docs.prebid.org/dev-docs/publisher-api-reference.html#setConfig-fpd).
@@ -45,9 +35,64 @@ For modules and core platform updates, the initial reviewer should request an ad
- Adapters cannot accept an schain parameter. Rather, they must look for the schain parameter at bidRequest.schain.
- The bidRequest page referrer must checked in addition to any bidder-specific parameter.
- If they're getting the COPPA flag, it must come from config.getConfig('coppa');
-
+- Below are some examples of bidder specific updates that should require docs update (in their dev-docs/bidders/BIDDER.md file):
+ - If they support the GDPR consentManagement module and TCF1, add `gdpr_supported: true`
+ - If they support the GDPR consentManagement module and TCF2, add `tcf2_supported: true`
+ - If they support the US Privacy consentManagementUsp module, add `usp_supported: true`
+ - If they support one or more userId modules, add `userId: (list of supported vendors)`
+ - If they support video and/or native mediaTypes add `media_types: video, native`. Note that display is added by default. If you don't support display, add "no-display" as the first entry, e.g. `media_types: no-display, native`
+ - If they support COPPA, add `coppa_supported: true`
+ - If they support SChain, add `schain_supported: true`
+ - If their bidder doesn't work well with safeframed creatives, add `safeframes_ok: false`. This will alert publishers to not use safeframed creatives when creating the ad server entries for their bidder.
+ - If they're setting a deal ID in some scenarios, add `bidder_supports_deals: true`
+ - If they have an IAB Global Vendor List ID, add `gvl_id: ID`. There's no default.
- After a new adapter is approved, let the submitter know they may open a PR in the [headerbid-expert repository](https://github.com/prebid/headerbid-expert) to have their adapter recognized by the [Headerbid Expert extension](https://chrome.google.com/webstore/detail/headerbid-expert/cgfkddgbnfplidghapbbnngaogeldmop). The PR should be to the [bidder patterns file](https://github.com/prebid/headerbid-expert/blob/master/bidderPatterns.js), adding an entry with their adapter's name and the url the adapter uses to send and receive bid responses.
+### Reviewing a New or Updated Analytics Adapter
+Documentation they're supposed to be following is https://docs.prebid.org/dev-docs/integrate-with-the-prebid-analytics-api.html
+
+No additional steps above the general review process and making sure it conforms to the [Module Rules](https://docs.prebid.org/dev-docs/module-rules.html).
+
+Make sure there's a docs pull request
+
+### Reviewing a New or Updated User ID Sub-Module
+Documentation they're supposed to be following is https://docs.prebid.org/dev-docs/modules/userId.html#id-providers
+
+Follow steps above for general review process. In addition:
+- Try running the new user ID module with a basic config and confirm it hits the endpoint and stores the results.
+- the filename should be camel case ending with `IdSystem` (e.g. `myCompanyIdSystem.js`)
+- the `const MODULE_NAME` value should be camel case ending with `Id` (e.g. `myCompanyId` )
+- the response of the `decode` method should be an object with the key being ideally camel case similar to the module name and ending in `id` or `Id`, but in some cases this value is a shortened name and sometimes with the `id` part being all lowercase, provided there are no other uppercase letters. if there's no id or it's an invalid object, the response should be `undefined`. example "valid" values (although this is more style than a requirement)
+ - `mcid`
+ - `mcId`
+ - `myCompanyId`
+- make sure they've added references of their new module everywhere required:
+ - modules/.submodules.json
+ - modules/userId/eids.js
+ - modules/userId/eids.md
+ - modules/userId/userId.md
+- tests can go either within the userId_spec.js file or in their own _spec file if they wish
+- GVLID is recommended in the *IdSystem file if they operate in EU
+- make sure example configurations align to the actual code (some modules use the userId storage settings and allow pub configuration, while others handle reading/writing cookies on their own, so should not include the storage params in examples)
+- the 3 available methods (getId, extendId, decode) should be used as they were intended
+ - decode (required method) should not be making requests to retrieve a new ID, it should just be decoding a response
+ - extendId (optional method) should not be making requests to retrieve a new ID, it should just be adding additional data to the id object
+ - getId (required method) should be the only method that gets a new ID (from ajax calls or a cookie/local storage). this ensures that decode and extend do not unnecessarily delay the auction in places where it is not expected.
+- in the eids.js file, the source should be the actual domain of the provider, not a made up domain.
+- in the eids.js file, the key in the array should be the same value as the key in the decode function
+- make sure all supported config params align in the submodule js file and the docs / examples
+- make sure there's a docs pull request
+
+### Reviewing a New or Updated Real-Time-Data Sub-Module
+Documentation they're supposed to be following is https://docs.prebid.org/dev-docs/add-rtd-submodule.html
+
+Follow steps above for general review process. In addition:
+- The RTD Provider must include a `providerRtdProvider.md` file. This file must have example parameters and document a sense of what to expect: what should change in the bidrequest, or what targeting data should be added?
+- Try running the new sub-module and confirm the provided test parameters.
+- Make sure the sub-module is making HTTP requests as early as possible, but not more often than needed.
+- Consider whether the kind of data the module is obtaining could have privacy implications. If so, make sure they're utilizing the `consent` data passed to them.
+- make sure there's a docs pull request
+
## Ticket Coordinator
Each week, Prebid Org assigns one person to keep an eye on incoming issues and PRs. Every Monday morning a reminder is
diff --git a/integrationExamples/gpt/userId_example.html b/integrationExamples/gpt/userId_example.html
index dddc0915db2..7375293fdf0 100644
--- a/integrationExamples/gpt/userId_example.html
+++ b/integrationExamples/gpt/userId_example.html
@@ -269,7 +269,10 @@
},
{
name: "quantcastId"
- }
+ },
+ {
+ name: "criteo"
+ },
],
syncDelay: 5000,
auctionDelay: 1000
diff --git a/modules/.submodules.json b/modules/.submodules.json
index 18e75dd1794..91cda9d95ad 100644
--- a/modules/.submodules.json
+++ b/modules/.submodules.json
@@ -15,7 +15,9 @@
"intentIqIdSystem",
"zeotapIdPlusIdSystem",
"haloIdSystem",
- "quantcastIdSystem"
+ "quantcastIdSystem",
+ "idxIdSystem",
+ "fabrickIdSystem"
],
"adpod": [
"freeWheelAdserverVideo",
diff --git a/modules/adtelligentBidAdapter.js b/modules/adtelligentBidAdapter.js
index e22aafb73fc..51138a2cac7 100644
--- a/modules/adtelligentBidAdapter.js
+++ b/modules/adtelligentBidAdapter.js
@@ -6,12 +6,23 @@ import { Renderer } from '../src/Renderer.js';
import find from 'core-js-pure/features/array/find.js';
const subdomainSuffixes = ['', 1, 2];
-const getUri = (function () {
- let num = 0;
- return function () {
- return 'https://ghb' + subdomainSuffixes[num++ % subdomainSuffixes.length] + '.adtelligent.com/v2/auction/'
+const AUCTION_PATH = '/v2/auction/';
+const PROTOCOL = 'https://';
+const HOST_GETTERS = {
+ default: (function () {
+ let num = 0;
+ return function () {
+ return 'ghb' + subdomainSuffixes[num++ % subdomainSuffixes.length] + '.adtelligent.com'
+ }
+ }()),
+ appaloosa: function () {
+ return 'hb.appaloosa.media'
}
-}())
+}
+const getUri = function (bidderCode) {
+ let getter = HOST_GETTERS[bidderCode] || HOST_GETTERS['default'];
+ return PROTOCOL + getter() + AUCTION_PATH
+}
const OUTSTREAM_SRC = 'https://player.adtelligent.com/outstream-unit/2.01/outstream.min.js';
const BIDDER_CODE = 'adtelligent';
const OUTSTREAM = 'outstream';
@@ -21,7 +32,7 @@ const syncsCache = {};
export const spec = {
code: BIDDER_CODE,
gvlid: 410,
- aliases: ['onefiftytwomedia', 'selectmedia'],
+ aliases: ['onefiftytwomedia', 'selectmedia', 'appaloosa'],
supportedMediaTypes: [VIDEO, BANNER],
isBidRequestValid: function (bid) {
return !!utils.deepAccess(bid, 'params.aid');
@@ -82,7 +93,7 @@ export const spec = {
data: Object.assign({}, tag, { BidRequests: bids }),
adapterRequest,
method: 'POST',
- url: getUri()
+ url: getUri(adapterRequest.bidderCode)
};
})
},
diff --git a/modules/adyoulikeBidAdapter.js b/modules/adyoulikeBidAdapter.js
index 725ee0f5626..40d3cf84369 100644
--- a/modules/adyoulikeBidAdapter.js
+++ b/modules/adyoulikeBidAdapter.js
@@ -1,5 +1,6 @@
import * as utils from '../src/utils.js';
import { registerBidder } from '../src/adapters/bidderFactory.js';
+import { config } from '../src/config.js';
import find from 'core-js-pure/features/array/find.js';
const VERSION = '1.0';
@@ -104,15 +105,6 @@ function getHostname(bidderRequest) {
return '';
}
-/* Get current page referrer url */
-function getReferrerUrl(bidderRequest) {
- let referer = '';
- if (bidderRequest && bidderRequest.refererInfo) {
- referer = bidderRequest.refererInfo.referer;
- }
- return referer;
-}
-
/* Get current page canonical url */
function getCanonicalUrl() {
let link;
@@ -155,9 +147,14 @@ function createEndpoint(bidRequests, bidderRequest) {
function createEndpointQS(bidderRequest) {
const qs = {};
- const ref = getReferrerUrl(bidderRequest);
- if (ref) {
- qs.RefererUrl = encodeURIComponent(ref);
+ if (bidderRequest) {
+ const ref = bidderRequest.refererInfo;
+ if (ref) {
+ qs.RefererUrl = encodeURIComponent(ref.referer);
+ if (ref.numIframes > 0) {
+ qs.SafeFrame = true;
+ }
+ }
}
const can = getCanonicalUrl();
@@ -165,6 +162,11 @@ function createEndpointQS(bidderRequest) {
qs.CanonicalUrl = encodeURIComponent(can);
}
+ const domain = config.getConfig('publisherDomain');
+ if (domain) {
+ qs.PublisherDomain = encodeURIComponent(domain);
+ }
+
return qs;
}
diff --git a/modules/appnexusBidAdapter.js b/modules/appnexusBidAdapter.js
index f3ebf9bf4f6..ff0e3230007 100644
--- a/modules/appnexusBidAdapter.js
+++ b/modules/appnexusBidAdapter.js
@@ -157,6 +157,7 @@ export const spec = {
const memberIdBid = find(bidRequests, hasMemberId);
const member = memberIdBid ? parseInt(memberIdBid.params.member, 10) : 0;
const schain = bidRequests[0].schain;
+ const omidSupport = find(bidRequests, hasOmidSupport);
const payload = {
tags: [...tags],
@@ -168,6 +169,13 @@ export const spec = {
schain: schain
};
+ if (omidSupport) {
+ payload['iab_support'] = {
+ omidpn: 'Appnexus',
+ omidpv: '$prebid.version$'
+ }
+ }
+
if (member > 0) {
payload.member_id = member;
}
@@ -766,16 +774,27 @@ function bidToTag(bid) {
type = (utils.isArray(type)) ? type[0] : type;
tag.video[param] = VIDEO_MAPPING[param][type];
break;
+ // Deprecating tags[].video.frameworks in favor of tags[].video_frameworks
+ case 'frameworks':
+ break;
default:
tag.video[param] = bid.params.video[param];
}
});
+
+ if (bid.params.video.frameworks && utils.isArray(bid.params.video.frameworks)) {
+ tag['video_frameworks'] = bid.params.video.frameworks;
+ }
}
if (bid.renderer) {
tag.video = Object.assign({}, tag.video, { custom_renderer_present: true });
}
+ if (bid.params.frameworks && utils.isArray(bid.params.frameworks)) {
+ tag['banner_frameworks'] = bid.params.frameworks;
+ }
+
let adUnit = find(auctionManager.getAdUnits(), au => bid.transactionId === au.transactionId);
if (adUnit && adUnit.mediaTypes && adUnit.mediaTypes.banner) {
tag.ad_types.push(BANNER);
@@ -844,6 +863,19 @@ function hasAdPod(bid) {
);
}
+function hasOmidSupport(bid) {
+ let hasOmid = false;
+ const bidderParams = bid.params;
+ const videoParams = bid.params.video;
+ if (bidderParams.frameworks && utils.isArray(bidderParams.frameworks)) {
+ hasOmid = includes(bid.params.frameworks, 6);
+ }
+ if (!hasOmid && videoParams && videoParams.frameworks && utils.isArray(videoParams.frameworks)) {
+ hasOmid = includes(bid.params.video.frameworks, 6);
+ }
+ return hasOmid;
+}
+
/**
* Expand an adpod placement into a set of request objects according to the
* total adpod duration and the range of duration seconds. Sets minduration/
diff --git a/modules/atsAnalyticsAdapter.js b/modules/atsAnalyticsAdapter.js
index 9811c306738..a5bb3797bbf 100644
--- a/modules/atsAnalyticsAdapter.js
+++ b/modules/atsAnalyticsAdapter.js
@@ -126,13 +126,16 @@ let atsAnalyticsAdapter = Object.assign(adapter(
callHandler(eventType, args);
}
if (eventType === CONSTANTS.EVENTS.AUCTION_END) {
- // send data to ats analytic endpoint
- try {
- let dataToSend = {'Data': atsAnalyticsAdapter.context.events};
- let strJSON = JSON.stringify(dataToSend);
- ajax(atsAnalyticsAdapter.context.host, function () {
- }, strJSON, {method: 'POST', contentType: 'application/json'});
- } catch (err) {
+ if (atsAnalyticsAdapter.shouldFireRequest()) {
+ // send data to ats analytic endpoint
+ try {
+ let dataToSend = {'Data': atsAnalyticsAdapter.context.events};
+ let strJSON = JSON.stringify(dataToSend);
+ utils.logInfo('atsAnalytics tried to send analytics data!');
+ ajax(atsAnalyticsAdapter.context.host, function () {
+ }, strJSON, {method: 'POST', contentType: 'application/json'});
+ } catch (err) {
+ }
}
}
}
@@ -141,6 +144,11 @@ let atsAnalyticsAdapter = Object.assign(adapter(
// save the base class function
atsAnalyticsAdapter.originEnableAnalytics = atsAnalyticsAdapter.enableAnalytics;
+// add check to not fire request every time, but instead to send 1/10 events
+atsAnalyticsAdapter.shouldFireRequest = function () {
+ return (Math.floor((Math.random() * 11)) === 10);
+}
+
// override enableAnalytics so we can get access to the config passed in from the page
atsAnalyticsAdapter.enableAnalytics = function (config) {
if (!config.options.pid) {
diff --git a/modules/britepoolIdSystem.js b/modules/britepoolIdSystem.js
index 90fd159571f..3bf416957d2 100644
--- a/modules/britepoolIdSystem.js
+++ b/modules/britepoolIdSystem.js
@@ -29,11 +29,12 @@ export const britepoolIdSubmodule = {
/**
* Performs action to obtain id and return a value in the callback's response argument
* @function
- * @param {SubmoduleParams} [submoduleConfigParams]
+ * @param {SubmoduleConfig} [submoduleConfig]
* @param {ConsentData|undefined} consentData
* @returns {function(callback:function)}
*/
- getId(submoduleConfigParams, consentData) {
+ getId(submoduleConfig, consentData) {
+ const submoduleConfigParams = (submoduleConfig && submoduleConfig.params) || {};
const { params, headers, url, getter, errors } = britepoolIdSubmodule.createParams(submoduleConfigParams, consentData);
let getterResponse = null;
if (typeof getter === 'function') {
diff --git a/modules/criteoIdSystem.js b/modules/criteoIdSystem.js
index 017194d0e86..83bc773cb30 100644
--- a/modules/criteoIdSystem.js
+++ b/modules/criteoIdSystem.js
@@ -31,7 +31,7 @@ function areCookiesWriteable() {
}
function extractProtocolHost (url, returnOnlyHost = false) {
- const parsedUrl = utils.parseUrl(url)
+ const parsedUrl = utils.parseUrl(url, {noDecodeWholeURL: true})
return returnOnlyHost
? `${parsedUrl.hostname}`
: `${parsedUrl.protocol}://${parsedUrl.hostname}${parsedUrl.port ? ':' + parsedUrl.port : ''}/`;
@@ -103,7 +103,9 @@ function callCriteoUserSync(parsedCriteoData, gdprString) {
} else if (jsonResponse.bundle) {
saveOnAllStorages(bundleStorageKey, jsonResponse.bundle);
}
- }
+ },
+ undefined,
+ { method: 'GET', contentType: 'application/json', withCredentials: true }
);
}
@@ -126,11 +128,11 @@ export const criteoIdSubmodule = {
/**
* get the Criteo Id from local storages and initiate a new user sync
* @function
- * @param {SubmoduleParams} [configParams]
+ * @param {SubmoduleConfig} [config]
* @param {ConsentData} [consentData]
* @returns {{id: {criteoId: string} | undefined}}}
*/
- getId(configParams, consentData) {
+ getId(config, consentData) {
const hasGdprData = consentData && typeof consentData.gdprApplies === 'boolean' && consentData.gdprApplies;
const gdprConsentString = hasGdprData ? consentData.consentString : undefined;
diff --git a/modules/fabrickIdSystem.js b/modules/fabrickIdSystem.js
new file mode 100644
index 00000000000..e61b377eefa
--- /dev/null
+++ b/modules/fabrickIdSystem.js
@@ -0,0 +1,147 @@
+/**
+ * This module adds neustar's fabrickId to the User ID module
+ * The {@link module:modules/userId} module is required
+ * @module modules/fabrickIdSystem
+ * @requires module:modules/userId
+ */
+
+import * as utils from '../src/utils.js'
+import { ajax } from '../src/ajax.js';
+import { submodule } from '../src/hook.js';
+import { getRefererInfo } from '../src/refererDetection.js';
+
+/** @type {Submodule} */
+export const fabrickIdSubmodule = {
+ /**
+ * used to link submodule with config
+ * @type {string}
+ */
+ name: 'fabrickId',
+
+ /**
+ * decode the stored id value for passing to bid requests
+ * @function decode
+ * @param {(Object|string)} value
+ * @returns {(Object|undefined)}
+ */
+ decode(value) {
+ if (value && value.fabrickId) {
+ return { 'fabrickId': value.fabrickId };
+ } else {
+ return undefined;
+ }
+ },
+
+ /**
+ * performs action to obtain id and return a value in the callback's response argument
+ * @function getId
+ * @param {SubmoduleConfig} [config]
+ * @param {ConsentData}
+ * @param {Object} cacheIdObj - existing id, if any consentData]
+ * @returns {IdResponse|undefined}
+ */
+ getId(config, consentData, cacheIdObj) {
+ try {
+ const configParams = (config && config.params) || {};
+ if (window.fabrickMod1) {
+ window.fabrickMod1(configParams, consentData, cacheIdObj);
+ }
+ if (!configParams || typeof configParams.apiKey !== 'string') {
+ utils.logError('fabrick submodule requires an apiKey.');
+ return;
+ }
+ try {
+ let url = _getBaseUrl(configParams);
+ let keysArr = Object.keys(configParams);
+ for (let i in keysArr) {
+ let k = keysArr[i];
+ if (k === 'url' || k === 'refererInfo') {
+ continue;
+ }
+ let v = configParams[k];
+ if (Array.isArray(v)) {
+ for (let j in v) {
+ url += `${k}=${v[j]}&`;
+ }
+ } else {
+ url += `${k}=${v}&`;
+ }
+ }
+ // pull off the trailing &
+ url = url.slice(0, -1)
+ const referer = _getRefererInfo(configParams);
+ const urls = new Set();
+ url = truncateAndAppend(urls, url, 'r', referer.referer);
+ if (referer.stack && referer.stack[0]) {
+ url = truncateAndAppend(urls, url, 'r', referer.stack[0]);
+ }
+ url = truncateAndAppend(urls, url, 'r', referer.canonicalUrl);
+ url = truncateAndAppend(urls, url, 'r', window.location.href);
+
+ const resp = function (callback) {
+ const callbacks = {
+ success: response => {
+ if (window.fabrickMod2) {
+ return window.fabrickMod2(
+ callback, response, configParams, consentData, cacheIdObj);
+ } else {
+ let responseObj;
+ if (response) {
+ try {
+ responseObj = JSON.parse(response);
+ } catch (error) {
+ utils.logError(error);
+ responseObj = {};
+ }
+ }
+ callback(responseObj);
+ }
+ },
+ error: error => {
+ utils.logError(`fabrickId fetch encountered an error`, error);
+ callback();
+ }
+ };
+ ajax(url, callbacks, null, {method: 'GET', withCredentials: true});
+ };
+ return {callback: resp};
+ } catch (e) {
+ utils.logError(`fabrickIdSystem encountered an error`, e);
+ }
+ } catch (e) {
+ utils.logError(`fabrickIdSystem encountered an error`, e);
+ }
+ }
+};
+
+function _getRefererInfo(configParams) {
+ if (configParams.refererInfo) {
+ return configParams.refererInfo;
+ } else {
+ return getRefererInfo();
+ }
+}
+
+function _getBaseUrl(configParams) {
+ if (configParams.url) {
+ return configParams.url;
+ } else {
+ return `https://fid.agkn.com/f?`;
+ }
+}
+
+function truncateAndAppend(urls, url, paramName, s) {
+ if (s && url.length < 2000) {
+ if (s.length > 200) {
+ s = s.substring(0, 200);
+ }
+ // Don't send the same url in multiple params
+ if (!urls.has(s)) {
+ urls.add(s);
+ return `${url}&${paramName}=${s}`
+ }
+ }
+ return url;
+}
+
+submodule('userId', fabrickIdSubmodule);
diff --git a/modules/fabrickIdSystem.md b/modules/fabrickIdSystem.md
new file mode 100644
index 00000000000..268c861710a
--- /dev/null
+++ b/modules/fabrickIdSystem.md
@@ -0,0 +1,24 @@
+## Neustar Fabrick User ID Submodule
+
+Fabrick ID Module - https://www.home.neustar/fabrick
+Product and Sales Inquiries: 1-855-898-0036
+
+## Example configuration for publishers:
+```
+pbjs.setConfig({
+ userSync: {
+ userIds: [{
+ name: 'fabrickId',
+ storage: {
+ name: 'pbjs_fabrickId',
+ type: 'cookie',
+ expires: 7
+ },
+ params: {
+ apiKey: 'your apiKey', // provided to you by Neustar
+ e: '31c5543c1734d25c7206f5fd591525d0295bec6fe84ff82f946a34fe970a1e66' // example hash identifier (sha256)
+ }
+ }]
+ }
+});
+```
diff --git a/modules/haloIdSystem.js b/modules/haloIdSystem.js
index 237b502f6a7..d0eb79d4ac2 100644
--- a/modules/haloIdSystem.js
+++ b/modules/haloIdSystem.js
@@ -30,10 +30,10 @@ export const haloIdSubmodule = {
/**
* performs action to obtain id and return a value in the callback's response argument
* @function
- * @param {SubmoduleParams} [configParams]
+ * @param {SubmoduleConfig} [config]
* @returns {IdResponse|undefined}
*/
- getId(configParams) {
+ getId(config) {
const url = `https://id.halo.ad.gt/api/v1/pbhid`;
const resp = function (callback) {
diff --git a/modules/hybridBidAdapter.js b/modules/hybridBidAdapter.js
index 5671756e0b2..dd55483ef33 100644
--- a/modules/hybridBidAdapter.js
+++ b/modules/hybridBidAdapter.js
@@ -10,12 +10,14 @@ const DSP_ENDPOINT = 'https://hbe198.hybrid.ai/prebidhb';
const TRAFFIC_TYPE_WEB = 1;
const PLACEMENT_TYPE_BANNER = 1;
const PLACEMENT_TYPE_VIDEO = 2;
+const PLACEMENT_TYPE_IN_IMAGE = 3;
const TTL = 60;
const RENDERER_URL = 'https://acdn.adnxs.com/video/outstream/ANOutstreamVideo.js';
const placementTypes = {
'banner': PLACEMENT_TYPE_BANNER,
- 'video': PLACEMENT_TYPE_VIDEO
+ 'video': PLACEMENT_TYPE_VIDEO,
+ 'inImage': PLACEMENT_TYPE_IN_IMAGE
};
function buildBidRequests(validBidRequests) {
@@ -26,7 +28,8 @@ function buildBidRequests(validBidRequests) {
transactionId: validBidRequest.transactionId,
sizes: validBidRequest.sizes,
placement: placementTypes[params.placement],
- placeId: params.placeId
+ placeId: params.placeId,
+ imageUrl: params.imageUrl || ''
};
return bidRequest;
@@ -94,6 +97,33 @@ function buildBid(bidData) {
bid.renderer = createRenderer(bid);
}
}
+ } else if (bidData.placement === PLACEMENT_TYPE_IN_IMAGE) {
+ bid.mediaType = BANNER;
+ bid.inImageContent = {
+ content: {
+ content: bidData.content,
+ actionUrls: {}
+ }
+ };
+ let actionUrls = bid.inImageContent.content.actionUrls;
+ actionUrls.loadUrls = bidData.inImage.loadtrackers || [];
+ actionUrls.impressionUrls = bidData.inImage.imptrackers || [];
+ actionUrls.scrollActUrls = bidData.inImage.startvisibilitytrackers || [];
+ actionUrls.viewUrls = bidData.inImage.viewtrackers || [];
+ actionUrls.stopAnimationUrls = bidData.inImage.stopanimationtrackers || [];
+ actionUrls.closeBannerUrls = bidData.inImage.closebannertrackers || [];
+
+ if (bidData.inImage.but) {
+ let inImageOptions = bid.inImageContent.content.inImageOptions = {};
+ inImageOptions.hasButton = true;
+ inImageOptions.buttonLogoUrl = bidData.inImage.but_logo;
+ inImageOptions.buttonProductUrl = bidData.inImage.but_prod;
+ inImageOptions.buttonHead = bidData.inImage.but_head;
+ inImageOptions.buttonHeadColor = bidData.inImage.but_head_colour;
+ inImageOptions.dynparams = bidData.inImage.dynparams || {};
+ }
+
+ bid.ad = wrapAd(bid, bidData);
} else {
bid.ad = bidData.content;
bid.mediaType = BANNER;
@@ -116,6 +146,30 @@ function hasVideoMandatoryParams(mediaTypes) {
return isHasVideoContext && isPlayerSize;
}
+function wrapAd(bid, bidData) {
+ return `
+
+
+
+
+
+
+
+
+
+
+
+ `;
+}
+
export const spec = {
code: BIDDER_CODE,
supportedMediaTypes: [BANNER, VIDEO],
@@ -133,6 +187,7 @@ export const spec = {
!!bid.params.placement &&
(
(getMediaTypeFromBid(bid) === BANNER && bid.params.placement === 'banner') ||
+ (getMediaTypeFromBid(bid) === BANNER && bid.params.placement === 'inImage' && !!bid.params.imageUrl) ||
(getMediaTypeFromBid(bid) === VIDEO && bid.params.placement === 'video' && hasVideoMandatoryParams(bid.mediaTypes))
)
);
diff --git a/modules/hybridBidAdapter.md b/modules/hybridBidAdapter.md
index 245f010970a..098d8642415 100644
--- a/modules/hybridBidAdapter.md
+++ b/modules/hybridBidAdapter.md
@@ -52,3 +52,187 @@ var adUnits = [{
}];
```
+# Sample In-Image Ad Unit
+
+```js
+var adUnits = [{
+ code: 'test-div',
+ mediaTypes: {
+ banner: {
+ sizes: [0, 0]
+ }
+ },
+ bids: [{
+ bidder: "hybrid",
+ params: {
+ placement: "inImage",
+ placeId: "102030405060708090000020",
+ imageUrl: "https://hybrid.ai/images/image.jpg"
+ }
+ }]
+}];
+```
+
+# Example page with In-Image
+
+```html
+
+
+
+
+ Prebid.js Banner Example
+
+
+
+
+
+ Prebid.js InImage Banner Test
+
+
+
+
Prebid.js Banner Ad Unit Test
+
+
+
+
+
+
tag1
', 'tracking': {'brandId': 123}
+ }, {
+ 'bidId': 'bid2', 'cpm': 7.3, 'width': 728, 'height': 90, 'ad': 'tag2
'
+ }]
+ });
+
+ const createWindow = (href, params = {}) => {
+ let {parent, referrer, top, frameElement, placementElements = []} = params;
+
+ const protocol = (href.indexOf('https') === 0) ? 'https:' : 'http:';
+ const win = {
+ frameElement,
+ parent,
+ top,
+ location: {
+ protocol, href
+ },
+ document: {
+ createElement: function () {
+ return {
+ setAttribute: function () {
+ }
+ }
+ },
+ referrer,
+ getElementById: id => placementElements.find(el => el.id === id)
+ }
+ };
+
+ win.self = win;
+
+ if (!parent) {
+ win.parent = win;
+ }
+
+ if (!top) {
+ win.top = win;
+ }
+
+ return win;
+ };
+
+ function createElement(id, offsetTop = 0) {
+ return {
+ id,
+ getBoundingClientRect: function () {
+ return {
+ top: offsetTop, height: 1
+ }
+ }
+ }
+ }
+
+ function setupSingleWindow(sandBox, placementElements = [createElement('div-1', 17), createElement('div-2', 54)]) {
+ const win = createWindow('http://www.xyz.com/', {
+ parent: win, top: win, frameElement: createElement(undefined, 304), placementElements: placementElements
+ });
+
+ win.innerHeight = 200;
+
+ sandBox.stub(utils, 'getWindowSelf').returns(win);
+ sandBox.stub(utils, 'getWindowTop').returns(win);
+
+ return win;
+ }
+
+ function setupNestedWindows(sandBox, placementElements = [createElement('div-1', 17), createElement('div-2', 54)]) {
+ const topWin = createWindow('http://www.abc.org/', {referrer: 'http://www.google.com/?query=monkey'});
+ topWin.innerHeight = 800;
+
+ const midWin = createWindow('http://www.abc.org/', {parent: topWin, top: topWin, frameElement: createElement()});
+ midWin.innerHeight = 400;
+
+ const win = createWindow('http://www.xyz.com/', {
+ parent: midWin, top: topWin, frameElement: createElement(undefined, 304), placementElements
+ });
+
+ win.innerHeight = 200;
+
+ sandBox.stub(utils, 'getWindowSelf').returns(win);
+ sandBox.stub(utils, 'getWindowTop').returns(topWin);
+
+ return {topWin, midWin, win};
+ }
+
+ it('should only support BANNER mediaType', function () {
+ assert.deepEqual(spec.supportedMediaTypes, [BANNER]);
+ });
+
+ describe('bid validation entry point', () => {
+ let bidRequest;
+
+ beforeEach(() => {
+ bidRequest = buildBidderRequest().bids[0];
+ });
+
+ it('should have \"isBidRequestValid\" function', () => {
+ assert.isFunction(spec.isBidRequestValid);
+ });
+
+ it('should pass a valid bid', () => {
+ assert.isTrue(spec.isBidRequestValid(bidRequest));
+ });
+
+ it('should exclude bids without slot id param', () => {
+ bidRequest.params.sid = undefined;
+ assert.isFalse(spec.isBidRequestValid(bidRequest));
+ });
+
+ it('should exclude non-banner bids', () => {
+ delete bidRequest.mediaTypes.banner;
+ bidRequest.mediaTypes.video = {
+ playerSize: [640, 480]
+ };
+
+ assert.isFalse(spec.isBidRequestValid(bidRequest));
+ });
+
+ it('should exclude non-banner, pre-version 3 bids', () => {
+ delete bidRequest.mediaTypes;
+ bidRequest.mediaType = VIDEO;
+ assert.isFalse(spec.isBidRequestValid(bidRequest));
+ });
+ });
+
+ describe('build request entry point', () => {
+ it('should have \"buildRequests\" function', () => {
+ assert.isFunction(spec.buildRequests);
+ });
+
+ describe('url on server request info object', () => {
+ let win;
+ beforeEach(() => {
+ win = setupSingleWindow(sandbox);
+ });
+
+ afterEach(() => {
+ sandbox.restore();
+ });
+
+ it('should use hardcoded url as default endpoint', () => {
+ const bidReq = buildBidderRequest();
+ let serverRequestInfo = spec.buildRequests(bidReq.bids, bidReq);
+
+ assert.equal(serverRequestInfo.method, 'POST');
+ assert.isObject(serverRequestInfo.data);
+ assert.equal(serverRequestInfo.url, 'https://hb.adscale.de/dsh');
+ });
+
+ describe('should use custom url if provided', () => {
+ const samples = [{
+ protocol: 'http:', params: {sid: 'ODA=', host: 'other.com', port: '234', path: '/xyz'}, expected: 'https://other.com:234/xyz'
+ }, {
+ protocol: 'https:', params: {sid: 'ODA=', host: 'other.com', port: '234', path: '/xyz'}, expected: 'https://other.com:234/xyz'
+ }, {
+ protocol: 'https:',
+ params: {sid: 'ODA=', host: 'other.com', port: '234', securePort: '871', path: '/xyz'},
+ expected: 'https://other.com:871/xyz'
+ }, {
+ protocol: 'http:', params: {sid: 'ODA=', port: '234', path: '/xyz'}, expected: 'https://hb.adscale.de:234/xyz'
+ }, ];
+
+ samples.forEach(sample => {
+ it(`should use ${sample.expected} as endpoint when given params ${JSON.stringify(sample.params)} and protocol ${sample.protocol}`,
+ function () {
+ win.location.protocol = sample.protocol;
+
+ const bidReq = buildBidderRequest();
+ bidReq.bids[0].params = sample.params;
+ bidReq.bids.length = 1;
+
+ let serverRequestInfo = spec.buildRequests(bidReq.bids, bidReq);
+
+ assert.equal(serverRequestInfo.method, 'POST');
+ assert.isObject(serverRequestInfo.data);
+ assert.equal(serverRequestInfo.url, sample.expected);
+ });
+ });
+ });
+ });
+
+ describe('payload on server request info object', () => {
+ let topWin;
+ let win;
+
+ let placementElements;
+ beforeEach(() => {
+ placementElements = [createElement('div-1', 17), createElement('div-2', 54)];
+ ({ topWin, win } = setupNestedWindows(sandbox, placementElements));
+ });
+
+ afterEach(() => {
+ sandbox.restore();
+ });
+
+ it('should have expected JSON structure', () => {
+ clock.tick(13500);
+ const bidReq = buildBidderRequest();
+
+ const serverRequestInfo = spec.buildRequests(bidReq.bids, bidReq);
+
+ const expectedTimeout = bidderRequest.timeout - (13500 - bidderRequest.auctionStart);
+
+ assert.equal(expectedTimeout, 1500);
+
+ const expectedJsonPayload = {
+ 'id': AUCTION_ID,
+ 'timeout': expectedTimeout,
+ 'ref': topWin.document.referrer,
+ 'mpa': true,
+ 'ssl': false,
+ 'bids': [{
+ 'sid': 'NDA=', 'bid': 'bid1', 'siz': [[300, 600], [160, 60]], 'viz': true
+ }, {
+ 'sid': 'ODA=', 'bid': 'bid2', 'siz': [[728, 90]], 'viz': true
+ }],
+ 'user': {
+ 'euids': userIds
+ }
+ };
+
+ // trim away fields with undefined
+ const actualJsonPayload = JSON.parse(JSON.stringify(serverRequestInfo.data));
+
+ assert.deepEqual(actualJsonPayload, expectedJsonPayload);
+ });
+
+ it('should handle banner sizes for pre version 3', () => {
+ // Version 3 changes the way how banner sizes are accessed.
+ // We can support backwards compatibility with version 2.x
+ const bidReq = buildBidderRequestPreVersion3();
+ const serverRequestInfo = spec.buildRequests(bidReq.bids, bidReq);
+ assert.deepEqual(serverRequestInfo.data.bids[0].siz, [[300, 600], [160, 60]]);
+ assert.deepEqual(serverRequestInfo.data.bids[1].siz, [[728, 90]]);
+ });
+
+ describe('optional fields', () => {
+ it('should skip viz field when unable to determine visibility of placement', () => {
+ placementElements.length = 0;
+ const bidReq = buildBidderRequest();
+
+ const serverRequestInfo = spec.buildRequests(bidReq.bids, bidReq);
+ assert.lengthOf(serverRequestInfo.data.bids, 2);
+
+ for (let bid of serverRequestInfo.data.bids) {
+ assert.isUndefined(bid.viz);
+ }
+ });
+
+ it('should skip ref field when unable to determine document referrer', () => {
+ // i.e., empty if user came from bookmark, or web page using 'rel="noreferrer" on link, etc
+ buildBidderRequest();
+
+ const serverRequestInfo = spec.buildRequests(bidderRequest.bids, bidderRequest);
+ assert.lengthOf(serverRequestInfo.data.bids, 2);
+
+ for (let bid of serverRequestInfo.data.bids) {
+ assert.isUndefined(bid.ref);
+ }
+ });
+
+ const gdprSamples = [{consentString: 'RG9ua2V5IEtvbmc=', gdprApplies: true}, {consentString: 'UGluZyBQb25n', gdprApplies: false}];
+ gdprSamples.forEach((sample) => {
+ it(`should add GDPR info ${JSON.stringify(sample)} when provided`, () => {
+ const bidReq = buildBidderRequest();
+ bidReq.gdprConsent = sample;
+
+ const serverRequestInfo = spec.buildRequests(bidReq.bids, bidReq);
+
+ const actualGdpr = serverRequestInfo.data.gdpr;
+ assert.propertyVal(actualGdpr, 'applies', sample.gdprApplies);
+ assert.propertyVal(actualGdpr, 'consent', sample.consentString);
+ });
+ });
+
+ const skippableGdprSamples = [{consentString: null, gdprApplies: true}, //
+ {consentString: 'UGluZyBQb25n', gdprApplies: null}, //
+ {consentString: null, gdprApplies: null}, //
+ {consentString: undefined, gdprApplies: true}, //
+ {consentString: 'UGluZyBQb25n', gdprApplies: undefined}, //
+ {consentString: undefined, gdprApplies: undefined}];
+ skippableGdprSamples.forEach((sample) => {
+ it(`should not add GDPR info ${JSON.stringify(sample)} when one or more values are missing`, () => {
+ const bidReq = buildBidderRequest();
+ bidReq.gdprConsent = sample;
+
+ const serverRequestInfo = spec.buildRequests(bidReq.bids, bidReq);
+
+ const actualGdpr = serverRequestInfo.data.gdpr;
+ assert.isUndefined(actualGdpr);
+ });
+ });
+
+ it('should be able to build without third party user id data', () => {
+ const bidReq = buildBidderRequest();
+ bidReq.bids.forEach(bid => delete bid.userId);
+ const serverRequestInfo = spec.buildRequests(bidReq.bids, bidReq);
+ assert.lengthOf(serverRequestInfo.data.bids, 2);
+ assert.notProperty(serverRequestInfo, 'uids');
+ });
+ });
+ });
+ });
+
+ describe('interpret response entry point', () => {
+ it('should have \"interpretResponse\" function', () => {
+ assert.isFunction(spec.interpretResponse);
+ });
+
+ const invalidResponses = ['', ' ', ' ', undefined, null];
+ invalidResponses.forEach(sample => {
+ it('should ignore invalid responses (\"' + sample + '\") response', () => {
+ const result = spec.interpretResponse({body: sample});
+ assert.isArray(result);
+ assert.lengthOf(result, 0);
+ });
+ });
+
+ it('should interpret a standard response', () => {
+ const bidderResponse = buildBidderResponse();
+
+ const result = spec.interpretResponse({body: bidderResponse});
+ assertStandardFieldsOnBid(result[0], 'bid1', 'tag1
', 300, 600, 4);
+ assertStandardFieldsOnBid(result[1], 'bid2', 'tag2
', 728, 90, 7.3);
+ });
+
+ it('should return empty array, when response contains no bids', () => {
+ const result = spec.interpretResponse({body: {bids: []}});
+ assert.deepStrictEqual(result, []);
+ });
+ });
+
+ describe('get user syncs entry point', () => {
+ let win;
+ beforeEach(() => {
+ win = setupSingleWindow(sandbox);
+
+ // fake
+ win.document.createElement = function () {
+ const attrs = {};
+ return {
+ setAttribute: (name, value) => {
+ attrs[name] = value
+ },
+ getAttribute: (name) => attrs[name],
+ hasAttribute: (name) => attrs[name] !== undefined,
+ tagName: 'SCRIPT',
+ }
+ }
+ });
+
+ it('should have \"getUserSyncs\" function', () => {
+ assert.isFunction(spec.getUserSyncs);
+ });
+
+ describe('when iframe option is enabled', () => {
+ it('should perform user connect when there was a response', () => {
+ const expectedUrl = 'https://js.adscale.de/pbsync.html';
+ const userSyncResponse = spec.getUserSyncs({iframeEnabled: true}, ['']);
+
+ assert.deepStrictEqual(userSyncResponse, [{type: 'iframe', url: expectedUrl}]);
+ });
+
+ it('should not perform user connect when there was no response', () => {
+ const userSyncResponse = spec.getUserSyncs({iframeEnabled: true}, []);
+
+ assert.deepStrictEqual(userSyncResponse, []);
+ });
+
+ describe('and gdpr consent is defined', () => {
+ describe('and gdpr applies', () => {
+ it('should place gdpr query param to the user sync url with value of 1', () => {
+ const expectedUrl = 'https://js.adscale.de/pbsync.html?gdpr=1&gdpr_consent=';
+ const userSyncResponse = spec.getUserSyncs({iframeEnabled: true}, [''], {gdprApplies: true});
+
+ assert.deepStrictEqual(userSyncResponse, [{type: 'iframe', url: expectedUrl}]);
+ });
+ });
+
+ describe('and gdpr does not apply', () => {
+ it('should place gdpr query param to the user sync url with zero value', () => {
+ const expectedUrl = 'https://js.adscale.de/pbsync.html?gdpr=0&gdpr_consent=';
+ const userSyncResponse = spec.getUserSyncs({iframeEnabled: true}, [''], {gdprApplies: false});
+
+ assert.deepStrictEqual(userSyncResponse, [{type: 'iframe', url: expectedUrl}]);
+ });
+
+ describe('because consent does not specify it', () => {
+ it('should place gdpr query param to the user sync url with zero value', () => {
+ const expectedUrl = 'https://js.adscale.de/pbsync.html?gdpr=0&gdpr_consent=';
+ const userSyncResponse = spec.getUserSyncs({iframeEnabled: true}, [''], {});
+
+ assert.deepStrictEqual(userSyncResponse, [{type: 'iframe', url: expectedUrl}]);
+ });
+ });
+ });
+
+ describe('and consent string is defined', () => {
+ it('should pass consent string to gdpr consent query param', () => {
+ const consentString = 'consent_string';
+ const expectedUrl = `https://js.adscale.de/pbsync.html?gdpr=1&gdpr_consent=${consentString}`;
+ const userSyncResponse = spec.getUserSyncs({iframeEnabled: true}, [''], {gdprApplies: true, consentString});
+
+ assert.deepStrictEqual(userSyncResponse, [{type: 'iframe', url: expectedUrl}]);
+ });
+
+ it('should correctly escape invalid characters', () => {
+ const consentString = 'consent ?stri&ng';
+ const expectedUrl = `https://js.adscale.de/pbsync.html?gdpr=1&gdpr_consent=consent%20%3Fstri%26ng`;
+ const userSyncResponse = spec.getUserSyncs({iframeEnabled: true}, [''], {gdprApplies: true, consentString});
+
+ assert.deepStrictEqual(userSyncResponse, [{type: 'iframe', url: expectedUrl}]);
+ });
+ });
+ });
+ });
+
+ describe('when iframe option is disabled', () => {
+ it('should not perform user connect even when there was a response', () => {
+ const userSyncResponse = spec.getUserSyncs({iframeEnabled: false}, ['']);
+
+ assert.deepStrictEqual(userSyncResponse, []);
+ });
+
+ it('should not perform user connect when there was no response', () => {
+ const userSyncResponse = spec.getUserSyncs({iframeEnabled: false}, []);
+
+ assert.deepStrictEqual(userSyncResponse, []);
+ });
+ });
+ });
+});
diff --git a/test/spec/modules/teadsBidAdapter_spec.js b/test/spec/modules/teadsBidAdapter_spec.js
index 17841b271d4..a6ae17ec8ff 100644
--- a/test/spec/modules/teadsBidAdapter_spec.js
+++ b/test/spec/modules/teadsBidAdapter_spec.js
@@ -200,8 +200,8 @@ describe('teadsBidAdapter', () => {
performance.getEntriesByType('navigation')[0] &&
performance.getEntriesByType('navigation')[0].responseStart &&
performance.getEntriesByType('navigation')[0].requestStart &&
- performance.getEntriesByType('navigation')[0].responseStart >= 0 &&
- performance.getEntriesByType('navigation')[0].requestStart >= 0 &&
+ performance.getEntriesByType('navigation')[0].responseStart > 0 &&
+ performance.getEntriesByType('navigation')[0].requestStart > 0 &&
Math.round(
performance.getEntriesByType('navigation')[0].responseStart - performance.getEntriesByType('navigation')[0].requestStart
);
@@ -211,9 +211,15 @@ describe('teadsBidAdapter', () => {
if (ttfbExpectedV2) {
expect(payload.timeToFirstByte).to.deep.equal(ttfbExpectedV2.toString());
} else {
- const ttfbExpectedV1 = performance.timing.responseStart - performance.timing.requestStart;
-
- expect(payload.timeToFirstByte).to.deep.equal(ttfbExpectedV1.toString());
+ const ttfbWithTimingV1 = performance &&
+ performance.timing.responseStart &&
+ performance.timing.requestStart &&
+ performance.timing.responseStart > 0 &&
+ performance.timing.requestStart > 0 &&
+ performance.timing.responseStart - performance.timing.requestStart;
+ const ttfbExpectedV1 = ttfbWithTimingV1 ? ttfbWithTimingV1.toString() : '';
+
+ expect(payload.timeToFirstByte).to.deep.equal(ttfbExpectedV1);
}
});
diff --git a/test/spec/modules/truereachBidAdapter_spec.js b/test/spec/modules/truereachBidAdapter_spec.js
index 5fe053ceb91..36441722648 100644
--- a/test/spec/modules/truereachBidAdapter_spec.js
+++ b/test/spec/modules/truereachBidAdapter_spec.js
@@ -81,4 +81,25 @@ describe('truereachBidAdapterTests', function () {
expect(bid.netRevenue).to.equal(false);
expect(bid.meta.advertiserDomains[0]).to.equal('https://www.momagic.com/');
});
+
+ describe('user_sync', function() {
+ const user_sync_url = 'http://ads.momagic.com/jsp/usersync.jsp';
+ it('register_iframe_pixel_if_iframeEnabled_is_true', function() {
+ let syncs = spec.getUserSyncs(
+ {iframeEnabled: true}
+ );
+ expect(syncs).to.be.an('array');
+ expect(syncs.length).to.equal(1);
+ expect(syncs[0].type).to.equal('iframe');
+ expect(syncs[0].url).to.equal(user_sync_url);
+ });
+
+ it('if_pixelEnabled_is_true', function() {
+ let syncs = spec.getUserSyncs(
+ {pixelEnabled: true}
+ );
+ expect(syncs).to.be.an('array');
+ expect(syncs.length).to.equal(0);
+ });
+ });
});
diff --git a/test/spec/modules/userId_spec.js b/test/spec/modules/userId_spec.js
index c4e52d9a121..c5ab2e249fc 100644
--- a/test/spec/modules/userId_spec.js
+++ b/test/spec/modules/userId_spec.js
@@ -20,6 +20,7 @@ import {
resetConsentData,
setConsentConfig
} from 'modules/consentManagement.js';
+import {server} from 'test/mocks/xhr.js';
import {unifiedIdSubmodule} from 'modules/unifiedIdSystem.js';
import {pubCommonIdSubmodule} from 'modules/pubCommonIdSystem.js';
import {britepoolIdSubmodule} from 'modules/britepoolIdSystem.js';
@@ -32,8 +33,8 @@ import {intentIqIdSubmodule} from 'modules/intentIqIdSystem.js';
import {zeotapIdPlusSubmodule} from 'modules/zeotapIdPlusIdSystem.js';
import {sharedIdSubmodule} from 'modules/sharedIdSystem.js';
import {haloIdSubmodule} from 'modules/haloIdSystem.js';
-import {server} from 'test/mocks/xhr.js';
-import {pubProvidedIdSubmodule} from 'modules/pubProvidedSystem.js';
+import {pubProvidedIdSubmodule} from 'modules/pubProvidedIdSystem.js';
+import {criteoIdSubmodule} from 'modules/criteoIdSystem.js';
let assert = require('chai').assert;
let expect = require('chai').expect;
@@ -41,22 +42,11 @@ const EXPIRED_COOKIE_DATE = 'Thu, 01 Jan 1970 00:00:01 GMT';
const CONSENT_LOCAL_STORAGE_NAME = '_pbjs_userid_consent_data';
describe('User ID', function () {
- function getConfigMock(configArr1, configArr2, configArr3, configArr4, configArr5, configArr6, configArr7, configArr8, configArr9, configArr10) {
+ function getConfigMock(...configArrays) {
return {
userSync: {
syncDelay: 0,
- userIds: [
- (configArr1 && configArr1.length >= 3) ? getStorageMock.apply(null, configArr1) : null,
- (configArr2 && configArr2.length >= 3) ? getStorageMock.apply(null, configArr2) : null,
- (configArr3 && configArr3.length >= 3) ? getStorageMock.apply(null, configArr3) : null,
- (configArr4 && configArr4.length >= 3) ? getStorageMock.apply(null, configArr4) : null,
- (configArr5 && configArr5.length >= 3) ? getStorageMock.apply(null, configArr5) : null,
- (configArr6 && configArr6.length >= 3) ? getStorageMock.apply(null, configArr6) : null,
- (configArr7 && configArr7.length >= 3) ? getStorageMock.apply(null, configArr7) : null,
- (configArr8 && configArr8.length >= 3) ? getStorageMock.apply(null, configArr8) : null,
- (configArr9 && configArr9.length >= 3) ? getStorageMock.apply(null, configArr9) : null,
- (configArr10 && configArr10.length >= 3) ? getStorageMock.apply(null, configArr10) : null
- ].filter(i => i)
+ userIds: configArrays.map(configArray => (configArray && configArray.length >= 3) ? getStorageMock.apply(null, configArray) : null)
}
}
}
@@ -94,6 +84,12 @@ describe('User ID', function () {
return cfg;
}
+ function findEid(eids, source) {
+ return eids.find((eid) => {
+ if (eid.source === source) { return true; }
+ });
+ }
+
before(function () {
coreStorage.setCookie('_pubcid_optout', '', EXPIRED_COOKIE_DATE);
localStorage.removeItem('_pbjs_id_optout');
@@ -311,6 +307,108 @@ describe('User ID', function () {
expect(typeof (getGlobal()).getUserIdsAsEids).to.equal('function');
expect((getGlobal()).getUserIdsAsEids()).to.deep.equal(createEidsArray((getGlobal()).getUserIds()));
});
+
+ it('pbjs.refreshUserIds refreshes', function() {
+ let sandbox = sinon.createSandbox();
+
+ let mockIdCallback = sandbox.stub().returns({id: {'MOCKID': '1111'}});
+
+ let mockIdSystem = {
+ name: 'mockId',
+ decode: function(value) {
+ return {
+ 'mid': value['MOCKID']
+ };
+ },
+ getId: mockIdCallback
+ };
+
+ setSubmoduleRegistry([mockIdSystem]);
+ init(config);
+ config.setConfig({
+ userSync: {
+ syncDelay: 0,
+ userIds: [{
+ name: 'mockId',
+ value: {id: {mockId: '1111'}}
+ }]
+ }
+ });
+ expect(typeof (getGlobal()).refreshUserIds).to.equal('function');
+
+ getGlobal().getUserIds(); // force initialization
+
+ // update config so that getId will be called
+ config.setConfig({
+ userSync: {
+ syncDelay: 0,
+ userIds: [{
+ name: 'mockId',
+ storage: {name: 'mockid', type: 'cookie'},
+ }]
+ }
+ });
+
+ getGlobal().refreshUserIds();
+ expect(mockIdCallback.callCount).to.equal(1);
+ });
+
+ it('pbjs.refreshUserIds refreshes single', function() {
+ coreStorage.setCookie('MOCKID', '', EXPIRED_COOKIE_DATE);
+ coreStorage.setCookie('REFRESH', '', EXPIRED_COOKIE_DATE);
+
+ let sandbox = sinon.createSandbox();
+ let mockIdCallback = sandbox.stub().returns({id: {'MOCKID': '1111'}});
+ let refreshUserIdsCallback = sandbox.stub();
+
+ let mockIdSystem = {
+ name: 'mockId',
+ decode: function(value) {
+ return {
+ 'mid': value['MOCKID']
+ };
+ },
+ getId: mockIdCallback
+ };
+
+ let refreshedIdCallback = sandbox.stub().returns({id: {'REFRESH': '1111'}});
+
+ let refreshedIdSystem = {
+ name: 'refreshedId',
+ decode: function(value) {
+ return {
+ 'refresh': value['REFRESH']
+ };
+ },
+ getId: refreshedIdCallback
+ };
+
+ setSubmoduleRegistry([refreshedIdSystem, mockIdSystem]);
+ init(config);
+ config.setConfig({
+ userSync: {
+ syncDelay: 0,
+ userIds: [
+ {
+ name: 'mockId',
+ storage: {name: 'MOCKID', type: 'cookie'},
+ },
+ {
+ name: 'refreshedId',
+ storage: {name: 'refreshedid', type: 'cookie'},
+ }
+ ]
+ }
+ });
+
+ getGlobal().getUserIds(); // force initialization
+
+ getGlobal().refreshUserIds({submoduleNames: 'refreshedId'}, refreshUserIdsCallback);
+
+ expect(refreshedIdCallback.callCount).to.equal(2);
+ expect(mockIdCallback.callCount).to.equal(1);
+ expect(refreshUserIdsCallback.callCount).to.equal(1);
+ });
});
describe('Opt out', function () {
@@ -361,7 +459,7 @@ describe('User ID', function () {
});
it('handles config with no usersync object', function () {
- setSubmoduleRegistry([pubCommonIdSubmodule, unifiedIdSubmodule, id5IdSubmodule, identityLinkSubmodule, merkleIdSubmodule, netIdSubmodule, sharedIdSubmodule, intentIqIdSubmodule, zeotapIdPlusSubmodule, pubProvidedIdSubmodule]);
+ setSubmoduleRegistry([pubCommonIdSubmodule, unifiedIdSubmodule, id5IdSubmodule, identityLinkSubmodule, merkleIdSubmodule, netIdSubmodule, sharedIdSubmodule, intentIqIdSubmodule, zeotapIdPlusSubmodule, pubProvidedIdSubmodule, criteoIdSubmodule]);
init(config);
config.setConfig({});
// usersync is undefined, and no logInfo message for 'User ID - usersync config updated'
@@ -369,14 +467,14 @@ describe('User ID', function () {
});
it('handles config with empty usersync object', function () {
- setSubmoduleRegistry([pubCommonIdSubmodule, unifiedIdSubmodule, id5IdSubmodule, identityLinkSubmodule, merkleIdSubmodule, netIdSubmodule, sharedIdSubmodule, intentIqIdSubmodule, zeotapIdPlusSubmodule, pubProvidedIdSubmodule]);
+ setSubmoduleRegistry([pubCommonIdSubmodule, unifiedIdSubmodule, id5IdSubmodule, identityLinkSubmodule, merkleIdSubmodule, netIdSubmodule, sharedIdSubmodule, intentIqIdSubmodule, zeotapIdPlusSubmodule, pubProvidedIdSubmodule, criteoIdSubmodule]);
init(config);
config.setConfig({userSync: {}});
expect(typeof utils.logInfo.args[0]).to.equal('undefined');
});
it('handles config with usersync and userIds that are empty objs', function () {
- setSubmoduleRegistry([pubCommonIdSubmodule, unifiedIdSubmodule, id5IdSubmodule, identityLinkSubmodule, merkleIdSubmodule, netIdSubmodule, sharedIdSubmodule, intentIqIdSubmodule, zeotapIdPlusSubmodule, pubProvidedIdSubmodule]);
+ setSubmoduleRegistry([pubCommonIdSubmodule, unifiedIdSubmodule, id5IdSubmodule, identityLinkSubmodule, merkleIdSubmodule, netIdSubmodule, sharedIdSubmodule, intentIqIdSubmodule, zeotapIdPlusSubmodule, pubProvidedIdSubmodule, criteoIdSubmodule]);
init(config);
config.setConfig({
userSync: {
@@ -387,7 +485,7 @@ describe('User ID', function () {
});
it('handles config with usersync and userIds with empty names or that dont match a submodule.name', function () {
- setSubmoduleRegistry([pubCommonIdSubmodule, unifiedIdSubmodule, id5IdSubmodule, identityLinkSubmodule, merkleIdSubmodule, netIdSubmodule, sharedIdSubmodule, intentIqIdSubmodule, zeotapIdPlusSubmodule, pubProvidedIdSubmodule]);
+ setSubmoduleRegistry([pubCommonIdSubmodule, unifiedIdSubmodule, id5IdSubmodule, identityLinkSubmodule, merkleIdSubmodule, netIdSubmodule, sharedIdSubmodule, intentIqIdSubmodule, zeotapIdPlusSubmodule, pubProvidedIdSubmodule, criteoIdSubmodule]);
init(config);
config.setConfig({
userSync: {
@@ -404,15 +502,15 @@ describe('User ID', function () {
});
it('config with 1 configurations should create 1 submodules', function () {
- setSubmoduleRegistry([pubCommonIdSubmodule, unifiedIdSubmodule, id5IdSubmodule, identityLinkSubmodule, netIdSubmodule, sharedIdSubmodule, intentIqIdSubmodule, zeotapIdPlusSubmodule, pubProvidedIdSubmodule]);
+ setSubmoduleRegistry([pubCommonIdSubmodule, unifiedIdSubmodule, id5IdSubmodule, identityLinkSubmodule, netIdSubmodule, sharedIdSubmodule, intentIqIdSubmodule, zeotapIdPlusSubmodule, pubProvidedIdSubmodule, criteoIdSubmodule]);
init(config);
config.setConfig(getConfigMock(['unifiedId', 'unifiedid', 'cookie']));
expect(utils.logInfo.args[0][0]).to.exist.and.to.equal('User ID - usersync config updated for 1 submodules');
});
- it('config with 11 configurations should result in 12 submodules add', function () {
- setSubmoduleRegistry([pubCommonIdSubmodule, unifiedIdSubmodule, id5IdSubmodule, identityLinkSubmodule, liveIntentIdSubmodule, britepoolIdSubmodule, netIdSubmodule, sharedIdSubmodule, intentIqIdSubmodule, zeotapIdPlusSubmodule, haloIdSubmodule, pubProvidedIdSubmodule]);
+ it('config with 13 configurations should result in 13 submodules add', function () {
+ setSubmoduleRegistry([pubCommonIdSubmodule, unifiedIdSubmodule, id5IdSubmodule, identityLinkSubmodule, liveIntentIdSubmodule, britepoolIdSubmodule, netIdSubmodule, sharedIdSubmodule, intentIqIdSubmodule, zeotapIdPlusSubmodule, haloIdSubmodule, pubProvidedIdSubmodule, criteoIdSubmodule]);
init(config);
config.setConfig({
userSync: {
@@ -450,14 +548,16 @@ describe('User ID', function () {
storage: {name: 'haloId', type: 'cookie'}
}, {
name: 'zeotapIdPlus'
+ }, {
+ name: 'criteo'
}]
}
});
- expect(utils.logInfo.args[0][0]).to.exist.and.to.equal('User ID - usersync config updated for 12 submodules');
+ expect(utils.logInfo.args[0][0]).to.exist.and.to.equal('User ID - usersync config updated for 13 submodules');
});
it('config syncDelay updates module correctly', function () {
- setSubmoduleRegistry([pubCommonIdSubmodule, unifiedIdSubmodule, id5IdSubmodule, identityLinkSubmodule, netIdSubmodule, sharedIdSubmodule, intentIqIdSubmodule, zeotapIdPlusSubmodule, haloIdSubmodule, pubProvidedIdSubmodule]);
+ setSubmoduleRegistry([pubCommonIdSubmodule, unifiedIdSubmodule, id5IdSubmodule, identityLinkSubmodule, netIdSubmodule, sharedIdSubmodule, intentIqIdSubmodule, zeotapIdPlusSubmodule, haloIdSubmodule, pubProvidedIdSubmodule, criteoIdSubmodule]);
init(config);
config.setConfig({
userSync: {
@@ -472,7 +572,7 @@ describe('User ID', function () {
});
it('config auctionDelay updates module correctly', function () {
- setSubmoduleRegistry([pubCommonIdSubmodule, unifiedIdSubmodule, id5IdSubmodule, identityLinkSubmodule, netIdSubmodule, sharedIdSubmodule, intentIqIdSubmodule, zeotapIdPlusSubmodule, haloIdSubmodule, pubProvidedIdSubmodule]);
+ setSubmoduleRegistry([pubCommonIdSubmodule, unifiedIdSubmodule, id5IdSubmodule, identityLinkSubmodule, netIdSubmodule, sharedIdSubmodule, intentIqIdSubmodule, zeotapIdPlusSubmodule, haloIdSubmodule, pubProvidedIdSubmodule, criteoIdSubmodule]);
init(config);
config.setConfig({
userSync: {
@@ -487,7 +587,7 @@ describe('User ID', function () {
});
it('config auctionDelay defaults to 0 if not a number', function () {
- setSubmoduleRegistry([pubCommonIdSubmodule, unifiedIdSubmodule, id5IdSubmodule, identityLinkSubmodule, netIdSubmodule, sharedIdSubmodule, intentIqIdSubmodule, zeotapIdPlusSubmodule, haloIdSubmodule, pubProvidedIdSubmodule]);
+ setSubmoduleRegistry([pubCommonIdSubmodule, unifiedIdSubmodule, id5IdSubmodule, identityLinkSubmodule, netIdSubmodule, sharedIdSubmodule, intentIqIdSubmodule, zeotapIdPlusSubmodule, haloIdSubmodule, pubProvidedIdSubmodule, criteoIdSubmodule]);
init(config);
config.setConfig({
userSync: {
@@ -731,6 +831,10 @@ describe('User ID', function () {
source: 'pubcid.org',
uids: [{id: 'testpubcid', atype: 1}]
});
+
+ // verify no sharedid was added
+ expect(bid.userId).to.not.have.property('sharedid');
+ expect(findEid(bid.userIdAsEids, 'sharedid.org')).to.be.undefined;
});
});
coreStorage.setCookie('pubcid', '', EXPIRED_COOKIE_DATE);
@@ -738,6 +842,36 @@ describe('User ID', function () {
}, {adUnits});
});
+ it('test hook from pubcommonid html5', function (done) {
+ // simulate existing browser local storage values
+ localStorage.setItem('pubcid', 'testpubcid');
+ localStorage.setItem('pubcid_exp', new Date(Date.now() + 100000).toUTCString());
+
+ setSubmoduleRegistry([pubCommonIdSubmodule]);
+ init(config);
+ config.setConfig(getConfigMock(['pubCommonId', 'pubcid', 'html5']));
+
+ requestBidsHook(function () {
+ adUnits.forEach(unit => {
+ unit.bids.forEach(bid => {
+ expect(bid).to.have.deep.nested.property('userId.pubcid');
+ expect(bid.userId.pubcid).to.equal('testpubcid');
+ expect(bid.userIdAsEids[0]).to.deep.equal({
+ source: 'pubcid.org',
+ uids: [{id: 'testpubcid', atype: 1}]
+ });
+
+ // verify no sharedid was added
+ expect(bid.userId).to.not.have.property('sharedid');
+ expect(findEid(bid.userIdAsEids, 'sharedid.org')).to.be.undefined;
+ });
+ });
+ localStorage.removeItem('pubcid');
+ localStorage.removeItem('pubcid_exp');
+ done();
+ }, {adUnits});
+ });
+
it('test hook from pubcommonid config value object', function (done) {
setSubmoduleRegistry([pubCommonIdSubmodule]);
init(config);
@@ -755,7 +889,7 @@ describe('User ID', function () {
}, {adUnits});
});
- it('test hook from pubcommonid html5', function (done) {
+ it('test hook from UnifiedId html5', function (done) {
// simulate existing browser local storage values
localStorage.setItem('unifiedid_alt', JSON.stringify({'TDID': 'testunifiedid_alt'}));
localStorage.setItem('unifiedid_alt_exp', '');
@@ -829,6 +963,29 @@ describe('User ID', function () {
}, {adUnits});
});
+ it('test hook from criteoIdModule cookie', function (done) {
+ coreStorage.setCookie('storage_bidid', JSON.stringify({'criteoId': 'test_bidid'}), (new Date(Date.now() + 100000).toUTCString()));
+
+ setSubmoduleRegistry([criteoIdSubmodule]);
+ init(config);
+ config.setConfig(getConfigMock(['criteo', 'storage_bidid', 'cookie']));
+
+ requestBidsHook(function () {
+ adUnits.forEach(unit => {
+ unit.bids.forEach(bid => {
+ expect(bid).to.have.deep.nested.property('userId.criteoId');
+ expect(bid.userId.criteoId).to.equal('test_bidid');
+ expect(bid.userIdAsEids[0]).to.deep.equal({
+ source: 'criteo.com',
+ uids: [{id: 'test_bidid', atype: 1}]
+ });
+ });
+ });
+ coreStorage.setCookie('storage_bidid', '', EXPIRED_COOKIE_DATE);
+ done();
+ }, {adUnits});
+ });
+
it('test hook from liveIntentId html5', function (done) {
// simulate existing browser local storage values
localStorage.setItem('_li_pbid', JSON.stringify({'unifiedId': 'random-ls-identifier'}));
@@ -1310,7 +1467,7 @@ describe('User ID', function () {
}, {adUnits});
});
- it('test hook when pubCommonId, unifiedId, id5Id, identityLink, britepoolId, intentIqId, zeotapIdPlus, sharedId, netId and haloId have data to pass', function (done) {
+ it('test hook when pubCommonId, unifiedId, id5Id, identityLink, britepoolId, intentIqId, zeotapIdPlus, sharedId, netId, haloId and Criteo have data to pass', function (done) {
coreStorage.setCookie('pubcid', 'testpubcid', (new Date(Date.now() + 5000).toUTCString()));
coreStorage.setCookie('unifiedid', JSON.stringify({'TDID': 'testunifiedid'}), (new Date(Date.now() + 5000).toUTCString()));
coreStorage.setCookie('id5id', JSON.stringify({'universal_uid': 'testid5id'}), (new Date(Date.now() + 5000).toUTCString()));
@@ -1324,8 +1481,9 @@ describe('User ID', function () {
'ts': 1590525289611
}), (new Date(Date.now() + 5000).toUTCString()));
coreStorage.setCookie('haloId', JSON.stringify({'haloId': 'testHaloId'}), (new Date(Date.now() + 5000).toUTCString()));
+ coreStorage.setCookie('storage_criteo', JSON.stringify({'criteoId': 'test_bidid'}), (new Date(Date.now() + 5000).toUTCString()));
- setSubmoduleRegistry([pubCommonIdSubmodule, unifiedIdSubmodule, id5IdSubmodule, identityLinkSubmodule, britepoolIdSubmodule, netIdSubmodule, sharedIdSubmodule, intentIqIdSubmodule, zeotapIdPlusSubmodule, haloIdSubmodule]);
+ setSubmoduleRegistry([pubCommonIdSubmodule, unifiedIdSubmodule, id5IdSubmodule, identityLinkSubmodule, britepoolIdSubmodule, netIdSubmodule, sharedIdSubmodule, intentIqIdSubmodule, zeotapIdPlusSubmodule, haloIdSubmodule, criteoIdSubmodule]);
init(config);
config.setConfig(getConfigMock(['pubCommonId', 'pubcid', 'cookie'],
['unifiedId', 'unifiedid', 'cookie'],
@@ -1336,7 +1494,8 @@ describe('User ID', function () {
['sharedId', 'sharedid', 'cookie'],
['intentIqId', 'intentIqId', 'cookie'],
['zeotapIdPlus', 'IDP', 'cookie'],
- ['haloId', 'haloId', 'cookie']));
+ ['haloId', 'haloId', 'cookie'],
+ ['criteo', 'storage_criteo', 'cookie']));
requestBidsHook(function () {
adUnits.forEach(unit => {
@@ -1373,7 +1532,11 @@ describe('User ID', function () {
// also check that haloId id was copied to bid
expect(bid).to.have.deep.nested.property('userId.haloId');
expect(bid.userId.haloId).to.equal('testHaloId');
- expect(bid.userIdAsEids.length).to.equal(10);
+ // also check that criteo id was copied to bid
+ expect(bid).to.have.deep.nested.property('userId.criteoId');
+ expect(bid.userId.criteoId).to.equal('test_bidid');
+
+ expect(bid.userIdAsEids.length).to.equal(11);
});
});
coreStorage.setCookie('pubcid', '', EXPIRED_COOKIE_DATE);
@@ -1386,11 +1549,12 @@ describe('User ID', function () {
coreStorage.setCookie('intentIqId', '', EXPIRED_COOKIE_DATE);
coreStorage.setCookie('IDP', '', EXPIRED_COOKIE_DATE);
coreStorage.setCookie('haloId', '', EXPIRED_COOKIE_DATE);
+ coreStorage.setCookie('storage_criteo', '', EXPIRED_COOKIE_DATE);
done();
}, {adUnits});
});
- it('test hook when pubCommonId, unifiedId, id5Id, britepoolId, intentIqId, zeotapIdPlus, sharedId, netId and haloId have their modules added before and after init', function (done) {
+ it('test hook when pubCommonId, unifiedId, id5Id, britepoolId, intentIqId, zeotapIdPlus, sharedId, criteo, netId and haloId have their modules added before and after init', function (done) {
coreStorage.setCookie('pubcid', 'testpubcid', (new Date(Date.now() + 5000).toUTCString()));
coreStorage.setCookie('unifiedid', JSON.stringify({'TDID': 'cookie-value-add-module-variations'}), new Date(Date.now() + 5000).toUTCString());
coreStorage.setCookie('id5id', JSON.stringify({'universal_uid': 'testid5id'}), (new Date(Date.now() + 5000).toUTCString()));
@@ -1404,6 +1568,7 @@ describe('User ID', function () {
coreStorage.setCookie('intentIqId', 'testintentIqId', (new Date(Date.now() + 5000).toUTCString()));
coreStorage.setCookie('IDP', btoa(JSON.stringify('zeotapId')), (new Date(Date.now() + 5000).toUTCString()));
coreStorage.setCookie('haloId', JSON.stringify({'haloId': 'testHaloId'}), (new Date(Date.now() + 5000).toUTCString()));
+ coreStorage.setCookie('storage_criteo', JSON.stringify({'criteoId': 'test_bidid'}), (new Date(Date.now() + 5000).toUTCString()));
setSubmoduleRegistry([]);
@@ -1422,6 +1587,7 @@ describe('User ID', function () {
attachIdSystem(intentIqIdSubmodule);
attachIdSystem(zeotapIdPlusSubmodule);
attachIdSystem(haloIdSubmodule);
+ attachIdSystem(criteoIdSubmodule);
config.setConfig(getConfigMock(['pubCommonId', 'pubcid', 'cookie'],
['unifiedId', 'unifiedid', 'cookie'],
@@ -1432,7 +1598,8 @@ describe('User ID', function () {
['sharedId', 'sharedid', 'cookie'],
['intentIqId', 'intentIqId', 'cookie'],
['zeotapIdPlus', 'IDP', 'cookie'],
- ['haloId', 'haloId', 'cookie']));
+ ['haloId', 'haloId', 'cookie'],
+ ['criteo', 'storage_criteo', 'cookie']));
requestBidsHook(function () {
adUnits.forEach(unit => {
@@ -1470,7 +1637,12 @@ describe('User ID', function () {
// also check that haloId id data was copied to bid
expect(bid).to.have.deep.nested.property('userId.haloId');
expect(bid.userId.haloId).to.equal('testHaloId');
- expect(bid.userIdAsEids.length).to.equal(10);
+
+ // also check that criteo id data was copied to bid
+ expect(bid).to.have.deep.nested.property('userId.criteoId');
+ expect(bid.userId.criteoId).to.equal('test_bidid');
+
+ expect(bid.userIdAsEids.length).to.equal(11);
});
});
coreStorage.setCookie('pubcid', '', EXPIRED_COOKIE_DATE);
@@ -1483,6 +1655,7 @@ describe('User ID', function () {
coreStorage.setCookie('intentIqId', '', EXPIRED_COOKIE_DATE);
coreStorage.setCookie('IDP', '', EXPIRED_COOKIE_DATE);
coreStorage.setCookie('haloId', '', EXPIRED_COOKIE_DATE);
+ coreStorage.setCookie('storage_criteo', '', EXPIRED_COOKIE_DATE);
done();
}, {adUnits});
});
@@ -1511,6 +1684,192 @@ describe('User ID', function () {
}, {adUnits});
});
+ it('test sharedid enabled via pubcid cookie', function (done) {
+ coreStorage.setCookie('pubcid', 'testpubcid', (new Date(Date.now() + 5000).toUTCString()));
+ coreStorage.setCookie('pubcid_sharedid', 'testsharedid', (new Date(Date.now() + 5000).toUTCString()));
+
+ setSubmoduleRegistry([pubCommonIdSubmodule]);
+ init(config);
+
+ const customCfg = getConfigMock(['pubCommonId', 'pubcid', 'cookie']);
+ addConfig(customCfg, 'params', {enableSharedId: true});
+ config.setConfig(customCfg);
+
+ requestBidsHook(function () {
+ adUnits.forEach(unit => {
+ unit.bids.forEach(bid => {
+ // verify that the PubCommonId id data was copied to bid
+ expect(bid).to.have.deep.nested.property('userId.pubcid');
+ expect(bid.userId.pubcid).to.equal('testpubcid');
+ expect(findEid(bid.userIdAsEids, 'pubcid.org')).to.deep.equal(
+ {'source': 'pubcid.org', 'uids': [{'id': 'testpubcid', 'atype': 1}]}
+ );
+ // verify that the sharedid was also copied to bid
+ expect(bid).to.have.deep.nested.property('userId.sharedid');
+ expect(bid.userId.sharedid).to.deep.equal({id: 'testsharedid'});
+ expect(findEid(bid.userIdAsEids, 'sharedid.org')).to.deep.equal(
+ {'source': 'sharedid.org', 'uids': [{'id': 'testsharedid', 'atype': 1}]}
+ );
+ });
+ });
+ coreStorage.setCookie('pubcid', '', EXPIRED_COOKIE_DATE);
+ coreStorage.setCookie('pubcid_sharedid', '', EXPIRED_COOKIE_DATE);
+
+ done();
+ }, {adUnits});
+ });
+
+ it('test sharedid disabled via pubcid cookie', function (done) {
+ coreStorage.setCookie('pubcid', 'testpubcid', (new Date(Date.now() + 5000).toUTCString()));
+ coreStorage.setCookie('pubcid_sharedid', 'testsharedid', (new Date(Date.now() + 5000).toUTCString()));
+
+ setSubmoduleRegistry([pubCommonIdSubmodule]);
+ init(config);
+
+ // pubCommonId's support for sharedId is off by default
+ config.setConfig(getConfigMock(['pubCommonId', 'pubcid', 'cookie']));
+
+ requestBidsHook(function () {
+ adUnits.forEach(unit => {
+ unit.bids.forEach(bid => {
+ // verify that the PubCommonId id data was copied to bid
+ expect(bid).to.have.deep.nested.property('userId.pubcid');
+ expect(bid.userId.pubcid).to.equal('testpubcid');
+ expect(findEid(bid.userIdAsEids, 'pubcid.org')).to.deep.equal(
+ {'source': 'pubcid.org', 'uids': [{'id': 'testpubcid', 'atype': 1}]}
+ );
+ // verify that the sharedid was not added to bid
+ expect(bid.userId).to.not.have.property('sharedid');
+ expect(findEid(bid.userIdAsEids, 'sharedid.org')).to.be.undefined;
+ });
+ });
+ coreStorage.setCookie('pubcid', '', EXPIRED_COOKIE_DATE);
+ coreStorage.setCookie('pubcid_sharedid', '', EXPIRED_COOKIE_DATE);
+
+ done();
+ }, {adUnits});
+ });
+
+ it('test sharedid enabled via pubcid html5', function (done) {
+ coreStorage.setDataInLocalStorage('pubcid', 'testpubcid');
+ coreStorage.setDataInLocalStorage('pubcid_exp', new Date(Date.now() + 5000).toUTCString());
+ coreStorage.setDataInLocalStorage('pubcid_sharedid', 'testsharedid');
+ coreStorage.setDataInLocalStorage('pubcid_sharedid_exp', new Date(Date.now() + 5000).toUTCString());
+
+ setSubmoduleRegistry([pubCommonIdSubmodule]);
+ init(config);
+
+ const customCfg = getConfigMock(['pubCommonId', 'pubcid', 'html5']);
+ addConfig(customCfg, 'params', {enableSharedId: true});
+ config.setConfig(customCfg);
+
+ requestBidsHook(function () {
+ adUnits.forEach(unit => {
+ unit.bids.forEach(bid => {
+ // verify that the PubCommonId id data was copied to bid
+ expect(bid).to.have.deep.nested.property('userId.pubcid');
+ expect(bid.userId.pubcid).to.equal('testpubcid');
+ expect(findEid(bid.userIdAsEids, 'pubcid.org')).to.deep.equal(
+ {'source': 'pubcid.org', 'uids': [{'id': 'testpubcid', 'atype': 1}]}
+ );
+ // verify that the sharedid was also copied to bid
+ expect(bid).to.have.deep.nested.property('userId.sharedid');
+ expect(bid.userId.sharedid).to.deep.equal({id: 'testsharedid'});
+ expect(findEid(bid.userIdAsEids, 'sharedid.org')).to.deep.equal(
+ {'source': 'sharedid.org', 'uids': [{'id': 'testsharedid', 'atype': 1}]}
+ );
+ });
+ });
+ coreStorage.setCookie('pubcid', '', EXPIRED_COOKIE_DATE);
+ coreStorage.setCookie('pubcid_sharedid', '', EXPIRED_COOKIE_DATE);
+
+ coreStorage.removeDataFromLocalStorage('pubcid');
+ coreStorage.removeDataFromLocalStorage('pubcid_exp');
+ coreStorage.removeDataFromLocalStorage('pubcid_sharedid');
+ coreStorage.removeDataFromLocalStorage('pubcid_sharedid_exp');
+ done();
+ }, {adUnits});
+ });
+
+ it('test expired sharedid via pubcid html5', function (done) {
+ coreStorage.setDataInLocalStorage('pubcid', 'testpubcid');
+ coreStorage.setDataInLocalStorage('pubcid_exp', new Date(Date.now() + 5000).toUTCString());
+
+ // set sharedid to expired already
+ coreStorage.setDataInLocalStorage('pubcid_sharedid', 'testsharedid');
+ coreStorage.setDataInLocalStorage('pubcid_sharedid_exp', new Date(Date.now() - 100).toUTCString());
+
+ setSubmoduleRegistry([pubCommonIdSubmodule]);
+ init(config);
+
+ const customCfg = getConfigMock(['pubCommonId', 'pubcid', 'html5']);
+ addConfig(customCfg, 'params', {enableSharedId: true});
+ config.setConfig(customCfg);
+
+ requestBidsHook(function () {
+ adUnits.forEach(unit => {
+ unit.bids.forEach(bid => {
+ // verify that the PubCommonId id data was copied to bid
+ expect(bid).to.have.deep.nested.property('userId.pubcid');
+ expect(bid.userId.pubcid).to.equal('testpubcid');
+ expect(findEid(bid.userIdAsEids, 'pubcid.org')).to.deep.equal(
+ {'source': 'pubcid.org', 'uids': [{'id': 'testpubcid', 'atype': 1}]}
+ );
+ // verify that the sharedid was not added
+ expect(bid.userId).to.not.have.property('sharedid');
+ expect(findEid(bid.userIdAsEids, 'sharedid.org')).to.be.undefined;
+ });
+ });
+
+ coreStorage.removeDataFromLocalStorage('pubcid');
+ coreStorage.removeDataFromLocalStorage('pubcid_exp');
+ coreStorage.removeDataFromLocalStorage('pubcid_sharedid');
+ coreStorage.removeDataFromLocalStorage('pubcid_sharedid_exp');
+ done();
+ }, {adUnits});
+ });
+
+ it('test pubcid coexisting with sharedid', function (done) {
+ coreStorage.setCookie('pubcid', 'testpubcid', (new Date(Date.now() + 5000).toUTCString()));
+ coreStorage.setCookie('pubcid_sharedid', 'test111', (new Date(Date.now() + 5000).toUTCString()));
+ coreStorage.setCookie('sharedid', JSON.stringify({
+ 'id': 'test222',
+ 'ts': 1590525289611
+ }), (new Date(Date.now() + 5000).toUTCString()));
+
+ // When both pubcommon and sharedid are configured, pubcommon are invoked first due to
+ // module loading order. This mean the output from the primary sharedid module will overwrite
+ // the one in pubcommon.
+
+ setSubmoduleRegistry([pubCommonIdSubmodule, sharedIdSubmodule]);
+ init(config);
+ config.setConfig(getConfigMock(['pubCommonId', 'pubcid', 'cookie'],
+ ['sharedId', 'sharedid', 'cookie'],
+ ));
+
+ requestBidsHook(function () {
+ adUnits.forEach(unit => {
+ unit.bids.forEach(bid => {
+ // verify that the PubCommonId id data was copied to bid
+ expect(bid).to.have.deep.nested.property('userId.pubcid');
+ expect(bid.userId.pubcid).to.equal('testpubcid');
+ expect(findEid(bid.userIdAsEids, 'pubcid.org')).to.deep.equal(
+ {'source': 'pubcid.org', 'uids': [{'id': 'testpubcid', 'atype': 1}]}
+ );
+ // verify that the sharedid was also copied to bid
+ expect(bid).to.have.deep.nested.property('userId.sharedid');
+ expect(bid.userId.sharedid.id).to.equal('test222');
+ expect(findEid(bid.userIdAsEids, 'sharedid.org').uids[0].id).to.equal('test222');
+ });
+ });
+ coreStorage.setCookie('pubcid', '', EXPIRED_COOKIE_DATE);
+ coreStorage.setCookie('pubcid_sharedid', '', EXPIRED_COOKIE_DATE);
+ coreStorage.setCookie('sharedid', '', EXPIRED_COOKIE_DATE);
+
+ done();
+ }, {adUnits});
+ });
+
it('should add new id system ', function (done) {
coreStorage.setCookie('pubcid', 'testpubcid', (new Date(Date.now() + 5000).toUTCString()));
coreStorage.setCookie('unifiedid', JSON.stringify({'TDID': 'cookie-value-add-module-variations'}), new Date(Date.now() + 5000).toUTCString());
@@ -1567,7 +1926,7 @@ describe('User ID', function () {
'mid': value['MOCKID']
};
},
- getId: function (params, storedId) {
+ getId: function (config, storedId) {
if (storedId) return {};
return {id: {'MOCKID': '1234'}};
}
@@ -1636,6 +1995,7 @@ describe('User ID', function () {
sinon.stub(events, 'getEvents').returns([]);
sinon.stub(utils, 'triggerPixel');
coreStorage.setCookie('pubcid', '', EXPIRED_COOKIE_DATE);
+ coreStorage.setCookie('pubcid_sharedid', '', EXPIRED_COOKIE_DATE);
coreStorage.setCookie('unifiedid', '', EXPIRED_COOKIE_DATE);
coreStorage.setCookie('_parrable_eid', '', EXPIRED_COOKIE_DATE);
});
@@ -1644,6 +2004,7 @@ describe('User ID', function () {
events.getEvents.restore();
utils.triggerPixel.restore();
coreStorage.setCookie('pubcid', '', EXPIRED_COOKIE_DATE);
+ coreStorage.setCookie('pubcid_sharedid', '', EXPIRED_COOKIE_DATE);
coreStorage.setCookie('unifiedid', '', EXPIRED_COOKIE_DATE);
coreStorage.setCookie('_parrable_eid', '', EXPIRED_COOKIE_DATE);
});
@@ -1651,7 +2012,7 @@ describe('User ID', function () {
it('pubcid callback with url', function () {
let adUnits = [getAdUnitMock()];
let innerAdUnits;
- let customCfg = getConfigMock(['pubCommonId', 'pubcid_alt', 'cookie']);
+ let customCfg = getConfigMock(['pubCommonId', 'pubcid', 'cookie']);
customCfg = addConfig(customCfg, 'params', {pixelUrl: '/any/pubcid/url'});
setSubmoduleRegistry([pubCommonIdSubmodule, unifiedIdSubmodule]);
@@ -1701,6 +2062,85 @@ describe('User ID', function () {
events.emit(CONSTANTS.EVENTS.AUCTION_END, {});
expect(server.requests[0].url).to.equal('https://match.adsrvr.org/track/rid?ttd_pid=rubicon&fmt=json');
});
+
+ it('verify sharedid callback via pubcid when enabled', function () {
+ let adUnits = [getAdUnitMock()];
+ let innerAdUnits;
+ let customCfg = getConfigMock(['pubCommonId', 'pubcid', 'cookie']);
+ customCfg = addConfig(customCfg, 'params', {pixelUrl: '/any/pubcid/url', enableSharedId: true});
+
+ server.respondWith('https://id.sharedid.org/id', function(xhr) {
+ xhr.respond(200, {}, '{"sharedId":"testsharedid"}');
+ });
+ server.respondImmediately = true;
+
+ setSubmoduleRegistry([pubCommonIdSubmodule]);
+ init(config);
+ config.setConfig(customCfg);
+ requestBidsHook((config) => {
+ innerAdUnits = config.adUnits
+ }, {adUnits});
+
+ expect(utils.triggerPixel.called).to.be.false;
+ events.emit(CONSTANTS.EVENTS.AUCTION_END, {});
+ expect(utils.triggerPixel.getCall(0).args[0]).to.include('/any/pubcid/url');
+
+ expect(server.requests[0].url).to.equal('https://id.sharedid.org/id');
+ expect(coreStorage.getCookie('pubcid_sharedid')).to.equal('testsharedid');
+ });
+
+ it('verify no sharedid callback via pubcid when disabled', function () {
+ let adUnits = [getAdUnitMock()];
+ let innerAdUnits;
+ let customCfg = getConfigMock(['pubCommonId', 'pubcid', 'cookie']);
+ customCfg = addConfig(customCfg, 'params', {pixelUrl: '/any/pubcid/url'});
+
+ server.respondWith('https://id.sharedid.org/id', function(xhr) {
+ xhr.respond(200, {}, '{"sharedId":"testsharedid"}');
+ });
+ server.respondImmediately = true;
+
+ setSubmoduleRegistry([pubCommonIdSubmodule]);
+ init(config);
+ config.setConfig(customCfg);
+ requestBidsHook((config) => {
+ innerAdUnits = config.adUnits
+ }, {adUnits});
+
+ expect(utils.triggerPixel.called).to.be.false;
+ events.emit(CONSTANTS.EVENTS.AUCTION_END, {});
+ expect(utils.triggerPixel.getCall(0).args[0]).to.include('/any/pubcid/url');
+
+ expect(server.requests).to.have.lengthOf(0);
+ expect(coreStorage.getCookie('pubcid_sharedid')).to.be.null;
+ });
+
+ it('verify sharedid optout via pubcid when enabled', function () {
+ let adUnits = [getAdUnitMock()];
+ let innerAdUnits;
+ let customCfg = getConfigMock(['pubCommonId', 'pubcid', 'cookie']);
+ customCfg = addConfig(customCfg, 'params', {pixelUrl: '/any/pubcid/url', enableSharedId: true});
+ coreStorage.setCookie('pubcid_sharedid', 'testsharedid', (new Date(Date.now() + 5000).toUTCString()));
+
+ server.respondWith('https://id.sharedid.org/id', function(xhr) {
+ xhr.respond(200, {}, '{"sharedId":"00000000000000000000000000"}');
+ });
+ server.respondImmediately = true;
+
+ setSubmoduleRegistry([pubCommonIdSubmodule]);
+ init(config);
+ config.setConfig(customCfg);
+ requestBidsHook((config) => {
+ innerAdUnits = config.adUnits
+ }, {adUnits});
+
+ expect(utils.triggerPixel.called).to.be.false;
+ events.emit(CONSTANTS.EVENTS.AUCTION_END, {});
+ expect(utils.triggerPixel.getCall(0).args[0]).to.include('/any/pubcid/url');
+
+ expect(server.requests[0].url).to.equal('https://id.sharedid.org/id');
+ expect(coreStorage.getCookie('pubcid_sharedid')).to.be.null;
+ });
});
describe('Set cookie behavior', function () {
diff --git a/test/spec/modules/vuukleBidAdapter_spec.js b/test/spec/modules/vuukleBidAdapter_spec.js
new file mode 100644
index 00000000000..fdca4085c8e
--- /dev/null
+++ b/test/spec/modules/vuukleBidAdapter_spec.js
@@ -0,0 +1,59 @@
+import { expect } from 'chai';
+import { spec } from 'modules/vuukleBidAdapter.js';
+
+describe('vuukleBidAdapterTests', function() {
+ let bidRequestData = {
+ bids: [
+ {
+ bidId: 'testbid',
+ bidder: 'vuukle',
+ params: {
+ test: 1
+ },
+ sizes: [[300, 250]]
+ }
+ ]
+ };
+ let request = [];
+
+ it('validate_pub_params', function() {
+ expect(
+ spec.isBidRequestValid({
+ bidder: 'vuukle',
+ params: {
+ test: 1
+ }
+ })
+ ).to.equal(true);
+ });
+
+ it('validate_generated_params', function() {
+ request = spec.buildRequests(bidRequestData.bids);
+ let req_data = request[0].data;
+
+ expect(req_data.bidId).to.equal('testbid');
+ });
+
+ it('validate_response_params', function() {
+ let serverResponse = {
+ body: {
+ 'cpm': 0.01,
+ 'width': 300,
+ 'height': 250,
+ 'creative_id': '12345',
+ 'ad': 'test ad'
+ }
+ };
+
+ request = spec.buildRequests(bidRequestData.bids);
+ let bids = spec.interpretResponse(serverResponse, request[0]);
+ expect(bids).to.have.lengthOf(1);
+
+ let bid = bids[0];
+ expect(bid.ad).to.equal('test ad');
+ expect(bid.cpm).to.equal(0.01);
+ expect(bid.width).to.equal(300);
+ expect(bid.height).to.equal(250);
+ expect(bid.creativeId).to.equal('12345');
+ });
+});
diff --git a/test/spec/modules/zeotapIdPlusIdSystem_spec.js b/test/spec/modules/zeotapIdPlusIdSystem_spec.js
index 54082618120..4f9e691f12e 100644
--- a/test/spec/modules/zeotapIdPlusIdSystem_spec.js
+++ b/test/spec/modules/zeotapIdPlusIdSystem_spec.js
@@ -34,26 +34,23 @@ function getAdUnitMock(code = 'adUnit-code') {
};
}
-describe('Zeotap ID System', function() {
- let getDataFromLocalStorageStub, localStorageIsEnabledStub;
- let getCookieStub, cookiesAreEnabledStub;
- beforeEach(function () {
- getDataFromLocalStorageStub = sinon.stub(storage, 'getDataFromLocalStorage');
- localStorageIsEnabledStub = sinon.stub(storage, 'localStorageIsEnabled');
- getCookieStub = sinon.stub(storage, 'getCookie');
- cookiesAreEnabledStub = sinon.stub(storage, 'cookiesAreEnabled');
- });
+function unsetCookie() {
+ storage.setCookie(ZEOTAP_COOKIE_NAME, '');
+}
- afterEach(function () {
- getDataFromLocalStorageStub.restore();
- localStorageIsEnabledStub.restore();
- getCookieStub.restore();
- cookiesAreEnabledStub.restore();
- });
+function unsetLocalStorage() {
+ storage.setDataInLocalStorage(ZEOTAP_COOKIE_NAME, '');
+}
+describe('Zeotap ID System', function() {
describe('test method: getId', function() {
+ afterEach(() => {
+ unsetCookie();
+ unsetLocalStorage();
+ });
+
it('provides the stored Zeotap id if a cookie exists', function() {
- getCookieStub.withArgs(ZEOTAP_COOKIE_NAME).returns(ENCODED_ZEOTAP_COOKIE);
+ storage.setCookie(ZEOTAP_COOKIE_NAME, ENCODED_ZEOTAP_COOKIE);
let id = zeotapIdPlusSubmodule.getId();
expect(id).to.deep.equal({
id: ENCODED_ZEOTAP_COOKIE
@@ -61,7 +58,7 @@ describe('Zeotap ID System', function() {
});
it('provides the stored Zeotap id if cookie is absent but present in local storage', function() {
- getDataFromLocalStorageStub.withArgs(ZEOTAP_COOKIE_NAME).returns(ENCODED_ZEOTAP_COOKIE);
+ storage.setDataInLocalStorage(ZEOTAP_COOKIE_NAME, ENCODED_ZEOTAP_COOKIE);
let id = zeotapIdPlusSubmodule.getId();
expect(id).to.deep.equal({
id: ENCODED_ZEOTAP_COOKIE
@@ -99,10 +96,18 @@ describe('Zeotap ID System', function() {
beforeEach(function() {
adUnits = [getAdUnitMock()];
+ storage.setCookie(
+ ZEOTAP_COOKIE_NAME,
+ ENCODED_ZEOTAP_COOKIE
+ );
setSubmoduleRegistry([zeotapIdPlusSubmodule]);
init(config);
config.setConfig(getConfigMock());
- getCookieStub.withArgs(ZEOTAP_COOKIE_NAME).returns(ENCODED_ZEOTAP_COOKIE);
+ });
+
+ afterEach(function() {
+ unsetCookie();
+ unsetLocalStorage();
});
it('when a stored Zeotap ID exists it is added to bids', function(done) {
diff --git a/test/spec/unit/pbjs_api_spec.js b/test/spec/unit/pbjs_api_spec.js
index 960ccf08c92..afad1d665fd 100644
--- a/test/spec/unit/pbjs_api_spec.js
+++ b/test/spec/unit/pbjs_api_spec.js
@@ -1197,6 +1197,14 @@ describe('Unit: Prebid Module', function () {
assert.deepEqual($$PREBID_GLOBAL$$.getAllWinningBids()[0], adResponse);
});
+ it('should replace ${CLICKTHROUGH} macro in winning bids response', function () {
+ pushBidResponseToAuction({
+ ad: ""
+ });
+ $$PREBID_GLOBAL$$.renderAd(doc, bidId, {clickThrough: 'https://someadserverclickurl.com'});
+ expect(adResponse).to.have.property('ad').and.to.match(/https:\/\/someadserverclickurl\.com/i);
+ });
+
it('fires billing url if present on s2s bid', function () {
const burl = 'http://www.example.com/burl';
pushBidResponseToAuction({
@@ -1765,6 +1773,32 @@ describe('Unit: Prebid Module', function () {
expect(auctionArgs.adUnits[0].mediaTypes.native.icon).to.exist;
assert.ok(logErrorSpy.calledWith('Please use an array of sizes for native.icon.sizes field. Removing invalid mediaTypes.native.icon.sizes property from request.'));
});
+
+ it('should throw error message and remove adUnit if adUnit.bids is not defined correctly', function () {
+ const adUnits = [{
+ code: 'ad-unit-1',
+ mediaTypes: {
+ banner: {
+ sizes: [300, 400]
+ }
+ },
+ bids: [{code: 'appnexus', params: 1234}]
+ }, {
+ code: 'bad-ad-unit-2',
+ mediaTypes: {
+ banner: {
+ sizes: [300, 400]
+ }
+ }
+ }];
+
+ $$PREBID_GLOBAL$$.requestBids({
+ adUnits: adUnits
+ });
+ expect(auctionArgs.adUnits.length).to.equal(1);
+ expect(auctionArgs.adUnits[1]).to.not.exist;
+ assert.ok(logErrorSpy.calledWith("Detected adUnit.code 'bad-ad-unit-2' did not have 'adUnit.bids' defined or 'adUnit.bids' is not an array. Removing adUnit from auction."));
+ });
});
});
});